rails-static-router 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed5f5ce3ad32c88587aeb6fcbc59cf2154be0169
+  data.tar.gz: d640729f05619c6caca6928498a76c7c350297bc
+SHA512:
+  metadata.gz: 6076b9cdbe743910d5cdc04bba8e2495faecf3abb374435b6ac0ff0ef5e1566529d1b9ccca98d67ad1d1ef3c742a010d821a20a365cd16550d440debf2ece96d
+  data.tar.gz: 49e69a8eb45e2e32f96d994a0f83ed75edae853c67971516be71b65f3dd76af26de76018d3a2e294c9ea590da4b3897b4d77ebf1dd345058ac10a1fec8853d87

data/.editorconfig

@@ -0,0 +1,15 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*~
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+Gemfile.*.lock
+coverage/*
+doc/*
+log/*
+measurement/*
+pkg/*
+spec/examples.txt
+spec/reports/*
+test/coverage

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--order random
+--require spec_helper
+--format documentation --color
+--format html --out spec/reports/rspec_results.html

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: false
+
+matrix:
+  include:
+    - gemfile: gemfiles/rails41.gemfile
+      rvm: 2.3.7
+    - gemfile: gemfiles/rails42.gemfile
+      rvm: 2.3.7
+    - gemfile: gemfiles/rails50.gemfile
+      rvm: 2.4.4
+    - gemfile: gemfiles/rails51.gemfile
+      rvm: 2.4.4

data/Appraisals

@@ -0,0 +1,27 @@
+appraise 'rails41' do
+  gem 'rails', '~> 4.1.0'
+  gem 'sqlite3'
+
+  gem 'rspec-rails'
+end
+
+appraise 'rails42' do
+  gem 'rails', '~> 4.2.0'
+  gem 'sqlite3'
+
+  gem 'rspec-rails'
+end
+
+appraise 'rails50' do
+  gem 'rails', '~> 5.0.0'
+  gem 'sqlite3'
+
+  gem 'rspec-rails'
+end
+
+appraise 'rails51' do
+  gem 'rails', '~> 5.1.0'
+  gem 'sqlite3'
+
+  gem 'rspec-rails'
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eliot Sykes
+Copyright (c) 2018 Muhammad Mufid Afif
+
+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,104 @@
+# Rails Static Router [![Build Status](https://travis-ci.org/mufid/rails-static-router.svg?branch=master)](https://travis-ci.org/mufid/rails-static-router)
+
+Enjoy static routes in your Rails `config/routes.rb`.
+
+<!-- MarkdownTOC depth=0 autolink=true bracket=round -->
+
+- [Installation](#installation)
+- [Example use](#example-use)
+- [Why?](#why)
+- [TODO](#todo)
+- [Contributors](#contributors)
+
+<!-- /MarkdownTOC -->
+
+## Installation
+
+1. Put `gem 'rails-static-router'` in your `Gemfile`
+2. Restart app
+
+## Example use
+
+```ruby
+Rails.application.routes.draw do
+  ...
+  # This route will serve public/index.html at the /login URL path, and have
+  # URL helper named `login_path`:
+  get "/login", to: static("index.html")
+
+  # This route will serve public/index.html at the /register URL path, and
+  # have URL helper named `new_user_registration_path`:
+  get "/register", to: static("index.html"), as: :new_user_registration
+  ...
+end
+```
+
+`bin/rake routes` output for the above routes:
+
+```
+               Prefix  Verb  URI Pattern          Controller#Action
+                login  GET   /login(.:format)     static('index.html')
+new_user_registration  GET   /register(.:format)  static('index.html')
+```
+ 
+## Compatibility
+
+This gem is compatible with Rails 4.1+.
+
+## Why?
+
+This introduces a `static(path_to_file)` helper method to route to static files
+from within `routes.rb`. It is inspired by Rails' existing `redirect(...)` method.
+
+Some benefits of this technique over alternatives (such as rack-rewrite,
+nginx/httpd-configured rewrites):
+
+- Named URL helper method for static file available throughout app, for
+  example in mail templates, view templates, and tests.
+
+- Route discoverable via `bin/rake routes` and Routing Error page in development.
+
+- Takes advantage of ActionDispatch's built-in gzip handling. Controller action
+  based solutions for rendering static files tend to not use this.
+
+- Handy for Single Page Apps that serve the same static HTML file for multiple
+  paths, as is often the case with Ember & Angular apps.
+
+- Heroku-like production environments work with this that do use the Rails app
+  to serve static files.
+
+- Leaves door open for nginx, Apache, Varnish and friends to serve the static
+  files directly for improved performance in production environments via symlinks
+  and/or other artifacts generated at deploy time.
+
+## Contributors
+
+- Eliot Sykes https://eliotsykes.com/
+- Muhammad Mufid Afif https://mufid.github.io
+- Your name here! Contributions are welcome and easy. Fork the GitHub repo, make your changes, then submit your pull request. Don't hesitate to ask if you'd like some help.
+
+## Contributing
+
+We are using Appraisals to test against multiple Rails version. To set it
+up for the first time, please run:
+
+    bundle install
+    bundle exec appraisal install
+
+After Appraisal installed, use this command to run the test:
+
+    bundle exec appraisal rake test
+
+To test it agains multiple Ruby version, you may want to use rvm.
+For example:
+
+    # Test it against all specified Rails version
+    # with Ruby version 2.3.7
+    rvm install 2.3.7
+    rvm use 2.3.7
+    bundle exec appraisals rake test
+
+    # Test it against all specified Rails version
+    # with Ruby version 2.4.4
+    rvm install 2.4.4
+    bundle exec appraisals rake test

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# RSpec Rails available via Appraisal
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task test: :spec
+rescue LoadError
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'reek/rake/task'
+Reek::Rake::Task.new
+
+task default: %i[spec]

data/gemfiles/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+*.gemfile.lock

data/gemfiles/rails41.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+gem "sqlite3"
+gem "rspec-rails"
+
+gemspec path: "../"

data/gemfiles/rails42.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "sqlite3"
+gem "rspec-rails"
+
+gemspec path: "../"

data/gemfiles/rails50.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "sqlite3"
+gem "rspec-rails"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+gem "sqlite3"
+gem "rspec-rails"
+
+gemspec path: "../"

data/lib/action_dispatch/routing/static_responder.rb

@@ -0,0 +1,109 @@
+# Example use:
+#
+# Rails.application.routes.draw do
+#   ...
+#   # This route will serve public/index.html at the /login URL path, and have
+#   # URL helper named `login_path`:
+#   get "/login", to: static("index.html")
+#
+#   # This route will serve public/index.html at the /register URL path, and
+#   # have URL helper named `new_user_registration_path`:
+#   get "/register", to: static("index.html"), as: :new_user_registration
+#   ...
+# end
+#
+# `bin/rake routes` output for the above routes:
+#
+#                Prefix  Verb  URI Pattern          Controller#Action
+#                 login  GET   /login(.:format)     static('index.html')
+# new_user_registration  GET   /register(.:format)  static('index.html')
+#
+#
+# Why?
+#
+# static(path_to_file) helper method used to route to static files
+# from within routes.rb. Inspired by Rails' existing redirect(...) method.
+#
+# Some benefits of this technique over alternatives (such as rack-rewrite,
+# nginx/httpd-configured rewrites):
+#
+# - Named URL helper method for static file available throughout app, for
+#   example in mail templates, view templates, and tests.
+#
+# - Route discoverable via `bin/rake routes` and Routing Error page in development.
+#
+# - Takes advantage of ActionDispatch's built-in gzip handling. Controller action
+#   based solutions for rendering static files tend to not use this.
+#
+# - Handy for Single Page Apps that serve the same static HTML file for multiple
+#   paths, as is often the case with Ember & Angular apps.
+#
+# - Heroku-like production environments work with this that do use the Rails app
+#   to serve static files.
+#
+# - Leaves door open for nginx, Apache, Varnish and friends to serve the static
+#   files directly for improved performance in production environments via symlinks
+#   and/or other artifacts generated at deploy time.
+#
+
+# Required if serve_static_assets set to false
+require 'action_dispatch/middleware/static'
+
+module ActionDispatch
+  module Routing
+    if Gem::Version.new(Rails.version) >= Gem::Version.new('4.2')
+      class StaticResponder < Endpoint; end
+    else
+      class StaticResponder; end
+    end
+
+    if Gem::Version.new(Rails.version) >= Gem::Version.new('5.0')
+      class StaticResponder
+        def file_handler
+          @file_handler ||= ::ActionDispatch::FileHandler.new(
+            Rails.configuration.paths["public"].first
+          )
+        end
+      end
+    else
+      class StaticResponder
+        def file_handler
+          @file_handler ||= ::ActionDispatch::FileHandler.new(
+            Rails.configuration.paths["public"].first,
+            Rails.configuration.static_cache_control
+          )
+        end
+      end
+    end
+
+    class StaticResponder
+
+      attr_accessor :path
+
+      def initialize(path)
+        self.path = path
+        self.trigger_file_handler_initialization
+      end
+
+      def trigger_file_handler_initialization
+        file_handler
+      end
+
+      def call(env)
+        env["PATH_INFO"] = @file_handler.match?(path)
+        @file_handler.call(env)
+      end
+
+      def inspect
+        "static('#{path}')"
+      end
+
+    end
+
+    class Mapper
+      def static(path)
+        StaticResponder.new(path)
+      end
+    end
+  end
+end

data/lib/rails-static-router.rb

@@ -0,0 +1,2 @@
+require 'rails_static_router/railtie'
+require 'rails_static_router/version'

data/lib/rails_static_router/railtie.rb

@@ -0,0 +1,7 @@
+module RailsStaticRouter
+  class Railtie < Rails::Railtie
+    initializer 'rails_static_router.railtie' do
+      require 'action_dispatch/routing/static_responder'
+    end
+  end
+end

data/lib/rails_static_router/version.rb

@@ -0,0 +1,3 @@
+module RailsStaticRouter
+  VERSION = '1.0.0'
+end

data/rails-static-router.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('./lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_static_router/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ['Eliot Sykes', 'Muhammad Mufid Afif']
+  spec.description   = 'Enjoy static routes in your Rails `config/routes.rb`'
+  spec.email         = ['mufidafif@icloud.com']
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.start_with?('spec/') }
+  spec.homepage      = 'https://github.com/mufid/rails-static-router'
+  spec.licenses      = %w[MIT]
+  spec.name          = 'rails-static-router'
+  spec.require_paths = %w[lib]
+
+  spec.summary       = spec.description
+  spec.version       = RailsStaticRouter::VERSION
+
+  # Test and build tools
+  # The test shouldn't broken by the incompatible RSpec version.
+  # Thus, we need to lock the version.
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-html'
+
+  # Docs, debugger, linter.
+  # We don't need to specify the lock version for these documentation
+  # Please do adjust our program so that it will always compatible
+  # with the latest version of these dependencies
+  spec.add_development_dependency 'maruku'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: rails-static-router
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eliot Sykes
+- Muhammad Mufid Afif
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enjoy static routes in your Rails `config/routes.rb`
+email:
+- mufidafif@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gemfiles/.gitignore
+- gemfiles/rails41.gemfile
+- gemfiles/rails42.gemfile
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- lib/action_dispatch/routing/static_responder.rb
+- lib/rails-static-router.rb
+- lib/rails_static_router/railtie.rb
+- lib/rails_static_router/version.rb
+- rails-static-router.gemspec
+homepage: https://github.com/mufid/rails-static-router
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Enjoy static routes in your Rails `config/routes.rb`
+test_files: []