rails_export_routes 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b758249798b4db8f7d467d746f2270d09337adf7af6ae9dfb8812bad1ec477
-  data.tar.gz: f26b25d605c5be2a2a81637707bfbe9aa001d1ed1f6bca85ee592f247d6d4ee6
+  metadata.gz: d29c125a39682f15f553976276b709f76d64ba131677d694034f54dc226b776c
+  data.tar.gz: 4454f83cae0c2723fa7f812f69a5574f948dbe5f752d8a1c9e2617d5886361a3
 SHA512:
-  metadata.gz: 48c7fbf70092b376cfbc7fd9bf44fe1e1c9d00a37ca7539b84f16085213df1988a52ff16821d9bf26c191c760771e770fc8815f6b685ef7e8f8bb1ea8cca96d9
-  data.tar.gz: 0b3c91f1d12409aac54f7641e312b761188e44af2072e65f934d2b7e6b6b1c6ddf288fa3a76e0081ded8db60b959986c9fdaf2cb695a7116665939591fb9e18b
+  metadata.gz: 54b4b67e680719652cc4fa9494bfeb4bbf53f4545961225c2e4eb8a2f30d33490fe084fce3e9af531a354681d51dcde71ffea403eefdf89a032b92042c826148
+  data.tar.gz: 8e4d9362c99f7da3a14af78955968bacb31e286df4e57dd23fc3f678903f114d83e70dfe7d19c4c3370ef9b27ce59b0cf822ab25f8cb3c1d01868500bfcc3b63

data/README.md

@@ -1,8 +1,6 @@
-# RailsExportRoutes
+# rails-export-routes
 
-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
+This is a small gem that allows you to export Rails routes to CSV or JSON.
 
 ## Installation
 
@@ -16,24 +14,35 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install rails_export_routes
+To export Routes to CSV:
 
-## Usage
+```bash
+bundle exec rails-export-routes export my-app-routes.csv
+```
+
+When JSON is the preferred format:
 
-TODO: Write usage instructions here
+```bash
+bundle exec rails-export-routes export --format json my-app-routes.json
+```
+
+Pretty JSON:
+
+```bash
+bundle exec rails-export-routes export --format json-pretty my-app-routes.json
+```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/rails_export_routes/version.rb` and push a new tag.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_export_routes.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/lenon/rails_export_routes.
 
 ## License
 

data/lib/rails_export_routes.rb

@@ -4,6 +4,7 @@ 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/formatters/json_pretty'
 require 'rails_export_routes/cli'
 
 module RailsExportRoutes

data/lib/rails_export_routes/cli.rb

@@ -11,13 +11,14 @@ module RailsExportRoutes
     desc('export FILE', 'export Rails routes to FILE')
     method_option(:format, type: :string,
                            default: 'csv',
-                           enum: %w[csv json])
+                           enum: %w[csv json json-pretty])
     def export(file)
       load_rails_app(Dir.pwd)
 
       formatter = case options.fetch(:format)
                   when 'csv' then Formatters::CSV
                   when 'json' then Formatters::JSON
+                  when 'json-pretty' then Formatters::JSONPretty
                   end
 
       formatter.new(wrapped_rails_routes).export_to_file(file)

data/lib/rails_export_routes/formatters/json_pretty.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module RailsExportRoutes
+  module Formatters
+    class JSONPretty
+      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.pretty_generate(data))
+        end
+      end
+    end
+  end
+end

data/lib/rails_export_routes/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_export_routes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lenon Marcel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,6 +53,7 @@ files:
 - lib/rails_export_routes/cli.rb
 - lib/rails_export_routes/formatters/csv.rb
 - lib/rails_export_routes/formatters/json.rb
+- lib/rails_export_routes/formatters/json_pretty.rb
 - lib/rails_export_routes/route_wrapper.rb
 - lib/rails_export_routes/version.rb
 homepage: https://github.com/lenon/rails_export_routes