routes2spec 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fc17061731dc2153d96ef54d172142c910ea6d3c2015573550adc07f480d08b
-  data.tar.gz: d3a56701c40d97a9c8408ab1fa8918c869aed151ed8c7fecedf190596f82b9e9
+  metadata.gz: 197213dfc7438c267e64f2ad938f57d7e9a48454781e6aabeae8eebba7e6f79c
+  data.tar.gz: a963d77704bb92c2177ddd05b1d7fd2053b13df1c54a866597db16a300d72acd
 SHA512:
-  metadata.gz: a71c32eea1a488faa670cec692ea8c4394fb168a11418c5cd69873a2533dc8914d54f6fc63080ca96aa5418c412689a6035926960ebc84875e2416c59049749f
-  data.tar.gz: 1525809ecbb6e2a7f4de27d0f904de0b2ed886f11120a4be8b227ff04e7790ec6cb350d5d19a1b61e9bbca0897d5337d360c3b98c1798cc331454edd9d599f59
+  metadata.gz: decf81e5b7aa98f01e6d48b7590f1e6bb6773c7e61f9f65071e303b12ead8f098ab179d627b82fe8c8512a765db0e931ab7366b2eede8675484f77a4666af5c7
+  data.tar.gz: cdff45fff6fc5f45cf8e13336e123a0b566fb239b88577afa4991a7a96f6b7e6b1075da88e79373de687ac67e44029d9f9705dc9582568ca7864aad14285776e

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

@@ -6,6 +6,8 @@
 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:

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,10 +17,12 @@ 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 :literal_path, banner: "", desc: "Use literal paths instead of path helper."
+    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
@@ -37,6 +41,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"
 
@@ -107,7 +116,7 @@ module Routes2spec
     end
 
     def formatter_opts
-      options.symbolize_keys.slice(:symbol_status, :pending)
+      options.symbolize_keys.slice(:symbol_status, :literal_path, :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,27 +59,36 @@ 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
           status = @opts[:symbol_status] ? SYMBOL_STATUS[verb.to_sym] : STATUS[verb.to_sym]
+          use_literal_path = @opts[:literal_path] || false
+          path_helper_str = "#{path_name}_path#{params_str.empty? ? "" : "(#{params_str})"}"
+          literal_path_str = "\"#{path}\""
+          path_str = use_literal_path ? literal_path_str : path_helper_str
           r.merge(
             path: path,
+            path_str: path_str,
             path_name: path_name,
             params_str: params_str,
             reqs: r[:reqs],
             endpoint: endpoint,
             constraints: constraints || "",
-            status: status
+            status: status,
           )
         end.compact
         if routes.empty?

data/lib/routes2spec/templates/request_spec.rb.erb

@@ -4,7 +4,7 @@ RSpec.describe "<%= controller_name %>", type: :request do
 <% routes.each do |route| %>
   describe "<%= route[:verb].upcase %> <%= route[:path] %>" do
     it "works!" do
-      <%= pending ? 'pending "now write some real specs. and remove pending mark."' + "\n      " : "" %><%= route[:verb].downcase %> <%= route[:path_name] %>_path<%= route[:params_str].empty? ? "" : "(#{route[:params_str]})" %>
+      <%= pending ? 'pending "now write some real specs. and remove pending mark."' + "\n      " : "" %><%= route[:verb].downcase %> <%= route[:path_str] %>
       expect(response).to have_http_status(<%= route[:status] %>)
     end
   end

data/lib/routes2spec/version.rb

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

data/routes2spec.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   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,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: routes2spec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - shuuuuuny
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2024-07-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'
+        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: []
@@ -66,14 +66,14 @@ 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.4.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Generate Request specs and Routing specs of RSpec, from your Rails routes