routes2spec 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe60dcfbe04e4fb8eab34486d415fc35f96b4087d7cc3d526b2764b85e84c22b
-  data.tar.gz: 91d6bbbb4e835fddf3ee82b66e2c58e0607cc75c468d013fb430ebb61f8027a7
+  metadata.gz: 79e4e2150811b3cc919d8db511042cc8a733e141f3c1d4e04891accbf364f922
+  data.tar.gz: '07904d17f0923955560f427586158be17578697bbf75e45eac0dae7728ccec63'
 SHA512:
-  metadata.gz: 6a6ee2e33e390e4d70f70c50388e071381a56f96623ddfd47c1d0bb76749a9ce739ef048ad914bb65a96da3b05c7ac7a227f1b77e4363a5e85fda3c270db4960
-  data.tar.gz: f306579044aba45f60890ab6093d5cf807bb0648f154dc3091b7b64c778e1a0f7c270c7319b3078da94f5163874e9fd8954c2c38faeb75487e95bd180029635f
+  metadata.gz: fe56ba68c66c4115fab4940447ac7641e439656f2ba7bd7819ba9f14324ef610a2be1df81efab02913bfe17854587718bc3557f4f47c0f081c5cf1a4f20864ac
+  data.tar.gz: c4887452c2fdc0c26216ff590be8b4fa8c24eb5844fb03ae10000ef67fec8807882918147286cbd8998516bf0f1500da45e862bdc4510fa3018696e4cef379d0

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-rubycw
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true

data/Gemfile

@@ -11,3 +11,5 @@ gem "rubocop", "~> 1.21", require: false
 gem "rubocop-rake", require: false
 gem "rubocop-rspec", require: false
 gem "rubocop-rubycw", require: false
+
+gem "listen" # for test

data/README.md

@@ -1,8 +1,13 @@
 # Routes2spec
 
+[![Gem Version](https://badge.fury.io/rb/routes2spec.svg)](https://badge.fury.io/rb/routes2spec)
+[![Ruby](https://github.com/shuuuuun/routes2spec/actions/workflows/main.yml/badge.svg)](https://github.com/shuuuuun/routes2spec/actions/workflows/main.yml)
+
 Generate Request specs and Routing specs of RSpec, from your Rails routes config.
 It is useful as a test scaffolding.
 
+**Currently does not work with Rails 7.**
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -53,7 +58,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]/routes2spec. 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]/routes2spec/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/shuuuuun/routes2spec. 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/shuuuuun/routes2spec/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/routes2spec/command.rb

@@ -6,6 +6,8 @@ require_relative "./request_spec_formatter"
 module Routes2spec
   # Routes2spec::Command class
   class Command < Rails::Command::Base
+    SUPPORTED_VERBS = Routes2spec::RequestSpecFormatter::SUPPORTED_VERBS
+
     class_option :help, aliases: "-h", banner: "", desc: "Show this message."
     class_option :version, aliases: "-V", banner: "", desc: "Show version."
 
@@ -15,9 +17,11 @@ module Routes2spec
                               desc: "Filter by a specific controller, e.g. PostsController or Admin::PostsController."
     class_option :grep, aliases: "-g", desc: "Grep routes by a specific pattern."
     class_option :symbol_status, banner: "", desc: "Use symbols for http status."
-    class_option :overwrite, banner: "", desc: "Overwrite files even if they exist."
-    class_option :force_overwrite, banner: "", desc: "Force overwrite files even if they exist."
+    class_option :overwrite, banner: "", desc: "Prompts for confirmation to overwrite each file if it already exists."
+    class_option :force_overwrite, banner: "", desc: "Forcibly overwrites existing files without confirmation."
     class_option :pending, banner: "", desc: "Mark examples as pending."
+    class_option :routing, type: :boolean, defalut: false, desc: "Generate routing specs."
+    class_option :verb, desc: "Generate only specific verb. Supported verbs: [#{SUPPORTED_VERBS.join(", ")}]"
 
     class << self
       def executable
@@ -36,6 +40,11 @@ module Routes2spec
         exit 0
       end
 
+      if options.verb? && !SUPPORTED_VERBS.include?(options.verb&.downcase)
+        say "Specified verb(#{options.verb}) is not supported! Supported verbs: [#{SUPPORTED_VERBS.join(", ")}]"
+        exit 1
+      end
+
       require_application_and_environment!
       require "action_dispatch/routing/inspector"
 
@@ -45,7 +54,7 @@ module Routes2spec
         writing_file(relative_path, result[:content])
 
         relative_path = File.join("spec/routing", *result[:namespaces], "#{result[:name].underscore}_spec.rb")
-        writing_file(relative_path, result[:routing_content])
+        writing_file(relative_path, result[:routing_content]) if options.routing?
       end
     end
     # https://github.com/rails/rails/blob/v7.0.4/railties/lib/rails/command/base.rb#L144
@@ -106,7 +115,7 @@ module Routes2spec
     end
 
     def formatter_opts
-      options.symbolize_keys.slice(:symbol_status, :pending)
+      options.symbolize_keys.slice(:symbol_status, :pending, :verb)
     end
   end
 end

data/lib/routes2spec/request_spec_formatter.rb

@@ -3,6 +3,8 @@
 module Routes2spec
   # Routes2spec::RequestSpecFormatter class
   class RequestSpecFormatter
+    SUPPORTED_VERBS = %w[get post patch put delete].freeze
+
     STATUS = {
       get: 200,
       post: 201,
@@ -57,15 +59,19 @@ module Routes2spec
           params_str = param_names.map{|name| "#{name}: \"#{name}\"" }.join(", ")
           path_name = r[:name] || ""
           path_name = grouped_routes.find{ _1[:path] == r[:path] && !_1[:name].empty? }&.fetch(:name) || "" if path_name.empty?
-          Routes2spec.log_debug "verb: #{verb}, path: #{path}, path_name: #{path_name}"
+          Routes2spec.log_debug "verb: #{verb}, path: #{path}, path_name: #{path_name}, @opts: #{@opts}"
           if path_name.empty?
             Routes2spec.log "Skip. No path name! `#{verb&.upcase} #{path}`"
             next
           end
-          unless %w[get post patch put delete].include?(verb)
+          unless SUPPORTED_VERBS.include?(verb)
             Routes2spec.log "Skip. Unsupported verb! `#{verb&.upcase} #{path}`"
             next
           end
+          if !@opts[:verb].nil? && @opts[:verb].downcase != verb
+            Routes2spec.log "Skip. Not matched specified verb(#{@opts[:verb].upcase})! `#{verb&.upcase} #{path}`"
+            next
+          end
           endpoint, constraints = r[:reqs].split(" ")
           Routes2spec.log_debug "endpoint: #{endpoint}, constraints: #{constraints}"
           # TODO: insert constraints to routing spec

data/lib/routes2spec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Routes2spec
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/routes2spec.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors = ["shuuuuuny"]
   spec.email = []
 
-  spec.summary = "routes2spec"
-  spec.description = "routes2spec"
+  spec.summary = "Generate Request specs and Routing specs of RSpec, from your Rails routes config."
+  spec.description = "Generate Request specs and Routing specs of RSpec, from your Rails routes config. It is useful as a test scaffolding."
   spec.homepage = "https://github.com/shuuuuun/routes2spec"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/shuuuuun/routes2spec"
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "rails", "~> 6.1"
   # spec.add_dependency "rspec", ">= 3.9"
 
   # For more information and examples about making a new gem, check out our

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: routes2spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - shuuuuuny
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2024-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
-description: routes2spec
+        version: '6.1'
+description: Generate Request specs and Routing specs of RSpec, from your Rails routes
+  config. It is useful as a test scaffolding.
 email: []
 executables:
 - routes2spec
@@ -65,15 +66,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: routes2spec
+summary: Generate Request specs and Routing specs of RSpec, from your Rails routes
+  config.
 test_files: []