manifest-destiny 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 James Smith
+
+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,69 @@
+Manifest Destiny
+================
+
+A cache.manifest generator in ruby, for use in your HTML5 offline apps.
+
+The configuration DSL is designed to map closely to the keywords in the HTML5 
+cache manifest syntax: <http://www.w3.org/TR/html5/offline.html#manifests>
+
+
+Installation
+============
+
+    gem install manifest-destiny
+
+
+Configuration
+=============
+
+    # Build up the cache manifest
+    manifest = ManifestDestiny.configure do
+      # Cache local files in your offline app (maps to CACHE section)
+      cache "images/sound-icon.png"
+      cache "images/background.png"
+    
+      # Cache a remote file in your offline app (maps to CACHE section)
+      cache "http://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js"
+
+      # Online file whitelist (maps to NETWORK section)
+      network "comm.cgi"
+      
+      # Fallback locations (maps to cache manifest FALLBACK section)
+      fallback "/" => "offline.html"
+    end
+
+
+Generate a Cache Manifest
+=============
+
+    manifest.to_s
+
+
+Render a Cache Manifest in Rails 2.x
+====================================
+
+    render_manifest do
+      # Same configuration syntax as above
+      cache "images/sound-icon.png"
+      cache "images/background.png"
+    end
+
+
+Contributing to manifest-destiny
+================================
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+Copyright
+=========
+
+Copyright (c) 2011 James Smith. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "manifest-destiny"
+  gem.homepage = "http://github.com/loopj/manifest-destiny"
+  gem.license = "MIT"
+  gem.summary = %Q{Generate a cache.manifest file for your html5 offline app}
+  gem.description = %Q{Generate a cache.manifest file for your html5 offline app}
+  gem.email = "james@loopj.com"
+  gem.authors = ["James Smith"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "manifest-destiny #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/manifest-destiny.rb

@@ -0,0 +1,140 @@
+# Generate a cache.manifest file for your html5 offline app
+# 
+# The `watch` and `watch_path` methods will only affect the version hash
+#
+# Usage:
+#
+#   manifest = ManifestDestiny.configure do
+#     cache "path"
+#     network "path"
+#   end
+
+require "digest"
+require "pathname"
+
+class ManifestDestiny
+  class Config
+    def initialize(root, &block)
+      @cache = []
+      @watch = []
+      @network = []
+      @fallback = {}
+      @root = root
+      instance_eval(&block) if block_given?
+    end
+
+    def cache_path(*patterns)
+      add_path(@cache, patterns)
+    end
+    
+    def cache(*names)
+      add(@cache, names)
+    end
+
+    def watch_path(*patterns)
+      add_path(@watch, patterns)
+    end
+    
+    def watch(*names)
+      add(@watch, names)
+    end
+
+    def network(*names)
+      @network.concat(names)
+    end
+
+    def fallback(hash = {})
+      @fallback.merge!(hash)
+    end
+
+    def root
+      @root
+    end
+
+    private
+
+    def add_path(collection, patterns)
+      patterns.each do |pattern|
+        Dir[File.join(@root, pattern)].each do |file|
+          collection << file.split(root).second
+        end
+      end
+    end
+
+    def add(collection, names)
+      flat_names = names.map do |n|
+        if (n =~ Regexp.new(root.to_s)) == 0
+          n.split(root).second
+        else
+          n
+        end
+      end
+      
+      collection.concat(flat_names)
+    end
+  end
+  
+  def self.configure(*args, &block)
+    new(*args, &block)
+  end
+
+  def initialize(options = {}, &block)
+    @cache = options[:cache]
+    @root = Pathname.new(options[:root] || Dir.pwd)
+    
+    if block_given?
+      @config = Config.new(@root, &block)
+    end
+  end
+
+  def to_s
+    body = ["CACHE MANIFEST"]
+
+    # Generate sha hash of cache and watch files
+    hash = (@config.cache + @config.watch).map do |item|
+      if (item =~ /:\/\//)
+        Digest::SHA2.hexdigest(item)
+      else
+        begin
+          path = File.new(File.join(@root, item))
+          Digest::SHA2.hexdigest(path.read) if ::File.file?(path)
+        rescue
+          $stderr.puts "Couldn't find file #{File.join(@root, item)}, not adding to cache hash"
+          nil
+        end
+      end
+    end
+    body << "# #{Digest::SHA2.hexdigest(hash.compact.join)}"
+
+    unless @config.cache.empty?
+      body << "" << "CACHE:"
+      body.concat @config.cache.uniq
+    end
+
+    unless @config.network.empty?
+      body << "" << "NETWORK:"
+      body.concat @config.network.uniq
+    end
+
+    unless @config.fallback.empty?
+      body << "" << "FALLBACK:"
+      @config.fallback.each do |namespace, url|
+        body << "#{namespace} #{URI.escape(url.to_s)}"
+      end
+    end
+    
+    return body.join("\n")
+  end
+  
+  private
+  # Rails 2.3.x support
+  module Rails
+    def render_manifest(root=::Rails.public_path, &block)
+      manifest = ManifestDestiny.configure(:root => root, &block)
+      response.headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
+      response.headers["Pragma"] = "no-cache"
+      response.headers["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
+      render :text => manifest, :layout => false, :content_type => "text/cache-manifest"
+    end
+  end
+end

data/manifest-destiny.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "manifest-destiny"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Smith"]
+  s.date = "2011-11-04"
+  s.description = "Generate a cache.manifest file for your html5 offline app"
+  s.email = "james@loopj.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/manifest-destiny.rb",
+    "manifest-destiny.gemspec",
+    "test/helper.rb",
+    "test/test_manifest-destiny.rb"
+  ]
+  s.homepage = "http://github.com/loopj/manifest-destiny"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Generate a cache.manifest file for your html5 offline app"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'manifest-destiny'
+
+class Test::Unit::TestCase
+end

data/test/test_manifest-destiny.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestManifestDestiny < Test::Unit::TestCase
+  should "generate a typical cache.manifest file" do
+    # flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: manifest-destiny
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id001
+  name: shoulda
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  type: :development
+description: Generate a cache.manifest file for your html5 offline app
+email: james@loopj.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/manifest-destiny.rb
+- manifest-destiny.gemspec
+- test/helper.rb
+- test/test_manifest-destiny.rb
+homepage: http://github.com/loopj/manifest-destiny
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generate a cache.manifest file for your html5 offline app
+test_files: []
+