better_routes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60732ea58a9817c84477c8d32e6451e311f278434ee1ef1c77e5cdd8c05ba328
+  data.tar.gz: becf64bc8fd1636834454d81976e0bd65ae2758a1bc3142e6f4e1304e3d08ad6
+SHA512:
+  metadata.gz: d42dcc609245c12a7f914dc6ea9115cd66322637aec4d2cb3dff4085acb9dc23b0202c2621dffce0b4f23909a253e22847cf407a5711ef57231ab328c07af24f
+  data.tar.gz: 7b9c81db8ca0f63425339b9aa1250957d859cb01032ac228759a750c0ccd3297796cd2c730a664aface7fe6c3bf5d2824ce97e79579a17f44cad82d3886ba3d8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 msroz
+
+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,95 @@
+# 🖌 BetterRoutes
+
+Print rials routes with various formats.  
+It is easy way to copy and paste on Spreadsheet, GitHub and so on :)
+
+## 🤲 Usage
+
+```bash
+$ rake better_routes
+```
+
+## 📐 Formats
+
+### Sample routes file
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  resources :entries
+end
+```
+
+### TSV (Tab Separated Values)
+
+```bash
+# (default)
+$ FORMAT=tsv rake better_routes
+
+Prefix, Verb, URI Pattern, Controller#Action
+entries GET     /entries(.:format)      entries#index
+        POST    /entries(.:format)      entries#create
+new_entry       GET     /entries/new(.:format)  entries#new
+edit_entry      GET     /entries/:id/edit(.:format)     entries#edit
+entry   GET     /entries/:id(.:format)  entries#show
+        PATCH   /entries/:id(.:format)  entries#update
+        PUT     /entries/:id(.:format)  entries#update
+        DELETE  /entries/:id(.:format)  entries#destroy
+```
+
+### CSV (Comma Separated Values)
+
+```bash
+$ FORMAT=csv rake better_routes
+Prefix, Verb, URI Pattern, Controller#Action
+entries,GET,/entries(.:format),entries#index
+,POST,/entries(.:format),entries#create
+new_entry,GET,/entries/new(.:format),entries#new
+edit_entry,GET,/entries/:id/edit(.:format),entries#edit
+entry,GET,/entries/:id(.:format),entries#show
+,PATCH,/entries/:id(.:format),entries#update
+,PUT,/entries/:id(.:format),entries#update
+,DELETE,/entries/:id(.:format),entries#destroy
+```
+
+### Markdown Table
+
+```bash
+$ FORMAT=markdown rake better_routes
+|Prefix|Verb|URI Pattern|Controller#Action|
+|------|----|-----------|-----------------|
+|entries|GET|/entries(.:format)|entries#index|
+||POST|/entries(.:format)|entries#create|
+|new_entry|GET|/entries/new(.:format)|entries#new|
+|edit_entry|GET|/entries/:id/edit(.:format)|entries#edit|
+|entry|GET|/entries/:id(.:format)|entries#show|
+||PATCH|/entries/:id(.:format)|entries#update|
+||PUT|/entries/:id(.:format)|entries#update|
+||DELETE|/entries/:id(.:format)|entries#destroy|
+```
+
+## 🤝 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'better_routes'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install better_routes
+```
+
+## 👍 Contributing
+
+Contribution directions go here.
+
+## 👉 License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BetterRoutes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/better_routes.rb

@@ -0,0 +1,4 @@
+require "better_routes/version"
+require "better_routes/railtie" if defined?(Rails)
+
+module BetterRoutes; end

data/lib/better_routes/formatter.rb

@@ -0,0 +1,3 @@
+require_relative './formatter/csv_formatter'
+require_relative './formatter/markdown_formatter'
+require_relative './formatter/tsv_formatter'

data/lib/better_routes/formatter/csv_formatter.rb

@@ -0,0 +1,38 @@
+module BetterRoutes
+  module Formatter
+    class CsvFormatter
+      def initialize
+        @buffer = []
+        @current_section = "Application"
+      end
+
+      def result
+        @buffer.join("\n")
+      end
+
+      def section_title(title)
+        @current_section = title
+      end
+
+      def section(routes)
+        @buffer << routes.map do |r|
+          "#{r[:name]},#{r[:verb]},#{r[:path]},#{r[:reqs]}"
+        end
+      end
+
+      def header(routes)
+        @buffer << "Prefix, Verb, URI Pattern, Controller#Action"
+      end
+
+      if Rails.version > '4.2.11'
+        def no_routes(routes)
+          @buffer << ""
+        end
+      else
+        def no_routes
+          @buffer << ""
+        end
+      end
+    end
+  end
+end

data/lib/better_routes/formatter/markdown_formatter.rb

@@ -0,0 +1,39 @@
+module BetterRoutes
+  module Formatter
+    class MarkdownFormatter
+      def initialize
+        @buffer = []
+        @current_section = "Application"
+      end
+
+      def result
+        @buffer.join("\n")
+      end
+
+      def section_title(title)
+        @current_section = title
+      end
+
+      def section(routes)
+        @buffer << routes.map do |r|
+          "|#{r[:name]}|#{r[:verb]}|#{r[:path]}|#{r[:reqs]}|"
+        end
+      end
+
+      def header(routes)
+        @buffer << "|Prefix|Verb|URI Pattern|Controller#Action|"
+        @buffer << "|------|----|-----------|-----------------|"
+      end
+
+      if Rails.version > '4.2.11'
+        def no_routes(routes)
+          @buffer << ""
+        end
+      else
+        def no_routes
+          @buffer << ""
+        end
+      end
+    end
+  end
+end

data/lib/better_routes/formatter/tsv_formatter.rb

@@ -0,0 +1,38 @@
+module BetterRoutes
+  module Formatter
+    class TsvFormatter
+      def initialize
+        @buffer = []
+        @current_section = "Application"
+      end
+
+      def result
+        @buffer.join("\n")
+      end
+
+      def section_title(title)
+        @current_section = title
+      end
+
+      def section(routes)
+        @buffer << routes.map do |r|
+          "#{r[:name]}\t#{r[:verb]}\t#{r[:path]}\t#{r[:reqs]}"
+        end
+      end
+
+      def header(routes)
+        @buffer << "Prefix, Verb, URI Pattern, Controller#Action"
+      end
+
+      if Rails.version > '4.2.11'
+        def no_routes(routes)
+          @buffer << ""
+        end
+      else
+        def no_routes
+          @buffer << ""
+        end
+      end
+    end
+  end
+end

data/lib/better_routes/railtie.rb

@@ -0,0 +1,7 @@
+module BetterRoutes
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../../tasks/better_routes_tasks.rake', __FILE__)
+    end
+  end
+end

data/lib/better_routes/version.rb

@@ -0,0 +1,3 @@
+module BetterRoutes
+  VERSION = '0.0.1'
+end

data/lib/tasks.rb

@@ -0,0 +1 @@
+load 'tasks/better_routes_tasks.rake'

data/lib/tasks/better_routes_tasks.rake

@@ -0,0 +1,38 @@
+require_relative '../better_routes/formatter'
+
+desc "custom_routes"
+task better_routes: :environment do
+
+  all_routes = Rails.application.routes.routes
+  require 'action_dispatch/routing/inspector'
+  inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+
+  routes_filter = nil
+  format = ENV['FORMAT'] || 'tsv'
+
+  OptionParser.new do |opts|
+    opts.banner = "Usage: rails better_routes [options]"
+
+    Rake.application.standard_rake_options.each { |args| opts.on(*args) }
+
+    # opts.on("-F FORMAT") do |format|
+    #  format = format
+    # end
+
+    opts.on("-c CONTROLLER") do |controller|
+      routes_filter = { controller: controller }
+    end
+
+    opts.on("-g PATTERN") do |pattern|
+      routes_filter = pattern
+    end
+  end.parse!(ARGV.reject { |x| x == "routes" })
+
+  formatter_klass = "BetterRoutes::Formatter::#{format.titleize}Formatter".safe_constantize
+  if formatter_klass.nil?
+    STDERR.puts "format must be one of csv, markdown and tsv(default). got: #{format}"
+  end
+  STDOUT.puts inspector.format(formatter_klass.new, routes_filter)
+
+  exit 0
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: better_routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- msroz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Print rails routes with formats for development;)
+email:
+- masaru95__at__gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/better_routes.rb
+- lib/better_routes/formatter.rb
+- lib/better_routes/formatter/csv_formatter.rb
+- lib/better_routes/formatter/markdown_formatter.rb
+- lib/better_routes/formatter/tsv_formatter.rb
+- lib/better_routes/railtie.rb
+- lib/better_routes/version.rb
+- lib/tasks.rb
+- lib/tasks/better_routes_tasks.rake
+homepage: https://github.com/msroz/better_routes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Print rails routes with formats for development;)
+test_files: []