js-routes-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2e41da3f7d5988bb153308e80144c92278820f7
+  data.tar.gz: 354ef08359fa825406e15dc906855c4ddbf2c82f
+SHA512:
+  metadata.gz: 3d38649bd0817b0c77c50d4d85a53084485a7fedc24be3cede82c1230a16e5c115e08de5772de4b7e5cf7236460460579a3aaec25a4e08ca7cf12817e584e18f
+  data.tar.gz: 390599f022123fea8bdf8dc5072f75ea0dabcb8ec14ecc0d09b566b89b44ccbb08f3b358fb86ff429adf4c8da7ca3ca4860f52deb2fe426b9d4f77a10852af63

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at damian.nicholson21@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in js-routes-rails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Damian Nicholson
+
+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,71 @@
+# Js::Routes::Rails
+
+Generates a JavaScript file containing a predefined set of Rails URL helpers on the client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'js-routes-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Set up
+
+Append `export: true` to any route defined in you `config/routes.rb` which declares that resource able to be exported to the client.
+
+```ruby
+# config/routes.rb
+resources :articles, export: true
+
+resources :comments
+
+resources :publishers, export: true do
+  resources :magazines do
+    resources :photos
+  end
+end
+
+match "/about", to: "static#index", via: :get, export: true
+```
+
+And then execute:
+
+    $ bundle exec rake js_routes_rails:export
+
+This will generate a JavaScript file in `app/assets/javascript/js-routes-rails.js`, which you can consume using the Asset Pipeline, for example:
+
+
+```ruby
+javascript_include_tag 'js-routes-rails'
+```
+
+or in `application.js`
+
+```javascript
+//= 'js-routes-rails'
+```
+
+## Usage
+
+Once you've brought the exported file in to your project your now able to use the `JsRoutesRails` object which gives you access to all of your Rails URL helpers on the client.
+
+```javascript
+JsRoutesRails.new_articles_path() // '/articles/new'
+JsRoutesRails.edit_articles_path({ id: 23 }) // '/articles/23/edit'
+JsRoutesRails.edit_magazines_path({ publishers_id: 5, id: 9 }) // '/publishers/5/magazines/9/edit'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/damian/js-routes-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+#
+# RSpec::Core::RakeTask.new(:spec)
+#
+# task :default => :spec

data/js-routes-rails-template.js

@@ -0,0 +1,19 @@
+var JsRoutesRails = (function() {
+  var routes = {};
+  <% @routes.each do |helper, path| %>
+  routes['<%= helper %>'] = function(options) {
+    return format('<%= path %>', options);
+  };
+  <% end %>
+
+  function format(string, options) {
+    var str = string.toString();
+    for (option in options) {
+      str = str.replace(RegExp("\\:" + option, "gi"), options[option]);
+    }
+
+    return str;
+  };
+
+  return routes;
+})();

data/js-routes-rails.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js-routes/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "js-routes-rails"
+  spec.version       = Js::Routes::Rails::VERSION
+  spec.authors       = ["Damian Nicholson"]
+  spec.email         = ["hi@damiannicholson.com"]
+
+  spec.summary       = %q{Brings Rails url_helpers to JavaScript}
+  spec.description   = %q{Generates a JavaScript file containing specific url_helpers defined in config/routes.rb}
+  spec.homepage      = "https://github.com/damian/js-routes-rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  # spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/js-routes/rails/engine.rb

@@ -0,0 +1,14 @@
+require "js-routes/rails/route_finder"
+require "js-routes/rails/route_exporter"
+
+module Js
+  module Routes
+    module Rails
+      class Engine < ::Rails::Engine
+        rake_tasks do
+          load "js-routes/tasks/js-routes-rails.rake"
+        end
+      end
+    end
+  end
+end

data/lib/js-routes/rails/route_exporter.rb

@@ -0,0 +1,37 @@
+module Js
+  module Routes
+    module Rails
+      class RouteExporter
+        attr_reader :routes
+
+        def initialize(finder = nil)
+          @routes = finder.routes
+        end
+
+        def export!
+          File.open(output_path, 'w') { |f| f.write(compiled) }
+        end
+
+        private
+
+        def output_path
+          ::Rails.root.join('app', 'assets', 'javascripts', 'js-routes-rails.js')
+        end
+
+        def compiled
+          b = binding
+          b.local_variable_set(:routes, routes)
+          ERB.new(template).result(b)
+        end
+
+        def template
+          File.read(template_path)
+        end
+
+        def template_path
+          File.join(Js::Routes.root, 'js-routes-rails-template.js')
+        end
+      end
+    end
+  end
+end

data/lib/js-routes/rails/route_finder.rb

@@ -0,0 +1,31 @@
+module Js
+  module Routes
+    module Rails
+      class RouteFinder
+        attr_reader :routes
+
+        def initialize(application_routes = nil)
+          @routes = {}
+          @application_routes = application_routes
+          find_routes
+        end
+
+        def find_routes
+          @application_routes.to_a.each do |route|
+            if route.defaults.key?(:export) && route.name.present?
+              @routes[path_helper(route)] = path(route)
+            end
+          end
+        end
+
+        def path_helper(route)
+          "#{route.name}_path"
+        end
+
+        def path(route)
+          route.path.spec.to_s.chomp("(.:format)")
+        end
+      end
+    end
+  end
+end

data/lib/js-routes/rails/version.rb

@@ -0,0 +1,7 @@
+module Js
+  module Routes
+    module Rails
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/js-routes/rails.rb

@@ -0,0 +1,26 @@
+require "js-routes/rails/engine"
+require "js-routes/rails/version"
+
+module Js
+  module Routes
+    module Rails
+      class << self
+        attr_writer :configuration
+      end
+
+      def self.configuration
+        @configuration ||= OpenStruct.new
+      end
+
+      def self.export!(routes = nil)
+        finder = Js::Routes::Rails::RouteFinder.new(routes)
+        exporter = Js::Routes::Rails::RouteExporter.new(finder)
+        exporter.export!
+      end
+
+      def self.configure
+        yield configuration
+      end
+    end
+  end
+end

data/lib/js-routes/tasks/js-routes-rails.rake

@@ -0,0 +1,6 @@
+namespace :js_routes_rails do
+  desc "Generates an JavaScript file containing routes accessible on the client"
+  task :export => :environment do
+    Js::Routes::Rails.export!(::Rails.application.routes.routes)
+  end
+end

data/lib/js-routes-rails.rb

@@ -0,0 +1,9 @@
+require 'js-routes/rails'
+
+module Js
+  module Routes
+    def self.root
+      File.expand_path('../..', __FILE__)
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: js-routes-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damian Nicholson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Generates a JavaScript file containing specific url_helpers defined in
+  config/routes.rb
+email:
+- hi@damiannicholson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- js-routes-rails-template.js
+- js-routes-rails.gemspec
+- lib/js-routes-rails.rb
+- lib/js-routes/rails.rb
+- lib/js-routes/rails/engine.rb
+- lib/js-routes/rails/route_exporter.rb
+- lib/js-routes/rails/route_finder.rb
+- lib/js-routes/rails/version.rb
+- lib/js-routes/tasks/js-routes-rails.rake
+homepage: https://github.com/damian/js-routes-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Brings Rails url_helpers to JavaScript
+test_files: []