js_rails_routes 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6542396accf937692fb966d1cea9e13b037059fc
-  data.tar.gz: 2fabec2ed3c39d5b12c9735e0a2e84aaaa39e640
+  metadata.gz: ca0f6f4f31f67057a1ae5f4d839b98564d323dfa
+  data.tar.gz: 9966df2ec91cc5f7ec03dd6ca082a01a3c73f4d4
 SHA512:
-  metadata.gz: 5d0df45754906758a9266abbc7382dc07390e5ad0b06a564883fdf21e3569da2d92797496789dc72331566c3ba76308c427b3430d7cb837a1819ca375cbb7ea2
-  data.tar.gz: 160bf9a51331d3ecb1809f6f229aff92748d7a3853f3047920d608bdc28c4260fa194c8ce870dd2cb27773f79e4bd00b19812a3a1c8de54d608067a9bb651354
+  metadata.gz: 08885b9714f50b48795aab6d79f5ce0e8e32de2ce1c245865a158c14011be5b38024a4d99f7024574b0c431f11907aee16fb5cfc73c34499cc9c845a939ed322
+  data.tar.gz: 2143f80a2c1090ce16b4493ccb196a62d0c889930ff1ec5e6fe2ad6fb149b2491e7d4a716f3843f3b5e93285d2cf779a48843f56dc75fbbaeb7441722c48bc6b

data/.gitignore

@@ -2,3 +2,4 @@
 *.gem
 Gemfile.lock
 spec/examples.txt
+coverage

data/.rubocop.yml

@@ -4,9 +4,16 @@ Metrics/LineLength:
 Metrics/AbcSize:
   Max: 20
 
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'
+
 Style/Documentation:
   Enabled: false
 
+Style/SymbolArray:
+  Enabled: false
+
 Style/TrailingCommaInLiteral:
   Enabled: false
 

data/.travis.yml

@@ -3,3 +3,8 @@ rvm:
 - 2.3.1
 notifications:
   email: false
+script:
+- bundle exec rake rubocop
+- bundle exec rake spec
+after_success:
+- bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -4,7 +4,14 @@ All notable changes to this project will be documented in this file.
 
 This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 
-## [0.3.0]
+## [0.4.0] - 2017-04-05
+### Added
+- Add `include_names` and `exclude_names` option
+
+### Changed
+- Rename `includes` and `excludes` as `include_paths` and `exclude_paths` respectively
+
+## [0.3.0] - 2016-06-25
 ### Added
 - Enable to configure through Ruby interface
 
@@ -24,6 +31,7 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 ### Added
 - Implement "js:rails:routes" task
 
+[0.4.0]: https://github.com/yuku-t/js_rails_routes/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/yuku-t/js_rails_routes/compare/v0.2.1...v0.3.0
 [0.2.1]: https://github.com/yuku-t/js_rails_routes/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/yuku-t/js_rails_routes/compare/v0.1.0...v0.2.0

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,15 +1,20 @@
 # rake js:routes
 
