rails_export_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3b758249798b4db8f7d467d746f2270d09337adf7af6ae9dfb8812bad1ec477
+  data.tar.gz: f26b25d605c5be2a2a81637707bfbe9aa001d1ed1f6bca85ee592f247d6d4ee6
+SHA512:
+  metadata.gz: 48c7fbf70092b376cfbc7fd9bf44fe1e1c9d00a37ca7539b84f16085213df1988a52ff16821d9bf26c191c760771e770fc8815f6b685ef7e8f8bb1ea8cca96d9
+  data.tar.gz: 0b3c91f1d12409aac54f7641e312b761188e44af2072e65f934d2b7e6b6b1c6ddf288fa3a76e0081ded8db60b959986c9fdaf2cb695a7116665939591fb9e18b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lenon Marcel
+
+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,40 @@
+# RailsExportRoutes
+
+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/rails_export_routes`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_export_routes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_export_routes
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, 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]/rails_export_routes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/rails-export-routes

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rails_export_routes'
+
+RailsExportRoutes::CLI.start(ARGV)

data/lib/rails_export_routes.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rails_export_routes/version'
+require 'rails_export_routes/route_wrapper'
+require 'rails_export_routes/formatters/csv'
+require 'rails_export_routes/formatters/json'
+require 'rails_export_routes/cli'
+
+module RailsExportRoutes
+end

data/lib/rails_export_routes/cli.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module RailsExportRoutes
+  class CLI < Thor
+    def self.exit_on_failure?
+      true # Thor must exit with status 1 on errors
+    end
+
+    desc('export FILE', 'export Rails routes to FILE')
+    method_option(:format, type: :string,
+                           default: 'csv',
+                           enum: %w[csv json])
+    def export(file)
+      load_rails_app(Dir.pwd)
+
+      formatter = case options.fetch(:format)
+                  when 'csv' then Formatters::CSV
+                  when 'json' then Formatters::JSON
+                  end
+
+      formatter.new(wrapped_rails_routes).export_to_file(file)
+    end
+
+    no_commands do
+      def load_rails_app(app_path)
+        require "#{app_path}/config/environment.rb"
+      rescue ::LoadError
+        raise Error, "Rails app not found in #{app_path}"
+      end
+
+      def wrapped_rails_routes
+        Rails.application.routes.routes.reject(&:internal).map do |route|
+          RouteWrapper.new(route)
+        end
+      end
+    end
+  end
+end

data/lib/rails_export_routes/formatters/csv.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'json'
+
+module RailsExportRoutes
+  module Formatters
+    class CSV
+      def initialize(routes)
+        @routes = routes
+      end
+
+      def export_to_file(file) # rubocop:disable Metrics/MethodLength
+        ::CSV.open(file, 'wb') do |csv|
+          csv << %w[verb path controller action name constraints]
+
+          @routes.each do |route|
+            csv << [
+              route.verb,
+              route.path_spec,
+              route.controller,
+              route.action,
+              route.name,
+              route.constraints.to_json
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_export_routes/formatters/json.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RailsExportRoutes
+  module Formatters
+    class JSON
+      def initialize(routes)
+        @routes = routes
+      end
+
+      def export_to_file(file) # rubocop:disable Metrics/MethodLength
+        data = @routes.map do |route|
+          {
+            verb: route.verb,
+            path: route.path_spec,
+            controller: route.controller,
+            action: route.action,
+            name: route.name,
+            constraints: route.constraints.to_h
+          }
+        end
+
+        File.open(file, 'wb') do |f|
+          f.write(::JSON.generate(data))
+        end
+      end
+    end
+  end
+end

data/lib/rails_export_routes/route_wrapper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module RailsExportRoutes
+  class RouteWrapper < SimpleDelegator
+    def path_spec
+      path.spec.to_s
+    end
+
+    def controller
+      requirements[:controller]
+    end
+
+    def action
+      requirements[:action]
+    end
+
+    def constraints
+      requirements.except(:controller, :action)
+    end
+  end
+end

data/lib/rails_export_routes/version.rb

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rails_export_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lenon Marcel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-05 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tool to export Rails routes to CSV
+email:
+- lenon.marcel@gmail.com
+executables:
+- rails-export-routes
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/rails-export-routes
+- lib/rails_export_routes.rb
+- lib/rails_export_routes/cli.rb
+- lib/rails_export_routes/formatters/csv.rb
+- lib/rails_export_routes/formatters/json.rb
+- lib/rails_export_routes/route_wrapper.rb
+- lib/rails_export_routes/version.rb
+homepage: https://github.com/lenon/rails_export_routes
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/lenon/rails_export_routes
+  source_code_uri: https://github.com/lenon/rails_export_routes
+  changelog_uri: https://github.com/lenon/rails_export_routes/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Tool to export Rails routes to CSV
+test_files: []