manifesto 0.6.0 → 0.7.0

data/README.rdoc

@@ -32,17 +32,27 @@ You might need administrator privileges on your system to install it.
   # Specify a directory and don't compute the hash
   Manifesto.cache :directory => './mobile', :compute_hash => false
   
+  # Add network includes
+  Manifesto.cache :directory => '.mobile', :network_includes => ['http://google.com', 'http://github.com']
+
+  # Add file exclusions
+  Manifesto.cache :directory => '.mobile', :excludes => ['dynamic-dir/', 'dynamic.js')]
+
 == Sample Output
 
   CACHE MANIFEST
   # Generated by manifesto (http://github.com/johntopley/manifesto)
   # Hash: 7013a3b8292ceeeb6336849bee1d1365
+  CACHE:
   /apple-touch-icon.png
   /apple-touch-startup.png
   /index.html
   /mobile/mobile.css
   /mobile/mobile.js
 
+  NETWORK:
+  http://github.com
+
 == Sinatra Example
 
    require 'manifesto.rb'

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/manifesto.rb

@@ -19,25 +19,40 @@ class Manifesto
   def self.cache(options = {})
     directory = options.fetch(:directory, './public')
     compute_hash  = options.fetch(:compute_hash, true)
-    validate_options(directory, compute_hash)
+    timestamp = options.fetch(:timestamp, true)
+    timestamp_exclusions = options.fetch(:timestamp_exclusions, [])
+    network_includes = options.fetch(:network_includes, [])
+    excludes = options.fetch(:excludes, [])
+    validate_options(directory, compute_hash, timestamp, network_includes, excludes)
     manifest = []
     hashes = ''
     
+    if !network_includes.empty? then
+      network_includes.each { |inc| manifest << "#{inc}\n" }
+      manifest << "\nNETWORK:\n"
+    end
+
     get_file_paths(directory).each do |path|
-    
       # Only include real files (i.e. not directories, symlinks etc.) and non-hidden
       # files in the manifest.
       if File.file?(path) && File.basename(path)[0,1] != '.'
-        manifest << "#{normalize_path(directory, path)}\n"
+        if not in_path(path, excludes) then
+          if timestamp and not in_path(path, timestamp_exclusions)
+            manifest << "#{normalize_path(directory, path)}?#{get_timestamp(path)}\n"
+          else
+            manifest << "#{normalize_path(directory, path)}\n"
+          end
+        end
         hashes += compute_file_contents_hash(path) if compute_hash
       end
     end
     
     # Hash the hashes of each file and output as a comment.
+    manifest << "CACHE:\n"
     manifest << "# Hash: #{Digest::MD5.hexdigest(hashes)}\n" if compute_hash
     manifest << "# Generated by manifesto (http://github.com/johntopley/manifesto)\n"
     manifest << "CACHE MANIFEST\n"
-    manifest.reverse
+    manifest.reverse.join
   end
   
   # Reads the file contents to calculate the MD5 hash, so that if a file is
@@ -66,11 +81,29 @@ class Manifesto
     normalized_path = '/' + normalized_path unless normalized_path[0,1] == '/'
     normalized_path
   end
+
+  # Calculates the timestamp for a given file using same methodology as Rails' asset timestamps.
+  def self.get_timestamp(path)
+    File.mtime(path).to_i.to_s
+  end
+
+  # Determines whether or not the path contains any of the targets; used for exclusions/inclusions.
+  def self.in_path(path, targets)
+    targets.each do |target|
+      if path.include? target
+        return true
+      end
+    end
+    false
+  end
   
   # Checks that the options passed to the <tt>cache</tt> method are valid.
-  def self.validate_options(directory, compute_hash)
+  def self.validate_options(directory, compute_hash, timestamp, network_includes, excludes)
     raise(ArgumentError, ":directory must be a real directory") unless valid_directory?(directory)
     raise(ArgumentError, ":compute_hash must be a boolean") unless valid_compute_hash?(compute_hash)
+    raise(ArgumentError, ":timestamp must be a boolean") unless valid_timestamp?(timestamp)
+    raise(ArgumentError, ":network_includes must be an array") unless valid_network_includes?(network_includes)
+    raise(ArgumentError, ":excludes must be an array") unless valid_excludes?(excludes)
   end
   
   # Checks that the <tt>compute_hash</tt> option is a boolean.
@@ -82,4 +115,19 @@ class Manifesto
   def self.valid_directory?(directory)
     File.directory?(directory)
   end
