actionpack-direct_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a389d748b0ee8d8763f9c640a7b83442da5c8730
+  data.tar.gz: 9b6f8e1f13c5b8d62875d73fafff1cf6296f9031
+SHA512:
+  metadata.gz: b8d4194c1a1ea9ecac75b08430c3e94c5b87d2a50c84566da824e07ac905ae62642ab134511dfc1a07b0ce864b0deee173e1f1bbf3a1f909085366af14eb970b
+  data.tar.gz: 99a148bae6858c94a4a7eb9c50bd2eab670ea0f3d7dff2588aac13bd37b2b2327fdb457aa4d49f8c299c036c18dfd7bb6b18f38e21c8dffdef43ba167502eec5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 hamuyuuki
+
+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,39 @@
+# actionpack-direct_routes
+`actionpack-direct_routes` backports Direct routes into Rails 4 and Rails 5.0.
+
+Rails 5.1 adds Direct routes that you can create custom URL helpers directly.
+[Ruby on Rails 5.1 Release Notes — Ruby on Rails Guides](https://guides.rubyonrails.org/5_1_release_notes.html#direct-resolved-routes)
+
+## Getting Started
+Install `actionpack-direct_routes` at the command prompt:
+```
+gem install actionpack-direct_routes
+```
+
+Or add `actionpack-direct_routes` to your Gemfile:
+```
+gem "actionpack-direct_routes"
+```
+
+## How to use
+You can create custom URL helpers directly. For example:
+```
+direct :homepage do
+  "http://www.rubyonrails.org"
+end
+
+# >> homepage_url
+# => "http://www.rubyonrails.org"
+```
+
+For details to [Rails Routing from the Outside In — Ruby on Rails Guides](https://guides.rubyonrails.org/routing.html#direct-routes)
+
+
+## Limitation
+You can backport Direct routes into Rails 4.2 only now.
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/hamuyuuki/actionpack-direct_routes. 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
+`actionpack-direct_routes` is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'DirectRoutes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/action_dispatch/routing/direct_routes/mapper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    module DirectRoutes
+      module Mapper
+        def direct(name, options = {}, &block)
+          unless @scope.root?
+            raise RuntimeError, "The direct method can't be used inside a routes scope block"
+          end
+
+          @set.add_url_helper(name, options, &block)
+        end
+      end
+    end
+  end
+end

data/lib/action_dispatch/routing/direct_routes/mapper/scope.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    module DirectRoutes
+      module Mapper
+        module Scope
+          def root?
+            @parent == {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_dispatch/routing/direct_routes/route_set.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    module DirectRoutes
+      module RouteSet
+        def add_url_helper(name, options, &block)
+          named_routes.add_url_helper(name, options, &block)
+        end
+
+        def url_helpers(supports_path = true)
+          routes = self
+
+          Module.new do
+            extend ActiveSupport::Concern
+            include ActionDispatch::Routing::UrlFor
+
+            # Define url_for in the singleton level so one can do:
+            # Rails.application.routes.url_helpers.url_for(args)
+            proxy_class = Class.new do
+              include ActionDispatch::Routing::UrlFor
+              include routes.named_routes.path_helpers_module
+              include routes.named_routes.url_helpers_module
+
+              attr_reader :_routes
+
+              def initialize(routes)
+                @_routes = routes
+              end
+
+              def optimize_routes_generation?
+                @_routes.optimize_routes_generation?
+              end
+            end
+
+            @_proxy = proxy_class.new(routes)
+
+            class << self
+              def url_for(options)
+                @_proxy.url_for(options)
+              end
+
+              def optimize_routes_generation?
+                @_proxy.optimize_routes_generation?
+              end
+
+              def _routes; @_proxy._routes; end
+              def url_options; {}; end
+            end
+
+            url_helpers = routes.named_routes.url_helpers_module
+
+            # Make named_routes available in the module singleton
+            # as well, so one can do:
+            # Rails.application.routes.url_helpers.posts_path
+            extend url_helpers
+
+            # Any class that includes this module will get all
+            # named routes...
+            include url_helpers
+
+            if supports_path
+              path_helpers = routes.named_routes.path_helpers_module
+
+              include path_helpers
+              extend path_helpers
+            end
+
+            # plus a singleton class method called _routes ...
+            included do
+              singleton_class.send(:redefine_method, :_routes) { routes }
+            end
+
+            # And an instance method _routes. Note that
+            # UrlFor (included in this module) add extra
+            # conveniences for working with @_routes.
+            define_method(:_routes) { @_routes || routes }
+
+            define_method(:_generate_paths_by_default) do
+              supports_path
+            end
+
+            private :_generate_paths_by_default
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_dispatch/routing/direct_routes/route_set/custom_url_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    module DirectRoutes
+      module RouteSet
+        class CustomUrlHelper
+          attr_reader :name, :defaults, :block
+
+          def initialize(name, defaults, &block)
+            @name = name
+            @defaults = defaults
+            @block = block
+          end
+
+          def call(t, args, only_path = false)
+            options = args.extract_options!
+            url = t.url_for(eval_block(t, args, options))
+
+            if only_path
+              "/" + url.partition(%r{(?<!/)/(?!/)}).last
+            else
+              url
+            end
+          end
+
+          private
+            def eval_block(t, args, options)
+              t.instance_exec(*args, merge_defaults(options), &block)
+            end
+
+            def merge_defaults(options)
+              defaults ? defaults.merge(options) : options
+            end
+        end
+      end
+    end
+  end
+end

data/lib/action_dispatch/routing/direct_routes/route_set/named_route_collection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "custom_url_helper"
+
+module ActionDispatch
+  module Routing
+    module DirectRoutes
+      module RouteSet
+        module NamedRouteCollection
+          def add_url_helper(name, defaults, &block)
+            helper = CustomUrlHelper.new(name, defaults, &block)
+            path_name = :"#{name}_path"
+            url_name = :"#{name}_url"
+
+            @path_helpers_module.module_eval do
+              redefine_method(path_name) do |*args|
+                helper.call(self, args, true)
+              end
+            end
+
+            @url_helpers_module.module_eval do
+              redefine_method(url_name) do |*args|
+                helper.call(self, args, false)
+              end
+            end
+
+            @path_helpers << path_name
+            @url_helpers << url_name
+
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/actionpack/direct_routes.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "active_support/lazy_load_hooks"
+
+ActiveSupport.on_load(:before_initialize) do
+  require "action_dispatch/routing/direct_routes/mapper"
+  require "action_dispatch/routing/direct_routes/mapper/scope"
+  require "action_dispatch/routing/direct_routes/route_set"
+  require "action_dispatch/routing/direct_routes/route_set/named_route_collection"
+
+  ActionDispatch::Routing::Mapper.include(ActionDispatch::Routing::DirectRoutes::Mapper)
+  ActionDispatch::Routing::Mapper::Scope.include(ActionDispatch::Routing::DirectRoutes::Mapper::Scope)
+  ActionDispatch::Routing::RouteSet.prepend(ActionDispatch::Routing::DirectRoutes::RouteSet)
+  ActionDispatch::Routing::RouteSet::NamedRouteCollection.include(ActionDispatch::Routing::DirectRoutes::RouteSet::NamedRouteCollection)
+end

data/lib/actionpack/direct_routes/version.rb

@@ -0,0 +1,5 @@
+module ActionPack
+  module DirectRoutes
+    VERSION = "0.1.0"
+  end
+end

data/test/application/routing_test.rb

@@ -0,0 +1,206 @@
+require "active_support"
+require "active_support/test_case"
+require "active_support/testing/autorun"
+
+require "action_controller"
+require "action_controller/test_case"
+
+require "rack/test"
+
+class RoutingTest < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+  include Rack::Test::Methods
+
+  def app_path
+    @app_path ||= Dir.mktmpdir("direct_routes-")
+  end
+
+  def app_template_path
+    @app_template_path ||= File.join(File.expand_path("../", __dir__), "dummy")
+  end
+
+  def app_file(path, contents, mode = 'w')
+    FileUtils.mkdir_p File.dirname("#{app_path}/#{path}")
+    File.open("#{app_path}/#{path}", mode) do |f|
+      f.puts contents
+    end
+  end
+
+  def app(env = "production")
+    old_env = ENV["RAILS_ENV"]
+    @app ||= begin
+      ENV["RAILS_ENV"] = env
+      require "#{app_path}/config/environment"
+      Rails.application
+    end
+  ensure
+    ENV["RAILS_ENV"] = old_env
+  end
+
+  def controller(name, contents)
+    app_file("app/controllers/#{name}_controller.rb", contents)
+  end
+
+  def setup
+    FileUtils.cp_r(Dir.glob("#{app_template_path}/*"), app_path)
+  end
+
+  def teardown
+    FileUtils.rm_rf(app_path)
+  end
+
+  {
+    "development" => ["baz", "http://www.apple.com", "/dashboard"],
+    "production"  => ["bar", "http://www.microsoft.com", "/profile"]
+  }.each do |mode, (expected_action, expected_url, expected_mapping)|
+    test "reloads routes when configuration is changed in #{mode}" do
+      controller :foo, <<-RUBY
+        class FooController < ApplicationController
+          def custom
+            render plain: custom_url
+          end
+        end
+      RUBY
+
+      app_file "config/routes.rb", <<-RUBY
+        Rails.application.routes.draw do
+          get 'custom', to: 'foo#custom'
+
+          direct(:custom) { "http://www.microsoft.com" }
+        end
+      RUBY
+
+      app(mode)
+
+      get "/custom"
+      assert_equal "http://www.microsoft.com", last_response.body
+
+      app_file "config/routes.rb", <<-RUBY
+        Rails.application.routes.draw do
+          get 'custom', to: 'foo#custom'
+
+          direct(:custom) { "http://www.apple.com" }
+        end
+      RUBY
+
+      sleep 0.1
+
+      get "/custom"
+      assert_equal expected_url, last_response.body
+    end
+  end
+
+  test "routes are added and removed when reloading" do
+    app("development")
+
+    controller :foo, <<-RUBY
+      class FooController < ApplicationController
+        def index
+          render plain: "foo"
+        end
+
+        def custom
+          render plain: custom_url
+        end
+      end
+    RUBY
+
+    controller :bar, <<-RUBY
+      class BarController < ApplicationController
+        def index
+          render plain: "bar"
+        end
+      end
+    RUBY
+
+    app_file "config/routes.rb", <<-RUBY
+      Rails.application.routes.draw do
+        get 'foo', to: 'foo#index'
+      end
+    RUBY
+
+    get "/foo"
+    assert_equal "foo", last_response.body
+    assert_equal "/foo", Rails.application.routes.url_helpers.foo_path
+
+    get "/bar"
+    assert_equal 404, last_response.status
+    assert_raises NoMethodError do
+      assert_equal "/bar", Rails.application.routes.url_helpers.bar_path
+    end
+
+    app_file "config/routes.rb", <<-RUBY
+      Rails.application.routes.draw do
+        get 'foo', to: 'foo#index'
+        get 'bar', to: 'bar#index'
+
+        get 'custom', to: 'foo#custom'
+        direct(:custom) { 'http://www.apple.com' }
+      end
+    RUBY
+
+    Rails.application.reload_routes!
+
+    get "/foo"
+    assert_equal "foo", last_response.body
+    assert_equal "/foo", Rails.application.routes.url_helpers.foo_path
+
+    get "/bar"
+    assert_equal "bar", last_response.body
+    assert_equal "/bar", Rails.application.routes.url_helpers.bar_path
+
+    get "/custom"
+    assert_equal "http://www.apple.com", last_response.body
+    assert_equal "http://www.apple.com", Rails.application.routes.url_helpers.custom_url
+
+    app_file "config/routes.rb", <<-RUBY
+      Rails.application.routes.draw do
+        get 'foo', to: 'foo#index'
+      end
+    RUBY
+
+    Rails.application.reload_routes!
+
+    get "/foo"
+    assert_equal "foo", last_response.body
+    assert_equal "/foo", Rails.application.routes.url_helpers.foo_path
+
+    get "/bar"
+    assert_equal 404, last_response.status
+    assert_raises NoMethodError do
+      assert_equal "/bar", Rails.application.routes.url_helpers.bar_path
+    end
+
+    get "/custom"
+    assert_equal 404, last_response.status
+    assert_raises NoMethodError do
+      assert_equal "http://www.apple.com", Rails.application.routes.url_helpers.custom_url
+    end
+  end
+
+  test "named routes are cleared when reloading" do
+    app_file "config/routes.rb", <<-RUBY
+      Rails.application.routes.draw do
+        direct(:microsoft) { 'http://www.microsoft.com' }
+      end
+    RUBY
+
+    app("development")
+
+    assert_equal "http://www.microsoft.com", Rails.application.routes.url_helpers.microsoft_url
+
+    app_file "config/routes.rb", <<-RUBY
+      Rails.application.routes.draw do
+        direct(:apple) { 'http://www.apple.com' }
+      end
+    RUBY
+
+    Rails.application.reload_routes!
+
+    assert_equal "http://www.apple.com", Rails.application.routes.url_helpers.apple_url
+
+    assert_raises NoMethodError do
+      assert_equal "http://www.microsoft.com", Rails.application.routes.url_helpers.microsoft_url
+    end
+  end
+end