colrou 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c7367465b841f2060d90d41d9c8493c68ee82b95ffdcb4b67292e0323d7efc
-  data.tar.gz: 7f78fe6baa21b74f75560c4e914cf809725f21c84a956e44267037dab21fa5e6
+  metadata.gz: 117b780b16ccd0157f77379e590164cd39c78ff94238863a3c7df37cba684ac0
+  data.tar.gz: 13219de4be890fd29b35bf7fca053c19d7be1d2049cadbf14acd2d73740d9e52
 SHA512:
-  metadata.gz: 694ed42e1c1c0718192bc36ca74babbb00aac6b272cbd4b555bf16332baba1f2489d15f3eda65b38a3b9c4a4eddb971bffde2a0367ee4057599d33f0de6d9cec
-  data.tar.gz: 8bf01225cb8d917d024f5551e0fb3baaeab5628148535eac0bacc2f75d20ea14c832d3dcd36ca23ef869ea6658e44cd1dd2020178a0c4e86ee446982748c85d9
+  metadata.gz: 55a25cdd099d84b86781caff4c3ed7229bdd95eaee14b069dd7c3e552e6cbd356ef77bc30913756201321457f5075c5b5606738773202bf357454c04725c4bbf
+  data.tar.gz: 6978e7a6767208f56e027cd31d2aae00dfb66e2f5fde7e1f059cc9e0e54cc6ea8072f5236a5b007a01edebf03fb7b6a1faee257f475ab0075ea25cf67a806141

data/README.md

@@ -1,39 +1,57 @@
+![Gem Version](https://img.shields.io/gem/v/colrou.svg) ![License](https://img.shields.io/github/license/evaneykelen/colrou.svg)
+![Last Commit](https://img.shields.io/github/last-commit/evaneykelen/colrou.svg)
+
 # Colrou
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/colrou`. To experiment with that code, run `bin/console` for an interactive prompt.
+Colrou reformats output of `rails routes`. The name is a portmanteau of "colorized routes".
+
+## Example
 
-TODO: Delete this and the text above, and describe your gem
+![Example](https://user-images.githubusercontent.com/11846/54473866-ccc02600-47dd-11e9-9093-8ba1d9fe7d44.png)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+`gem install colrou`
 
-```ruby
-gem 'colrou'
-```
+The `colrou` command operates on the output of the `rails routes` command.
+
+It performs two operations:
 
-And then execute:
+- HTTP verbs and path parameters are colorized
+- Line breaks are inserted between controllers
 
-    $ bundle
+## Usage examples
 
-Or install it yourself as:
+`$ rails routes | colrou`
 
-    $ gem install colrou
+`$ rails routes -g posts | colrou`
 
-## Usage
 
-TODO: Write usage instructions here
+## Color configuration
 
-## Development
+Place a file called `.colrou.yml` in your home directory (e.g. `~` on Unix) to configure output colors:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+http_verb_colors:
+  delete: "\e[91m"
+  get: "\e[92m"
+  patch: "\e[95m"
+  post: "\e[93m"
+  put: "\e[95m"
+misc_colors:
+  reset: "\e[0m"
+  param: "\e[96m"
+```
 
-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).
+See [here](https://misc.flogisoft.com/bash/tip_colors_and_formatting) for a nice overview of shell color codes.
 
-## Contributing
+## Tip
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/colrou.
+Add the following lines to e.g. `~/.bash_profile` (the location depends on your shell and OS):
 
-## License
+```
+alias rr='rails routes'
+alias cr='colrou'
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+You now only have to type `$ rr | cr` to colorize your routes.

data/lib/colrou/parse.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Colrou
   class Parse
     def self.rails_routes
@@ -27,26 +29,30 @@ $ rails routes -g posts | colrou
     CYAN        = "\e[96m"
     RESET_COLOR = "\e[0m"
 
-    VERBS_AND_COLORS = [
-      { verb: "DELETE", color: RED    },
-      { verb: "GET",    color: GREEN  },
-      { verb: "PATCH",  color: PURPLE },
-      { verb: "POST",   color: YELLOW },
-      { verb: "PUT",    color: PURPLE }
-    ]
+    COLORS = {
+      http_verb_colors: {
+        delete: RED,
+        get: GREEN,
+        patch: PURPLE,
+        post: YELLOW,
+        put: PURPLE
+      },
+      misc_colors: {
+        reset: RESET_COLOR,
+        param: CYAN
+      }
+    }
 
     def self.colorize_verbs(line)
-      VERBS_AND_COLORS.each do |verb_and_color|
-        verb = verb_and_color[:verb]
-        color = verb_and_color[:color]
-        line.gsub!(/#{verb}/, "#{color}#{verb}#{RESET_COLOR}")
+      COLORS[:http_verb_colors].each do |verb, color|
+        line.gsub!(/#{verb.upcase}/, "#{color}#{verb.upcase}#{COLORS[:misc_colors][:reset]}")
       end
     end
 
     # Uses https://ruby-doc.org/core-1.9.3/Regexp.html#class-Regexp-label-Capturing
     def self.colorize_parameters(line)
       line.gsub!(/(?<parameter>\/:\w+)/) do
-        "/#{CYAN}#{$~[:parameter].slice(1..-1)}#{RESET_COLOR}"
+        "/#{COLORS[:misc_colors][:param]}#{$~[:parameter].slice(1..-1)}#{COLORS[:misc_colors][:reset]}"
       end
     end
 
@@ -56,7 +62,20 @@ $ rails routes -g posts | colrou
       controller_action.split("#")[0]      # Get "controller" from "controller#action"
     end
 
+    def self.prepare_colors
+      config_file = File.join(Dir.home, ".colrou.yml")
+      return unless File.file?(config_file)
+      config = YAML.load_file(File.join(Dir.home, ".colrou.yml"))
+      config["http_verb_colors"].each do |verb, color|
+        COLORS[:http_verb_colors][verb.to_sym] = color
+      end
+      config["misc_colors"].each do |attrib, color|
+        COLORS[:misc_colors][attrib.to_sym] = color
+      end
+    end
+
     def self.parse
+      prepare_colors
       prev_controller_name = nil
       begin
         while input = ARGF.gets
@@ -77,7 +96,7 @@ $ rails routes -g posts | colrou
           end
         end
       rescue
-        puts "Invalid input"
+        puts "Invalid input (#{$!})"
       end
     end
   end

data/lib/colrou/version.rb

@@ -1,3 +1,3 @@
 module Colrou
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colrou
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Erik van Eykelen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-16 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,7 +47,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt