flat_hash 0.0.2 → 0.1.0

data/HISTORY.rdoc

@@ -0,0 +1,3 @@
+= 0.1.0
+
+* Added rubygems-test

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require 'gemesis/rake'
+rescue Exception
+  puts "gemesis related tasks will only be available if you 'gem install gemesis'"
+end
+
+desc 'execute specifications'
+task :test do
+  sh 'rspec spec'
+end

data/spec/directory_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__)+'/spec_helper'
+
+describe FlatHash::Directory do
+  before do
+    @hash = {'key1'=>'value1', 'key2'=>'value2'}
+    @key = 'somekey'
+  end
+
+  it "should initially contain no entries" do
+    in_temp_directory do
+      with_directory do |directory|
+        directory.entries.should == []
+      end
+    end
+  end
+
+  it "should enumerate keys" do
+    in_temp_directory do
+      with_directory do |directory|
+        directory[@key] = @hash
+        directory.entries.should == [@hash]
+      end
+    end
+  end
+
+  it "should add id to hash" do
+    in_temp_directory do
+      with_directory do |directory|
+        directory[@key] = @hash
+      end
+      with_directory do |directory|
+        directory[@key].id.should == @key
+      end
+    end
+  end
+
+  it "should expose indexers" do
+    in_temp_directory do
+      with_directory do |directory|
+        directory[@key] = @hash
+      end
+      with_directory do |directory|
+        directory[@key].should == @hash
+      end
+    end
+  end
+
+  it "should allow entries to be appended" do
+    in_temp_directory do
+      with_directory do |directory|
+        directory << FlatHash::Entry.new(@key, @hash)
+      end
+      with_directory do |directory|
+        directory[@key].should == @hash
+      end
+    end
+  end
+  
+  it "should allow entries to be destroyed" do
+    in_temp_directory do
+      with_directory do |directory|
+        directory.entries.should == []
+        directory << FlatHash::Entry.new(@key, @hash)
+        directory[@key].should == @hash
+        directory.destroy(@key)
+        directory.entries.should == []
+      end
+    end
+  end
+end

data/spec/git_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__)+'/spec_helper'
+require 'vcs_spec_shared'
+
+require 'flat_hash/git'
+
+describe FlatHash::Hg do
+  it_should_behave_like "a vcs wrapper"
+
+  def vcs_class
+    FlatHash::Git
+  end
+
+  it 'should handle checking for nonexistant paths' do
+    in_vcs_working_directory do |vcs|
+      write 'some content', 'a', 'b', 'c', 'file1'
+      vcs.addremovecommit 'added file1 and file2'
+
+      changeset = vcs.changesets.first
+      vcs.contains?(changeset, 'file1').should be_false
+      vcs.contains?(changeset, 'b/c/file1').should be_false
+      vcs.contains?(changeset, 'a/b/c/file1').should be_true
+    end
+  end
+end

data/spec/hg_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__)+'/spec_helper'
+require 'vcs_spec_shared'
+
+require 'flat_hash/hg'
+
+describe FlatHash::Hg do
+  it_should_behave_like "a vcs wrapper"
+
+  def vcs_class
+    FlatHash::Hg
+  end
+end

data/spec/repository_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__)+'/spec_helper'
+
+describe FlatHash::Repository do
+  it "should raise exception when no vcs repository is detected" do
+    in_temp_directory do
+      with_repository do |repository|
+        repository.should_not be_vcs_supported
+      end
+    end
+  end
+end
+
+shared_examples_for "a repository" do
+  it "should have an initially empty history" do
+    in_vcs_working_directory do |vcs|
+      with_repository do |repository|
+        repository.changesets.should == []
+      end
+    end
+  end
+
+  it 'should detect additions' do
+    in_vcs_working_directory do |vcs|
+      with_repository do |repository|
+        repository['entry'] = {'key' => 'value'}
+        vcs.addremovecommit 'first commit'
+        repository.changesets.size.should == 1
+      end
+    end
+  end
+
+  it 'should detect deletions' do
+    in_vcs_working_directory do |vcs|
+      with_repository do |repository|
+        repository['entry1'] = {'key' => 'value'}
+        vcs.addremovecommit 'added entry1'
+
+        repository['entry2'] = {'key' => 'value'}
+        vcs.addremovecommit 'added entry2'
+
+        repository['entry1'] = {'key' => 'a different value'}
+        vcs.addremovecommit 'updated entry1'
+
+        repository.destroy 'entry1'
+        vcs.addremovecommit 'removed entry1'
+
+        repository.changesets.size.should == 4
+      end
+    end
+  end
+
+  it 'should detect modifications' do
+    in_vcs_working_directory do |vcs|
+      with_repository do |repository|
+        repository['entry'] = {'key' => 'value'}
+        vcs.addremovecommit 'first commit'
+        repository['entry'] = {'key' => 'value2'}
+        vcs.addremovecommit 'next commit'
+        repository.changesets.size.should == 2
+      end
+    end
+  end
+end
+
+describe FlatHash::Repository, 'git' do
+  it_should_behave_like "a repository"
+
+  def vcs_class
+    FlatHash::Git
+  end
+end
+
+describe FlatHash::Repository, 'hg' do
+  it_should_behave_like "a repository"
+
+  def vcs_class
+    FlatHash::Hg
+  end
+end

