js_rails_routes 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c971acaca259fdde1cd934667f6ea2ca761f42e9
-  data.tar.gz: 8895cd1743d727e936e9da298f392e8a2c1c9960
+  metadata.gz: 6542396accf937692fb966d1cea9e13b037059fc
+  data.tar.gz: 2fabec2ed3c39d5b12c9735e0a2e84aaaa39e640
 SHA512:
-  metadata.gz: 709cca081ac5958d1cf68398ff15a0ff5cc17ce3201f1e05fa232198bbca591be22969ca51140b9770edfa87b45e6b94e3b11efbefb90b666f759d78b5a7632f
-  data.tar.gz: e07ad1c8d18f843701a008b59796c94952a29eaa0eb314b21727e27095dd4099a4fcc4655fe7a812ed05d8f5f9fd8dbb15ef431f107e1906916407c952d13b2f
+  metadata.gz: 5d0df45754906758a9266abbc7382dc07390e5ad0b06a564883fdf21e3569da2d92797496789dc72331566c3ba76308c427b3430d7cb837a1819ca375cbb7ea2
+  data.tar.gz: 160bf9a51331d3ecb1809f6f229aff92748d7a3853f3047920d608bdc28c4260fa194c8ce870dd2cb27773f79e4bd00b19812a3a1c8de54d608067a9bb651354

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -1,3 +1,4 @@
 /pkg/
 *.gem
 Gemfile.lock
+spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+- 2.3.1
+notifications:
+  email: false

data/CHANGELOG.md

@@ -4,6 +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]
+### Added
+- Enable to configure through Ruby interface
+
+### Changed
+- Depend on rails >= 3.2
+- Remove rake command line parameter from js file
+
 ## [0.2.1] - 2016-06-24
 ### Fixed
 - Make sure that js file ends with a new line char
@@ -16,6 +24,7 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 ### Added
 - Implement "js:rails:routes" task
 
