rack-polymer 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50cf117879336a91ecc1d51591f36b0c7b5cccd4
+  data.tar.gz: d245ed9f1cd9f3f852bc80de4fe9ee06c3cb3f18
+SHA512:
+  metadata.gz: 8ddb8a8482b22baf25575b20c9254b36d7da553f678d548a5052e10a5e56d360600a2986791bf39b39b78aed54490a37a58705a77f8f0ebc87c50c6e817db7a8
+  data.tar.gz: 1c52746e4cd8b1aa20972f483b566839e1f0a09ef95ccd684c08acf4b00d9ab4eb1df3c46df50ddd07921486d7cec7a99a462bf73a6e12ebb11e302ad977e6aa

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rspec

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+
+# whitelist
+branches:
+  only:
+    - master
+    - develop

data/CHANGES.md

@@ -0,0 +1,32 @@
+# CH CH CH CH CHANGES! #
+
+
+## Thursday the 29th of August 2013 ##
+
+### v0.3.0 ###
+
+* Updated the version of Polymer to 0.0.20130816.
+
+
+### v0.2.0 ###
+
+* Added route for the javascript source map.
+
+----
+
+
+## Wednesday the 28th of August 2013 ##
+
+### v0.1.1 ###
+
+* Was using a newer version of the source map that I should've been. Fixed.
+
+### v0.1.0 ###
+
+* Added :cdn option to opt out of using the CDN, mainly so I can use the newer scripts without waiting for the CDNs to catch up.
+
+### v0.0.1 ###
+
+* First version.
+
+----

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-polymer.gemspec
+gemspec
+
+group :development do
+  gem "wirble"
+  gem "yard"
+end
+
+group :examples do
+  gem "sinatra"
+  gem "haml"
+end
+
+group :test do
+  gem "rspec"
+  gem "rack-test"
+  gem "simplecov"
+  gem "timecop"
+end

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Iain Barnett
+
+MIT Licence
+
+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/Polymer-LICENSE

