rspec_tree 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc85df0dd2b82d08ccda1a27d0f6b23a779bac0df99f33eec75f45dd5d99abbe
-  data.tar.gz: fae13802971ba1a4bc7f8b3af835adcb5708931f37618c9f4613ed0bd5c25a64
+  metadata.gz: b274e69832e65ed946b50548b72cbbd0cebb08f736d1f08a3de9e3a3841773bf
+  data.tar.gz: 3e9183e5707288dcd67c4ad580c1967ce839fad9c072a324a07a7e72ac19c83a
 SHA512:
-  metadata.gz: 69547316a54ede78c5e72a246fd39c6114e064088db76bd4543d659322cec2dc0d7719eee50db5edc448f14641dd5886ba5ee19b7b0d3b02864fd980a9d1deca
-  data.tar.gz: dc40926bf1390ca5e4b350d4420d7201fb87217621a0607081589cf0398932daaeae38a9f379315ce5adddbccd3dfa0e7d7873367c1e5f2f845d3c86d801fd1a
+  metadata.gz: 2b6ffed12d9068beae9a87a753c09965f0fac1e9b9f9d5676564ac6ad8a092bc861e522523e6cded0a42454a09eafa9dcb74b046c7e47fe5b8fa1e78ebbff957
+  data.tar.gz: 9c4481673679ab6cbde600495df838cdfb7e54715aa2fa8e80b73475154e85b79884ed09d340681aee616e8da0d7ba954c5a71e2743f087c2b216806bbde7760

data/.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"

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-12-31
+
+- Refactor to use prism parser
+
 ## [0.1.6] - 2024-03-25
 
 - Fix SyntaxError
@@ -28,4 +32,3 @@
 ## [0.1.0] - 2024-03-07
 
 - Initial release
-

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec_tree (0.1.6)
+    rspec_tree (0.2.0)
       thor
 
 GEM
@@ -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!

data/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.)

data/lib/rspec_tree/cli.rb

@@ -2,6 +2,7 @@
 
 require "thor"
 require "rspec_tree/tree"
+require "rspec_tree/visitor"
 
 module RspecTree
   # This class is used to define the CLI
@@ -9,14 +10,18 @@ module RspecTree
     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

data/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

data/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

data/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

data/lib/rspec_tree/root.rb

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

data/lib/rspec_tree/tree.rb

@@ -1,63 +1,54 @@
 # frozen_string_literal: true
 
-require_relative "tree/rspec"
-require_relative "tree/monkey_patch"
-
 module RspecTree
-  # This module is used to parse the RSpec file
-  # and print the tree structure of the RSpec file.
   class Tree
-    attr_reader :file, :type
-    attr_accessor :base_depth
-
-    PATTERN = /'*[::]*[A-Z][\w-]*(?:::[A-Z][\w-]*)+'*/.freeze
-
-    def initialize(file, type)
-      @file = const_to_string(file)
+    def initialize(root, type)
+      @root = root
       @type = type
-      @base_depth = 0
     end
 
     def print
-      eval(file) # rubocop:disable Security/Eval
+      print_root_description(@root, 0)
     end
 
     private
 
-    def describe(*args, &block)
-      self.base_depth = caller.size
-      RSpec.describe(*args, &block)
-    end
+    def print_root_description(description, depth)
+      puts "desc: #{description.title}"
 
-    def context(*args, &block)
-      tree(args.first, "ctx")
-      block.call
+      description.descriptions.each do |nested_description|
+        print_description(nested_description, depth + 1)
+      end
     end
 
-    def example(*args, &_block)
-      tree(args.first, "ex")
-    end
+    def print_description(description, depth)
+      puts "#{indent(depth)}desc: #{description.title}"
 
-    def it(*args, &_block)
-      tree(args.first, "it") if type == :all
+      description.contexts.each do |context|
+        print_context(context, depth + 1)
+      end
     end
 
-    def it_behaves_like(*args, &_block)
-      tree(args.first, "it_behaves_like") if type == :all
-    end
+    def print_context(context, depth)
+      puts "#{indent(depth)}ctx: #{context.title}"
+
+      context.contexts.each do |ctx|
+        print_context(ctx, depth + 1)
+      end
 
-    def dash
-      "─" * (caller.size - base_depth)
+      context.examples.each do |example|
+        print_example(example, depth + 1)
+      end
     end
 
-    def tree(arg, name)
-      puts "├#{dash}#{name}: #{arg}"
+    def print_example(example, depth)
+      return if @type == :ctx
+
+      puts "#{indent(depth)}it: #{example.title}"
     end
 
-    def const_to_string(str)
-      str.gsub(PATTERN) do |match|
-        "\"#{match}\""
-      end
+    def indent(level)
+      "\u251C#{"\u2500\u2500" * level}"
     end
   end
 end

data/lib/rspec_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RspecTree
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/rspec_tree/visitor.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "prism"
+
+require_relative "root"
+require_relative "description"
+require_relative "context"
+require_relative "example"
+
+module RspecTree
+  class Visitor < Prism::Visitor
+    attr_accessor :root
+
+    def initialize
+      @root = RspecTree::Root.new
+      super
+    end
+
+    def call_node?(node)
+      node.is_a?(Prism::CallNode)
+    end
+
+    def block_node?(node)
+      node.is_a?(Prism::BlockNode)
+    end
+
+    def root_describe_node?(node)
+      node&.name == :describe && node.receiver
+    end
+
+    def describe_node?(node)
+      node.name == :describe
+    end
+
+    def context_node?(node)
+      node.name == :context
+    end
+
+    def example_node?(node)
+      node.name == :it || node.name == :specify || node.name == :example
+    end
+
+    def handle_root_describe_node(node)
+      @root.title = node.arguments.arguments.first.name
+      call_nodes_in_block(node).each do |child_node|
+        if describe_node?(child_node)
+          @root.descriptions << RspecTree::Description.new
+          handle_describe_node(child_node, @root.descriptions.last)
+        end
+      end
+    end
+
+    def handle_describe_node(node, parent)
+      parent.title = node.arguments.arguments.first.unescaped
+      call_nodes_in_block(node).each do |child_node|
+        if context_node?(child_node)
+          parent.contexts << RspecTree::Context.new
+          handle_context_node(child_node, parent.contexts.last)
+        end
+      end
+    end
+
+    def handle_context_node(node, parent)
+      parent.title = node.arguments.arguments.first.unescaped
+      call_nodes_in_block(node).each do |child_node|
+        if context_node?(child_node)
+          parent.contexts << RspecTree::Context.new
+          handle_context_node(child_node, parent.contexts.last)
+        elsif example_node?(child_node)
+          parent.examples << RspecTree::Example.new
+          handle_example_node(child_node, parent.examples.last)
+        end
+      end
+    end
+
+    def handle_example_node(node, parent)
+      parent.title = node.arguments.arguments.first.unescaped
+    end
+
+    def call_nodes_in_block(node)
+      call_nodes = []
+      node.compact_child_nodes.each do |child_node|
+        next unless block_node?(child_node)
+
+        call_nodes = child_node.compact_child_nodes.first.compact_child_nodes.select do |grand_child_node|
+          call_node?(grand_child_node)
+        end
+      end
+      call_nodes
+    end
+
+    def visit_call_node(node)
+      if root_describe_node?(node)
+        handle_root_describe_node(node)
+      elsif describe_node?(node)
+        handle_describe_node(node)
+      elsif context_node?(node)
+        handle_context_node(node)
+      elsif example_node?(node)
+        handle_example_node(node)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - sasamuku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -44,11 +45,13 @@ files:
 - exe/rspec_tree
 - lib/rspec_tree.rb
 - lib/rspec_tree/cli.rb
+- lib/rspec_tree/context.rb
+- lib/rspec_tree/description.rb
+- lib/rspec_tree/example.rb
+- lib/rspec_tree/root.rb
 - lib/rspec_tree/tree.rb
-- lib/rspec_tree/tree/monkey_patch.rb
-- lib/rspec_tree/tree/rspec.rb
 - lib/rspec_tree/version.rb
-- rspec_tree.gemspec
+- lib/rspec_tree/visitor.rb
 - sig/rspec_tree.rbs
 homepage: https://github.com/sasamuku/rspec_tree
 licenses:
@@ -65,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.3.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: tree command for rspec test files.

data/lib/rspec_tree/tree/monkey_patch.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module RspecTree
-  # This is a monkey patch to override basic behavior
-  class Tree
-    Class.class_eval do
-      def const_missing(name)
-        name.to_s
-      end
-    end
-
-    private
-
-    def require_relative(file); end
-
-    def require(file); end
-
-    def include(*args); end
-
-    def method_missing(method, *args, &block); end
-
-    def respond_to_missing?(method, *)
-      super
-    end
-  end
-end

data/lib/rspec_tree/tree/rspec.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module RspecTree
-  class Tree
-    # This module is used to override the RSpec module
-    module RSpec
-      class << self
-        def describe(*args, &block)
-          puts "desc: #{args.first}"
-          block.call
-        end
-      end
-    end
-  end
-end

data/rspec_tree.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/rspec_tree/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "rspec_tree"
-  spec.version = RspecTree::VERSION
-  spec.authors = ["sasamuku"]
-  spec.email = ["sasazawa3330@gmail.com"]
-
-  spec.summary = "tree command for rspec test files."
-  spec.description = "tree command for rspec test files."
-  spec.homepage = "https://github.com/sasamuku/rspec_tree"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/sasamuku/rspec_tree"
-  spec.metadata["changelog_uri"] = "https://github.com/sasamuku/rspec_tree"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-
-  spec.add_dependency "thor"
-end