rack-single-page-app 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20ad54943b5639b800d32713819e23c9b751f913
-  data.tar.gz: 5031a70579df3a16bc6ab53977e38e94edab5759
+  metadata.gz: bdc49baa4203f9ce612869dd38f0227c6cbfa398
+  data.tar.gz: 1024d14598013310e88f8873710d5b75160e071c
 SHA512:
-  metadata.gz: 26dbe7188ab2aec6b95a3a03ce7b82ae5801447a1f87160ff3f52cde85d13971fb3d8e6cca98992f4181ef06c9d4366c4bdc8db006c9021e25d2c881b9ebf264
-  data.tar.gz: 889d6e0725e3bd05d87f743751f2f13946d783a1c19c9c2ec770427cd1005b15769aeedabc1f53bef3338cac62a5ce020923441ffb800b84df0306162aff2923
+  metadata.gz: 17626674f1a683fa339193657a940ef79c5de30134e6fab0457878f11d1a459b849d2ac82ab90afeec46ac45c40006b92ffe8d49721b830640e6daac19a6aa39
+  data.tar.gz: 33ba963492ff135c7ebf5e006589a9c2897f43e0a3d85bee762a2da1a82ca3000ebf47ef3e8cf4f99b4a1352487e4453a22a93243f5042e0a560890ab7192aa6

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-single-page-app.gemspec
 gemspec
+
+group :development, :test do
+  gem 'mustache'
+end

data/README.md

@@ -22,16 +22,26 @@ gem 'rack-single-page-app', :require => 'rack/single_page_app'
 
 ## Configuration
 
-### Rack
+### Static Index Page
 
-In `config.ru`, configure `Rack::SinglePageApp` by passing the destination file to the constructor:
+In `config.ru`, configure `Rack::SinglePageApp::Index` by passing the destination file to the constructor:
 
 ```ruby
-run Rack::SinglePageApp.new("public/index.html")
+run Rack::SinglePageApp::Index.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.
 
+### Mustache Templates
+
+Use `Rack::SinglePageApp::Template` to compile the static output from a Mustache template. Pass the path to the template and a context object to the constructor:
+
+```ruby
+run Rack::SinglePageApp::Index.new("templates/index.html", context)
+```
+
+Note that this template will be compiled once in-memory when the app starts up, and the content will be static for the lifetime of the app.
+
 ### Testing
 
 To contribute to the project, begin by cloning the repo and installing the necessary gems:

data/Rakefile

@@ -8,6 +8,7 @@ rescue Bundler::BundlerError => ex
   exit e.status_code
 end
 
+require "bundler/gem_tasks"
 require 'rdoc/task'
 require 'rake/testtask'
 require 'git-version-bump/rake-tasks'

data/lib/rack-single-page-app.rb

@@ -0,0 +1 @@
+require 'rack/single_page_app'

data/lib/rack/single_page_app.rb

@@ -2,25 +2,63 @@ require 'rack'
 require 'git-version-bump'
 
 module Rack
-  # Rack::SinglePageApp is a default endpoint. Initialize with the path to
-  # your index page.
+  module SinglePageApp
+    def self.release
+      GVB.version
+    end
 
-  class SinglePageApp
     F = ::File
 
-    def self.release
-      GVB.version
+    # The base Rack application which sends default HTML content.
+    class Base
+      # @param content [String] Response body content
+      def initialize(content)
+        @content = content
+        @length = @content.size.to_s
+      end
+
+      def call(env)
+        [200, {'Content-Type' => 'text/html', 'Content-Length' => @length}, [@content]]
+      end
     end
 
-    def initialize(path)
-      file = F.expand_path(path)
-      @content = F.read(file)
-      @length = @content.size.to_s
+    # Respond to generic server requests with a static HTML index page.
+    #
+    # @example
+    #   run Rack::SinglePageApp::Index('assets/index.html')
+    #
+    class Index < Base
+      # @param path [String] Path to static file
+      def initialize(path)
+        file = F.expand_path(path)
+        super(F.read(file))
+      end
     end
 
-    def call(env)
-      [200, {'Content-Type' => 'text/html', 'Content-Length' => @length}, [@content]]
+    # Respond to generic server requests with a Mustache template, rendered with
+    # the provided context.
+    #
+    # Mustache is an optional dependency, so needs to be required before this
+    # object is constructed.
+    #
+    # @example
+    #   require 'mustache'
+    #
+    #   context = {
+    #     title: "App Title",
+    #     body_class: "app-layout app-layout-fixed-width",
+    #     root_element_id: "app-root",
+    #   }
+    #   run Rack::SinglePageApp::Template.new('assets/index.mustache', context)
+    #
+    class Template < Base
+      # @param path [String] Path to template
+      # @param context [Hash] Context object
+      def initialize(path, context)
+        template = F.read(F.expand_path(path))
+        output = ::Mustache.render(template, context)
+        super(output)
+      end
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-single-page-app
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rob Sharp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -101,6 +101,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/rack-single-page-app.rb
 - lib/rack/single_page_app.rb
 - rack-single-page-app.gemspec
 homepage: https://github.com/qnm/rack-single-page-app
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A rack middleware to assist running a single-page-app on rack.