manifesto 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Topley
+
+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.rdoc

@@ -0,0 +1,69 @@
+= manifesto
+
+Manifesto dynamically generates an {HTML5 cache manifest}[http://developer.apple.com/safari/library/documentation/iphone/conceptual/safarijsdatabaseguide/OfflineApplicationCache/OfflineApplicationCache.html] for offline application caching. It returns a list of files within the specified directory and sub-directories.
+By default it also includes a computed hash of the files' contents, so that if a file is changed a different hash is produced, causing the cache to be automatically invalidated.
+
+== Requirements
+
+* Ruby >= 1.8.6 (not tested with previous versions)
+
+== Installation
+
+This library is intended to be installed as a Gem.
+
+  $ gem install manifesto
+
+You might need administrator privileges on your system to install it.
+
+== Usage
+
+  # Basic usage, list all non-hidden files in ./public and include a computed hash of their contents
+  Manifesto.cache
+  
+  # Specify a directory
+  Manifesto.cache :directory => './mobile'
+  
+  # Specify a directory and don't compute the hash
+  Manifesto.cache :directory => './mobile', :compute_hash => false
+  
+== Sample Output
+
+  CACHE MANIFEST
+  # Generated by manifesto (http://github.com/johntopley/manifesto)
+  # Hash: 7013a3b8292ceeeb6336849bee1d1365
+  /apple-touch-icon.png
+  /apple-touch-startup.png
+  /index.html
+  /mobile/mobile.css
+  /mobile/mobile.js
+
+== Sinatra Example
+
+   require 'manifesto.rb'
+   
+   get '/manifest' do
+     headers 'Content-Type' => 'text/cache-manifest' # Must be served with this MIME type
+     Manifesto.cache
+   end
+
+== Ruby on Rails Example
+
+TODO
+
+== Issues
+
+Please use the {GitHub issues tracker}[http://github.com/johntopley/manifesto/issues].
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project
+* Make your feature addition or bug fix
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally
+* Commit, do not mess with rakefile, version, or history
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches
+
+== Copyright
+
+Copyright (c) 2010 John Topley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "manifesto"
+    gem.summary = %Q{Manifesto is a Ruby library that dynamically generates an HTML5 cache manifest}
+    gem.description = %Q{Dynamically generates an HTML5 cache manifest from the contents of a directory}
+    gem.email = "john@johntopley.com"
+    gem.homepage = "http://manifesto.rubyforge.org"
+    gem.authors = ["John Topley"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov_opts = %w{--exclude gems/*,Ruby}
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "manifesto #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/manifesto.rb

@@ -0,0 +1,76 @@
+require 'digest/md5'
+require 'find'
+
+module Manifesto
+  
+  # Returns an Array of non-hidden files within the <tt>./public</tt> directory, unless <tt>:directory</tt> is specified.
+  # The output also includes a computed hash of the files' contents, unless <tt>:compute_hash</tt> is set to <tt>false</tt>.
+  #
+  # === Examples
+  #
+  # Basic usage, list all non-hidden files in <tt>./public</tt> and include a computed hash of their contents:
+  #   Manifesto.cache
+  #
+  # Specify a directory:
+  #   Manifesto.cache :directory => './mobile'
+  #
+  # Specify a directory and don't compute the hash:
+  #   Manifesto.cache :directory => './mobile', :compute_hash => false
+  def self.cache(options = {})
+    directory = options.fetch(:directory, './public')
+    compute_hash  = options.fetch(:compute_hash, true)
+    validate_arguments(directory, compute_hash)
+    manifest = []
+    hashes = ''
+    Find.find(directory) 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"
+        hashes += compute_file_contents_hash(path) if compute_hash
+      end
+    end
+    
+    # Hash the hashes of each file and output as a comment.
+    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
+  end
+  
+  private
+  
+  # Reads the file contents to calculate the MD5 hash, so that if a file is
+  # changed, the manifest is changed too.
+  def self.compute_file_contents_hash(path)
+    hash = ''
+    digest = Digest::MD5.new
+    File.open(path, 'r') do |file|
+      digest.update(file.read(8192)) until file.eof
+      hash += digest.hexdigest
+    end
+    hash
+  end
+  
+  # Strips the directory from the start of path, so that each path is relative
+  # to directory. Add a leading forward slash if not present.
+  def self.normalize_path(directory, path)
+    normalized_path = path[directory.length,path.length]
+    normalized_path = '/' + normalized_path unless normalized_path[0,1] == '/'
+    normalized_path
+  end
+  
+  def self.validate_arguments(directory, compute_hash)
+    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)
+  end
+  
+  def self.valid_compute_hash?(compute_hash)
+    compute_hash.is_a?(TrueClass) || compute_hash.is_a?(FalseClass)
+  end
+  
+  def self.valid_directory?(directory)
+    File.directory?(directory)
+  end
+end

data/manifesto.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{manifesto}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Topley"]
+  s.date = %q{2010-06-05}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/manifesto.rb",
+     "manifesto.gemspec",
+     "spec/manifesto_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://manifesto.rubyforge.org}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Manifesto is a Ruby library that dynamically generates an HTML5 cache manifest}
+  s.test_files = [
+    "spec/manifesto_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/manifesto_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Manifesto do
+  it "should raise ArgumentError if directory is not a real directory" do
+    expect{ Manifesto.validate_arguments('', false) }.to raise_error(ArgumentError)
+  end
+  
+  it "should raise ArgumentError if compute_hash is not a boolean" do
+    expect{ Manifesto.validate_arguments('.', nil) }.to raise_error(ArgumentError)
+  end
+  
+  it "should return a list of files within the default directory"
+  
+  it "should return a list of files within the specified directory"
+  
+  it "should compute a hash of the files within the default directory"
+  
+  it "should compute a hash of the files within the specified directory"
+  
+  it "should compute a different hash if the content of a file changes"
+  
+  it "shouldn't include hidden files or directories within the default directory"
+  
+  it "shouldn't include hidden files or directories within the specified directory"
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format specdoc
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'manifesto.rb')
+require 'spec'
+require 'spec/autorun'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: manifesto
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Topley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Dynamically generates an HTML5 cache manifest from the contents of a directory
+email: john@johntopley.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/manifesto.rb
+- manifesto.gemspec
+- spec/manifesto_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://manifesto.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Manifesto is a Ruby library that dynamically generates an HTML5 cache manifest
+test_files: 
+- spec/manifesto_spec.rb
+- spec/spec_helper.rb