secretary 0.0.1 → 0.1.0

data/spec/spec_helper.rb

@@ -1 +1,10 @@
+
 $: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+def relative_path path
+	File.expand_path(File.dirname(__FILE__) + '/' + path)
+end
+
+def delete_if_exists path
+	File.delete path if File.exist? path
+end

data/spec/two-rows.csv

@@ -0,0 +1,2 @@
+red,blue,yellow
+one,two,three

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: secretary
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Joshua Choi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-12 00:00:00 -07:00
+date: 2008-08-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.7.0
     version: 
-description: Secretary is a gem who makes managing simple preference files in Ruby easy and painless. If you tire of being bound to PStore or YAML and want a consistent, pluggable way to read and write preferences, your Secretary would be happy to help!
+description: Secretary is a gem who makes managing simple preference files in Ruby easier and more painless.
 email: 
 - joshua@choi.name
 executables: []
@@ -33,7 +33,6 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-- spec/broken-yaml.txt
 files: 
 - History.txt
 - Manifest.txt
@@ -44,12 +43,14 @@ files:
 - lib/secretary/gopher.rb
 - lib/secretary/gopher/yaml.rb
 - spec/spec_helper.rb
-- spec/secretary_spec.rb
+- spec/secretary.rb
 - spec/error_spec.rb
-- spec/gopher_spec.rb
+- spec/gopher/yaml_spec.rb
 - spec/hash.yaml
 - spec/array.yaml
-- spec/broken-yaml.txt
+- spec/broken-yaml.yaml
+- spec/one-row.csv
+- spec/two-rows.csv
 has_rdoc: true
 homepage: http://secretary.rubyforge.org
 post_install_message: 
@@ -76,6 +77,6 @@ rubyforge_project: secretary
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Secretary is a gem who makes managing simple preference files in Ruby easy and painless
+summary: Secretary is a gem who makes managing simple preference files in Ruby easier and more painless.
 test_files: []
 

data/spec/gopher_spec.rb