data/spec/serialiser_conversion_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__)+'/spec_helper'
+
+require 'flat_hash/serialiser'
+
+describe FlatHash::Serialiser, '#yaml' do
+  before do
+    @serialiser = FlatHash::Serialiser.new   
+  end
+
+  def read string
+    @serialiser.read StringIO.new(string)
+  end
+
+  it "should detect and deserialise yaml persisted hash" do
+    hash = {'key1' => 'value1', 'key2' => 'value2'}
+    read(hash.to_yaml).should == hash
+  end
+
+  it "should detect and deserialise yaml persisted open struct" do
+    ostruct = OpenStruct.new
+    ostruct.keya = 'valuea'
+    ostruct.keyb = 'valueb'
+    read(ostruct.to_yaml).should == {'keya' => 'valuea', 'keyb' => 'valueb'}
+  end
+end

data/spec/serialiser_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__)+'/spec_helper'
+
+describe FlatHash::Serialiser, '#read' do
+  before do
+    @serialiser = FlatHash::Serialiser.new    
+  end
+
+  def read string
+    @serialiser.read StringIO.new(string)
+  end
+
+  it "should read an empty hash when stream is empty" do
+    read('').should == {}
+  end
+
+  it "should read a single line and treat it as a key" do
+    read('key').should == {'key' => ''}
+  end
+
+  it "should read a double line and treat it as a key and value" do
+    read(<<EOF).should == {'key' => 'value'}
+key
+value
+EOF
+  end
+
+  it "should read multiple key value pairs delimited by <----->" do
+    read(<<EOF).should == {'key1' => 'value1', 'key2' => 'value2'}
+key1
+value1
+<----->
+key2
+value2
+EOF
+  end
+
+  it "should read multiple line values" do
+    read(<<EOF).should == {'key1' => "value1line1\nvalue1line2", 'key2' => "value2line1\nvalue2line2"}
+key1
+value1line1
+value1line2
+<----->
+key2
+value2line1
+value2line2
+EOF
+  end
+end
+
+describe FlatHash::Serialiser, '#write' do
+  before do
+    @serialiser = FlatHash::Serialiser.new   
+  end
+  
+  def write hash
+    io = StringIO.new
+    @serialiser.write(io, hash)
+    io.flush
+    io.string
+  end
+
+  it 'should output empty string ' do
+    write({}).should == ''
+  end
+
+  it 'should write single key' do
+    write({'key' => 'value'}).should == <<EOF
+key
+value
+EOF
+  end
+  
+  it 'should write multiple keys delimited by <-----> in order by key' do
+    write({'key1' => 'value1', 'key2' => 'value2', 'key3' => 'value3'}).should == <<EOF
+key1
+value1
+<----->
+key2
+value2
+<----->
+key3
+value3
+EOF
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+$: << File.dirname(__FILE__)+'/../lib'
+$: << File.dirname(__FILE__)
+
+require 'flat_hash'
+require 'tempfile'
+require 'fileutils'
+
+def in_temp_directory
+  tempfile = Tempfile.new('')
+  tempdir = tempfile.path
+  tempfile.close!
+  begin
+    FileUtils.mkdir_p tempdir
+    Dir.chdir(tempdir) do
+      yield
+    end
+  ensure
+    FileUtils.rm_rf tempdir
+  end
+end
+
+def sh command, options={}
+  lines=[]
+  IO.popen("#{command} 2>&1") {|io| io.each {|l| lines << l.chomp } }
+  raise "\"#{command}\" failed with status #{$?}: #{lines.join("\n")}" unless $?.success?
+end
+
+def in_vcs_working_directory
+  vcs = vcs_class.new
+  in_temp_directory do
+    vcs.init
+    yield vcs
+  end
+end
+
+def with_directory
+  yield FlatHash::Directory.new(FlatHash::Serialiser.new, '.cards')
+end
+
+def with_repository
+  yield FlatHash::Repository.new(FlatHash::Serialiser.new, '.cards')
+end
+
+def write content, *paths
+  path = File.join(*paths)
+  FileUtils.mkdir_p File.dirname(path)
+  File.open(path, 'w') {|file| file.puts content}
+end
+
+def delete *paths
+  FileUtils.rm(File.join(*paths))
+end

