js_routes_watcher 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d5640a23ab6258d66842baf221d11ea9e4f618af4bd36697d15bd0c306895db
+  data.tar.gz: 818a72e79e16ff165bf70caf31259dd982dcd726fe4e61f808948e2590595d15
+SHA512:
+  metadata.gz: 19262d7208e113d6b296fbc07fb01ec5097229c1f3d7265aa254ddd9f45d4503352a280ceb058c96162a8448fdddc7860dbb5247f0505808ebb544c8036d694d
+  data.tar.gz: f6ad50439df37fa4efaab8bd4d5c6f7af9f0b616778cfab43353775fd10902ce674a62c4bcfdbf19b316e55d7ecf25cb946a1d91c915467eca309c1a657b9328

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'rake', :task => 'js_routes_watcher:generate' do
+  watch(%r{^config/routes.rb})
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Dmitriy Beliaev
+
+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/Procfile

@@ -0,0 +1,5 @@
+# Example Procfile
+backend: bin/rails s -p 3000
+guard: bundle exec guard
+sidekiq: bundle exec sidekiq
+frontend: bin/webpack-dev-server

data/README.md

@@ -0,0 +1,54 @@
+# JsRoutesWatcher
+Plugin for *Ruby on Rails* which utilise [js-routes](https://github.com/railsware/js-routes) gem to work with **webpacker**.
+
+Using modern JS-frameworks such as **Vue** or **React**, you have to move all rails-generated routes to javascript.
+Then you'll be able to do this:
+```javascript
+const login_path = Routes.api_login_path()
+```
+
+[js-routes](https://github.com/railsware/js-routes) gem gives you the ability to export rails routes to standalone js-file. 
+
+But how to do this automatically? There's gem you're watching on comes to play.
+
+Every time when `config/routes.rb` is updated `Guard` task will regenerate `app/javascript/packs/routes.js` file. And all you have to do – is to import it in your project js-packs.
+```javascript
+import './routes.js'
+// Then
+Routes.api_login_path()
+```
+
+
+
+## Installation
+All you need to start using plugin is to:
+
+1. Install gem.
+Add this line to your application's Gemfile:
+```ruby
+gem 'js_routes_watcher', github: "codemotion/js_routes_watcher"
+```
+And then execute:
+```bash
+$ bundle
+```
+2. Create `Guardfile` in the root of the project and fill it with:
+```ruby
+guard 'rake', :task => 'js_routes_watcher:generate' do
+  watch(%r{^config/routes.rb})
+end
+```
+And then save file.
+
+3. Be shure what you're using **webpacker** gem and starting it with [Foreman](https://github.com/ddollar/foreman) or [Overmind](https://github.com/DarthSim/overmind).
+
+4. `Procfile` must have the following line to start `Guard` task in background:
+```
+guard: bundle exec guard
+```
+
+## Contributing
+You're free to contribute via pull requests.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsRoutesWatcher'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/js_routes_watcher/engine.rb

@@ -0,0 +1,5 @@
+module JsRoutesWatcher
+  class Engine < ::Rails::Engine
+    isolate_namespace JsRoutesWatcher
+  end
+end

data/lib/js_routes_watcher/version.rb

@@ -0,0 +1,3 @@
+module JsRoutesWatcher
+  VERSION = '0.1.1'
+end

data/lib/js_routes_watcher.rb

@@ -0,0 +1,5 @@
+require "js_routes_watcher/engine"
+
+module JsRoutesWatcher
+  # Your code goes here...
+end

data/lib/tasks/js_routes_watcher_tasks.rake

@@ -0,0 +1,8 @@
+namespace :js_routes_watcher do
+  desc "Generate routes for javascript"
+  task :generate => :environment do
+    path = Rails.root.join 'app/javascript/packs/routes.js'
+    File.delete path if File.exist? path
+    JsRoutes.generate!(path)
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: js_routes_watcher
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dmitriy Beliaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: js-routes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creating a Guard task to auto-regenerate app/javascript/packs/routes.js
+  file when config/routes.rb is updated.
+email:
+- admin@cogear.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Guardfile
+- MIT-LICENSE
+- Procfile
+- README.md
+- Rakefile
+- lib/js_routes_watcher.rb
+- lib/js_routes_watcher/engine.rb
+- lib/js_routes_watcher/version.rb
+- lib/tasks/js_routes_watcher_tasks.rake
+homepage: https://github.com/codemotion/js_routes_watcher
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Plugin for Ruby on Rails which utilise js-routes gem to work with webpacker.
+test_files: []