flatten_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e3e904496ba4058af2d181e7336acc9351f7cd4
+  data.tar.gz: e6996d5eb5bed9ee50662b02410ac2fb6821a7c6
+SHA512:
+  metadata.gz: 6ca17a1184bb4920a82fed08a45c8bd1f8f12d2ee6ce621e1152d47b7ce15a0c573f118faebc5f67ab769b8a192c263233f5c60b83312fc5ef5ed5b5727c1fde
+  data.tar.gz: ba00f51a07651f6fe5b9afe37b6dac42374729f2560be8f44df7244f3e26b1f37c1771711fdbec5ab0cbf378fab0622103d648da032972edf72d767f836fc515

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at nserihiro@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flatten_routes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kazuhiro Serizawa
+
+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,189 @@
+[![Build Status](https://travis-ci.org/serihiro/flatten_routes.svg?branch=master)](https://travis-ci.org/serihiro/flatten_routes)
+
+# FlattenRoutes
+
+Convert the routes.rb to not using resource style.
+This gem provides 2 rake tasks.
+
+```
+rake flatten_routes:annotate            # Annotate routes.rb
+rake flatten_routes:convert             # Convert routes.rb to not using resource style
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flatten_routes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flatten_routes
+
+## Usage
+
+### Convert your routes.rb.
+
+Execute the following command in your Rails.root.
+
+```ruby
+$ rake flatten_routes:convert
+```
+
+If routes.rb is like this,
+
+```ruby
+Rails.application.routes.draw do
+  ActiveAdmin.routes(self)
+  resources :todos, except: [:new, :edit] do
+    member do
+      post :start
+      post :finish
+      post :restart
+      post :giveup
+      put :awesome
+    end
+    collection do
+      get :finished
+      get :not_yet
+    end
+  end
+end
+```
+
+then your routes.rb will become like this.
+
+```ruby
+Rails.application.routes.draw do
+# == generated by flatten_routes from here 2016-02-27 17:53:37 +0900
+  get    '/admin'                    => 'admin/dashboard#index'
+  get    '/admin/dashboard'          => 'admin/dashboard#index'
+  post   '/admin/todos/batch_action' => 'admin/todos#batch_action'
+  get    '/admin/todos'              => 'admin/todos#index'
+  post   '/admin/todos'              => 'admin/todos#create'
+  get    '/admin/todos/new'          => 'admin/todos#new'
+  get    '/admin/todos/:id/edit'     => 'admin/todos#edit'
+  get    '/admin/todos/:id'          => 'admin/todos#show'
+  patch  '/admin/todos/:id'          => 'admin/todos#update'
+  put    '/admin/todos/:id'          => 'admin/todos#update'
+  delete '/admin/todos/:id'          => 'admin/todos#destroy'
+  get    '/admin/comments'           => 'admin/comments#index'
+  post   '/admin/comments'           => 'admin/comments#create'
+  get    '/admin/comments/:id'       => 'admin/comments#show'
+  delete '/admin/comments/:id'       => 'admin/comments#destroy'
+  post   '/todos/:id/start'          => 'todos#start'
+  post   '/todos/:id/finish'         => 'todos#finish'
+  post   '/todos/:id/restart'        => 'todos#restart'
+  post   '/todos/:id/giveup'         => 'todos#giveup'
+  put    '/todos/:id/awesome'        => 'todos#awesome'
+  get    '/todos/finished'           => 'todos#finished'
+  get    '/todos/not_yet'            => 'todos#not_yet'
+  get    '/todos'                    => 'todos#index'
+  post   '/todos'                    => 'todos#create'
+  get    '/todos/:id'                => 'todos#show'
+  patch  '/todos/:id'                => 'todos#update'
+  put    '/todos/:id'                => 'todos#update'
+  delete '/todos/:id'                => 'todos#destroy'
+# == generated by flatten_routes to here
+# ActiveAdmin.routes(self)
+# resources :todos, except: [:new, :edit] do
+#   member do
+#     post :start
+#     post :finish
+#     post :restart
+#     post :giveup
+#     put :awesome
+#   end
+#   collection do
+#     get :finished
+#     get :not_yet
+#   end
+# end
+```
+
+### Annotate your routes.rb with simple style routes definitions as comment.
+
+Execute the following command in your Rails.root.
+
+```ruby
+$ rake flatten_routes:annotate
+```
+
+```ruby
+Rails.application.routes.draw do
+# == generated by flatten_routes from here 2016-02-27 17:56:31 +0900
+#  get    '/admin'                    => 'admin/dashboard#index'
+#  get    '/admin/dashboard'          => 'admin/dashboard#index'
+#  post   '/admin/todos/batch_action' => 'admin/todos#batch_action'
+#  get    '/admin/todos'              => 'admin/todos#index'
+#  post   '/admin/todos'              => 'admin/todos#create'
+#  get    '/admin/todos/new'          => 'admin/todos#new'
+#  get    '/admin/todos/:id/edit'     => 'admin/todos#edit'
+#  get    '/admin/todos/:id'          => 'admin/todos#show'
+#  patch  '/admin/todos/:id'          => 'admin/todos#update'
+#  put    '/admin/todos/:id'          => 'admin/todos#update'
+#  delete '/admin/todos/:id'          => 'admin/todos#destroy'
+#  get    '/admin/comments'           => 'admin/comments#index'
+#  post   '/admin/comments'           => 'admin/comments#create'
+#  get    '/admin/comments/:id'       => 'admin/comments#show'
+#  delete '/admin/comments/:id'       => 'admin/comments#destroy'
+#  post   '/todos/:id/start'          => 'todos#start'
+#  post   '/todos/:id/finish'         => 'todos#finish'
+#  post   '/todos/:id/restart'        => 'todos#restart'
+#  post   '/todos/:id/giveup'         => 'todos#giveup'
+#  put    '/todos/:id/awesome'        => 'todos#awesome'
+#  get    '/todos/finished'           => 'todos#finished'
+#  get    '/todos/not_yet'            => 'todos#not_yet'
+#  get    '/todos'                    => 'todos#index'
+#  post   '/todos'                    => 'todos#create'
+#  get    '/todos/:id'                => 'todos#show'
+#  patch  '/todos/:id'                => 'todos#update'
+#  put    '/todos/:id'                => 'todos#update'
+#  delete '/todos/:id'                => 'todos#destroy'
+# == generated by flatten_routes to here
+  ActiveAdmin.routes(self)
+  resources :todos, except: [:new, :edit] do
+    member do
+      post :start
+      post :finish
+      post :restart
+      post :giveup
+      put :awesome
+    end
+    collection do
+      get :finished
+      get :not_yet
+    end
+  end
+end
+```
+
+## Note
+* If you update annotated comments, just execute `$ rake flatten_routes:convert` again.
+
+
+## Dependency
+* Rails '>= 4.0.0', '< 4.2'
+* I do not confirm that this gem works in rails5.x yet...
+
+## 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]/flatten_routes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flatten_routes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flatten_routes.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flatten_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flatten_routes'
+  spec.version       = FlattenRoutes::VERSION
+  spec.authors       = ['Kazuhiro Serizawa']
+  spec.email         = ['nserihiro@gmail.com']
+
+  spec.summary       = %q{Convert the routes.rb to not using resource style.}
+  spec.description   = %q{Convert the routes.rb to not using resource style.}
+  spec.homepage      = 'https://github.com/serihiro/flatten_routes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'actionpack', '~> 4.2.0'
+end

data/lib/flatten_routes/version.rb

@@ -0,0 +1,3 @@
+module FlattenRoutes
+  VERSION = '0.1.0'
+end

data/lib/flatten_routes.rb

@@ -0,0 +1,64 @@
+require 'flatten_routes/version'
+require 'rubygems'
+require 'rake'
+require 'action_dispatch/routing/inspector'
+
+module FlattenRoutes
+  Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+
+  class Util
+    ROUTES_CONTENT_PATTERN = %r{(routes.draw do\r?\n)(.*?)(\r?\nend)}m
+    MAGIC_COMMENT_START_CONTENT = '# == generated by flatten_routes from here'.freeze
+    MAGIC_COMMENT_END_CONTENT = '# == generated by flatten_routes to here'.freeze
+    MAGIC_COMMENT_QUOTED_PATTERN = %r{(# == generated by flatten_routes from here)(.*?)(# == generated by flatten_routes to here\r?\n)}m
+
+    class << self
+      def routes_from_rails_application
+        all_routes = Rails.application.routes.routes
+        inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+        inspector.send(:collect_routes, all_routes)
+      end
+
+      SEPARATOR = '=>'.freeze
+
+      def format_routes(routes)
+        routes.map! do |route|
+          {
+            verb: route[:verb].downcase,
+            path: route[:path].gsub(%r{\(\.:format\)},'').gsub(%r{[\w\/:]+}, '\'\&\''),
+            reqs: route[:reqs].gsub(%r{[\w\/#]+}, '\'\&\'')
+          }
+        end
+        verb_length, path_length = %i(verb path).map do |key|
+          routes.map { |route| route[key].length }.max || 0
+        end
+        line = []
+        new_routes = []
+        routes.each do |routes|
+          line.clear
+          line << routes[:verb].ljust(verb_length)
+          line << routes[:path].ljust(path_length)
+          line << SEPARATOR
+          line << routes[:reqs]
+          new_routes << ('  ' << line.join(' '))
+        end
+
+        new_routes
+      end
+
+      def add_magic_comment(content, time = Time.now)
+        "#{MAGIC_COMMENT_START_CONTENT} #{time}\n#{content}\n#{MAGIC_COMMENT_END_CONTENT}\n"
+      end
+
+      def delete_flatten_routes_definition(content)
+        content.gsub(MAGIC_COMMENT_QUOTED_PATTERN, '')
+      end
+
+      def commentize(contents)
+        return contents if contents.size < 1
+
+        contents.map { |content| "##{content}" }
+      end
+    end
+  end
+end

data/lib/tasks/flatten_routes.rake

@@ -0,0 +1,49 @@
+require 'flatten_routes'
+
+namespace :flatten_routes do
+  desc 'Convert routes.rb to not using resource style. The original routes definitions will remain as comment.'
+  task convert: :environment do
+    routes = FlattenRoutes::Util.routes_from_rails_application
+    new_routes_definition = FlattenRoutes::Util.format_routes(routes)
+    new_routes_definition = FlattenRoutes::Util.add_magic_comment(new_routes_definition.join("\n"))
+
+    file_name = File.join(Rails.root, 'config', 'routes.rb')
+    original_content = File.read(file_name)
+
+    matched = FlattenRoutes::Util::ROUTES_CONTENT_PATTERN.match(original_content)
+    exit unless matched
+
+    original_routes_definition = matched[2]
+    # delete old generated routes definition by flatten_routes
+    original_routes_definition = FlattenRoutes::Util.delete_flatten_routes_definition(original_routes_definition)
+
+    # comment out original definition
+    original_routes_definition = original_routes_definition.split("\n").map do
+      |line| %r{(^#|^\s*?#)}.match(line) ? line : "##{line}"
+    end.join("\n")
+    new_content = original_content.gsub(FlattenRoutes::Util::ROUTES_CONTENT_PATTERN,
+                                        "\\1#{new_routes_definition + original_routes_definition}\\3")
+    File.open(file_name, 'wb') { |f| f.puts(new_content) }
+  end
+
+  desc 'Annotate routes.rb'
+  task annotate: :environment do
+    routes = FlattenRoutes::Util.routes_from_rails_application
+    new_routes_definition = FlattenRoutes::Util.format_routes(routes)
+    new_routes_definition = FlattenRoutes::Util.commentize(new_routes_definition)
+    new_routes_definition = FlattenRoutes::Util.add_magic_comment(new_routes_definition.join("\n"))
+
+    file_name = File.join(Rails.root, 'config', 'routes.rb')
+    original_content = File.read(file_name)
+
+    matched = FlattenRoutes::Util::ROUTES_CONTENT_PATTERN.match(original_content)
+    exit unless matched
+
+    original_routes_definition = matched[2]
+    # delete old generated routes definition by flatten_routes
+    original_routes_definition = FlattenRoutes::Util.delete_flatten_routes_definition(original_routes_definition)
+    new_content = original_content.gsub(FlattenRoutes::Util::ROUTES_CONTENT_PATTERN,
+                                        "\\1#{new_routes_definition + original_routes_definition}\\3")
+    File.open(file_name, 'wb') { |f| f.puts(new_content) }
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: flatten_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuhiro Serizawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Convert the routes.rb to not using resource style.
+email:
+- nserihiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flatten_routes.gemspec
+- lib/flatten_routes.rb
+- lib/flatten_routes/version.rb
+- lib/tasks/flatten_routes.rake
+homepage: https://github.com/serihiro/flatten_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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Convert the routes.rb to not using resource style.
+test_files: []