@@ -1,157 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require 'lib/secretary/gopher/yaml'
-
-describe Secretary::Gopher::YAML do
-  
-  it 'should be equal with another if they are of equal class' do
-    gopher0 = Secretary::Gopher::YAML.new stub_everything
-    gopher1 = Secretary::Gopher::YAML.new stub_everything
-    gopher0.should == gopher1
-    gopher1.should == gopher0
-  end
-  
-  it 'should be unequal with another if they are of unequal class, even if the other is a kind of its class' do
-    gopher0 = Secretary::Gopher::YAML.new stub_everything
-    gopher1 = stub :kind_of? => true
-    gopher0.should_not == gopher1
-  end
-  
-  
-  it 'should know its valid data type' do
-    data_type = stub 'Data Type'
-    gopher = Secretary::Gopher::YAML.new data_type
-    gopher.valid_data_type.should == data_type
-  end
-  
-  it 'should know its valid file type and it should be YAML' do
-    Secretary::Gopher::YAML.new(stub_everything).valid_file_type.should == 'YAML'
-  end
-  
-  describe 'when trying to save an object into a YAML file using a file path' do
-    
-    it 'should save a given Hash when the valid data type is Hash' do
-        gopher = Secretary::Gopher::YAML.new Hash
-        data = {:name => 'Tracy', :url => 'http://tracy.name'}
-        file_path = File.dirname(__FILE__) + '/temporary.yaml'
-        gopher.save data, file_path
-        open file_path do |file|
-          YAML::load(file).should == data
-        end
-        File.delete file_path
-      end
-  
-    it 'should save a given object when the object is of its valid data type' do
-      class Person
-        def initialize
-          @name = 'Sal'
-          @age = 76
-        end
-        def ==(other)
-          self.class == other.class
-        end
-      end
-      data = Person.new
-      gopher = Secretary::Gopher::YAML.new Person
-      file_path = File.dirname(__FILE__) + '/temporary.yaml'
-      gopher.save data, file_path
-      open file_path do |file|
-        YAML::load(file).should == data
-      end
-      File.delete file_path
-    end
-  
-    it 'should raise an error if it tries to save data that is not of its valid data type' do
-      gopher = Secretary::Gopher::YAML.new Hash
-      data = [3, 2, 1]
-      file_path = File.dirname(__FILE__) + '/temporary.yaml'
-      lambda { gopher.save data, file_path }.should raise_error(ArgumentError)
-    end
-  
-    it 'should not create a new file if it tries to save data that is not of its valid data type' do
-      gopher = Secretary::Gopher::YAML.new Hash
-      data = [3, 2, 1]
-      file_path = File.dirname(__FILE__) + '/temporary.yaml'
-      begin
-        gopher.save data, file_path
-      rescue ArgumentError
-      end
-      File.exists?(file_path).should_not be_true
-    end
-  
-    it 'should not modify any file if it tries to save data that is not of its valid data type' do
-      gopher = Secretary::Gopher::YAML.new Hash
-      data0 = {:name => 'Tracy', :url => 'http://tracy.name'}
-      data1 = [3, 2, 1]
-      file_path = File.dirname(__FILE__) + '/temporary.yaml'
-      gopher.save data0, file_path
-      begin
-        gopher.save data1, file_path
-      rescue ArgumentError
-      end
-      open file_path do |file|
-        YAML::load(file).should == data0
-      end
-      File.delete file_path
-    end
-    
-  end
-  
-  describe 'when reading from a file' do
-    
-    it 'should get the file\'s data when the file is YAML and that data is a Hash and the given type is Hash' do
-      preferences0 = {'name' => 'Billy Bob', 'email' => 'xxx@yyy.zzz'}
-      file_path = File.dirname(__FILE__) + '/hash.yaml'
-      open file_path do |file|
-        require 'yaml'
-        gopher = Secretary::Gopher::YAML.new Hash
-        preferences1 = gopher.load_from_file file
-        preferences1.should == preferences0
-      end
-    end
-    
-    it 'should raise a ParsingError when the file is not YAML' do
-      gopher = Secretary::Gopher::YAML.new stub_everything
-      file_path = File.dirname(__FILE__) + '/broken-yaml.txt'
-      open file_path do |file|
-        lambda { gopher.load_from_file file } \
-          .should raise_error(Secretary::Error::Parsing)
-      end
-    end
-
-    it 'should raise an InvalidDataError when the file\'s data is not a Hash and the valid data type is Hash' do
-      gopher = Secretary::Gopher::YAML.new Hash
-      file_path = File.dirname(__FILE__) + '/array.yaml'
-      open file_path do |file|
-        lambda { gopher.load_from_file file } \
-          .should raise_error(Secretary::Error::InvalidData)
-      end
-    end
-
-  end
-  
-  describe 'when reading from a path to a file' do
-  
-    it 'should raise a MissingFileError when the path leads to nowhere' do
-      gopher = Secretary::Gopher::YAML.new Hash
-      lambda { gopher.load_from_path 'missing-file.yaml' } \
-        .should raise_error(Secretary::Error::MissingFile)
-    end
-
-    it 'should get the path\'s file\'s data when the file is YAML and that data is a Hash and the given type is Hash' do
-      preferences0 = {'name' => 'Billy Bob', 'email' => 'xxx@yyy.zzz'}
-      gopher = Secretary::Gopher::YAML.new Hash
-      file_path = File.dirname(__FILE__) + '/hash.yaml'
-      preferences1 = gopher.load_from_path(file_path)
-      preferences1.should == preferences0
-    end
-    
-    it 'should raise an InvalidDataError when the path\'s file\'s data is not a Hash and the valid data type is Hash' do
-      gopher = Secretary::Gopher::YAML.new Hash
-      file_path = File.dirname(__FILE__) + '/array.yaml'
-      lambda { gopher.load_from_path file_path } \
-        .should raise_error(Secretary::Error::InvalidData)
-    end
-    
-  end
-
-end

data/spec/secretary_spec.rb

