Merge pull request #12 from sasamuku/refactor_using_prism

Refactor using prism

Author: sasamuku

.github/workflows/main.yml

@@ -14,14 +14,14 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '3.1.2'
+          - "3.3.1"
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run the default task
+        run: bundle exec rake

.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.3.1
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +11,14 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "config/routes.rb"

.ruby-version

@@ -0,0 +1 @@
+3.3.1

Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "prism", "~> 1.3.0"

Gemfile.lock

@@ -15,6 +15,7 @@ GEM
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    prism (1.3.0)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
@@ -56,6 +57,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  prism (~> 1.3.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec_tree!

README.md

@@ -1,6 +1,6 @@
 # RspecTree
 
-This is tree command for rspec test files.
+`RspecTree` is a command-line tool for displaying the structure of RSpec test files in a tree format. It uses [prism](https://github.com/ruby/prism), the default parser introduced in Ruby 3.4, to parse and traverse the AST.
 
 ## Installation
 
@@ -14,31 +14,42 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-```
+### Display All Describes, Contexts, and Examples
+
+Use the `all` option to print all `describe`, `context`, and `example` blocks in a file:
+
+```bash
 $ rspec_tree all /path/to/your_spec.rb
-desc: Sample
-desc: First describe
-├─────ctx: First context
-├───────it: should do something
-├───────ctx: First nested context
-├─────────it: should do something
-├───────it_behaves_like: shared example
-desc: Second describe
-├─────ctx: Second context
-├───────it: should do something else
+desc: SampleClass
+├──desc: First describe
+├────ctx: First context
+├──────ctx: First nested context
+├────────it: should do something
+├──────it: should do something
+├──desc: Second describe
+├────ctx: Second context
+├──────it: should do something else
 ```
 
-```
+### Display Only Describes and Contexts
+
+Use the `ctx` option to print only `describe` and `context` blocks:
+
+```bash
 $ rspec_tree ctx /path/to/your_spec.rb
-desc: Sample
-desc: First describe
-├─────ctx: First context
-├───────ctx: First nested context
-desc: Second describe
-├─────ctx: Second context
+desc: SampleClass
+├──desc: First describe
+├────ctx: First context
+├──────ctx: First nested context
+├──desc: Second describe
+├────ctx: Second context
 ```
 
-```
+### Display Help Information
+
+Run the `help` command to see all available commands:
+
+```bash
 $ rspec_tree help
 Commands:
   rspec_tree all [file]      # Print all (describe, context, it, etc.)

lib/rspec_tree/cli.rb

@@ -2,21 +2,26 @@
 
 require "thor"
 require "rspec_tree/tree"
+require "rspec_tree/visitor"
 
 module RspecTree
   # This class is used to define the CLI
   class CLI < Thor
     desc "all [file]", "Print all (describe, context, it, etc.)"
     def all(file)
       File.open(file, "r") do |f|
-        Tree.new(f.read, :all).print
+        visitor = RspecTree::Visitor.new
+        Prism.parse(f.read).value.accept(visitor)
+        RspecTree::Tree.new(visitor.root, :all).print
       end
     end
 
     desc "ctx [file]", "Print only describe and context"
     def ctx(file)
       File.open(file, "r") do |f|
-        Tree.new(f.read, :ctx).print
+        visitor = RspecTree::Visitor.new
+        Prism.parse(f.read).value.accept(visitor)
+        RspecTree::Tree.new(visitor.root, :ctx).print
       end
     end
   end

lib/rspec_tree/context.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RspecTree
+  class Context
+    attr_accessor :title, :contexts, :examples
+
+    def initialize
+      @title = nil
+      @contexts = []
+      @examples = []
+    end
+  end
+end

lib/rspec_tree/description.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RspecTree
+  class Description
+    attr_accessor :title, :contexts
+
+    def initialize
+      @title = nil
+      @contexts = []
+    end
+  end
+end

lib/rspec_tree/example.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RspecTree
+  class Example
+    attr_accessor :title
+
+    def initialize
+      @title = nil
+    end
+  end
+end