annotate_controllers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbb6d466aa6f6e2d2d126315a62503b618c8005f
+  data.tar.gz: cc628056893005ff9c6412a44a7383b2ff9c5b18
+SHA512:
+  metadata.gz: 1df0df7202add63a2ba5c45c6d504509347c2d7c987426e5856f13738e2b863b78e258824e2e1693edd82bd64ffd4cd2f66b4c5fd3b2e26f1f71c122bfddd6c3
+  data.tar.gz: 3046a18e3042ec2d3067974b240ffdf9db1490c9ca7be1259096e6a2ae3e82d08be92441697039bf0fa807546ef7ec96ccbc8ccc0e5418f7f9dad309edadd3fb

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_controllers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Michael Michaelevich
+
+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,80 @@
+# Annotate Controllers
+
+Annotate Rails controllers with routes information.
+
+    class PagesController < ApplicationController
+
+      # GET / (root_path)
+      # GET /pages (pages_path)
+      def index
+      end
+    
+      # POST /pages (pages_path)
+      def create
+      end
+      
+      # GET /pages/new (new_page_path)
+      def new
+      end
+    
+      # GET /pages/:id (page_path)
+      def show
+      end
+    
+      # GET /pages/:id/edit (edit_page_path)
+      def edit
+      end
+    
+      # PATCH /pages/:id (page_path)
+      # PUT /pages/:id (page_path)
+      def update
+      end
+    
+      # DELETE /pages/:id (page_path)
+      def destroy
+      end
+
+    end
+
+**Note: This tool assumes you are using Rails standards for folder structures (e.g. /app/controllers) as well as naming conventions (snake\_case) for your controllers.** For example, if you have a class `HomeController`, your filename should be `home_controller.rb` as opposed to `HomeController.rb`. This isn't Javascript :stuck\_out\_tongue\_winking\_eye:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'annotate_controllers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install annotate_controllers
+
+## Usage
+
+    $ rake annotate_controllers
+
+## WARNING
+
+**Be sure to check the changes that this tool makes!** If you are using Git, you may simply check your project's status after annotating:
+
+    $ git status
+
+If you are not using a VCS (like Git, Subversion or similar), then you should consider stopping being a pleb, and just do it.
+
+## Contributing
+
+1. Fork it ( https://github.com/mmichael0413/annotate_controllers/fork )
+2. Create your feature branch (`git checkout -b my_dope_new_feature`)
+3. Commit your changes (`git commit -m 'Add some feature'`)
+4. Push to the branch (`git push origin my_dope_new_feature`)
+5. Create a new Pull Request
+
+
+## TODOs
+
+- Handle multi-route annotations (e.g. root & named path)
+- TESTS!
+- Considering modularizing the `annotate!` method a bit more. At 44 lines, it's a bit much.

data/Rakefile.rb

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/annotate_controllers.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_controllers/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'annotate_controllers'
+  s.version       = AnnotateControllers::VERSION
+  s.authors       = ['Michael Michaelevich']
+  s.description   = 'Annotate Rails controllers with routes information.'
+  s.email         = ['monkeysquirrel7@gmail.com']
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.files         = `git ls-files -z`.split("\x0")
+  s.homepage      = 'https://github.com/mmichael0413/annotate_controllers'
+  s.license       = 'MIT'
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 1.9.3'
+  s.summary       = 'Annotate Rails controllers'
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_development_dependency 'bundler', '~> 1.12.3'
+  s.add_development_dependency 'rake', '~> 11.1.2'
+
+  s.add_dependency 'rails', '> 4.2'
+end

data/lib/annotate_controllers.rb

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

data/lib/annotate_controllers/annotator.rb

@@ -0,0 +1,125 @@
+require 'annotate_controllers/errors'
+
+module AnnotateControllers
+  class Annotator
+
+    class << self
+
+      VERBS = ['GET', 'POST', 'PATCH', 'PUT', 'DELETE']
+
+      def annotate!
+        rake_output = []
+        mapped_routes = routes
+        pattern = /.*\/controllers\/(.*)\_controller\./
+        controller_paths = Dir[Rails.root.join('app/controllers/**/*_controller.rb')]
+
+        controller_paths.each do |path|
+          raise ControllerNotFound.new(path) unless File.exists?(path)
+
+          lines = []
+          prefixes = []
+          controller_name = pattern.match(path)[-1] # ignore match for entire filename
+          original_file_digest = Digest::SHA1.hexdigest(File.read(path))
+
+          IO.readlines(path).each do |line|
+            action_name = /def\W(.*)/.match(line).try(:[], -1)
+
+            if action_name && matches = select_routes_from_method(mapped_routes, controller_name, action_name)
+              matches.each do |match|
+                # add matched line to global array in order to reuse prefixes
+                prefixes << { action: action_name, prefix: match[:prefix] }
+                # replace existing annotation (if exists)
+                if overwrite_self?(match[:verb], lines[-1])
+                  lines[-1] = comment(prefixes, match)
+                # otherwise, insert comment
+                else
+                  lines << comment(prefixes, match)
+                end
+              end
+            end
+
+            lines << line
+          end
+
+          File.open(path, 'w') do |file|
+            file.puts lines
+          end
+
+          new_file_digest = Digest::SHA1.hexdigest(File.read(path))
+          rake_output << "Annotated #{controller_name}_controller" unless original_file_digest == new_file_digest
+        end
+
+        puts rake_output.any? ? rake_output : 'Nothing annotated'
+      end
+
+      def select_routes_from_method(routes, controller, action)
+        results = routes.select{ |r|
+          r[:controller] == controller && r[:action] == action
+        }
+        results.any? ? results : nil
+      end
+
+      def comment(prefixes, match)
+        "\t# #{match[:verb]} #{trim(match[:uri])}"\
+        "#{prefix_or_shared(prefixes, match[:verb], match[:prefix], match[:action])}\n"
+      end
+
+      def prefix_or_shared(prefixes, verb, prefix, action)
+        if prefix.present?
+          ' (' + prefix + '_path)'
+        else
+          shared_prefix(prefixes, verb, action)
+        end
+      end
+
+      def shared_prefix(prefixes, verb, action)
+        if VERBS.include? verb
+          ' (' +
+          prefixes.detect{ |l| l[:action] == shared_action_prefix(action) }.try(:[], :prefix) +
+          '_path)'
+        else
+          ''
+        end
+      end
+
+      def shared_action_prefix(action)
+        case action
+        when 'create'
+          'index'
+        when 'update'
+          'show'
+        when 'destroy'
+          'show'
+        end
+      end
+
+      def overwrite_self?(verb, line)
+        "# #{verb}" == /(\#\s\w*)/.match(line).try(:[], 0)
+      end
+
+      def routes
+        mapped_routes = []
+        AnnotateControllers::Inspector.map_all_routes.each do |route|
+          r = route.split(' ')
+          contraction = r[-1].split('#') # controller, action, controlleraction...
+          mapped_routes << {
+            prefix: r.size > 3 ? r.try(:[], 0) : nil,
+            verb: r.size > 3 ? r[1] : r[0],
+            uri: r.size > 3 ? r[2] : r[1],
+            controller: contraction.first,
+            action: contraction.last
+          }
+        end
+        mapped_routes
+      end
+
+      # Removes (.:format) from URI pattern string
+      def trim(string)
+        string.slice! '(.:format)'
+        string
+      end
+
+    end
+
+  end
+end

data/lib/annotate_controllers/errors.rb

@@ -0,0 +1,3 @@
+module AnnotateControllers
+  class ControllerNotFound < StandardError; end
+end

data/lib/annotate_controllers/inspector.rb

@@ -0,0 +1,23 @@
+require 'action_dispatch/routing/inspector'
+
+module AnnotateControllers
+  class Inspector
+
+    class << self
+
+      def map_all_routes
+        all_routes = Rails.application.routes.routes
+        inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+        remove_constraints(
+          inspector.format(ActionDispatch::Routing::ConsoleFormatter.new).split("\n").drop(1)
+        )
+      end
+
+      def remove_constraints(routes)
+        routes.each{ |r| r.slice!(/ \{(.*)}/) }
+      end
+
+    end
+
+  end
+end

data/lib/annotate_controllers/tasks.rb

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

data/lib/annotate_controllers/tasks/annotate_controllers.rake

@@ -0,0 +1,17 @@
+namespace :annotate_controllers do
+  task run: [:environment, :setup] do
+    begin
+      AnnotateControllers::Annotator.annotate!
+    rescue => e
+      puts e.message
+    end
+  end
+
+  task :setup do
+    require 'annotate_controllers/annotator'
+    require 'annotate_controllers/inspector'
+  end
+end
+
+desc 'Annotate controllers'
+task annotate_controllers: 'annotate_controllers:run'

data/lib/annotate_controllers/version.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: annotate_controllers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Michaelevich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Annotate Rails controllers with routes information.
+email:
+- monkeysquirrel7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile.rb
+- annotate_controllers.gemspec
+- lib/annotate_controllers.rb
+- lib/annotate_controllers/annotator.rb
+- lib/annotate_controllers/errors.rb
+- lib/annotate_controllers/inspector.rb
+- lib/annotate_controllers/tasks.rb
+- lib/annotate_controllers/tasks/annotate_controllers.rake
+- lib/annotate_controllers/version.rb
+homepage: https://github.com/mmichael0413/annotate_controllers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Annotate Rails controllers
+test_files: []