@@ -1,259 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-require 'lib/secretary'
-require 'lib/secretary/gopher/yaml'
-
-describe Secretary do
-  
-  it 'should be enumerable' do
-    gopher = stub 'Gopher', :load_from_path => {}
-    gopher_class = stub 'Gopher Class', :new => gopher
-    file_path = stub 'File Path'
-    secretary = Secretary.new file_path, {}, gopher_class
-    secretary.should be_a_kind_of(Enumerable)
-  end
-  
-  it 'should know the file path it saves to' do
-    gopher = stub 'Gopher', :load_from_path => {}
-    gopher_class = stub 'Gopher Class', :new => gopher
-    file_path = stub 'File Path'
-    secretary = Secretary.new file_path, {}, gopher_class
-    secretary.file_path.should == file_path
-  end
-  
-  it 'should know its defaults' do
-    gopher = stub 'Gopher', :load_from_path => {}
-    gopher_class = stub 'Gopher Class', :new => gopher
-    secretary = Secretary.new stub_everything, {'name' => ''}, gopher_class
-    secretary.defaults.should == {'name' => ''}
-  end
-  
-  it 'should have an empty hash for its defaults by default' do
-    gopher = stub 'Gopher', :load_from_path => {}
-    gopher_class = stub 'Gopher Class', :new => gopher
-    secretary = Secretary.new stub_everything, {}, gopher_class
-    secretary.defaults.should == {}
-  end
-  
-  it 'should create a new gopher, which expects a Hash, from the given gopher class' do
-    gopher = stub 'Gopher', :load_from_path => {}
-    gopher_class = mock 'Gopher Class'
-    gopher_class.should_receive(:new).with(Hash).and_return(gopher)
-    secretary = Secretary.new stub_everything, stub_everything, gopher_class
-  end
-  
-  it 'should create a new YAML gopher by default' do
-    secretary = Secretary.new 'file_path'
-    secretary.gopher.should be_a_kind_of(Secretary::Gopher::YAML)
-  end
-  
-  it 'should know its gopher' do
-    defaults = stub_everything
-    gopher = stub 'Gopher', :load_from_path => {}
-    gopher_class = stub 'Gopher Class', :new => gopher
-    secretary = Secretary.new stub_everything, defaults, gopher_class
-  end
-  
-  it 'should be able to set its values' do
-    data = {'name' => 'Billy Bob'}
-    gopher = stub 'Gopher', :load_from_path => data
-    gopher_class = stub 'Gopher Class', :new => gopher
-    secretary = Secretary.new stub_everything, {}, gopher_class
-    secretary['name'] = 'Joe'
-    secretary['name'].should == 'Joe'
-  end
-  
-  it 'should be able to delete its values' do
-    data = {'name' => 'Billy Bob'}
-    gopher = stub 'Gopher', :load_from_path => data
-    gopher_class = stub 'Gopher Class', :new => gopher
-    secretary = Secretary.new stub_everything, {}, gopher_class
-    secretary.delete 'name'
-    secretary.should_not include('name')
-  end
-  
-  describe 'when accessing a key' do
-    
-    it 'should know the key\'s value' do
-      data = {'name' => 'Billy Bob'}
-      gopher = stub 'Gopher', :load_from_path => data
-      gopher_class = stub 'Gopher Class', :new => gopher
-      secretary = Secretary.new stub_everything, {}, gopher_class
-      secretary['name'].should == 'Billy Bob'
-    end
-    
-    it 'should give the key\'s corresponding default value if the key\'s does not otherwise exist in its contents' do
-      defaults = {'name' => 'Billy Bob'}
-      data = {}
-      gopher = stub 'Gopher', :load_from_path => data
-      gopher_class = stub 'Gopher Class', :new => gopher
-      secretary = Secretary.new stub_everything, defaults, gopher_class
-      secretary['name'].should == 'Billy Bob'
-    end
-    
-    it 'should give the key\'s corresponding default value after the key is deleted' do
-      defaults = {'name' => 'Joe'}
-      data = {'name' => 'Billy Bob'}
-      gopher = stub 'Gopher', :load_from_path => data
-      gopher_class = stub 'Gopher Class', :new => gopher
-      secretary = Secretary.new stub_everything, defaults, gopher_class
-      secretary.delete 'name'
-      secretary['name'].should == 'Joe'
-    end
-    
-  end
-  
-  describe 'using a custom gopher' do
-    
-    it 'should raise an error when its given gopher class cannot make new gophers' do
-      gopher_class = stub 'Gopher Class'
-      lambda { Secretary.new stub_everything, {}, gopher_class } \
-        .should raise_error(ArgumentError)
-    end
-
-    it 'should raise an error when its given gopher class\'s objects cannot act like gophers' do
-      gopher = stub 'Gopher'
-      gopher_class = stub 'Gopher Class', :new => gopher
-      lambda { Secretary.new stub_everything, {}, gopher_class } \
-        .should raise_error(ArgumentError)
-    end
-
-    describe 'updating itself based on what the gopher brings from its file path' do
-      
-      it 'have contents of its defaults merged with the file\'s data, when initialized' do
-        defaults = {:bash => 'bang', :bar => 'bing'}
-        data = {:bar => 'foo', :bam => 'fiz'}
-        gopher = stub 'Gopher', :load_from_path => data
-        gopher_class = stub 'Gopher Class', :new => gopher
-        secretary = Secretary.new stub_everything, defaults, gopher_class
-        secretary.to_hash.should == defaults.merge(data)
-      end
-      
-      it 'have contents of its defaults only if its file does not yet exist, when initialized' do
-        defaults = {:bash => 'bang', :bar => 'bing'}
-        gopher = stub 'Gopher'
-        gopher.stub!(:load_from_path).and_raise(
-          Secretary::Error::MissingFile.new(stub_everything)
-        )
-        gopher_class = stub 'Gopher Class', :new => gopher
-        secretary = Secretary.new stub_everything, defaults, gopher_class
-        secretary.to_hash.should == defaults
-      end
-    
-      it 'should update its contents with its defaults, based on what the gopher brings from its file path, when reloaded' do
-        defaults = {:bash => 'bang', :bar => 'bing'}
-        data = {:bar => 'foo', :bam => 'fiz'}
-        gopher = stub 'Gopher'
-        gopher.stub!(:load_from_path).and_return({}, data)
-        gopher_class = stub 'Gopher Class', :new => gopher
-        secretary = Secretary.new stub_everything, defaults, gopher_class
-        secretary.reload
-        secretary.to_hash.should == defaults.merge(data)
-      end
-      
-    end
-
-    it 'should send its contents to the gopher when saving' do
-      contents = {:bar => 'foo', :bam => 'fiz'}
-      file_path = stub_everything
-      gopher = stub 'Gopher', :load_from_path => contents
-      gopher.should_receive(:save).with(contents, file_path).once
-      gopher_class = stub 'Gopher Class', :new => gopher
-      secretary = Secretary.new file_path, {}, gopher_class
-      secretary.save
-    end
-    
-  end
-
-  describe 'using a default YAML gopher' do
-
-    describe 'updating itself based on what the gopher brings from its file path' do
-      
-      it 'have contents of its defaults merged with the file\'s data, when initialized' do
-        defaults = {'name' => '', 'port' => 80}
-        data = {'name' => 'Billy Bob', 'email' => 'xxx@yyy.zzz'}
-        file_path = File.dirname(__FILE__) + '/hash.yaml'
-        secretary = Secretary.new file_path, defaults
-        secretary.to_hash.should == defaults.merge(data)
-      end
-      
-      it 'have contents of its defaults only if its file does not yet exist, when initialized' do
-        defaults = {'name' => '', 'port' => 80}
-        file_path = File.dirname(__FILE__) + '/missing_file.yaml'
-        secretary = Secretary.new file_path, defaults
-        secretary.to_hash.should == defaults
-      end
-      
-    end
-    
-    describe 'when saving data' do
-      
-      it 'should create a new data file if it does not exist' do
-        defaults = {'name' => '', 'port' => 80}
-        data = {'name' => 'Billy Bob', 'email' => 'xxx@yyy.zzz'}
-        file_path = File.dirname(__FILE__) + '/temporary.yaml'
-        secretary = Secretary.new file_path, defaults
-        secretary.save
-        File.exists?(file_path).should be_true
-        File.delete file_path
-      end
-
-    end
-    
-  end
-  
-  describe 'when comparing with another object' do
-    
-    it 'should be equal if their file paths, defaults, and contents are equal' do
-      file_path = stub_everything
-      defaults = {:boo => 'bash'}
-      contents = {:boo => 'bam', :foo => 'bar'}
-      gopher = stub 'Gopher', :load_from_path => contents
-      gopher_class = stub 'Gopher Class', :new => gopher
-      secretary = Secretary.new file_path, defaults, gopher_class
-      other = stub 'Other', :file_path => file_path, :defaults => defaults,
-        :gopher => gopher, :to_hash => contents
-      secretary.to_hash.should == other.to_hash
-      secretary.should == other
-    end
-    
-    it 'should be unequal if their file paths are unequal' do
-      defaults = {:bash => 'bang', :bar => 'bing'}
-      gopher_class = stub 'Gopher Class', :new => stub('Gopher', :load_from_path => {})
-      secretary0 = Secretary.new stub_everything, defaults, gopher_class
-      secretary1 = Secretary.new stub_everything, defaults, gopher_class
-      secretary0.should_not == secretary1
-    end
-    
-    it 'should be unequal if their defaults are unequal' do
-      gopher_class = stub 'Gopher Class', :new => stub('Gopher', :load_from_path => {})
-      defaults0 = {:bash => 'bang', :bar => 'bing'}
-      defaults1 = {:bash => 'foo', :bar => 'bing'}
-      secretary0 = Secretary.new stub_everything, defaults0, gopher_class
-      secretary1 = Secretary.new stub_everything, defaults1, gopher_class
-      secretary0.should_not == secretary1
-    end
-    
-    it 'should be unequal if the other does not respond to :file_path' do
-      gopher_class = stub 'Gopher Class', :new => stub('Gopher', :load_from_path => {})
-      secretary = Secretary.new stub_everything, {}, gopher_class
-      other = stub 'Other'
-      secretary.should_not == other
-    end
-    
-    it 'should be unequal if the other does not respond to :gopher' do
-      gopher_class = stub 'Gopher Class', :new => stub('Gopher', :load_from_path => {})
-      secretary = Secretary.new stub_everything, {}, gopher_class
-      other = stub 'Other'
-      secretary.should_not == other
-    end
-    
-    it 'should be unequal if the other does not respond to :file_path' do
-      gopher_class = stub 'Gopher Class', :new => stub('Gopher', :load_from_path => {})
-      secretary = Secretary.new stub_everything, {}, gopher_class
-      other = stub 'Other'
-      secretary.should_not == other
-    end
-    
-  end
-  
-end