+
+  # Checks that the <tt>timestamp</tt> option is a boolean.
+  def self.valid_timestamp?(timestamp)
+    timestamp.is_a?(TrueClass) || timestamp.is_a?(FalseClass)
+  end
+
+  # Checks that the <tt>network_includes</tt> option is a boolean.
+  def self.valid_network_includes?(network_includes)
+    network_includes.is_a?(Array)
+  end
+
+  # Checks that the <tt>excludes</tt> option is a boolean.
+  def self.valid_excludes?(excludes)
+    excludes.is_a?(Array)
+  end
 end

data/manifesto.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{manifesto}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Topley", "Nasir Jamal"]
-  s.date = %q{2010-06-30}
+  s.date = %q{2012-02-04}
   s.description = %q{Dynamically generates an HTML5 cache manifest from the contents of a directory}
   s.email = %q{john@johntopley.com}
   s.extra_rdoc_files = [
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{manifesto}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Manifesto is a Ruby library that dynamically generates an HTML5 cache manifest}
   s.test_files = [
     "spec/manifesto_spec.rb",
@@ -41,7 +41,6 @@ Gem::Specification.new do |s|
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/spec/manifesto_spec.rb

@@ -3,11 +3,23 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe Manifesto do
   describe ".validate_options" do
     it "should raise ArgumentError if directory is not a real directory" do
-      expect{ Manifesto.validate_options('', false) }.to raise_error(ArgumentError)
+      expect{ Manifesto.validate_options('', false, false, [], []) }.to raise_error(ArgumentError)
     end
 
     it "should raise ArgumentError if compute_hash is not a boolean" do
-      expect{ Manifesto.validate_options('.', nil) }.to raise_error(ArgumentError)
+      expect{ Manifesto.validate_options('.', nil, false, [], []) }.to raise_error(ArgumentError)
+    end
+
+    it "should raise ArgumentError if timestamp is not a boolean" do
+      expect{ Manifesto.validate_options('.', false, nil, [], []) }.to raise_error(ArgumentError)
+    end
+
+    it "should raise ArgumentError if network_includes is not an array" do
+      expect{ Manifesto.validate_options('.', false, false, nil, []) }.to raise_error(ArgumentError)
+    end
+
+    it "should raise ArgumentError if excludes is not an array" do
+      expect{ Manifesto.validate_options('.', false, false, [], nil) }.to raise_error(ArgumentError)
     end
   end
 
@@ -40,6 +52,11 @@ describe Manifesto do
         Manifesto.stub!(:get_file_paths).and_return([])
       end
 
+      it "should not get the timestamp" do
+        Manifesto.should_receive(:get_timestamp).never
+        Manifesto.cache
+      end
+
       it "should not compute hash" do
         Manifesto.should_receive(:compute_file_contents_hash).never
         Manifesto.cache
@@ -58,6 +75,11 @@ describe Manifesto do
           File.stub!(:file?).and_return(false)
         end
 
+        it "should not get the timestamp" do
+          Manifesto.should_receive(:get_timestamp).never
+          Manifesto.cache
+        end
+
         it "should not compute hash" do
           Manifesto.should_receive(:compute_file_contents_hash).never
           Manifesto.cache
@@ -75,6 +97,11 @@ describe Manifesto do
           File.stub!(:file?).and_return(true)
         end
 
+        it "should not get the timestamp" do
+          Manifesto.should_receive(:get_timestamp).never
+          Manifesto.cache
+        end
+
         it "should not compute hash" do
           Manifesto.should_receive(:compute_file_contents_hash).never
           Manifesto.cache
@@ -93,6 +120,11 @@ describe Manifesto do
           Manifesto.stub!(:compute_file_contents_hash).and_return('asdfsafasdfsdfszxsd')
         end
 
+        it "should get the timestamp" do
+          Manifesto.should_receive(:get_timestamp).and_return('anything')
+          Manifesto.cache
+        end
+
         it "should compute the hash" do
           Manifesto.should_receive(:compute_file_contents_hash).and_return('anything')
           Manifesto.cache

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: manifesto
 version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - John Topley
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-30 00:00:00 +01:00
-default_executable: 
+date: 2012-02-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -56,7 +55,6 @@ files:
 - spec/manifesto_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/johntopley/manifesto
 licenses: []
 
@@ -86,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: manifesto
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Manifesto is a Ruby library that dynamically generates an HTML5 cache manifest