routes2spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe60dcfbe04e4fb8eab34486d415fc35f96b4087d7cc3d526b2764b85e84c22b
+  data.tar.gz: 91d6bbbb4e835fddf3ee82b66e2c58e0607cc75c468d013fb430ebb61f8027a7
+SHA512:
+  metadata.gz: 6a6ee2e33e390e4d70f70c50388e071381a56f96623ddfd47c1d0bb76749a9ce739ef048ad914bb65a96da3b05c7ac7a227f1b77e4363a5e85fda3c270db4960
+  data.tar.gz: f306579044aba45f60890ab6093d5cf807bb0648f154dc3091b7b64c778e1a0f7c270c7319b3078da94f5163874e9fd8954c2c38faeb75487e95bd180029635f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,64 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-rubycw
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'spec/tmp/**/*'
+    - 'spec/isolation/abstract_unit.rb'
+    - 'vendor/bundle/**/*'
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - '*.gemspec'
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Max: 15
+
+# DisabledByDefault for RSpec
+RSpec:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: true
+
+RSpec/VerifiedDoubles:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in routes2spec.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21", require: false
+gem "rubocop-rake", require: false
+gem "rubocop-rspec", require: false
+gem "rubocop-rubycw", require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 shuuuuuny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Routes2spec
+
+Generate Request specs and Routing specs of RSpec, from your Rails routes config.
+It is useful as a test scaffolding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "routes2spec", group: :test
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+This gem depends on the Rails application, so it generates binstubs first.
+```sh
+$ bundle exec routes2spec --binstubs
+# => `bin/routes2spec` will be generated.
+```
+
+Then, simply execute the following command to generate the spec files.
+```sh
+$ bin/routes2spec
+```
+
+See help for other options.
+```sh
+$ bin/routes2spec --help
+Usage:
+  routes2spec [options]
+
+Options:
+  -h, [--help]                   # Show this message.
+  -V, [--version]                # Show version.
+      [--binstubs]               # Generate binstubs.
+  -c, [--controller=CONTROLLER]  # Filter by a specific controller, e.g. PostsController or Admin::PostsController.
+  -g, [--grep=GREP]              # Grep routes by a specific pattern.
+      [--symbol-status]          # Use symbols for http status.
+      [--overwrite]              # Overwrite files even if they exist.
+      [--force-overwrite]        # Force overwrite files even if they exist.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/routes2spec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "routes2spec"
+
+Routes2spec::Command.perform("routes2spec", ARGV, {})

data/lib/routes2spec/binstubs/routes2spec

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+
+require "routes2spec"
+Routes2spec::Command.perform("routes2spec", ARGV, {})

data/lib/routes2spec/command.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "rails/command"
+require_relative "./request_spec_formatter"
+
+module Routes2spec
+  # Routes2spec::Command class
+  class Command < Rails::Command::Base
+    class_option :help, aliases: "-h", banner: "", desc: "Show this message."
+    class_option :version, aliases: "-V", banner: "", desc: "Show version."
+
+    class_option :binstubs, banner: "", desc: "Generate binstubs."
+
+    class_option :controller, aliases: "-c",
+                              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 :pending, banner: "", desc: "Mark examples as pending."
+
+    class << self
+      def executable
+        "routes2spec"
+      end
+    end
+
+    def perform(*)
+      if options.version?
+        say "Routes2spec: #{Routes2spec::VERSION}"
+        exit 0
+      end
+
+      if options.binstubs?
+        make_binstubs
+        exit 0
+      end
+
+      require_application_and_environment!
+      require "action_dispatch/routing/inspector"
+
+      results = inspector.format(formatter, routes_filter)
+      results.each do |result|
+        relative_path = File.join("spec/requests", *result[:namespaces], "#{result[:name].underscore}_spec.rb")
+        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])
+      end
+    end
+    # https://github.com/rails/rails/blob/v7.0.4/railties/lib/rails/command/base.rb#L144
+    alias_method "routes2spec", "perform"
+
+    private
+
+    def writing_file(relative_path, content)
+      outfile = Rails.root.join(relative_path)
+      FileUtils.mkdir_p(File.dirname(outfile))
+
+      unless File.exist?(outfile)
+        Routes2spec.log "Generating: #{relative_path}"
+        File.write(outfile, content, mode: "w")
+        return
+      end
+
+      if options.force_overwrite?
+        Routes2spec.log "Overwriting: #{relative_path}"
+        File.write(outfile, content, mode: "w")
+        return
+      end
+
+      Routes2spec.log "Already exists: #{relative_path}"
+
+      if options.overwrite? && file_collision(relative_path)
+        say "Overwriting..."
+        File.write(outfile, content, mode: "w")
+      end
+    end
+
+    def make_binstubs
+      require "fileutils"
+      FileUtils.mkdir_p("bin")
+      outfile = File.expand_path("bin/routes2spec")
+      file_path = File.expand_path(File.join(File.dirname(__FILE__), "binstubs/routes2spec"))
+      content = File.read(file_path)
+      File.write(outfile, content, mode: "w")
+      FileUtils.chmod("+x", outfile)
+      Routes2spec.log "Generated: bin/routes2spec"
+    end
+
+    def inspector
+      ActionDispatch::Routing::RoutesInspector.new(routes)
+    end
+
+    def routes
+      # TODO: support engine routes.
+      Rails.application.routes.routes.reject{ _1.app.engine? || _1.internal }
+    end
+
+    def formatter
+      Routes2spec::RequestSpecFormatter.new(formatter_opts)
+    end
+
+    def routes_filter
+      options.symbolize_keys.slice(:controller, :grep)
+    end
+
+    def formatter_opts
+      options.symbolize_keys.slice(:symbol_status, :pending)
+    end
+  end
+end

data/lib/routes2spec/logging.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Routes2spec
+  # @private
+  module Logging
+    def debug?
+      ENV.fetch("ROUTES2SPEC_DEBUG", nil)
+    end
+
+    def log_debug(message)
+      warn("[Routes2spec][debug] #{message}") if debug?
+    end
+
+    def log(message)
+      warn("[Routes2spec] #{message}")
+    end
+
+    def warn_deprecated(message)
+      warn("[Routes2spec] [DEPRECATION] #{message}")
+    end
+  end
+end

data/lib/routes2spec/request_spec_formatter.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Routes2spec
+  # Routes2spec::RequestSpecFormatter class
+  class RequestSpecFormatter
+    STATUS = {
+      get: 200,
+      post: 201,
+      patch: 200,
+      put: 200,
+      delete: 204,
+    }.tap{ _1.default = 200 }.freeze
+
+    SYMBOL_STATUS = {
+      get: ":ok",
+      post: ":created",
+      patch: ":ok",
+      put: ":ok",
+      delete: ":no_content",
+    }.tap{ _1.default = ":ok" }.freeze
+
+    def initialize(opts = {})
+      @results = []
+      @opts = opts
+    end
+
+    def result
+      @results.flatten
+    end
+
+    def section_title(title)
+    end
+
+    def section(routes)
+      routes = routes.select do |r|
+        is_valid = r[:reqs].include?("#") && !r[:reqs].start_with?("#<")
+        Routes2spec.log "Skip. Unsupported reqs! `#{r[:reqs]}`" unless is_valid
+        is_valid
+      end
+      grouped = routes.group_by { |r| r[:reqs].split("#").first }
+      Routes2spec.log_debug "grouped: #{grouped}"
+      @results << grouped.map do |controller, grouped_routes|
+        # TODO: support redirect. ex: {"redirect(301, https://example.com)"=>[{:name=>"example", :verb=>"GET", :path=>"/example(.:format)", :reqs=>"redirect(301, https://example.com)"}]}
+
+        namespaces = controller.split("/")
+        controller_name = namespaces.map(&:camelize).join("::")
+        group_name = namespaces.pop
+        Routes2spec.log_debug "namespaces: #{namespaces}, group_name: #{group_name}, controller_name: #{controller_name}"
+        unless group_name
+          Routes2spec.log "Skip. Invalid controller format! `#{controller}`"
+          next
+        end
+        routes = grouped_routes.map do |r|
+          verb = r[:verb]&.downcase # GET|POST
+          path = r[:path].gsub("(.:format)", "")
+          param_names = path.scan %r{(?<=/:).+?(?=/|\z)}
+          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}"
+          if path_name.empty?
+            Routes2spec.log "Skip. No path name! `#{verb&.upcase} #{path}`"
+            next
+          end
+          unless %w[get post patch put delete].include?(verb)
+            Routes2spec.log "Skip. Unsupported verb! `#{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]
+          r.merge(
+            path: path,
+            path_name: path_name,
+            params_str: params_str,
+            reqs: r[:reqs],
+            endpoint: endpoint,
+            constraints: constraints || "",
+            status: status
+          )
+        end.compact
+        if routes.empty?
+          Routes2spec.log "Skip. Empty routes! `#{controller}`"
+          next
+        end
+        pending = @opts[:pending] || false
+        template_path = File.expand_path(File.join(File.dirname(__FILE__), "templates/request_spec.rb.erb"))
+        content = ERB.new(File.read(template_path)).result(binding)
+        routing_template_path = File.expand_path(File.join(File.dirname(__FILE__), "templates/routing_spec.rb.erb"))
+        routing_content = ERB.new(File.read(routing_template_path)).result(binding)
+        {
+          name: group_name,
+          namespaces: namespaces,
+          content: content,
+          routing_content: routing_content,
+        }
+      end.compact
+    end
+
+    def header(routes)
+    end
+
+    def no_routes(*)
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require "rails_helper"
+
+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]})" %>
+      expect(response).to have_http_status(<%= route[:status] %>)
+    end
+  end
+<% end %>
+end

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

@@ -0,0 +1,11 @@
+require "rails_helper"
+
+RSpec.describe "<%= controller_name %>", type: :routing do
+  describe "routing" do
+    <% routes.each do |route| %>
+    it "routes to <%= route[:endpoint] %>" do
+      <%= pending ? 'pending "now write some real specs. and remove pending mark."' + "\n      " : "" %>expect(<%= route[:verb].downcase %>: "<%= route[:path].delete(":") %>").to route_to("<%= route[:endpoint] %>"<%= route[:params_str].empty? ? "" : ", #{route[:params_str]}" %>)
+    end
+    <% end %>
+  end
+end

data/lib/routes2spec/version.rb

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

data/lib/routes2spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "routes2spec/version"
+require_relative "routes2spec/logging"
+require_relative "routes2spec/command"
+
+# Routes2spec module
+module Routes2spec
+  class Error < StandardError; end
+
+  class << self
+    include Routes2spec::Logging
+  end
+end

data/routes2spec.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/routes2spec/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "routes2spec"
+  spec.version = Routes2spec::VERSION
+  spec.authors = ["shuuuuuny"]
+  spec.email = []
+
+  spec.summary = "routes2spec"
+  spec.description = "routes2spec"
+  spec.homepage = "https://github.com/shuuuuun/routes2spec"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shuuuuun/routes2spec"
+  spec.metadata["changelog_uri"] = "https://github.com/shuuuuun/routes2spec/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 6.0"
+  # spec.add_dependency "rspec", ">= 3.9"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/routes2spec.rbs

@@ -0,0 +1,4 @@
+module Routes2spec
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: routes2spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shuuuuuny
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-06 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: routes2spec
+email: []
+executables:
+- routes2spec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/routes2spec
+- lib/routes2spec.rb
+- lib/routes2spec/binstubs/routes2spec
+- lib/routes2spec/command.rb
+- lib/routes2spec/logging.rb
+- lib/routes2spec/request_spec_formatter.rb
+- lib/routes2spec/templates/request_spec.rb.erb
+- lib/routes2spec/templates/routing_spec.rb.erb
+- lib/routes2spec/version.rb
+- routes2spec.gemspec
+- sig/routes2spec.rbs
+homepage: https://github.com/shuuuuun/routes2spec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shuuuuun/routes2spec
+  source_code_uri: https://github.com/shuuuuun/routes2spec
+  changelog_uri: https://github.com/shuuuuun/routes2spec/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: routes2spec
+test_files: []