path_rewrite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25d0011b70654e6cd76012e1245d3489adf5cfe6
+  data.tar.gz: 258f9d1c33e3c4fbc9ba729f0208fbe1ed04a87b
+SHA512:
+  metadata.gz: 201b09505e619678aebb089a705d4b245f768eb77f9b1416be7995bf8d003d5bb45c30ec4f7ee2b1d0975a08c2bcaa87095b2f7365eb7a2ac02c8f68a4ad54f1
+  data.tar.gz: d7c3abb0f7858687395115cc45bf38b7aec16eaefe26b1faf2d0607fe768bef2e0ec403b20ef61c6b3cdd421fc12b0d156a7837373af06eaea4596a103a18b01

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Michael Tucker
+
+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,26 @@
+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    = 'PathRewrite'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/test_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/path_rewrite/path_controller.rb

@@ -0,0 +1,15 @@
+module PathRewrite
+  class PathController < ActionController::Base
+
+    def rewrite
+      rewrite = PathTranslation.find_by(old_path: "/#{params["path"]}") or raise ActionController::RoutingError.new("Not Found")
+
+      Rails.logger.debug "Redirecting #{rewrite.old_path} to #{rewrite.new_path} from request #{request.url}"
+
+      redirect_to rewrite.new_path, status: 301
+    end
+
+  end
+end
+# FEATURE FLAG (in nemo)
+# TEST/REGRESSION

data/app/models/path_rewrite/path_translation.rb

@@ -0,0 +1,4 @@
+module PathRewrite
+  class PathTranslation < ActiveRecord::Base
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+PathRewrite::Engine.routes.draw do
+  get "*path", to: "path#rewrite", constraints: -> (req) do
+    PathRewrite.configuration.check_redirect? &&
+        PathRewrite::PathTranslation.find_by(old_path: "/#{req.params["path"]}").present?
+  end
+
+end

data/db/migrate/20150618003028_create_path_rewrite_path_translations.rb

@@ -0,0 +1,10 @@
+class CreatePathRewritePathTranslations < ActiveRecord::Migration
+  def change
+    create_table :path_rewrite_path_translations do |t|
+      t.string :old_path
+      t.string :new_path
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/path_rewrite.rb

@@ -0,0 +1,6 @@
+require "path_rewrite/engine"
+
+require "path_rewrite/configuration"
+
+module PathRewrite
+end

data/lib/path_rewrite/configuration.rb

@@ -0,0 +1,27 @@
+module PathRewrite
+  class Configuration
+
+    def check_redirect=(value)
+      @check_redirect = value
+    end
+
+    def check_redirect?
+      return @check_redirect unless @check_redirect.respond_to?(:call)
+
+      @check_redirect.call
+    end
+
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+end
+
+# initialize configuration
+PathRewrite.configuration.check_redirect = true

data/lib/path_rewrite/engine.rb

@@ -0,0 +1,10 @@
+module PathRewrite
+  class Engine < ::Rails::Engine
+    isolate_namespace PathRewrite
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+  end
+end

data/lib/path_rewrite/version.rb

@@ -0,0 +1,3 @@
+module PathRewrite
+  VERSION = "0.0.1"
+end

data/lib/tasks/path_rewrite_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :path_rewrite do
+#   # Task goes here
+# end

data/spec/controllers/path_rewrite/path_controller_spec.rb

@@ -0,0 +1,30 @@
+module PathRewrite
+  RSpec.describe PathController, type: :controller do
+
+    # ensure requests use the engine route. alternative is to specify use_route: "path_rewrite" in every test
+    routes { PathRewrite::Engine.routes }
+
+    context "when a translation matches the request path" do
+
+      let(:old_path) { "test" }
+      let(:new_path) { "/captured" }
+
+      before { PathRewrite::PathTranslation.create!(old_path: "/#{old_path}", new_path: "#{new_path}") }
+
+      it "redirects 301 to new path" do
+        get :rewrite, path: old_path
+        expect(response).to redirect_to new_path
+      end
+
+    end
+
+    context "when no translations match the request path" do
+
+      it "raises routing error" do
+        expect { get :rewrite, path: "non_translated_path" }.to raise_error ActionController::RoutingError
+      end
+
+    end
+
+  end
+end

data/spec/lib/path_rewrite/configuration_spec.rb

@@ -0,0 +1,33 @@
+module PathRewrite
+  describe Configuration do
+
+    it "exposes a singleton through #configuration" do
+      expect(PathRewrite.configuration).to be PathRewrite.configuration
+    end
+
+    it "allows configuration of singleton through #configure block" do
+      PathRewrite.configure do |config|
+        expect(config).to be PathRewrite.configuration
+      end
+    end
+
+    context "check_redirect" do
+
+      after do
+        PathRewrite.configuration.check_redirect = nil
+      end
+
+      it "supports static value setting" do
+        PathRewrite.configuration.check_redirect = false
+        expect(PathRewrite.configuration.check_redirect?).to eq false
+      end
+
+      it "supports lambda setting" do
+        PathRewrite.configuration.check_redirect = -> { true }
+        expect(PathRewrite.configuration.check_redirect?).to eq true
+      end
+
+    end
+
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,50 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require 'spec_helper'
+require File.expand_path('../test_app/config/environment', __FILE__)
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/rcov_exclude_list.rb

@@ -0,0 +1,4 @@
+@exclude_list = [
+    'spec/**/*.rb',
+    'db/**/*.rb'
+]

data/spec/routing/routes_spec.rb

@@ -0,0 +1,51 @@
+describe "routes", :type => :routing do
+
+  routes { PathRewrite::Engine.routes }
+
+  before { PathRewrite.configuration.check_redirect = true }
+
+  context "when check_redirect is configured to allow rewrites" do
+
+    context "and a matching route exists" do
+
+      before { PathRewrite::PathTranslation.create!(old_path: "/test", new_path: "/redirected" ) }
+
+      it "routes to path_controller rewrite action" do
+        expect(get: "/test").to route_to(controller: "path_rewrite/path", action: "rewrite", path: "test")
+      end
+
+    end
+
+    context "and no matching routes exist" do
+
+      it "does not route" do
+        expect(get: "/test").not_to be_routable
+      end
+
+    end
+
+  end
+
+  context "when check_redirect is configured to disable rewrites" do
+
+    before { PathRewrite.configuration.check_redirect = false }
+
+    context "and a matching route exists" do
+
+      it "does not route" do
+        expect(get: "/test").not_to be_routable
+      end
+
+    end
+
+    context "and no matching routes exist" do
+
+      it "does not route" do
+        expect(get: "/test").not_to be_routable
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+# configure code coverage
+if ENV["COVERAGE"]
+  require_relative 'rcov_exclude_list.rb'
+  exlist = Dir.glob(@exclude_list)
+  require 'simplecov'
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start do
+    exlist.each do |p|
+      add_filter p
+    end
+  end
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+=end
+end

data/spec/test_app/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>.