+[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
 [0.1.0]: https://github.com/yuku-t/js_rails_routes/compare/033b945...v0.1.0

data/Gemfile

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

data/README.md

@@ -1,5 +1,7 @@
 # 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)
+
 Generate a ES6 module that contains Rails routes.
 
 ## Description
@@ -7,7 +9,7 @@ Generate a ES6 module that contains Rails routes.
 This gem provides "js:routes" rake task.
 It generates a ES6 requirable module with exports url helper functions defined by your Rails application.
 
-Suppose there are some routes defined:
+Suppose a Rails app has some routes:
 
 ```rb
 # == Route Map
@@ -26,14 +28,14 @@ Rails.application.routes.draw do
 end
 ```
 
-The JS file generated by this gem exports following functions:
+This gem generates a JS file looks like this:
 
 ```js
-var RailsRoutes = require('./rails-routes');
-RailsRoutes.articles_path();              //=> '/articles'
-RailsRoutes.new_article_path();           //=> '/articles/new'
-RailsRoutes.edit_article_path({ id: 1 }); //=> '/articles/1/edit'
-RailsRoutes.article_path({ id: 1 });      //=> '/articles/1'
+// Don't edit manually. `rake js:routes` generates this file.
+export function article_path(params) { return '/articles/' + params.id + ''; }
+export function articles_path(params) { return '/articles'; }
+export function edit_article_path(params) { return '/articles/' + params.id + '/edit'; }
+export function new_article_path(params) { return '/articles/new'; }
 ```
 
 ## VS.
@@ -44,38 +46,53 @@ This gem uses ES6 modules.
 
 ## Requirement
 
-- Rails >= 3.0
+- Rails >= 3.2
 
 ## Usage
 
-Write all routes to app/assets/javascripts/rails-routes.js:
+Generate routes file.
 
-```
+```bash
 rake js:routes
 ```
 
-Write to client/src/rails-routes.js:
+### Configuration
 
-```
-rake js:routes path='client/src/rails-routes.js'
-```
+JSRailsRoutes supports several parameters:
 
-Generate routes except paths start with "/rails/" or "/sidekiq/":
+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"`
 
-```
-rake js:routes excludes='^/(rails|sidekiq)/'
-```
-Generate routes start with "/articles/" only:
+You can configure via `JSRailsRoutes.configure`.
 
+```rb
+# Rakefile
+JSRailsRoutes.configure |c|
+  c.excludes = %r{^/(rails|sidekiq)}
+  c.path = 'path/to/rails-routes.js'
+end
 ```
-rake js:routes includes='^/articles/'
+
+Now `rake js:routes` ignores paths starting with "/rails" or "/sidekiq".
+
+### Command line parameters
+
+You can override the coniguration via command line parameters:
+
+```bash
+rake js:routes excludes='^/rails'
 ```
 
+The command still ignores "/rails" but includes "/sidekiq".
+
 ## Install
 
 Your Rails Gemfile:
 
-```
+```rb
 gem 'js_rails_routes', group: :development
 ```
 
@@ -87,4 +104,4 @@ gem 'js_rails_routes', group: :development
 
 [mizchi](https://github.com/mizchi) wrote "js:routes" task with referencing [mtrpcic/js-routes](https://github.com/mtrpcic/js-routes).
 
-[yuku-t](https://yuku-t.com) refactor and improve the mizchi's script and published to rubygems.
+[yuku-t](https://yuku-t.com) refactored and improved the mizchi's script and published to [rubygems](https://rubygems.org/gems/js_rails_routes).

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/js_rails_routes.gemspec

@@ -1,4 +1,4 @@
-$: << File.expand_path('../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
 
 require 'js_rails_routes/version'
 
@@ -12,7 +12,9 @@ Gem::Specification.new do |spec|
   spec.license         = 'MIT'
   spec.files           = `git ls-files -z`.split("\x0")
   spec.require_paths   = ['lib']
-  spec.add_dependency 'rails', '>= 3'
+  spec.add_dependency 'rails', '>= 3.2'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
+  spec.add_development_dependency 'rubocop', '~> 0.40.0'
 end

data/lib/js_rails_routes/generator.rb

@@ -1,57 +1,51 @@
+require 'singleton'
+
 module JSRailsRoutes
   class Generator
-    COMPARE_REGEXP = /:(.*?)(\/|$)/
+    COMPARE_REGEXP = %r{:(.*?)(/|$)}
+
+    include Singleton
 
-    def initialize(includes: nil, excludes: nil)
-      @includes = includes
-      @excludes = excludes
+    attr_accessor :includes, :excludes, :path
+
+    def initialize
+      self.includes = /.*/
+      self.excludes = /^$/
+      self.path = Rails.root.join('app', 'assets', 'javascripts', 'rails-routes.js')
       Rails.application.reload_routes!
     end
 
-    def generate(task, save_path)
-      lines = ["// Don't edit manually. `rake #{task}#{env}` generates this file."]
-      lines += routes.map do |name, path|
-        handle_route(name, path) if match?(name, path)
+    def generate(task)
+      lines = ["// Don't edit manually. `rake #{task}` generates this file."]
+      lines += routes.map do |route_name, route_path|
+        handle_route(route_name, route_path) if match?(route_name, route_path)
       end.compact
-      lines += '' # End with new line
-      File.open(save_path, 'w') { |f| f.write(lines.join("\n")) }
+      lines += [''] # End with new line
+      write(lines.join("\n"))
     end
 
     private
 
-    attr_reader :includes, :excludes
-
-    def includes_regexp
-      @includes_regexp ||= Regexp.new(includes)
-    end
-
-    def excludes_regexp
-      @excludes_regexp ||= Regexp.new(excludes)
-    end
-
-    def match?(name, path)
-      return false if includes && includes_regexp !~ path
-      return false if excludes && excludes_regexp =~ path
+    def match?(_route_name, route_path)
+      return false if includes !~ route_path
+      return false if excludes =~ route_path
       true
     end
 
-    def handle_route(name, path)
-      path.sub!(COMPARE_REGEXP, "' + params.#{$1} + '#{$2}") while path =~ COMPARE_REGEXP
-      "export function #{name}_path(params) { return '#{path}'; }"
+    def handle_route(route_name, route_path)
+      route_path.sub!(COMPARE_REGEXP, "' + params.#{$1} + '#{$2}") while route_path =~ COMPARE_REGEXP
+      "export function #{route_name}_path(params) { return '#{route_path}'; }"
     end
 
     def routes
       @routes ||= Rails.application.routes.routes
-        .select(&:name)
-        .map { |r| [r.name, r.path.spec.to_s.split('(')[0]] }
-        .sort { |a, b| a[0] <=> b[0] }
+                       .select(&:name)
+                       .map { |r| [r.name, r.path.spec.to_s.split('(')[0]] }
+                       .sort { |a, b| a[0] <=> b[0] }
     end
 
-    def env
-      result = []
-      result << "includes='#{includes}'" if includes
-      result << "excludes='#{excludes}'" if excludes
-      result.empty? ? '' : ' ' + result.join(' ')
+    def write(string)
+      File.open(path, 'w') { |f| f.write(string) }
     end
   end
 end

data/lib/js_rails_routes/version.rb

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

data/lib/js_rails_routes.rb

@@ -1,3 +1,11 @@
 require 'js_rails_routes/engine'
 require 'js_rails_routes/generator'
 require 'js_rails_routes/version'
+
+module JSRailsRoutes
+  module_function
+
+  def configure
+    yield Generator.instance if block_given?
+  end
+end

data/lib/tasks/js_rails_routes.rake

@@ -1,12 +1,11 @@
 desc 'Generate a ES6 module that contains Rails routes'
 namespace :js do
   task routes: :environment do |task|
-    path =  ENV['path'] || Rails.root.join('app', 'assets', 'javascripts', 'rails-routes.js')
-    generator = JSRailsRoutes::Generator.new(
-      includes: ENV['includes'],
-      excludes: ENV['excludes']
-    )
-    generator.generate(task, path)
-    puts "Routes saved to #{path}."
+    generator = JSRailsRoutes::Generator.instance
+    generator.includes = Regexp.new(ENV['includes']) if ENV['includes']
+    generator.excludes = Regexp.new(ENV['excludes']) if ENV['excludes']
+    generator.path = ENV['path'] if ENV['path']
+    generator.generate(task)
+    puts "Routes saved to #{generator.path}."
   end
 end

data/spec/js_rails_routes/generator_spec.rb

@@ -0,0 +1,62 @@
+RSpec.describe JSRailsRoutes::Generator do
+  let(:generator) do
+    described_class.clone.instance
+  end
+
+  it { expect(described_class).to include(Singleton) }
+
+  describe '#generate' do
+    subject do
+      generator.generate(task)
+    end
+
+    let(:task) do
+      'js:routes'
+    end
+
+    it 'writes a JS file' do
+      expect(generator).to receive(:write).with(a_string_including("rake #{task}"))
+      subject
+    end
+
+    context 'when includes is given' do
+      before do
+        generator.includes = Regexp.new(includes)
+      end
+
+      let(:includes) do
+        '/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))
+        end
+        subject
+      end
+    end
+
+    context 'when excludes is given' do
+      before do
+        generator.excludes = Regexp.new(excludes)
+      end
+
+      let(:excludes) do
+        '/new'
+      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 include(excludes)
+          end
+        end
+        subject
+      end
+    end
+  end
+end

data/spec/js_rails_routes_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe JSRailsRoutes do
+  describe '.configure' do
+    it 'yields with Generator instance' do
+      expect { |b| described_class.configure(&b) }.to yield_with_args(JSRailsRoutes::Generator.instance)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.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
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_rails_routes
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
 description: 
 email:
 - taka84u9@gmail.com
@@ -59,7 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -71,6 +103,9 @@ files:
 - lib/js_rails_routes/generator.rb
 - lib/js_rails_routes/version.rb
 - lib/tasks/js_rails_routes.rake
+- spec/js_rails_routes/generator_spec.rb
+- spec/js_rails_routes_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/yuku-t/js_rails_routes
 licenses:
 - MIT