secretary 0.0.1 → 0.1.0

data/lib/secretary/gopher/yaml.rb

@@ -1,27 +1,21 @@
 require 'secretary/gopher'
 require 'yaml'
 
-class Secretary
+class Secretary::Gopher::YAML < Secretary::Gopher
+  @file_type = 'YAML'
   
-  class Gopher
-    
-    class YAML < Secretary::Gopher
-      @valid_file_type = 'YAML'
-      
-      def parse_file(file)
-        begin
-          return ::YAML::load(file)
-        rescue ArgumentError => parsing_error
-          raise Secretary::Error::Parsing.new(parsing_error, valid_file_type)
-        end
-      end
-      
-      def emit(data)
-        data.to_yaml
-      end
-      
+	protected
+	
+  def parse_file file
+    begin
+      return ::YAML::load(file)
+    rescue ArgumentError => parsing_error
+      raise Secretary::Error::Parsing.new(parsing_error, file_type)
     end
-    
+  end
+  
+  def emit data
+    data.to_yaml
   end
   
 end

data/spec/error_spec.rb

@@ -23,8 +23,9 @@ end
 describe Secretary::Error::InvalidData do
   
   it 'should have a message with the missing file\'s path' do
-    Secretary::Error::InvalidData.new([3, 2], Hash).to_s \
-      .should == 'preference file of invalid data type (should be Hash instead of Array)'
+    data = [3, 2]
+		Secretary::Error::InvalidData.new(data).to_s \
+      .should == "preference file contains invalid data (#{data.inspect})"
   end
   
 end

