manifesto 0.5.0 → 0.6.0

data/README.rdoc

@@ -7,6 +7,12 @@ By default it also includes a computed hash of the files' contents, so that if a
 
 * Ruby >= 1.8.6 (not tested with previous versions)
 
+Manifesto has been successfully tested against the following Ruby releases:
+
+* Ruby 1.8.6
+* Ruby 1.8.7
+* Ruby 1.9.1
+
 == Installation
 
 This library is intended to be installed as a Gem.
@@ -48,7 +54,20 @@ You might need administrator privileges on your system to install it.
 
 == Ruby on Rails Example
 
-TODO
+* Create a route for the cache manifest:
+
+   map.manifest '/manifest', :controller => 'manifest', :action => 'show' # Rails 2.x
+
+   -- or --
+
+   match '/manifest' => 'manifest#show' # Rails 3.x
+
+* Create a controller action:
+
+   def show
+     headers['Content-Type'] = 'text/cache-manifest'
+     render :text => Manifesto.cache, :layout => false
+   end
 
 == Issues
 
@@ -64,6 +83,10 @@ Please use the {GitHub issues tracker}[http://github.com/johntopley/manifesto/is
   (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
 
+== Thanks
+
+* Thanks to {Nasir Jamal}[http://github.com/nas] for helping me with RSpec.
+
 == Copyright
 
 Copyright (c) 2010 John Topley. See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{Dynamically generates an HTML5 cache manifest from the contents of a directory}
     gem.email = "john@johntopley.com"
     gem.homepage = "http://github.com/johntopley/manifesto"
-    gem.authors = ["John Topley"]
+    gem.authors = ["John Topley","Nasir Jamal"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.rubyforge_project = "manifesto"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/manifesto.rb

@@ -52,7 +52,7 @@ class Manifesto
     hash
   end
   
-  # Recursively find all file entries from within a directory.
+  # Recursively finds all file entries from within a directory.
   def self.get_file_paths(directory)
     entries = []
     Find.find(directory) { |entry| entries << entry }
@@ -67,16 +67,19 @@ class Manifesto
     normalized_path
   end
   
+  # Checks that the options passed to the <tt>cache</tt> method are valid.
   def self.validate_options(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
   
+  # Checks that the <tt>compute_hash</tt> option is a boolean.
   def self.valid_compute_hash?(compute_hash)
     compute_hash.is_a?(TrueClass) || compute_hash.is_a?(FalseClass)
   end
   
+  # Checks that the <tt>directory</tt> option corresponds to a real directory.
   def self.valid_directory?(directory)
     File.directory?(directory)
   end
-end
+end

data/manifesto.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{manifesto}
-  s.version = "0.5.0"
+  s.version = "0.6.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-09}
+  s.authors = ["John Topley", "Nasir Jamal"]
+  s.date = %q{2010-06-30}
   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 = [

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: manifesto
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - John Topley
+- Nasir Jamal
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-06-09 00:00:00 +01:00
+date: 2010-06-30 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency