kurin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4da2e05a2fb1373c2aa8ae355d639f70adead398
+  data.tar.gz: 1b1c7211f2c1a2428a02b4b7f7d1c7c9dd159115
+SHA512:
+  metadata.gz: 63518aecc17f5c37dfc75d3cc4474edad6400a43f2e4ee9a6811527d850705b3d92c90ed6e8e4859f9f53de6ba833e29c12544725cdbf7fb6ed25384aeae0441
+  data.tar.gz: 862a3a9ef7e0721753f37f6da7a1cfb7544fdb8d1987994947de6f15e30b871cdc78717263d75c2c16975db95ac659aa543ff1b037bc3e1d90aca75c591552b8

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2014 Joshua Kendall <me@joshuakendall.com>
+
+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,39 @@
+# Kurin
+
+A Squeaky Clean Routing task for Rails
+
+[[![Code Climate](https://codeclimate.com/github/jtkendall/kurin/badges/gpa.svg)](https://codeclimate.com/github/jtkendall/kurin) [![Gem Version](https://badge.fury.io/rb/kurin.svg)](https://badge.fury.io/rb/kurin) [![Dependency Status](https://gemnasium.com/jtkendall/kurin.svg)](https://gemnasium.com/jtkendall/kurin)
+
+## Installation
+
+    gem install kurin
+
+or in your Gemfile
+
+    gem 'kurin'
+
+
+## Documentation
+
+[rdoc.info/github/jtkendall/kurin](http://rdoc.info/github/jtkendall/kurin)
+
+## Usage
+
+rake kurin:routes
+
+![Kurin Example](https://raw.github.com/jtkendall/kurin/master/example.png)
+
+
+## Contributing & Development
+
+    $ git clone https://github.com/jtkendall/kurin && cd kurin
+    $ bundle install
+
+* Fork the project.
+* Make your feature addition or bug fix..
+* Commit, do not mess with version, or history. If you want to have your own version, that is fine but bump version in a commit by itself in another branch so a maintainer ignores it when your pull request is merged.
+* Send a pull request. Bonus points for topic branches.
+
+## License & Copyright
+
+See LICENSE for details.

data/lib/kurin/formatter.rb

@@ -0,0 +1,94 @@
+module Kurin
+  # This class outputs Rails routes into a clean and organized format.
+  # @author Joshua Kendall
+  class Formatter
+    def initialize
+      @buffer = []
+      lines
+    end
+
+    def result
+      lines
+      @buffer.join("\n")
+    end
+
+    def section_title(title)
+      @buffer << "\n#{title}:"
+    end
+
+    def header(routes)
+      controller, action, verb, name, path = widths(routes)
+      @buffer << [
+        'Controller'.ljust(controller),
+        'Action'.ljust(action),
+        'Verb'.ljust(verb),
+        'Prefix'.ljust(name),
+        'URI Pattern'.ljust(path)
+      ].join(' ')
+      lines
+    end
+
+    def section(routes)
+      routes.each do |route|
+        @buffer << make_route(route, widths(routes)).join(' ')
+      end
+    end
+
+    def no_routes
+      @buffer << <<-MESSAGE.strip_heredoc
+        You don't have any routes defined!
+        Please add some routes in config/routes.rb.
+        For more information about routes, see the
+        Rails guide: http://guides.rubyonrails.org/routing.html.
+        MESSAGE
+    end
+
+    private
+
+    def lines
+      @buffer << Array.new(140) { '-' }.join('')
+    end
+
+    def make_route(route, width)
+      name, verb, path, reqs, _regexp = route.values
+      controller, action = reqs.split('#')
+      [
+        controller.ljust(width[0]),
+        action.ljust(width[1]),
+        verb.ljust(width[2]),
+        name.ljust(width[3]),
+        path.ljust(width[4])
+      ]
+    end
+
+    def widths(routes)
+      [
+        controller_width(routes),
+        action_width(routes),
+        verb_width(routes),
+        name_width(routes),
+        path_width(routes)
+      ]
+    end
+
+    def controller_width(routes)
+      routes.map { |r| r[:reqs].split('#').first.length + 5 }.max || 0
+    end
+
+    def action_width(routes)
+      routes.map { |r| r[:reqs].split('#').last.length + 5 }.max || 0
+    end
+
+    def verb_width(routes)
+      routes.map { |r| r[:verb].length + 5 }.max || 0
+    end
+
+    def name_width(routes)
+      routes.map { |r| r[:name].length + 5 }.max || 0
+    end
+
+    def path_width(routes)
+      routes.map { |r| r[:path].length }.max || 0
+    end
+  end
+end

data/lib/kurin/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+module Kurin
+  # This class defines the Kurin Railtie
+  # @author Joshua Kendall
+  class Railtie < Rails::Railtie
+    railtie_name :kurin
+
+    rake_tasks do
+      load 'kurin/tasks/routes.rake'
+    end
+  end
+end

data/lib/kurin/tasks/routes.rake

@@ -0,0 +1,9 @@
+namespace :kurin do
+  desc 'Print out all defined routes in a clean fashion.'
+  task routes: :environment do
+    all_routes = Rails.application.routes.routes
+    require 'action_dispatch/routing/inspector'
+    inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+    puts inspector.format(Kurin::Formatter.new, ENV['CONTROLLER'])
+  end
+end

data/lib/kurin/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Kurin
+  VERSION = '0.0.1'.freeze
+end

data/lib/kurin.rb

@@ -0,0 +1,5 @@
+# Kurin - Squeaky Clean Routing
+module Kurin
+  require 'kurin/railtie' if defined?(Rails)
+  require 'kurin/formatter' if defined?(Rails)
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: kurin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Kendall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+description: A Rails gem that presents routes in a clean way.
+email: me@joshuakendall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/kurin.rb
+- lib/kurin/formatter.rb
+- lib/kurin/railtie.rb
+- lib/kurin/tasks/routes.rake
+- lib/kurin/version.rb
+homepage: http://github.com/jtkendall/kurin
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Squeaky Clean Routing task for Rails
+test_files: []
+has_rdoc: