rails_versioned_routing 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e50cb75d4d9578b599a26359351129984b140f7
+  data.tar.gz: bf9b224721b66fbfeaa2630d3258053e1cd99025
+SHA512:
+  metadata.gz: 79d27b65ddecbbb086e502fdb6869ee9d17117532cba1d92b75d5d6a12a6e2905b9d7f356bb62ec040f5e58495af934df0d06e200c9f15e486b8997ff807edc7
+  data.tar.gz: 52a6676f5dd5596a12275b7626e17008023b7161364da8abb8a019f00cf092f5c3d4cd11ad8692a67dac3652a2219dde56131d804ba31aef07a3d672ba457847

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Trek Glowacki
+
+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/Rakefile

@@ -0,0 +1,29 @@
+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    = 'RailsVersionedRouting'
+  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/rails_versioned_routing/railtie.rb

@@ -0,0 +1,7 @@
+module RailsVersionedRouting
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/rails_versioned_routing_tasks.rake'
+    end
+  end
+end

data/lib/rails_versioned_routing.rb

@@ -0,0 +1,202 @@
+require 'rails_versioned_routing/railtie' if defined?(Rails)
+
+module RailsVersionedRouting
+  VERSION = "1.1.0"
+
+  class VersionConstraint
+    attr_reader :version
+
+    def initialize(options)
+      @version = options.fetch(:version)
+    end
+
+    def matches?(request)
+      accept = request.headers.fetch(:accept, '*/*')
+      has_version = accept.match(/version=([\d+])/)
+
+      if has_version
+        version = has_version.captures.last.to_i
+        return @version <= version
+      else
+        return @version == 1
+      end
+    end
+  end
+
+  class VersionedGroup
+    class Visitor # :nodoc:
+      DISPATCH_CACHE = {}
+
+      def accept(node)
+        visit(node)
+      end
+
+      private
+
+        def visit node
+          send(DISPATCH_CACHE[node.type], node)
+        end
+
+        def binary(node)
+          visit(node.left)
+          visit(node.right)
+        end
+        def visit_CAT(n); binary(n); end
+
+        def nary(node)
+          node.children.each { |c| visit(c) }
+        end
+        def visit_OR(n); nary(n); end
+
+        def unary(node)
+          visit(node.left)
+        end
+        def visit_GROUP(n); unary(n); end
+        def visit_STAR(n); unary(n); end
+
+        def terminal(node); end
+        def visit_LITERAL(n); terminal(n); end
+        def visit_SYMBOL(n);  terminal(n); end
+        def visit_SLASH(n);   terminal(n); end
+        def visit_DOT(n);     terminal(n); end
+
+        private_instance_methods(false).each do |pim|
+          next unless pim =~ /^visit_(.*)$/
+          DISPATCH_CACHE[$1.to_sym] = pim
+        end
+    end
+
+    class OptimizedPath < Visitor
+      def accept(node)
+        Array(visit(node))
+      end
+
+      private
+
+      def visit_CAT(node)
+        [visit(node.left), visit(node.right)].flatten
+      end
+
+      def visit_SYMBOL(node)
+        node.left[1..-1].to_sym
+      end
+
+      def visit_STAR(node)
+        visit(node.left)
+      end
+
+      def visit_GROUP(node)
+        []
+      end
+
+      %w{ LITERAL SLASH DOT }.each do |t|
+        class_eval %{ def visit_#{t}(n); n.left; end }, __FILE__, __LINE__
+      end
+    end
+
+    def initialize(routes)
+      @routes = routes
+    end
+
+    def grouped_by_version
+      # `versions` is a hash whose empty value is
+      # a new, nested hash.
+      # The outer hash's keys will all be set to
+      # version numbers.
+      #
+      # The value for each will be a hash.
+      # The keys for the inner hash will be string key that
+      # combines the routes path and HTTP method.
+      #
+      # Since higher numbered versions appear first
+      # we can rely on the side effect of
+      # those path/method pairs being already set
+      # so we can safely avoid collisions.
+      #
+      # routes defined in *earlier* versions will appear
+      # in each `versions[version_number]` hash unless
+      # the current version has already set a matching
+      # path/method key.
+      versions = Hash.new {|h,k| h[k] = {}}
+
+      @routes.each do |route|
+        # routes that have a constraint added to them appear as
+        # an rack 'application' of the type ActionDispatch::Routing::Mapper::Constraints
+        if route.app.is_a?(ActionDispatch::Routing::Mapper::Constraints)
+
+          # the constraint might not be a versioned constraint. We handle versioned constraint
+          # rack apps different ly
+          version_constraint = route.app.constraints.find {|constraint| constraint.is_a?(VersionConstraint) }
+
+          # returns a string representation of the path by walking its
+          # AST and building a string
+          optimized_path = OptimizedPath.new.accept(route.path.spec)
+
+          if version_constraint
+            # transforms the variable names in path into a generic form so we can match the pattern
+            # not the specific variable.
+            # e.g.
+            # get 'posts/:id/hello'
+            # get 'posts/:post_id'/hello
+            # would generate paths of
+            # ['posts', :id, 'hello']
+            # and
+            # ['posts', :post_id, 'hello']
+            # but the routing matching should treat them as
+            # ['posts', ANY VARIABLE WE DONT CARE ABOUT NAME, 'hello']
+            #
+            # So, we transfrom all symbols into the same value
+            denormalized_path = denormalize_path(optimized_path)
+
+            # the full key for the hash is a combo of the path and the method
+            # since the same path will match different controller/actions if
+            # the HTTP method differs.
+            denormalize_path_and_method = "#{denormalized_path}-#{route.constraints[:request_method]}"
+
+            version = version_constraint.version
+
+            # add to current version
+            versions[version][denormalize_path_and_method] = route
+
+            # add to higher versions unless higher version
+            # already includes a path that matches
+            versions.each do |k,v|
+              next if k <= version
+
+              versions[k][denormalize_path_and_method] ||= route
+            end
+
+          else
+            versions[0][denormalize_path_and_method] = route
+          end
+        else
+          versions[0][optimized_path] = route
+        end
+      end
+
+      # flatten one level of the hash
+      # {
+      #   1 => [<#Route>, <#Route>],
+      #   2 => [<#Route>]
+      # }
+      versions.each do |k,v|
+        versions[k] = v.values
+      end
+
+      versions
+    end
+
+    def denormalize_path(path)
+      path.map {|slug| slug.is_a?(Symbol) ? :VARIABLE : slug }
+    end
+  end
+
+  def version(version_number, &routes)
+    api_constraint = VersionConstraint.new(version: version_number)
+    scope(module: "v#{version_number}", constraints: api_constraint, &routes)
+  end
+
+  def self.group_by_version
+    VersionedGroup.new(Rails.application.routes.routes).grouped_by_version
+  end
+end

data/lib/tasks/rails_versioned_routing_tasks.rake

@@ -0,0 +1,5 @@
+# desc "Print out all defined routes in match order, with names, grouped by version"
+# task :routes_versioned do
+#   puts "ok"
+# end
+

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/sample_controller.rb

@@ -0,0 +1,5 @@
+class SampleController < ApplicationController
+  def final_fallback
+    render text: 'v0'
+  end
+end

data/test/dummy/app/controllers/v1/sample_controller.rb

@@ -0,0 +1,7 @@
+module V1
+  class SampleController < ApplicationController
+    def a_path_overridden_from_v1
+      render text: 'v1'
+    end
+  end
+end

data/test/dummy/app/controllers/v2/sample_controller.rb

@@ -0,0 +1,11 @@
+module V2
+  class SampleController < ApplicationController
+    def a_path_in_v2
+      render text: 'v2'
+    end
+
+    def a_path_overridden_from_v1
+      render text: 'v2'
+    end
+  end
+end

data/test/dummy/app/controllers/v3/sample_controller.rb

@@ -0,0 +1,11 @@
+module V3
+  class SampleController < ApplicationController
+    def a_path_only_in_v3
+      render text: 'v3'
+    end
+
+    def posted_a_path_only_in_v3
+      render text: 'v3'
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "rails_versioned_routing"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,32 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]