manifesto 0.1.0 → 0.5.0

data/Rakefile

@@ -8,12 +8,17 @@ begin
     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.homepage = "http://github.com/johntopley/manifesto"
     gem.authors = ["John Topley"]
     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
   end
   Jeweler::GemcutterTasks.new
+  
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.5.0

data/lib/manifesto.rb

@@ -1,7 +1,7 @@
 require 'digest/md5'
 require 'find'
 
-module Manifesto
+class 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>.
@@ -19,10 +19,11 @@ module Manifesto
   def self.cache(options = {})
     directory = options.fetch(:directory, './public')
     compute_hash  = options.fetch(:compute_hash, true)
-    validate_arguments(directory, compute_hash)
+    validate_options(directory, compute_hash)
     manifest = []
     hashes = ''
-    Find.find(directory) do |path|
+    
+    get_file_paths(directory).each do |path|
     
       # Only include real files (i.e. not directories, symlinks etc.) and non-hidden
       # files in the manifest.
@@ -39,8 +40,6 @@ module Manifesto
     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)
@@ -53,6 +52,13 @@ module Manifesto
     hash
   end
   
+  # Recursively find all file entries from within a directory.
+  def self.get_file_paths(directory)
+    entries = []
+    Find.find(directory) { |entry| entries << entry }
+    entries
+  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)
@@ -61,7 +67,7 @@ module Manifesto
     normalized_path
   end
   
-  def self.validate_arguments(directory, compute_hash)
+  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

data/manifesto.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{manifesto}
-  s.version = "0.1.0"
+  s.version = "0.5.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.date = %q{2010-06-09}
   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 = [
@@ -29,9 +29,10 @@ Gem::Specification.new do |s|
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://manifesto.rubyforge.org}
+  s.homepage = %q{http://github.com/johntopley/manifesto}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
+  s.rubyforge_project = %q{manifesto}
   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 = [

data/spec/manifesto_spec.rb

@@ -1,25 +1,130 @@
 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)
+  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)
+    end
+
+    it "should raise ArgumentError if compute_hash is not a boolean" do
+      expect{ Manifesto.validate_options('.', nil) }.to raise_error(ArgumentError)
+    end
   end
-  
-  it "should raise ArgumentError if compute_hash is not a boolean" do
-    expect{ Manifesto.validate_arguments('.', nil) }.to raise_error(ArgumentError)
+
+  describe ".cache" do
+    before(:each) do
+      Manifesto.stub!(:validate_options).and_return(true)
+    end
+
+    it "should validate the options" do
+      Manifesto.should_receive(:validate_options).and_return(true)
+      Manifesto.cache
+    end
+
+    context "when default directory" do
+      it "should get file paths from the default directory" do
+        Manifesto.should_receive(:get_file_paths).with('./public').and_return([])
+        Manifesto.cache
+      end
+    end
+
+    context "when directory is specified" do
+      it "should get file path from within the specified directory" do
+        Manifesto.should_receive(:get_file_paths).with('./mobile').and_return([])
+        Manifesto.cache(:directory => './mobile')
+      end
+    end
+
+    context "when there are no files in the directory" do
+      before(:each) do
+        Manifesto.stub!(:get_file_paths).and_return([])
+      end
+
+      it "should not compute hash" do
+        Manifesto.should_receive(:compute_file_contents_hash).never
+        Manifesto.cache
+      end
+    end
+
+    context "when there are files in the directories" do
+      it "should check the file" do
+        File.should_receive(:file?)
+        Manifesto.cache
+      end
+
+      context "and path is for the directory or symlink" do
+        before(:each) do
+          Manifesto.stub!(:get_file_paths).and_return(['public/dir1', 'public/symlink'])
+          File.stub!(:file?).and_return(false)
+        end
+
+        it "should not compute hash" do
+          Manifesto.should_receive(:compute_file_contents_hash).never
+          Manifesto.cache
+        end
+
+        it "should not normalize the path" do
+          Manifesto.should_receive(:normalize_path).never
+          Manifesto.cache
+        end
+      end
+
+      context "and path is for the hidden file" do
+        before(:each) do
+          Manifesto.stub!(:get_file_paths).and_return(['public/.hiddenfile'])
+          File.stub!(:file?).and_return(true)
+        end
+
+        it "should not compute hash" do
+          Manifesto.should_receive(:compute_file_contents_hash).never
+          Manifesto.cache
+        end
+
+        it "should not normalize the path" do
+          Manifesto.should_receive(:normalize_path).never
+          Manifesto.cache
+        end
+      end
+
+      context "and path is for a valid file" do
+        before(:each) do
+          Manifesto.stub!(:get_file_paths).and_return(['/public/file1'])
+          File.stub!(:file?).and_return(true)
+          Manifesto.stub!(:compute_file_contents_hash).and_return('asdfsafasdfsdfszxsd')
+        end
+
+        it "should compute the hash" do
+          Manifesto.should_receive(:compute_file_contents_hash).and_return('anything')
+          Manifesto.cache
+        end
+
+        it "should normalize path" do
+          Manifesto.should_receive(:normalize_path).with('./public', '/public/file1')
+          Manifesto.cache
+        end
+
+        context "and return an array of values" do
+          it "should return an array of 4 elements" do
+             Manifesto.cache.size.should eql(4)
+          end
+
+          it "should have 'CACHE MANIFEST text in the first element of the return array'" do
+            Manifesto.cache.first.should eql("CACHE MANIFEST\n")
+          end
+
+          it "should have 'generated by manifesto text'" do
+            Manifesto.cache.should be_include("# Generated by manifesto (http://github.com/johntopley/manifesto)\n")
+          end
+
+          it "should have the file name in the last element of the array" do
+            Manifesto.cache.last.should eql("/file1\n")
+          end
+
+          it "should return the hash" do
+            Manifesto.cache.should be_include("# Hash: f2d6ac219e22a0eed707a24d65777a0e\n")
+          end
+        end
+      end
+    end
   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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: manifesto
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 5
   - 0
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - John Topley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-05 00:00:00 +01:00
+date: 2010-06-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,7 +56,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://manifesto.rubyforge.org
+homepage: http://github.com/johntopley/manifesto
 licenses: []
 
 post_install_message: 
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: manifesto
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3