rspec_tree 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69bf1c38057249aa20f8c357e0fe54d8f64928573890e834a5128c88942ee5f7
-  data.tar.gz: bc57d17307869b055d41b1b1278cd5d9c3fcc8434b582ae4441fbdfc4ef34d15
+  metadata.gz: f1d9e799aa7b3e41c8a9e3a874fc6118dee71641bf44c9912ec5a4a91b5af1ec
+  data.tar.gz: bdc2b58ef18964025325832d8767206fcd10e73e931e55605313d1fdc51e32f8
 SHA512:
-  metadata.gz: 753d815cb5cfd6d846810f2580318f6beb136c63b4bd73f5b84332dd84608a48522d04b8570c262b6fbc53f6013db853d380eceda00cbd02c69efbd6487c703d
-  data.tar.gz: 2e34458c6ccf09e8f3ddc92e5a4c94cef7692da9bde50d3d20de33c1c353a7e6d6e6317d14ba8eac099558121052a10afa5375358ac3e21472344cc7a530fdf4
+  metadata.gz: d411f6635d841e6aaec75577b26a8a8ba7c3236dfbf7c18672af0105fa20a47f52b06956076ec4e6e6ae2f7e705601738f4812ef58eb23093cc0c0e4724ff3b5
+  data.tar.gz: 176b03ecda162178c62477b9ad22f26d9c1fedb0cfdee2b9a56813b5ac99c36a7b885c7ce395faaa4d38c2a1f6bd9c6450a4473fa1c90f6e095e5376a27addb3

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-03-07
+## [0.1.2] - 2024-03-17
 
-- Initial release
+- Fix nested context
+- Support context mode
 
 ## [0.1.1] - 2024-03-16
 
 - Fix commnad description
+
+## [0.1.0] - 2024-03-07
+
+- Initial release
+

data/README.md

@@ -1,24 +1,50 @@
 # RspecTree
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec_tree`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is tree command for rspec test files.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add rspec_tree
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install rspec_tree
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+$ 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
+```
+
+```
+$ 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
+```
+
+```
+$ rspec_tree help
+Commands:
+  rspec_tree all [file]      # Print all (describe, context, it, etc.)
+  rspec_tree ctx [file]      # Print only describe and context
+  rspec_tree help [COMMAND]  # Describe available commands or one specific command
+```
 
 ## Development
 
@@ -28,7 +54,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec_tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rspec_tree/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/sasamuku/rspec_tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rspec_tree/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/exe/rspec_tree

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "rspec_tree"
 

data/lib/rspec_tree/cli.rb

@@ -1,19 +1,22 @@
+# frozen_string_literal: true
+
 require "thor"
 require "rspec_tree/tree"
 
 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.all(f.read)
+        Tree.new(f.read, :all).print
       end
     end
 
     desc "ctx [file]", "Print only describe and context"
     def ctx(file)
       File.open(file, "r") do |f|
-        Tree.ctx(f.read)
+        Tree.new(f.read, :ctx).print
       end
     end
   end

data/lib/rspec_tree/tree/monkey_patch.rb

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,15 @@
+# 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/lib/rspec_tree/tree.rb

@@ -1,63 +1,55 @@
 # frozen_string_literal: true
 
+require_relative "tree/rspec"
+require_relative "tree/monkey_patch"
+
 module RspecTree
-  module Tree
-    Class.class_eval do
-      def const_missing(name)
-        name.to_s
-      end
+  # 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
+
+    def initialize(file, type)
+      @file = file
+      @type = type
+      @base_depth = 0
     end
 
-    module RSpec
-      class << self
-        def describe(*args, &block)
-          puts "desc: #{args.first}"
-          block.call
-        end
-      end
+    def print
+      eval(file) # rubocop:disable Security/Eval
     end
 
-    class << self
-      # @param [String] file
-      def all(file)
-        eval(file)
-      end
-
-      # TODO: to be implemented
-      def ctx(file)
-        eval(file)
-      end
-
-      private
+    private
 
-      def describe(*args, &block)
-        RSpec.describe(*args, &block)
-      end
-
-      def context(*args, &block)
-        puts "├──ctx: #{args.first}"
-        block.call
-      end
-
-      def example(*args, &block)
-        puts "├────ex: #{args.first}"
-      end
+    def describe(*args, &block)
+      self.base_depth = caller.size
+      RSpec.describe(*args, &block)
+    end
 
-      def it(*args, &block)
-        puts "├────it: #{args.first}"
-      end
+    def context(*args, &block)
+      tree(args.first, "ctx")
+      block.call
+    end
 
-      def it_behaves_like(*args, &block)
-        puts "├────it_behaves_like: #{args.first}"
-      end
+    def example(*args, &_block)
+      tree(args.first, "ex")
+    end
 
-      def require_relative(file); end
+    def it(*args, &_block)
+      tree(args.first, "it") if type == :all
+    end
 
-      def require(file); end
+    def it_behaves_like(*args, &_block)
+      tree(args.first, "it_behaves_like") if type == :all
+    end
 
-      def include(*args); end
+    def dash
+      "─" * (caller.size - base_depth)
+    end
 
-      def method_missing(method, *args, &block); end
+    def tree(arg, name)
+      puts "├#{dash}#{name}: #{arg}"
     end
   end
 end

data/lib/rspec_tree/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - sasamuku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -45,6 +45,8 @@ files:
 - lib/rspec_tree.rb
 - lib/rspec_tree/cli.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
 - sig/rspec_tree.rbs
@@ -70,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: tree command for rspec test files.