data/spec/gopher/yaml_spec.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'lib/secretary/gopher/yaml'
+
+describe Secretary::Gopher::YAML do
+  
+  it 'should be equal with another if they have equal classes' do
+    gopher0 = Secretary::Gopher::YAML.new
+    gopher1 = Secretary::Gopher::YAML.new
+    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
+    gopher1 = stub :kind_of? => true
+    gopher0.should_not == gopher1
+  end
+
+  it 'should know its file-type and it should be YAML' do
+    Secretary::Gopher::YAML.new.file_type.should == 'YAML'
+  end
+	
+	it 'should always make-raw any data into itself' do
+		gopher = Secretary::Gopher::YAML.new
+		data = stub 'Data'
+		gopher.raw(data).should == data
+	end
+	
+	it 'should always cook any data into itself' do
+		gopher = Secretary::Gopher::YAML.new
+		data = stub 'Data'
+		gopher.cook(data).should == data
+	end
+	
+	it 'should optionally take special custom options when initialized' do
+		options = stub 'Options'
+		gopher = Secretary::Gopher::YAML.new options
+		gopher.options.should == options
+	end
+	
+	describe 'when trying to save an object into a YAML file using a file path' do
+    
+    it 'should save a given Hash' do
+			gopher = Secretary::Gopher::YAML.new
+			data = {:name => 'Tracy', :url => 'http://tracy.name'}
+			file_path = relative_path '/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 Array' do
+			gopher = Secretary::Gopher::YAML.new
+			data = ['Tracy', 'http://tracy.name']
+			file_path = relative_path '/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 custom object' 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
+      file_path = relative_path '/temporary.yaml'
+      gopher.save data, file_path
+      open file_path do |file|
+        YAML::load(file).should == data
+      end
+      delete_if_exists file_path
+    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
+      lambda { gopher.load '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' do
+      preferences0 = {'name' => 'Billy Bob', 'email' => 'xxx@yyy.zzz'}
+      gopher = Secretary::Gopher::YAML.new
+      file_path = relative_path 'hash.yaml'
+      preferences1 = gopher.load(file_path)
+      preferences1.should == preferences0
+    end
+    
+    it 'should get the path\'s file\'s data when the file is YAML and that ' +
+				'data is an Array' do
+			data0 = ['Foo', 'Bar', 'Bam']
+      gopher = Secretary::Gopher::YAML.new
+      file_path = relative_path 'array.yaml'
+      data1 = gopher.load file_path
+      data1.should == data0
+    end
+    
+    it 'should raise an InvalidDataError when the path\'s file\'s is broken ' +
+				'YAML' do
+      gopher = Secretary::Gopher::YAML.new
+      file_path = relative_path 'broken-yaml.yaml'
+      lambda { gopher.load file_path } \
+        .should raise_error(Secretary::Error::Parsing)
+    end
+    
+  end
+
+end

data/spec/one-row.csv

@@ -0,0 +1 @@
+red,blue,yellow

data/spec/secretary.rb

@@ -0,0 +1,321 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'lib/secretary'
+
+describe Secretary do
+  
+	describe 'when storing a mapping' do
+
+		it 'should be enumerable' do
+			gopher = stub 'Gopher', :load => {}, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			file_path = stub 'File Path'
+			secretary = Secretary.new file_path, :gopher => gopher_class
+			secretary.should be_a_kind_of(Enumerable)
+		end
+		
+		it 'should know the file path it saves to' do
+			gopher = stub 'Gopher', :load => {}, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			file_path = stub 'File Path'
+			secretary = Secretary.new file_path, :gopher => gopher_class
+			secretary.file_path.should == file_path
+		end
+		
+		it 'should know its defaults' do
+			gopher = stub 'Gopher', :load => {}, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			secretary = Secretary.new stub_everything, :defaults => {'name' => ''},
+				:gopher => gopher_class
+			secretary.defaults.should == {'name' => ''}
+		end
+		
+		it 'should have an empty hash for its defaults by default' do
+			gopher = stub 'Gopher', :load => {}, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			secretary = Secretary.new stub_everything, :gopher => gopher_class
+			secretary.defaults.should == {}
+		end
+		
+		it 'should create a new gopher from the given gopher class' do
+			gopher = stub 'Gopher', :load => {}, :save => nil
+			gopher_class = mock 'Gopher Class'
+			gopher_class.should_receive(:new).and_return(gopher)
+			secretary = Secretary.new stub_everything, :gopher => gopher_class
+		end
+		
+		it 'should create a new YAML gopher by default' do
+			secretary = Secretary.new 'hash.yaml'
+			secretary.gopher.should be_a_kind_of(Secretary::Gopher::YAML)
+		end
+				
+		it 'should know its gopher' do
+			defaults = stub_everything
+			gopher = stub 'Gopher', :load => {}, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			secretary = Secretary.new stub_everything, :gopher => gopher_class
+		end
+		
+		it 'should be able to set its values' do
+			data = {'name' => 'Billy Bob'}
+			gopher = stub 'Gopher', :load => data, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			secretary = Secretary.new stub_everything, :gopher => 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 => data, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			secretary = Secretary.new stub_everything, :gopher => gopher_class
+			secretary.delete 'name'
+			secretary.should_not include('name')
+		end
+		
+		it 'should be able to update its values' do
+			data0 = {'name' => ''}
+			data1 = {'name' => 'Billy Bob'}
+			gopher = stub 'Gopher', :load => data0, :save => nil
+			gopher_class = stub 'Gopher Class', :new => gopher
+			secretary = Secretary.new stub_everything, :gopher => gopher_class
+			secretary.update data1
+			secretary.contents.should == data0.merge(data1)
+		end
+		
+		describe 'when accessing a key' do
+			
+			it 'should know the key\'s value' do
+				data = {'name' => 'Billy Bob'}
+				gopher = stub 'Gopher', :load => data, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new stub_everything, :gopher => 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 => data, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new stub_everything, :defaults => defaults,
+					:gopher => 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 => data, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new stub_everything, :defaults => defaults,
+					:gopher => 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 => 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, :save => nil
+				lambda { Secretary.new stub_everything, :gopher => gopher_class } \
+					.should raise_error(ArgumentError)
+			end
+
+			it 'should give its options given to its gopher, sans :gopher and ' +
+					':defaults values' do
+				gopher = stub 'Gopher', :load => {}, :save => nil
+				options = stub 'Options'
+				gopher_class = mock 'Gopher Class'
+				gopher_class.should_receive(:new).with(options).and_return(gopher)
+				options.stub!(:delete).with(:gopher).and_return(gopher_class)
+				options.stub!(:delete).with(:defaults).and_return(nil)
+				secretary = Secretary.new stub_everything, options
+			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 => data, :save => nil
+					gopher_class = stub 'Gopher Class', :new => gopher
+					secretary = Secretary.new stub_everything, :defaults => defaults,
+						:gopher => gopher_class
+					secretary.contents.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', :save => nil
+					gopher.stub!(:load).and_raise(
+						Secretary::Error::MissingFile.new(stub_everything)
+					)
+					gopher_class = stub 'Gopher Class', :new => gopher
+					secretary = Secretary.new stub_everything, :defaults => defaults,
+						:gopher => gopher_class
+					secretary.contents.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', :save => nil
+					gopher.stub!(:load).and_return({}, data)
+					gopher_class = stub 'Gopher Class', :new => gopher
+					secretary = Secretary.new stub_everything, :defaults => defaults,
+						:gopher => gopher_class
+					secretary.reload!
+					secretary.contents.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 => contents
+				gopher.should_receive(:save).with(contents, file_path).once
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new file_path, :gopher => 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 = relative_path 'hash.yaml'
+					secretary = Secretary.new file_path, :defaults => defaults
+					secretary.contents.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 = relative_path 'missing_file.yaml'
+					secretary = Secretary.new file_path, :defaults => defaults
+					secretary.contents.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 = relative_path 'temporary.yaml'
+					secretary = Secretary.new file_path, :defaults => defaults
+					secretary.save
+					File.exists?(file_path).should be_true
+					File.delete file_path
+				end
+
+				it 'should save data in the file that can be retrieved' do
+					defaults = {'name' => '', 'port' => 80}
+					data0 = {'name' => 'Billy Bob', 'email' => 'xxx@yyy.zzz'}
+					file_path = relative_path 'temporary.yaml'
+					secretary0 = Secretary.new file_path, :defaults => defaults
+					secretary1 = Secretary.new file_path, :defaults => defaults
+					secretary0.update data0
+					data1 = secretary0.contents
+					secretary0.save
+					secretary1.reload!
+					secretary1.contents.should == data1
+				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 => contents, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new file_path, :defaults => defaults,
+					:gopher => gopher_class
+				other = stub 'Other', :file_path => file_path, :defaults => defaults,
+					:gopher => gopher, :contents => contents
+				secretary.should == other
+			end
+			
+			it 'should be unequal if their file paths are unequal' do
+				defaults = {:bash => 'bang', :bar => 'bing'}
+				gopher = stub 'Gopher', :load => {}, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary0 = Secretary.new stub_everything, :gopher => gopher_class
+				secretary1 = Secretary.new stub_everything, :gopher => gopher_class
+				secretary0.should_not == secretary1
+			end
+			
+			it 'should be unequal if their defaults are unequal' do
+				gopher = stub 'Gopher', :load => {}, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				defaults0 = {:bash => 'bang', :bar => 'bing'}
+				defaults1 = {:bash => 'foo', :bar => 'bing'}
+				secretary0 = Secretary.new stub_everything, :defaults => defaults0,
+					:gopher => gopher_class
+				secretary1 = Secretary.new stub_everything, :defaults => defaults1,
+					:gopher => gopher_class
+				secretary0.should_not == secretary1
+			end
+			
+			it 'should be unequal if the other does not respond to :file_path' do
+				gopher = stub 'Gopher', :load => {}, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new stub_everything, :gopher => gopher_class
+				other = stub 'Other'
+				secretary.should_not == other
+			end
+			
+			it 'should be unequal if the other does not respond to :gopher' do
+				gopher = stub 'Gopher', :load => {}, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new stub_everything, :gopher => 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 = stub 'Gopher', :load => {}, :save => nil
+				gopher_class = stub 'Gopher Class', :new => gopher
+				secretary = Secretary.new stub_everything, :gopher => gopher_class
+				other = stub 'Other'
+				secretary.should_not == other
+			end
+			
+		end
+		
+	end
+  
+end