data/spec/vcs_spec_shared.rb

@@ -0,0 +1,78 @@
+puts 'loading'
+
+shared_examples_for "a vcs wrapper" do
+  it "should initially have no changesets" do
+    in_vcs_working_directory do |vcs|
+      vcs.changesets.size.should == 0
+    end
+  end
+
+  it "should retrieve single changeset" do
+    in_vcs_working_directory do |vcs|
+      write 'some content', 'file1'
+      vcs.addremovecommit 'first commit'
+      vcs.changesets.size.should == 1
+    end
+  end
+
+  it "should retrieve details of each changeset" do
+    in_vcs_working_directory do |vcs|
+      write 'some content', 'file1'
+      write 'some different content', 'file2'
+      vcs.addremovecommit 'added file1 and file2'
+
+      write 'some new content', 'file1'
+      delete 'file2'
+      vcs.addremovecommit 'modified file1 and removed file2'
+
+      write 'some recreated content', 'file2'
+      vcs.addremovecommit 'recreated file2'
+
+      third, second, first = vcs.changesets
+
+      vcs.changeset(first).instance_eval do
+        id.should == first
+        additions.should == ['file1', 'file2']
+        deletions.should == []
+        modifications.should == []
+        description.should == 'added file1 and file2'
+      end
+      vcs.files_at(first).should == ['file1', 'file2']
+      vcs.content_at('file1',first).should == 'some content'
+      vcs.content_at('file2',first).should == 'some different content'
+
+      vcs.changeset(second).instance_eval do
+        id.should == second
+        additions.should == []
+        deletions.should == ['file2']
+        modifications.should == ['file1']
+        description.should == 'modified file1 and removed file2'
+      end
+      vcs.files_at(second).should == ['file1']
+      vcs.content_at('file1',second).should == 'some new content'
+
+      vcs.changeset(third).instance_eval do
+        id.should == third
+        additions.should == ['file2']
+        deletions.should == []
+        modifications.should == []
+        description.should == 'recreated file2'
+      end
+      vcs.files_at(third).should == ['file1', 'file2']
+      vcs.content_at('file2', third).should == 'some recreated content'
+      
+      vcs.changesets('file1').should == [second, first]
+      vcs.changesets('file2').should == [third, second, first]
+    end
+  end
+
+  it 'should handle retrieving files at any directory depth' do
+    in_vcs_working_directory do |vcs|
+      write 'some content', 'a', 'b', 'c', 'file1'
+      vcs.addremovecommit 'added file1 and file2'
+      changeset = vcs.changesets.first
+      vcs.files_at(changeset, 'a/b/c/d').should == []
+      vcs.files_at(changeset, 'a/b/c').should == ['a/b/c/file1']
+    end
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: flat_hash
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
 - Mark Ryall
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-21 00:00:00 +10:00
+date: 2011-02-04 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +19,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 2
-        - 0
-        version: 2.2.0
+        version: "2"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,14 +30,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
-        version: 0.8.7
+        version: "0.8"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -56,32 +41,11 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+        version: "2"
   type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: gemesis
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 0
-        - 3
-        version: 0.0.3
-  type: :development
-  version_requirements: *id004
 description: |
   Hash serialisation that writes key/value pairs in a predictable order
 
@@ -103,8 +67,19 @@ files:
 - lib/flat_hash/serialiser.rb
 - lib/flat_hash/vcs.rb
 - lib/flat_hash.rb
+- spec/directory_spec.rb
+- spec/git_spec.rb
+- spec/hg_spec.rb
+- spec/repository_spec.rb
+- spec/serialiser_conversion_spec.rb
+- spec/serialiser_spec.rb
+- spec/spec_helper.rb
+- spec/vcs_spec_shared.rb
 - README.rdoc
 - MIT-LICENSE
+- HISTORY.rdoc
+- Rakefile
+- .gemtest
 has_rdoc: true
 homepage: http://github.com/markryall/flat_hash
 licenses: []
@@ -119,23 +94,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: trivial but predictable serialisation for hashes