Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial commit

  • Loading branch information...
commit 1d927d08f0bad47b95f2ccd4bd3d8e4a996d1341 0 parents
@wycats authored
4 .gitignore
@@ -0,0 +1,4 @@
+.bundle
+public
+config.ru
+Gemfile*
0  CHANGELOG.textile
No changes.
21 LICENSE
@@ -0,0 +1,21 @@
+Copyright (c) 2010 Yehuda Katz
+
+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.
+
211 README.textile
@@ -0,0 +1,211 @@
+h1. HTML5 Offline
+
+HTML5 provides two robust offline capabilities already implemented in popular mobile devices, such as the iPhone and Android, and on modern desktop browsers based on the Webkit and Gecko rendering engines.
+
+h2. Usage
+
+The easiest way to use Rack::Offline is by using Rails::Offline in a Rails application.
+In your router:
+
+<pre lang="ruby">
+match "/application.manifest" => Rails::Offline
+</pre>
+
+This will automatically cache all JavaScript, CSS, and HTML in your @public@
+directory, and will cause the cache to be updated each request in development
+mode.
+
+You can fine-tune the behavior of Rack::Offline by using it directly:
+
+<pre lang="ruby">
+offline = Rack::Offline.configure do
+ cache "images/masthead.png"
+
+ public_path = Rails.public_path
+ Dir[public_path.join("javascripts/*.js")].each do |file|
+ cache file.relative_path_from(public_path)
+ end
+
+ network "/"
+end
+</pre>
+
+You can pass an options Hash into #configure in Rack::Offline:
+
+|_. name |_. purpose |_. value in Rails::Offline |
+| :cache | false means that the browser should download the assets on each request if a connection to the server can be made | the same as config.cache_classes |
+| :logger | a logger to send messages to | Rails.logger |
+| :root | The location of files listed in the manifest | Rails.public_path |
+
+h2. Application Cache
+
+The App Cache allows you to specify that the browser should cache certain files, and ensure that the user can access them even if the device is offline.
+
+You specify an application's cache with a new @manifest@ attribute on the @html@ element, which must point at a location on the web that serves the manifest. A manifest looks something like this:
+
+<pre>
+CACHE MANIFEST
+
+javascripts/application.js
+javascripts/jquery.js
+images/masthead.png
+
+NETWORK:
+/
+</pre>
+
+This specifies that the browser should cache the three files immediately following <code>CACHE MANIFEST</code>, and require a network connection for all other URLs.
+
+Unlike HTTP caches, the browser treats the files listed in the manifest as an atomic unit: either it can serve all of them out of the manifest or it needs to update all of them. It will not flush the cache unless the user specifically asks the browser to clear the cache or for security reasons.
+
+Additionally, the HTML file that supplies the @manifest@ attribute is implicitly in the manifest. This means that the browser can load the HTML file and all its cached assets as a unit, even if the device is offline.
+
+In short, the App Cache is a much stickier, atomic cache. After storing an App Cache, the browser takes the following (simplified) steps in subsequent requests:
+
+# Immediately serve the HTML file and its assets from the App Cache. This happens
+ whether or not the device is online
+# If the device is offline, treat any resources not specified in the App Cache
+ as 404s. This means that images will appear broken, for instance, unless you
+ make sure to include them in the App Cache.
+# Asynchronously try to download the file specified in the @manifest@ attribute
+# If it successfully downloads the file, compare the manifest byte-for-byte with
+ the stored manifest.
+** If it is identical, do nothing.
+** If it is not identical, download (again, asynchronously), all assets specified
+ in the manifest
+# Along the way, fire a number of JavaScript events. For instance, if the browser
+ updates the cache, fire an @updateready@ event. You can use this event to
+ display a notice to the user that the version of the HTML they are using is
+ out of date
+
+h3. App Cache Considerations
+
+The first browser hit after you change the HTML will always serve up stale HTML
+and JavaScript. You can mitigate this in two obvious ways:
+
+# Treat your mobile web app as an API consumer and make sure that your app
+ can support a "client" that's one version older than the current version
+ of the API.
+# Force the user to reload the HTML to see newer data. You can detect this
+ situation by listening for the @updateready@ event
+
+A good recommendation is to have your server support clients at most one
+version old, but force older clients to reload the page to get newer data.
+
+Regular users of your application will receive updates through normal usage,
+and will never be forced to update. Irregular users may be forced to update
+if they pick up the application months after they last used in. In all, a
+pretty good trade-off.
+
+While this may seem cumbersome at first, it makes it possible for your users
+to browse around your application more naturally when they have flaky
+connections, because the process of updating assets (including HTML)
+always happens in the background.
+
+h3. Updating the App Cache
+
+You will need to make sure that you update the cache manifest when any of
+the underlying assets change.
+
+<code>Rack::Offline</code> handles this using two strategies:
+
+# In development, it generates a SHA hash based on the timestamp for each
+ request. This means that the browser will always interpret the cache
+ manifest as stale. Note that, as discussed in the previous section,
+ you will need to reload the page twice to get updated assets.
+# In production, it generates a SHA hash once based on the contents of
+ all the assets in the manifest. This means that the cache manifest will
+ not be considered stale unless the underlying assets change.
+
+<code>Rails::Offline</code> caches all JavaScript, CSS, images and HTML
+files in @public@ and uses @config.cache_classes@ to determine which of
+the above modes to use. In Rails, you can get more fine-grained control
+over the process by using <code>Rack::Offline</code> directly.
+
+h2. Local Storage
+
+Browsers that support the App Cache also support Local Storage, from the
+<code>HTML5 Web Storage Spec</code>. IE8 and above also support Local
+Storage.
+
+Local Storage is a JavaScript API to an extremely simple key-value store.
+
+It works the same as accessing an Object in JavaScript, but persists the
+value across sessions.
+
+<pre>
+localStorage.title = "Welcome!"
+localStorage.title //=> "Welcome!"
+
+delete localStorage.title
+localStorage.title //=> undefined
+</pre>
+
+Browsers can offer different amounts of storage using this API. The
+iPhone, for instance, offers 5MB of storage, after which it asks the
+user for permission to store an additional 10MB.
+
+You can reclaim storage from a key by <code>delete</code>ing it or
+by overwriting its value. You can also enumerate over all keys in
+the localStorage using the normal JavaScript <code>for/in</code>
+API.
+
+In combination with the App Cache, you can use Local Storge to store
+data on the device, making it possible to show stale data to your
+users even if no connection is available (or in flaky connection
+scenarios).
+
+h2. Basic JavaScript Strategy
+
+You can implement a simple offline application using only a few
+lines of JavaScript. For simplicity, I will use jQuery, but you
+can easily implement this in pure JavaScript as well. The
+example is heavily commented, but the total number of lines of
+actual JavaScript is quite small.
+
+<pre lang="javascript">
+jQuery(function($) {
+ // Declare a function that can take a JS object and
+ // populate our HTML. Because we used the App Cache
+ // the HTML will be present regardless of online status
+ var updateArticles = function(object) {
+ template = $("#articles")
+ localStorage.articles = JSON.stringify(object);
+ $("#article-list").html(template.render(object));
+ }
+
+ // Create a flag so we don't poll the server twice
+ // at once
+ var updating = false;
+
+ // Create a function that will ask the server for
+ // updates to the article list
+ var remoteUpdate = function() {
+ // Don't ping the server again if we're in the
+ // process of updating
+ if(updating) return;
+
+ updating = true;
+
+ $("#loading").show();
+ $.getJSON("/article_list.json", function(json) {
+ updateArticles(json);
+ $("#loading").hide();
+ updating = false;
+ });
+ }
+
+ // If we have "articles" in the localStorage object,
+ // update the HTML with the stale articles. Even if
+ // the user never gets online, they will at least
+ // see the stale content
+ if(localStorage.articles) updateArticles(JSON.parse(localStorage.articles));
+
+ // If the user was offline, and goes online, ask
+ // the server for updates
+ $(window).bind("online", remoteUpdate);
+
+ // If the user is online, ask for updates now
+ if(window.navigator.onLine) remoteUpdate();
+})
+</pre>
45 lib/rack-offline.rb
@@ -0,0 +1,45 @@
+require "rack/offline"
+
+module Rails
+ class Offline < Rack::Offline
+ def self.call(env)
+ @app ||= new
+ @app.call(env)
+ end
+
+ def initialize(app = Rails.application, &block)
+ config = app.config
+ root = Rails.public_path
+
+ block = cache_block unless block_given?
+
+ opts = {
+ :cache => config.cache_classes,
+ :root => root,
+ :logger => Rails.logger
+ }
+
+ super opts, &block
+ end
+
+ private
+
+ def cache_block
+ Proc.new do
+ files = Dir[
+ "#{root}/**/*.html"
+ "#{root}/stylesheets/**/*.css",
+ "#{root}/javascripts/**/*.js",
+ "#{root}/images/**"]
+
+ files.each do |file|
+ cache file.relative_path_from(root)
+ end
+
+ cache *files
+ network "/"
+ end
+ end
+
+ end
+end
69 lib/rack/offline.rb
@@ -0,0 +1,69 @@
+require "rack/offline/config"
+require "rack/offline/version"
+require "digest/sha2"
+require "logger"
+
+module Rack
+ class Offline
+ def self.configure(*args, &block)
+ new(*args, &block)
+ end
+
+ def initialize(options = {}, &block)
+ @cache = options[:cache]
+
+ @logger = options[:logger] || begin
+ ::Logger.new(STDOUT).tap {|logger| logger.level = 1 }
+ end
+
+ @root = Pathname.new(options[:root] || Dir.pwd)
+
+ if block_given?
+ @config = Rack::Offline::Config.new(&block)
+ end
+
+ if @cache
+ raise "In order to run Rack::Offline in cached mode, " \
+ "you need to supply a root so Rack::Offline can " \
+ "calculate a hash of the files." unless root
+ precache_key
+ end
+ end
+
+ def precache_key
+ hash = @config.cached.map do |item|
+ Digest::SHA2.hexdigest(@root.join(item).read)
+ end
+
+ @key = Digest::SHA2.hexdigest(hash.join)
+ end
+
+ def call(env)
+ key = @key || Digest::SHA2.hexdigest(Time.now.to_s)
+
+ body = ["CACHE MANIFEST"]
+ body << "# #{key}"
+ @config.cached.each do |item|
+ body << item
+ end
+
+ unless @config.network.empty?
+ body << "" << "NETWORK:"
+ @config.network.each do |item|
+ body << item
+ end
+ end
+
+ unless @config.fallback.empty?
+ body << "" << "FALLBACK:"
+ @config.fallback.each do |namespace, url|
+ body << "#{namespace} #{url}"
+ end
+ end
+
+ @logger.debug body.join("\n")
+
+ [200, {"Content-Type" => "text/cache-manifest"}, body.join("\n")]
+ end
+ end
+end
26 lib/rack/offline/config.rb
@@ -0,0 +1,26 @@
+module Rack
+ class Offline
+ class Config
+ attr_reader :cached, :network, :fallback
+
+ def initialize(&block)
+ @cached = []
+ @network = []
+ @fallback = {}
+ instance_eval(&block) if block_given?
+ end
+
+ def cache(*names)
+ @cached.concat(names)
+ end
+
+ def network(*names)
+ @network.concat(names)
+ end
+
+ def fallback(hash = {})
+ @fallback.merge(hash)
+ end
+ end
+ end
+end
5 lib/rack/offline/version.rb
@@ -0,0 +1,5 @@
+module Rack
+ class Offline
+ VERSION = "0.5.0"
+ end
+end
23 rack-offline.gemspec
@@ -0,0 +1,23 @@
+path = File.expand_path("../lib", __FILE__)
+$:.unshift(path) unless $:.include?(path)
+require "rack/offline/version"
+
+Gem::Specification.new do |s|
+ s.platform = Gem::Platform::RUBY
+ s.name = 'rack-offline'
+ s.version = Rack::Offline::VERSION
+ s.summary = 'A Rack toolkit for working with offline applications'
+ s.description = 'A Rack endpoint that generates cache manifests and other useful ' \
+ 'HTML5 offline utilities that are useful on the server-side. ' \
+ 'Rack::Offline also provides a conventional Rails endpoint (' \
+ 'Rails::Offline) that configures Rack::Offline using expected ' \
+ 'Rails settings'
+
+ s.author = 'Yehuda Katz'
+ s.email = 'wycats@gmail.com'
+ s.homepage = 'http://www.yehudakatz.com'
+ s.rubyforge_project = 'rack-offline'
+
+ s.files = Dir['CHANGELOG', 'README', 'LICENSE', 'lib/**/*']
+ s.require_path = 'lib'
+end
41 spec/base_offline_spec.rb
@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe "Generating a basic manifest" do
+ include Rack::Test::Methods
+
+ self.app = Rack::Offline.configure do
+ cache "images/masthead.png"
+ end
+
+ before do
+ get "/"
+ end
+
+ it "returns the response as text/cache-manifest" do
+ headers["Content-Type"].should == "text/cache-manifest"
+ end
+
+ it "returns a 200 status code" do
+ status.should == 200
+ end
+
+ it "includes the text CACHE MANIFEST" do
+ body.should =~ /\ACACHE MANIFEST\n/
+ end
+
+ it "includes the entry to be cached on its own line" do
+ body.should =~ %r{^images/masthead.png$}
+ end
+
+ it "includes a cache-busting comment" do
+ body.should =~ %r{^# .{64}$}
+ end
+
+ it "doesn't contain a network section" do
+ body.should_not =~ %r{^NETWORK:}
+ end
+
+ it "doesn't contain a fallback section" do
+ body.should_not =~ %r{^FALLBACK:}
+ end
+end
53 spec/cached_offline_spec.rb
@@ -0,0 +1,53 @@
+require "spec_helper"
+require "fileutils"
+
+describe "Generating a manifest in cached mode" do
+ include Rack::Test::Methods
+
+ root = File.expand_path("../fixture_root", __FILE__)
+ self.app = Rack::Offline.configure(:root => root, :cache => true) do
+ cache "hello.html"
+ cache "hello.css"
+ cache "javascripts/hello.js"
+ end
+
+ before :all do
+ FileUtils.rm_rf File.expand_path("../fixture_root", __FILE__)
+ end
+
+ before do
+ get "/"
+ end
+
+ it "returns the same cache-busting header every time" do
+
+ end
+
+ # it "returns the response as text/cache-manifest" do
+ # headers["Content-Type"].should == "text/cache-manifest"
+ # end
+ #
+ # it "returns a 200 status code" do
+ # status.should == 200
+ # end
+ #
+ # it "includes the text CACHE MANIFEST" do
+ # body.should =~ /\ACACHE MANIFEST\n/
+ # end
+ #
+ # it "includes the entry to be cached on its own line" do
+ # body.should =~ %r{^images/masthead.png$}
+ # end
+ #
+ # it "includes a cache-busting comment" do
+ # body.should =~ %r{^# .{64}$}
+ # end
+ #
+ # it "doesn't contain a network section" do
+ # body.should_not =~ %r{^NETWORK:}
+ # end
+ #
+ # it "doesn't contain a fallback section" do
+ # body.should_not =~ %r{^FALLBACK:}
+ # end
+end
32 spec/spec_helper.rb
@@ -0,0 +1,32 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "rack/offline"
+Bundler.require(:test)
+
+module Rack::Test::Methods
+ def self.included(klass)
+ class << klass
+ attr_accessor :app
+ end
+ end
+
+ def body
+ last_response.body
+ end
+
+ def status
+ last_response.status
+ end
+
+ def headers
+ last_response.headers
+ end
+
+ def app
+ self.class.app
+ end
+end
Please sign in to comment.
Something went wrong with that request. Please try again.