rack-single-page-app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 26a3e3186a29d68ba7c0db6f3905c8c5d95b495e
+  data.tar.gz: 2031da59cc9f94df3d8f7165124d0c8d072c3120
+SHA512:
+  metadata.gz: bf107756717dc05770ab25807300aa339b3ba05dd91b283c18672c50d1a5fe2236d60e9785ff83dd325cb7543bccd6ded981bc1a6564f00c28237f1daa78f620
+  data.tar.gz: 7bbe83c7c8e5f3ba6aca9dd32c3921dd436c6ba3cec4a89841f8607a168b7e92b78a59870a2559297d035a80b4cf58b0e80d68f4a1212fbd139f5dbf9feb6e36

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-single-page-app.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rob Sharp
+
+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,43 @@
+# Rack Single Page App Middleware
+
+This middleware for Rack will route all web requests to a single file and return a '200' status code.
+
+The intention is to allow rack-based application servers to run single-page webapps which use HTML5 routing, a
+common pattern which is normally handled by the front-end web server.
+
+If you are unable or unwilling to reconfigure your web server, this gem may provide what you require!
+
+
+## Installation
+
+Install the gem:
+
+`gem install rack-single-page-app`
+
+Or in your Gemfile:
+
+```ruby
+gem 'rack-single-page-app', :require => 'rack/single_page_app'
+```
+
+## Configuration
+
+### Rack
+
+In `config.ru`, configure `Rack::SinglePageApp` by passing the destination file to the constructor:
+
+```ruby
+run Rack::SinglePageApp.new("public/index.html")
+```
+
+Generally, you'll run `Rack::Static` higher up in your `config.ru` so that you deliver static assets prior to single-page-app fall-through.
+
+### Testing
+
+To contribute to the project, begin by cloning the repo and installing the necessary gems:
+
+    gem install json rack ruby-prof test-spec test-unit
+
+To run the entire test suite, run
+
+    rake test

data/Rakefile

@@ -0,0 +1,23 @@
+exec(*(["bundle", "exec", $PROGRAM_NAME] + ARGV)) if ENV['BUNDLE_GEMFILE'].nil?
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => ex
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rdoc/task'
+require 'rake/testtask'
+require 'git-version-bump/rake-tasks'
+
+desc "Run all the tests"
+task :default => [:test]
+
+desc "Run specs"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/spec_*.rb']
+end
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/single/page/app"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/single_page_app.rb

@@ -0,0 +1,26 @@
+require 'rack'
+require 'git-version-bump'
+
+module Rack
+  # Rack::NotFound is a default endpoint. Initialize with the path to
+  # your 404 page.
+
+  class SinglePageApp
+    F = ::File
+
+    def self.release
+      GVB.version
+    end
+
+    def initialize(path)
+      file = F.expand_path(path)
+      @content = F.read(file)
+      @length = @content.size.to_s
+    end
+
+    def call(env)
+      [200, {'Content-Type' => 'text/html', 'Content-Length' => @length}, [@content]]
+    end
+  end
+end
+

data/rack-single-page-app.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+begin
+  require 'git-version-bump'
+rescue LoadError
+  nil
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-single-page-app"
+  spec.version       = GVB.version rescue "0.0.0.1.ENOGVB"
+  spec.date          = GVB.date    rescue Time.now.strftime("%F")
+
+  spec.authors       = ["Rob Sharp"]
+  spec.email         = ["rob.sharp@digivizer.com"]
+
+  spec.summary       = %q{A rack middleware to assist running a single-page-app on rack.}
+  spec.description   = %q{If you're running a javascript single-page-app with html5 routing,
+                          you may notice that deep links will 404 unless your web front-end is
+                          configured to rewrite all non-asset paths to index.html. If you'd like
+                          to achieve the same rewrite using rack, this is the gem for you!}
+  spec.homepage      = "https://github.com/qnm/rack-single-page-app"
+  spec.license       = "MIT"
+
+  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_runtime_dependency 'rack', '~> 1.4'
+  spec.add_runtime_dependency 'git-version-bump', '~> 0.15'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 5.6'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rack-single-page-app
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Sharp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: git-version-bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+description: |-
+  If you're running a javascript single-page-app with html5 routing,
+                            you may notice that deep links will 404 unless your web front-end is
+                            configured to rewrite all non-asset paths to index.html. If you'd like
+                            to achieve the same rewrite using rack, this is the gem for you!
+email:
+- rob.sharp@digivizer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/single_page_app.rb
+- rack-single-page-app.gemspec
+homepage: https://github.com/qnm/rack-single-page-app
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A rack middleware to assist running a single-page-app on rack.
+test_files: []