missing_rspec 0.0.2 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513b1ff6dc1280c5a1f67754bd404462e7be694f3bdc513fd5ed6cd9c6042db0
-  data.tar.gz: f7202135b767911e2eb016df90d375655bc7267b825bc8ab396ef7248bd3ecf7
+  metadata.gz: c77461cf31c770b16004fd024396d8d96cacf2f2ded526e2f9cf32d8958290ed
+  data.tar.gz: b01d1871f9aecc8ba9ca299864b2a639a0c5376948fb5d3401225ccfcb4756b3
 SHA512:
-  metadata.gz: caef5841515f222526f8c9f578b2c2cae57a0d43e2c78a26495d798c31ada4e1fdd01089f68e0cb0674c106b00c416c3b6f5e4b69df45254a719568fd6819548
-  data.tar.gz: 72a9a5e974fbd5101cccb94e51e8fb7aeabe24a0ddc575fe59dc2174a745078c1e652a3ede89e18d055b78a2bf4a9e7b18b9740c3da8a5064427c592e0ae2414
+  metadata.gz: 1d761bdccc8e153a66a60af9a4a8b4c6e8c57bbae849d57fff7a244e2a0ba05aa59e660e8eda27252a99916bd0720498e7276e76ee4b5c31959b1711b8bb1957
+  data.tar.gz: 2f0c8d94b311a05ff805004fec31c8880c55d1abfcd77e59b02cb73dd189c80b0008fab36cd15a87438de06bde1e0106a4c889bf784e730deb0e9a7ed8088065

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    missing_rspec (0.0.2)
+    missing_rspec (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -10,14 +10,10 @@ To use it, add it to your Gemfile:
 gem 'missing_rspec', group: :development
 ```
 
-## Usage
+## How to use the preview
 
 ### How to specify rails path as an argument to rake
 
-```shell
-bin/rails runner "puts Rails.root.to_s"
-```
-
 Example when rails path is /app
 
 ```shell
@@ -41,10 +37,19 @@ RAILS_APP_PATH=/app
 ```shell
 bin/rails missing_rspec
 ```
-## Execution example
+
+### The second argument can be used to narrow down the target.
+
+The following is an example of specifying models, controllers and jobs.
+
+```shell
+bin/rails missing_rspec[/app,models\;controllers\;jobs]
+```
+
+### Execution example
 
 ```shell
-root@be31b61b9f18:/app/missing_rspec# bin/rails missing_rspec
+bin/rails missing_rspec
 
 
 
@@ -157,6 +162,34 @@ The following folders are targeted: ["channels", "controllers", "forms", "helper
   └<staff>
 ```
 
+## How to use the creator
+Note: Due to the large number of rspec files to be written, It is recommended that you git-commit the file before executing it so that you can revert it.
+### Create all RSpecs shown in preview.
+
+Example when rails path is /app
+
+```shell
+bin/rails missing_rspec_create[/app]
+```
+
+Example .env file when rails path is /app
+
+```shell
+RAILS_APP_PATH=/app
+```
+
+```shell
+bin/rails missing_rspec_create
+```
+
+### The second argument can be used to narrow down the target.
+
+The following is an example of specifying models, controllers and jobs.
+
+```shell
+bin/rails missing_rspec_create[/app,models\;controllers\;jobs]
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kayamak/missing_rspec. 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/kayamak/missing_rspec).

data/lib/missing_rspec/core.rb

@@ -1,35 +1,26 @@
-require 'missing_rspec/directory'
 require 'missing_rspec/folder_types_finder'
-require 'missing_rspec/version'
+require 'missing_rspec/viewer'
+require 'missing_rspec/creator'
 
 module MissingRspec
   class Core
-    attr_reader :app_path
+    def self.execute(mode:, app_path:, folder_type:)
+      app_path ||= ENV['RAILS_APP_PATH']
+      raise "Set the rails app path to the rake argument or the environment variable RAILS_APP_PATH." unless app_path
 
-    def initialize(app_path)
-      # e.g. /app
-      @app_path = app_path || ENV['RAILS_APP_PATH']
-      raise "Set the rails app path to the rake argument or the environment variable RAILS_APP_PATH." unless @app_path
-    end
-
-    def execute
-      folder_types = MissingRspec::FolderTypesFinder.new(app_path).fetch_folder_types
-      puts "The following folders are targeted: #{folder_types}"
-      folder_types.each do |folder_type|
-        missing_tree = create_missing_tree(folder_type)
-        print_tree(missing_tree)
+      folder_type ||= 'all'
+      folder_types = MissingRspec::FolderTypesFinder.new(app_path).fetch_folder_types      
+      if folder_type != 'all'
+        folder_types &&= folder_type.split(';').map!(&:strip)
       end
+      puts "The following folders are targeted: #{folder_types}"
 
-      'hogehoge'
-    end
-
-    private
-    def create_missing_tree(folder_type)
-      MissingRspec::Directory.new(app_path: app_path, folder_type: folder_type).missing_tree
-    end
-
-    def print_tree(tree)
-      puts tree.join("\n")
+      case mode
+      when :viewer
+        MissingRspec::Viewer.new(app_path: app_path, folder_types: folder_types).execute
+      when :creator
+        MissingRspec::Creator.new(app_path: app_path, folder_types: folder_types).execute
+      end
     end
   end
 end

data/lib/missing_rspec/creator.rb

@@ -0,0 +1,74 @@
+require 'missing_rspec/tree'
+require 'missing_rspec/module_name'
+require 'fileutils'
+
+module MissingRspec
+  class Creator
+    attr_reader :app_path, :folder_types
+
+    def initialize(app_path:, folder_types:)
+     # e.g. app_path:/app
+      @app_path = app_path
+      @folder_types = folder_types
+    end
+
+    def execute
+      folder_types.each do |folder_type|
+        rspecs_per_module_name = fetch_rspecs_per_module_name(folder_type)
+        create_rspecs(folder_type, rspecs_per_module_name)
+      end
+    end
+
+    private
+
+    def fetch_rspecs_per_module_name(folder_type)
+      MissingRspec::ModuleName.new(app_path: app_path, folder_type: folder_type).rspecs_per_module_name
+    end
+
+    def create_rspecs(folder_type, rspecs_per_module_name)
+      rspecs_per_module_name.each do |module_name, rspecs|
+        rspec_full_path = make_rspec_full_path(folder_type, module_name)
+
+        rspecs.each do |rspec|
+          rspec_file_name = rspec.sub(/.rb$/, '_spec.rb')
+          rspec_full_path_file_name = "#{rspec_full_path}#{rspec_file_name}"
+          class_name = rspec.sub(/.rb$/, '').classify
+          full_class_name = build_full_class_name(module_name, class_name)
+          rspec_content = build_rspec_content(full_class_name, folder_type)
+
+          write_rspec_content(rspec_full_path_file_name, rspec_content)
+        end
+      end
+    end
+
+    def build_full_class_name(module_name, class_name)
+      if module_name == "Concerns"
+        "#{'"'}#{class_name}#{'"'}"
+      else
+        "#{module_name}#{module_name.blank? ? '' : '::'}#{class_name}"
+      end
+    end
+
+    def make_rspec_full_path(folder_type, module_name)
+      module_path = module_name.split('::').map(&:underscore).join('/')
+      rspec_full_path = "#{app_path}/spec/#{folder_type}/#{module_path}#{module_path.blank? ? '' : '/'}"
+      FileUtils.mkdir_p(rspec_full_path)
+      rspec_full_path
+    end
+
+    def build_rspec_content(full_class_name, folder_type)
+      <<~EOS
+        # rubocop:disable Lint/EmptyBlock
+        RSpec.describe #{full_class_name}, type: :#{folder_type.singularize} do
+        end
+        # rubocop:enaable Lint/EmptyBlock
+      EOS
+    end
+
+    def write_rspec_content(rspec_full_path_file_name, rspec_content)
+      File.open(rspec_full_path_file_name, "w") do |io|
+        io.write(rspec_content)
+      end
+    end
+  end
+end

data/lib/missing_rspec/module_name.rb

@@ -0,0 +1,77 @@
+require 'pry'
+
+module MissingRspec
+  class ModuleName
+    attr_reader :app_path, :folder_type
+
+    def initialize(app_path:, folder_type:)
+      @app_path = app_path
+      @folder_type = folder_type
+    end
+
+    def rspecs_per_module_name
+      original_module_names = make_original_module_names
+      spec_module_names = make_spec_module_names
+
+      target_module_names = find_rspecs_per_module_name(original_module_names, spec_module_names)
+      target_module_names
+    end
+
+    private
+
+    def make_original_module_names
+      models_path = "#{app_path}/app/#{folder_type}"
+      fetch_module_names(target_path: models_path, is_rspec: false)
+    end
+
+    def make_spec_module_names
+      spec_models_path = "#{app_path}/spec/#{folder_type}"
+      fetch_module_names(target_path: spec_models_path, is_rspec: true)
+    end
+
+    def fetch_module_names(target_path: ,is_rspec:)
+      unless File.directory?(target_path)
+        if folder_type == target_path.split('/').last
+          return {}
+        end        
+        raise "#{target_path} is not directory." 
+      end
+
+      result = Hash.new{ |hash, key| hash[key] = [] }
+
+      trace_dir = lambda do |dir, module_name|
+        Dir.chdir(dir)
+        dir_files = Dir.glob('*').sort
+        lower_dirs = dir_files.select { |df| File.directory?(df) }
+        files = dir_files - lower_dirs
+
+        lower_dirs.each do |lower_dir|
+          lower_module_name = "#{module_name}#{module_name.blank? ? '' : '::'}#{lower_dir.camelize}"
+          trace_dir.call(lower_dir, lower_module_name)
+        end
+
+        files.each do |file|
+          next unless /.rb$/ =~ file
+
+          replaced_file = is_rspec ? file.sub(/_spec.rb$/, '.rb') : file
+          result[module_name] << replaced_file
+        end
+
+        Dir.chdir('..')
+      end
+      trace_dir.call(target_path, '')
+
+      result
+    end
+
+    def find_rspecs_per_module_name(original_module_names, spec_module_names)
+      target_module_names = Hash.new{ |hash, key| hash[key] = [] }
+      original_module_names.each do |module_name, rb_files|
+        spec_files = spec_module_names[module_name] || []
+        target_files = rb_files - spec_files
+        target_module_names[module_name] = target_files if target_files.present?
+      end
+      target_module_names
+    end
+  end
+end

data/lib/missing_rspec/{directory.rb → tree.rb}

@@ -1,5 +1,5 @@
 module MissingRspec
-  class Directory
+  class Tree
     attr_reader :app_path, :folder_type
 
     def initialize(app_path:, folder_type:)

data/lib/missing_rspec/version.rb

@@ -1,3 +1,3 @@
 module MissingRspec
-  VERSION = "0.0.2"
+  VERSION = "0.1.2"
 end

data/lib/missing_rspec/viewer.rb

@@ -0,0 +1,30 @@
+require 'missing_rspec/tree'
+require 'missing_rspec/version'
+
+module MissingRspec
+  class Viewer
+    attr_reader :app_path, :folder_types
+
+    def initialize(app_path:, folder_types:)
+      # e.g. app_path:/app
+      @app_path = app_path
+      @folder_types = folder_types
+    end
+
+    def execute
+      folder_types.each do |folder_type|
+        missing_tree = create_missing_tree(folder_type)
+        print_tree(missing_tree)
+      end
+    end
+
+    private
+    def create_missing_tree(folder_type)
+      MissingRspec::Tree.new(app_path: app_path, folder_type: folder_type).missing_tree
+    end
+
+    def print_tree(tree)
+      puts tree.join("\n")
+    end
+  end
+end

data/lib/tasks/missing_rspec.rake

@@ -1,6 +1,11 @@
 require 'missing_rspec/core'
 
 desc "mechanically extracts uncreated RSpecs"
-task :missing_rspec, ['app_path'] => :environment do |_, args|
-  MissingRspec::Core.new(args.app_path).execute
+task :missing_rspec, %w[app_path folder_type] => :environment do |_, args|
+  MissingRspec::Core.execute(mode: :viewer, app_path: args.app_path, folder_type: args.folder_type)
+end
+
+desc "Create an uncreated Rsepc files"
+task :missing_rspec_create, %w[app_path folder_type] => :environment do |_, args|
+  MissingRspec::Core.execute(mode: :creator, app_path: args.app_path, folder_type: args.folder_type)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: missing_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.2
 platform: ruby
 authors:
 - Keiichi Kayama
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies: []
 description: This Gem extracts RSpec files that have not yet been created.
 email:
@@ -30,9 +30,12 @@ files:
 - bin/setup
 - lib/missing_rspec.rb
 - lib/missing_rspec/core.rb
-- lib/missing_rspec/directory.rb
+- lib/missing_rspec/creator.rb
 - lib/missing_rspec/folder_types_finder.rb
+- lib/missing_rspec/module_name.rb
+- lib/missing_rspec/tree.rb
 - lib/missing_rspec/version.rb
+- lib/missing_rspec/viewer.rb
 - lib/tasks/missing_rspec.rake
 - missing_rspec.gemspec
 homepage: https://github.com/kayamak/missing_rspec