@@ -0,0 +1,27 @@
+// Copyright (c) 2012 The Polymer Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,81 @@
+# Rack::Polymer #
+
+[Polymer](http://www.polymer-project.org/) CDN script tags and fallback in one neat package. Current version is for Polymer v#{Rack::Polymer::POLYMER_VERSION} (or if you're reading this in the source and that number doesn't display, look in the lib/rack/polymer/version.rb file).
+
+### Build status ###
+
+Master branch:
+[![Build Status](https://travis-ci.org/yb66/rack-polymer.png?branch=master)](https://travis-ci.org/yb66/rack-polymer)
+
+
+## Why? ##
+
+Because then I don't have to worry about versioning or fallback.
+
+## Installation ##
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-polymer'
+
+And then, from a command-line, execute:
+
+    bundle install
+
+Or even better:
+
+    bundle install --binstubs --path vendor
+
+Or install it yourself as:
+
+    gem install rack-polymer -r
+
+## Usage ##
+
+In your rackup file or Sinatra class (or wherever you like to set up Rack middleware…)
+
+    use Rack::Polymer
+
+Then wherever you need the script loaded (like in a layout file):
+
+    Rack::Polymer.cdn( env )
+
+That's it. There are more options, check the docs.
+
+## Contributing
+
+If you're going to change the code:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+You can also help by informing me of CDNs that are hosting it and/or releases of the Polymer library. Just add an issue.
+
+
+### Version numbers ###
+
+This library uses [semver](http://semver.org/) to version the **library**. That means the library version is ***not*** an indicator of quality but a way to manage changes. The version of Polymer can be found in the lib/rack/polymer/version.rb file, or via the {Rack::Polymer::POLYMER_VERSION} constant.
+
+On top of that, version numbers will also change when new releases of Polymer are supported.
+
+* If Polymer makes a major version jump, then this library will make a ***minor*** jump. That is because the API for the library has not really changed, but it is *possibly* a change that will break things.
+* If Polymer makes a minor version jump, then so will this library, for the same reason as above.
+* I doubt point releases will be followed, but if so, it will also precipitate a minor jump in this library's version number. That's because even though Polymer feel it's a point release, I'm not them, my responsibility is to users of this library and I'll take the cautious approach of making it a minor version number change.
+
+As an example, if the current library version was 1.0.0 and Polymer was at 2.0.0 and I made a change that I felt was major and breaking (to the Ruby library), I'd bump Rack::Polymer's version to 2.0.0. That the version numbers match between Rack::Polymer and the Polymer script is of no significance, it's just coincidental.  
+If then Polymer went to v2.1.0 and I decided to support that, I'd make the changes and bump Rack::Polymer's version to 2.1.0. That the version numbers match between Rack::Polymer and the Polymer script is of no significance, it's just coincidental.  
+If then I made a minor change to the library's API that could be breaking I'd bump it to 2.2.0.  
+If I then added some more instructions I'd bump Rack::Polymer's version to 2.2.1.  
+If then Polymer released version 3.0.0, I'd add it to the library, and bump Rack::Polymer's version to 2.3.0.
+
+Only one version of Polymer will be supported at a time. This is because the fallback script is shipped with the gem and I'd like to keep it as light as possible. It's also a headache to have more than one.
+
+So basically, if you want to use a specific version of Polymer, look for the library version that supports it via the {Rack::Polymer::POLYMER_VERSION} constant. Don't rely on the version numbers of *this* library to tell you anything other than compatibility between versions of this library.
+
+
+## Licences ##
+
+The licence for this library can be found in the LICENCE.txt file. The licence for parts taken from the Polymer library (like the fallback script, bits for examples and specs etc) is to be found in the Polymer-LICENSE file.

data/Rakefile

@@ -0,0 +1,73 @@
+require "bundler/gem_tasks"
+
+
+desc "(Re-) generate documentation and place it in the docs/ dir. Open the index.html file in there to read it."
+task :docs => [:"docs:environment", :"docs:yard"]
+namespace :docs do
+
+  task :environment do
+    ENV["RACK_ENV"] = "documentation"
+  end
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new :yard do |t|
+    t.files   = ['lib/**/*.rb', 'app/*.rb', 'spec/**/*.rb']
+    t.options = ['-odocs/'] # optional
+  end
+
+end
+
+task :default => "spec"
+
+task :spec => :"spec:run"
+task :rspec => :spec
+namespace :spec do
+  task :environment do
+    ENV["RACK_ENV"] = "test"
+  end
+
+  desc "Run specs"
+  task :run, [:any_args] => :"spec:environment" do |t,args|
+    warn "Entering spec task."
+    any_args = args[:any_args] || ""
+    cmd = "bin/rspec #{any_args}"
+    warn cmd
+    system cmd
+  end
+
+end
+
+namespace :examples do
+
+  desc "Run the examples."
+  task :run do
+    exec "bundle exec rackup examples/config.ru"
+  end
+
+end
+
+
+namespace :cdn do
+  require 'open3'
+  desc "An availability check, for sanity"
+  task :check do
+    require_relative './lib/rack/polymer.rb'
+    Rack::Polymer::CDN.constants.each do |const|
+      url = "#{Rack::Polymer::CDN.const_get(const)}"
+      url = "http:#{url}" unless url.start_with? "http"
+      cmd = "curl -I #{url}"
+      puts cmd
+      puts catch(:status) {
+        Open3.popen3(cmd) do |_,stdout,_|
+          line = stdout.gets
+          throw :status, "Nothing for #{const}" if line.nil?
+          puts line.match("HTTP/1.1 404 Not Found") ?
+              "FAILED: #{const}" :
+              "PASSED: #{const}"
+        end
+      }
+    end
+  end
+
+end

data/examples/config.rb

@@ -0,0 +1,90 @@
+require 'sinatra/base'
+require 'haml'
+require 'rack/polymer'
+
+class App < Sinatra::Base
+
+  enable :inline_templates
+  use Rack::Polymer
+
+  get "/" do
+    output = <<STR
+!!!
+%body
+  %ul
+    %li
+      %a{ href: "/cloudflare-cdn"} cloudflare-cdn
+    %li
+      %a{ href: "/unspecified-cdn"} unspecified-cdn
+    %li
+      %a{ href: "/specified-via-use"} specified-via-use
+    %li
+      %a{ href: "/no-cdn"} no-cdn
+STR
+    haml output
+  end
+
+  get "/cloudflare-cdn" do
+    haml :index, :layout => :cloudflare
+  end
+
+  get "/unspecified-cdn" do
+    haml :index, :layout => :unspecified
+  end
+
+  get "/no-cdn" do
+    haml :index, :layout => :no_cdn
+  end
+end
+
+
+# This is probably the one I'd use.
+class App2 < Sinatra::Base
+
+  enable :inline_templates
+  use Rack::Polymer, :organisation => :cloudflare
+
+  get "/" do
+    haml :index, :layout => :specified_via_use
+  end
+end
+
+__END__
+
+
+@@ cloudflare
+!!!
+%head
+  = Rack::Polymer.cdn( env, :organisation => :cloudflare )
+  %link{ rel: "import", href: "x-foo.html" }
+%body
+  = yield
+
+@@ unspecified
+!!!
+%head
+  = Rack::Polymer.cdn(env)
+  %link{ rel: "import", href: "x-foo.html" }
+%body
+  = yield
+
+@@ specified_via_use
+!!!
+%head
+  = Rack::Polymer.cdn(env)
+  %link{ rel: "import", href: "x-foo.html" }
+%body
+  = yield
+
+
+@@ no_cdn 
+!!!
+%head
+  = Rack::Polymer.cdn(env, cdn: false)
+  %link{ rel: "import", href: "x-foo.html" }
+%body
+  = yield
+
+@@index
+%p The polymer-all/polymer/workbench/oldSmoke/x-foo.html should be imported below.
+<x-foo></x-foo>

data/examples/config.ru

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler"
+Bundler.setup(:examples)
+require File.expand_path( '../config.rb', __FILE__)
+
+map "/specified-via-use" do
+  run App2
+end
+
+run App

data/examples/public/x-foo.html

@@ -0,0 +1,23 @@
+<!--
+Copyright 2013 The Polymer Authors. All rights reserved.
+Use of this source code is governed by a BSD-style
+license that can be found in the LICENSE file.
+-->
+<polymer-element name="x-foo">
+  <template>
+    It LIVES <content></content>
+    <x-bar label="{{label}}"></x-bar>
+  </template>
+  <script>
+    Polymer('x-foo', {
+      label: '',
+      ready: function(root) {
+        this.textContent = 'cordon bleu';
+        this.blueate();
+      },
+      blueate: function() {
+        this.style.backgroundColor = 'lightblue';
+      }
+    });
+  </script>
+</polymer-element>

data/lib/rack/polymer.rb

@@ -0,0 +1,141 @@
+require "rack/polymer/version"
+require "rack/jquery/helpers"
+
+module Rack
+  class Polymer
+    include Rack::JQuery::Helpers # for caching
+
+    # Namespaced CDNs for convenience.
+    module CDN
+
+      # Script tags for the Media Temple CDN
+      CLOUDFLARE = "//cdnjs.cloudflare.com/ajax/libs/polymer/#{POLYMER_VERSION}/polymer.min.js"
+
+    end
+
+
+    # The file name to use for the fallback route.
+    POLYMER_FILE_NAME = "polymer-#{POLYMER_VERSION}.min.js"
+
+    # The file name of the source map.
+    POLYMER_SOURCE_MAP = "polymer.min.js.map"
+
+
+    # This javascript checks if the Polymer object has loaded. If not, that most likely means the CDN is unreachable, so it uses the local minified Polymer.
+    FALLBACK = <<STR
+<script type="text/javascript">
+  if (typeof Polymer == 'undefined') {
+    document.write(unescape("%3Cscript src='/js/#{POLYMER_FILE_NAME}' type='text/javascript'%3E%3C/script%3E"))
+  };
+</script>
+STR
+
+
+    # @param [Hash] env The rack env.
+    # @param [Hash] opts Extra options.
+    # @options opts [Symbol] :organisation Choose which CDN to use. The default is :cloudflare. If an organisation was set via the Rack env this will override it.
+    # @options opts [FalseClass] :cdn Mark as false if you *don't* want to use the CDN and only want to use the fallback script. This option is primarily here so I can use the latest script without relying on the CDN, but use it however you wish.
+    # @return [String] The HTML script tags to get the CDN.
+    # @example
+    #   Rack::Polymer.cdn( env )
+    #
+    #   # Choose an organisation
+    #   Rack::Polymer.cdn( env, organisation: :cloudflare )
+    #
+    #   # Don't use a CDN, just use the fallback
+    #   Rack::Polymer.cdn( env, cdn: false )
+    def self.cdn( env, opts={} )
+      organisation =  opts[:organisation] ||
+                        (env["rack.polymer"] && env["rack.polymer"]["organisation"]) ||
+                        Rack::Polymer::DEFAULT_ORGANISATION
+
+      script = case organisation
+        when :cloudflare then CDN::CLOUDFLARE
+        else CDN::CLOUDFLARE
+      end
+
+      opts[:cdn] == false ?
+        FALLBACK :
+        "<script src='#{script}'></script>\n#{FALLBACK}"
+    end
+
+
+    # The default CDN to use.
+    DEFAULT_ORGANISATION = :cloudflare
+
+
+    # Default options hash for the middleware.
+    DEFAULT_OPTIONS = {
+      :http_path => "/js",
+      :organisation => DEFAULT_ORGANISATION
+    }
+
+
+    # @param [#call] app
+    # @param [Hash] options
+    # @option options [String] :http_path If you wish the Polymer fallback route to be "/js/polymer-0.0.20130711.min.js" (or whichever version this is at) then do nothing, that's the default. If you want the path to be "/assets/javascripts/polymer-0.0.20130711.min.js" then pass in `:http_path => "/assets/javascripts".
+    # @option options [Symbol] :organisation Choose which CDN to use. The default is :cloudflare.
+    # @example
+    #   # The default:
+    #   use Rack::Polymer
+    #
+    #   # With a different route to the fallback:
+    #   use Rack::Polymer, :http_path => "/assets/js"
+    #
+    #   # With the CDN specified via the use statement
+    #   use Rack::Polymer, :organisation => :cloudflare
+    def initialize( app, options={} )
+      @app, @options  = app, DEFAULT_OPTIONS.merge(options)
+      @http_path_to_polymer, @http_path_to_polymer_source_map =
+        [POLYMER_FILE_NAME,POLYMER_SOURCE_MAP].map{|file_name|
+          ::File.join @options[:http_path], file_name
+        }
+      @organisation = @options[:organisation]
+    end
+
+
+    # @param [Hash] env Rack request environment hash.
+    def call( env )
+      dup._call env
+    end
+
+
+    # For thread safety
+    # @param (see #call)
+    def _call( env )
+      env.merge! "rack.polymer" => {"organisation" => @organisation}
+
+      request = Rack::Request.new(env.dup)
+      if request.path_info == @http_path_to_polymer
+        @response = Rack::Response.new
+        # for caching
+        @response.headers.merge! caching_headers( POLYMER_FILE_NAME, POLYMER_VERSION_DATE)
+
+        # There's no need to test if the IF_MODIFIED_SINCE against the release date because the header will only be passed if the file was previously accessed by the requester, and the file is never updated. If it is updated then it is accessed by a different path.
+        if request.env['HTTP_IF_MODIFIED_SINCE']
+          @response.status = 304
+        else
+          serve_static_file "polymer.min.js"
+        end
+        @response.finish
+      elsif request.path_info == @http_path_to_polymer_source_map
+        # The source map isn't cached
+        serve_static_file( "polymer.min.js.map" ).finish
+      else
+        @app.call(env)
+      end
+    end # call
+
+
+    # Helper method for serving static files.
+    # @param [String] file The short file name.
+    # @return [Rack::Response]
+    def serve_static_file( file )
+      @response ||= Rack::Response.new
+      @response.status = 200
+      @response.write ::File.read( ::File.expand_path "../../../vendor/assets/javascript/libs/polymer/#{POLYMER_VERSION}/#{file}", __FILE__)
+      @response
+    end      
+
+  end
+end