-[![Gem](https://img.shields.io/gem/v/js_rails_routes.svg?maxAge=2592000)](https://rubygems.org/gems/js_rails_routes) [![Build Status](https://travis-ci.org/yuku-t/js_rails_routes.svg?branch=master)](https://travis-ci.org/yuku-t/js_rails_routes) [![Code Climate](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/gpa.svg)](https://codeclimate.com/github/yuku-t/js_rails_routes) [![Test Coverage](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/coverage.svg)](https://codeclimate.com/github/yuku-t/js_rails_routes/coverage) [![license](https://img.shields.io/github/license/yuku-t/js_rails_routes.svg?maxAge=2592000)](https://github.com/yuku-t/js_rails_routes/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/js_rails_routes.svg?maxAge=2592000)](https://rubygems.org/gems/js_rails_routes)
+[![Build Status](https://travis-ci.org/yuku-t/js_rails_routes.svg?branch=master)](https://travis-ci.org/yuku-t/js_rails_routes)
+[![Code Climate](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/gpa.svg)](https://codeclimate.com/github/yuku-t/js_rails_routes)
+[![Test Coverage](https://codeclimate.com/github/yuku-t/js_rails_routes/badges/coverage.svg)](https://codeclimate.com/github/yuku-t/js_rails_routes/coverage)
+[![license](https://img.shields.io/github/license/yuku-t/js_rails_routes.svg?maxAge=2592000)](https://github.com/yuku-t/js_rails_routes/blob/master/LICENSE)
+[![Analytics](https://ga-beacon.appspot.com/UA-4932407-14/js_rails_routes/readme)](https://github.com/igrigorik/ga-beacon)
 
 Generate a ES6 module that contains Rails routes.
 
 ## Description
 
 This gem provides "js:routes" rake task.
-It generates a ES6 requirable module with exports url helper functions defined by your Rails application.
+It generates a ES6 requirable module which exports url helper functions defined in your Rails application.
 
-Suppose a Rails app has some routes:
+Suppose the app has following routes:
 
 ```rb
 # == Route Map
@@ -28,7 +33,7 @@ Rails.application.routes.draw do
 end
 ```
 
-This gem generates a JS file looks like this:
+then `rake js:routes` generates "app/assets/javascripts/rails-routes.js" as:
 
 ```js
 // Don't edit manually. `rake js:routes` generates this file.
@@ -60,19 +65,21 @@ rake js:routes
 
 JSRailsRoutes supports several parameters:
 
-Name       | Type     | Description                             | Default
------------|----------|-----------------------------------------|----------------------------------------
-`includes` | `Regexp` | routes match to the regexp are included | `/.*/`
-`excludes` | `Regexp` | routes match to the regexp are excluded | `/^$/`
-`path`     | `String` | JS file path                            | `"app/assets/javascripts/rails-routes.js"`
+Name            | Type     | Description                             | Default
+----------------|----------|-----------------------------------------|----------------------------------------
+`include_paths` | `Regexp` | paths match to the regexp are included  | `/.*/`
+`exclude_paths` | `Regexp` | paths match to the regexp are excluded  | `/^$/`
+`include_names` | `Regexp` | names match to the regexp are included  | `/.*/`
+`exclude_names` | `Regexp` | names match to the regexp are excluded  | `/^$/`
+`path`          | `String` | JS file path                            | `Rails.root.join("app", "assets", "javascripts", "rails-routes.js")`
 
 You can configure via `JSRailsRoutes.configure`.
 
 ```rb
 # Rakefile
-JSRailsRoutes.configure |c|
-  c.excludes = %r{^/(rails|sidekiq)}
-  c.path = 'path/to/rails-routes.js'
+JSRailsRoutes.configure do |c|
+  c.exclude_paths = %r{^/(rails|sidekiq)}
+  c.path = Rails.root.join('path', 'to', 'rails-routes.js')
 end
 ```
 
@@ -83,7 +90,7 @@ Now `rake js:routes` ignores paths starting with "/rails" or "/sidekiq".
 You can override the coniguration via command line parameters:
 
 ```bash
-rake js:routes excludes='^/rails'
+rake js:routes exclude_paths='^/rails'
 ```
 
 The command still ignores "/rails" but includes "/sidekiq".
@@ -98,7 +105,7 @@ gem 'js_rails_routes', group: :development
 
 ## License
 
-[MIT](https://github.com/yuku-t/js_rails_routes/blob/master/LICENCE)
+[MIT](https://github.com/yuku-t/js_rails_routes/blob/master/LICENSE)
 
 ## Author
 

data/js_rails_routes.gemspec

@@ -14,7 +14,9 @@ Gem::Specification.new do |spec|
   spec.require_paths   = ['lib']
   spec.add_dependency 'rails', '>= 3.2'
   spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.40.0'
+  spec.add_development_dependency 'rubocop', '~> 0.48.1'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
 end

data/lib/js_rails_routes/generator.rb

@@ -6,11 +6,13 @@ module JSRailsRoutes
 
     include Singleton
 
-    attr_accessor :includes, :excludes, :path
+    attr_accessor :include_paths, :exclude_paths, :include_names, :exclude_names, :path
 
     def initialize
-      self.includes = /.*/
-      self.excludes = /^$/
+      self.include_paths = /.*/
+      self.exclude_paths = /^$/
+      self.include_names = /.*/
+      self.exclude_names = /^$/
       self.path = Rails.root.join('app', 'assets', 'javascripts', 'rails-routes.js')
       Rails.application.reload_routes!
     end
@@ -26,9 +28,11 @@ module JSRailsRoutes
 
     private
 
-    def match?(_route_name, route_path)
-      return false if includes !~ route_path
-      return false if excludes =~ route_path
+    def match?(route_name, route_path)
+      return false if include_paths !~ route_path
+      return false if exclude_paths =~ route_path
+      return false if include_names !~ route_name
+      return false if exclude_names =~ route_name
       true
     end
 

data/lib/js_rails_routes/version.rb

@@ -1,3 +1,3 @@
 module JSRailsRoutes
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/tasks/js_rails_routes.rake

@@ -2,8 +2,10 @@ desc 'Generate a ES6 module that contains Rails routes'
 namespace :js do
   task routes: :environment do |task|
     generator = JSRailsRoutes::Generator.instance
-    generator.includes = Regexp.new(ENV['includes']) if ENV['includes']
-    generator.excludes = Regexp.new(ENV['excludes']) if ENV['excludes']
+    generator.include_paths = Regexp.new(ENV['include_paths']) if ENV['include_paths']
+    generator.exclude_paths = Regexp.new(ENV['exclude_paths']) if ENV['exclude_paths']
+    generator.include_names = Regexp.new(ENV['include_names']) if ENV['include_names']
+    generator.exclude_names = Regexp.new(ENV['exclude_names']) if ENV['exclude_names']
     generator.path = ENV['path'] if ENV['path']
     generator.generate(task)
     puts "Routes saved to #{generator.path}."

data/spec/js_rails_routes/generator_spec.rb

@@ -19,32 +19,32 @@ RSpec.describe JSRailsRoutes::Generator do
       subject
     end
 
-    context 'when includes is given' do
+    context 'when include_paths is given' do
       before do
-        generator.includes = Regexp.new(includes)
+        generator.include_paths = include_paths
       end
 
-      let(:includes) do
-        '/new'
+      let(:include_paths) do
+        %r{/new}
       end
 
       it 'writes paths matching with the parameter' do
         expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
           paths = arg.split("\n")[1..-1]
           expect(paths).not_to be_empty
-          expect(paths).to all(a_string_including(includes))
+          expect(paths).to all(match(include_paths))
         end
         subject
       end
     end
 
-    context 'when excludes is given' do
+    context 'when exclude_paths is given' do
       before do
-        generator.excludes = Regexp.new(excludes)
+        generator.exclude_paths = exclude_paths
       end
 
-      let(:excludes) do
-        '/new'
+      let(:exclude_paths) do
+        %r{/new}
       end
 
       it 'writes paths not matching with the parameter' do
@@ -52,7 +52,47 @@ RSpec.describe JSRailsRoutes::Generator do
           paths = arg.split("\n")[1..-1]
           expect(paths).not_to be_empty
           paths.each do |path|
-            expect(path).to_not include(excludes)
+            expect(path).to_not match(exclude_paths)
+          end
+        end
+        subject
+      end
+    end
+
+    context 'when include_names is given' do
+      before do
+        generator.include_names = include_names
+      end
+
+      let(:include_names) do
+        /user/
+      end
+
+      it 'writes paths matching with the parameter' do
+        expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
+          paths = arg.split("\n")[1..-1]
+          expect(paths).not_to be_empty
+          expect(paths).to all(match(include_names))
+        end
+        subject
+      end
+    end
+
+    context 'when exclude_names is given' do
+      before do
+        generator.exclude_names = exclude_names
+      end
+
+      let(:exclude_names) do
+        /user/
+      end
+
+      it 'writes paths not matching with the parameter' do
+        expect(generator).to receive(:write).with(a_kind_of(String)) do |arg|
+          paths = arg.split("\n")[1..-1]
+          expect(paths).not_to be_empty
+          paths.each do |path|
+            expect(path).to_not match(exclude_names)
           end
         end
         subject

data/spec/spec_helper.rb

@@ -1,22 +1,21 @@
 $LOAD_PATH << File.expand_path('../../lib', __FILE__)
 
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'rails/all'
 require 'js_rails_routes'
 
 class TestApp < Rails::Application
   config.root = File.expand_path('../test_app', __FILE__)
-end
 
-RSpec.configure do |config|
-  config.before :all do
-    TestApp.routes.draw do
-      resources :apps
-    end
+  routes.draw do
+    resources :blogs
+    resources :users
   end
+end
 
+RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_rails_routes
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '0.14'
 description: 
 email:
 - taka84u9@gmail.com