annotate_routes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70629e32fc5b2f0f2106104f5023729ece47254a
+  data.tar.gz: 42f516780b3fd6dcb51466b346e863270306217d
+SHA512:
+  metadata.gz: 6055d4aef71ada5297e80dea666e7a70a0e28a44ecb720bb6957ae7046d51639ba49901490fc9a2bdb82b4382ce4fb09a9838e16ae10dca533d66ddb272cfff0
+  data.tar.gz: 05099bcf0603a111bce38a72a3180eb90774d89fb9c864ac62e86c7b93e1ba6d2b87af30af3707a100fd683600a572ef8a15cb4b972c2e3d777f3e2c4fec03ac

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Fumiaki MATSUSHIMA
+
+MIT License
+
+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,56 @@
+# AnnotateRoutes
+
+Annotate routes information to your controllers.
+
+```ruby
+class CommentsController < ApplicationController
+  # == Route Info
+  # comments GET /comments(.:format)
+  def index
+  end
+
+  # == Route Info
+  # POST /comments(.:format)
+  def create
+  end
+
+  # == Route Info
+  # PATCH /comments/:id(.:format)
+  # PUT /comments/:id(.:format)
+  def update
+  end
+
+  # == Route Info
+  # DELETE /comments/:id(.:format)
+  def destroy
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'annotate_routes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install annotate_routes
+
+## Usage
+
+    $ rake annotate_routes
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/annotate_routes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/annotate_routes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'annotate_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "annotate_routes"
+  spec.version       = AnnotateRoutes::VERSION
+  spec.authors       = ["Fumiaki MATSUSHIMA"]
+  spec.email         = ["mtsmfm@gmail.com"]
+  spec.summary       = %q{Annotate Rails routes}
+  spec.description   = %q{Annotate Rails routes to your controllers}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'rails', '> 3.2'
+end

data/lib/annotate_routes.rb

@@ -0,0 +1,9 @@
+require "annotate_routes/version"
+
+module AnnotateRoutes
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      require 'annotate_routes/tasks'
+    end
+  end
+end

data/lib/annotate_routes/annotator.rb

@@ -0,0 +1,44 @@
+require 'annotate_routes/exceptions'
+
+module AnnotateRoutes
+  class Annotator
+    COMMENT = '== Route Info'.freeze
+
+    def initialize(root, route)
+      @root = root
+      @reqs = route.fetch(:reqs)
+      @info = route.fetch(:info)
+    end
+
+    def annotate!
+      raise ControllerNotFound.new(controller_file_path) unless File.exists?(controller_file_path)
+
+      File.open(controller_file_path, 'r+') do |f|
+        body = f.read
+
+        raise ActionNotFound.new(@reqs) unless body =~ /def #{action}\W/
+
+        new_body = body.gsub(/(?:^ *# #{COMMENT}\n(?: *#.*\n)+)?( *def #{action}\W)/, comment + "\\1")
+
+        f.rewind
+        f.write(new_body)
+      end
+    end
+
+    def comment
+      ["#{COMMENT}", *@info.map {|i| i.join(' ')} ].map {|c| "  # " + c }.join("\n") + "\n"
+    end
+
+    def controller_file_path
+      @root.join("app/controllers/#{controller}_controller.rb")
+    end
+
+    def controller
+      @controller ||= @reqs.split('#').first
+    end
+
+    def action
+      @action ||= @reqs.split('#').last
+    end
+  end
+end

data/lib/annotate_routes/exceptions.rb

@@ -0,0 +1,25 @@
+module AnnotateRoutes
+  class ControllerNotFound < StandardError
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def message
+      "No such controller - #{file}"
+    end
+  end
+
+  class ActionNotFound < StandardError
+    attr_reader :reqs
+
+    def initialize(reqs)
+      @reqs = reqs
+    end
+
+    def message
+      "No such action - #{reqs}"
+    end
+  end
+end

data/lib/annotate_routes/inspector.rb

@@ -0,0 +1,17 @@
+require 'annotate_routes/route_wrapper'
+
+module AnnotateRoutes
+  class Inspector
+    def initialize(routes_stream)
+      @routes_stream = routes_stream
+    end
+
+    def routes
+      @routes_stream.each_line
+        .map {|l| RouteWrapper.new(l) }
+        .select(&:reqs)
+        .group_by(&:reqs)
+        .map {|reqs, r| {reqs: reqs, info: r.map(&:info)} }
+    end
+  end
+end

data/lib/annotate_routes/route_wrapper.rb

@@ -0,0 +1,12 @@
+module AnnotateRoutes
+  class RouteWrapper
+    attr_reader :info, :reqs
+
+    def initialize(route_str)
+      if route_str =~ /(.*) +([^[:upper:]]+#[^[:upper:]]+)\n/
+        @info = $1.strip.split(' ')
+        @reqs = $2
+      end
+    end
+  end
+end

data/lib/annotate_routes/tasks.rb

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

data/lib/annotate_routes/tasks/annotate_routes.rake

@@ -0,0 +1,22 @@
+namespace :annotate_routes do
+  task :run => [:environment, :setup] do
+    routes_stream = capture(:stdout) { Rake::Task['routes'].invoke }
+    inspector = AnnotateRoutes::Inspector.new(routes_stream)
+    inspector.routes.each do |route|
+      begin
+        AnnotateRoutes::Annotator.new(Rails.root, route).annotate!
+        puts "#{route[:reqs]} written"
+      rescue => e
+        puts e.message
+      end
+    end
+  end
+
+  task :setup do
+    require 'annotate_routes/annotator'
+    require 'annotate_routes/inspector'
+  end
+end
+
+desc 'Annotate routes'
+task :annotate_routes => 'annotate_routes:run'

data/lib/annotate_routes/version.rb

@@ -0,0 +1,3 @@
+module AnnotateRoutes
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: annotate_routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fumiaki MATSUSHIMA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Annotate Rails routes to your controllers
+email:
+- mtsmfm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- annotate_routes.gemspec
+- lib/annotate_routes.rb
+- lib/annotate_routes/annotator.rb
+- lib/annotate_routes/exceptions.rb
+- lib/annotate_routes/inspector.rb
+- lib/annotate_routes/route_wrapper.rb
+- lib/annotate_routes/tasks.rb
+- lib/annotate_routes/tasks/annotate_routes.rake
+- lib/annotate_routes/version.rb
+homepage: ''
+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
+signing_key: 
+specification_version: 4
+summary: Annotate Rails routes
+test_files: []
+has_rdoc: