ygg 0.0.2 → 1.0.6

data/spec/ygg/ygg_spec.rb

@@ -0,0 +1,364 @@
+require "spec_helper"
+
+describe Ygg do
+
+  # Helpers, helpers, helpers
+  def warrant_me_that_does_not_exist(full_path)
+    File.should_not exist(full_path)
+  end
+  def unavailable_resource_raises_with(*args)
+    expect { Ygg.ygg *args
+    }.to raise_error( 
+      Ygg::UnavailableResourceException,
+      "No resource was found in #{non_existent_full_path}" )
+  end
+  def no_interaction_done
+    Ygg.reset
+    expect { Ygg.events.should be_empty
+    }.to raise_error(
+      Ygg::NoInteractionDoneException,
+      "No events to load in the log." )
+  end
+  def do_demo_interaction(*args)
+    if args.empty?
+      return Ygg.ygg full_base_path, valid_file_identifier
+    else 
+      return Ygg.ygg *args
+    end
+  end
+  def demo_user
+    user = YggDemo::User.new
+    user.name = "Jane Eyre"
+    user
+  end
+  def do_interaction_with_block(*args)
+    args << full_base_path << valid_file_identifier if args.empty?
+    Ygg.ygg(*args) do
+      Ygg.add demo_user
+    end
+  end
+  def is_valid_resource?(path)
+    File.should exist(path)
+    content = File.read(path)
+    content.should include("- !ruby/object:")
+  end 
+  def reset_valid_file
+    File.open valid_full_path, "w" do |file|
+      file.write [demo_user].to_yaml
+    end
+  end
+  
+  describe ".base_dir" do
+    context "no interaction done" do
+      it "should be empty" do
+        no_interaction_done
+        Ygg.base_dir.should == "."
+      end
+    end
+    
+    context "base dir setted" do
+      it "should return a valid path" do
+        do_demo_interaction
+        Dir.should exist(Ygg.base_dir)
+      end
+    end
+  end
+  
+  describe ".ygg" do
+    before :each do
+      Ygg.base_dir = "."
+      is_valid_resource? valid_full_path
+    end
+    
+    after :each do
+      File.unlink to_create_full_path if File.exists? to_create_full_path
+    end
+    
+    context "called with no arguments" do
+      it "should return the Ygg module constant" do
+        Ygg.ygg.should be(Ygg)
+      end
+    end
+    
+    context "called with a symbol argument" do
+      before :each do
+        Ygg.base_dir = full_base_path
+      end
+      
+      it "should fail if no resource available" do
+        warrant_me_that_does_not_exist non_existent_full_path
+        unavailable_resource_raises_with non_existent_file_identifier
+      end
+      
+      it "should return a bundle of data" do
+        data_bundle = do_demo_interaction valid_file_identifier
+        data_bundle.should_not be_empty
+      end
+    end
+    
+    context "called with a path argument" do
+      it "should fail if no resource available" do
+        warrant_me_that_does_not_exist non_existent_full_path
+        unavailable_resource_raises_with non_existent_full_path
+      end
+      
+      it "should return a bundle of data" do
+        data_bundle = do_demo_interaction valid_full_path
+        data_bundle.should_not be_empty
+      end
+    end
+    
+    context "called with two arguments" do
+      it "should fail if no resource available" do
+        warrant_me_that_does_not_exist non_existent_full_path
+        unavailable_resource_raises_with full_base_path, non_existent_file_identifier
+      end
+      
+      it "should setup the base directory" do
+        do_demo_interaction 
+        Ygg.base_dir.should == full_base_path
+      end
+
+      it "should return a bundle of data" do
+        data_bundle = do_demo_interaction full_base_path, valid_file_identifier
+        data_bundle.should_not be_empty
+      end
+    end
+
+    context "called with an argument and a block" do
+      context "inexistent resource" do
+        it "should be created" do
+          warrant_me_that_does_not_exist to_create_full_path
+          do_interaction_with_block to_create_full_path
+          is_valid_resource? to_create_full_path
+        end
+      end
+
+      context "existent resource" do
+        it "should have its modification date changed" do
+          is_valid_resource? to_modify_full_path
+          original_mtime = File.mtime to_modify_full_path
+          do_interaction_with_block to_modify_full_path
+          original_mtime.should_not == File.mtime(to_modify_full_path)
+        end
+      end
+    end
+
+    context "called with two arguments and a block" do
+      context "inexistent resource" do
+        it "should be created" do
+          warrant_me_that_does_not_exist to_create_full_path
+          do_interaction_with_block full_base_path, to_create_file_identifier
+          is_valid_resource? to_create_full_path
+        end
+      end
+
+      context "existent resource" do
+        it "should have its modification date changed" do
+          is_valid_resource? to_modify_2_full_path
+          original_mtime = File.mtime to_modify_2_full_path
+          do_interaction_with_block full_base_path, to_modify_2_file_identifier
+          original_mtime.should_not == File.mtime(to_modify_2_full_path)
+        end
+      end
+    end
+  end
+
+  describe ".add" do
+    it "should fail when no argument is passed" do
+      expect { Ygg.add }.to raise_error( ArgumentError )
+    end
+
+    context "no previous activity" do
+      it "should fail for no resource was found" do
+        no_interaction_done
+        expect { Ygg.add demo_user
+        }.to raise_error(
+          Ygg::UnavailableResourceException,
+          "No resource was loaded, impossible to add the object" )
+      end
+    end
+
+    context "block session" do
+      it "should initialize records" do
+        Ygg.reset
+        do_interaction_with_block
+        Ygg.records.should_not be_empty
+      end
+      
+      it "should increment the resource size by 1" do
+        expect { do_interaction_with_block
+        }.to change { Ygg.records.length }.by(1)
+      end
+
+      it "should be the same the element passed and the last" do
+        user = YggDemo::User.new
+        user.name = "Ximena Krius"
+        Ygg.ygg valid_full_path do 
+          Ygg.add user
+          Ygg.records.last.should be(user)
+        end
+      end
+
+      it "should be present on the saved file" do
+        user = YggDemo::User.new
+        user.name = "Xandria Ymanus"
+        Ygg.ygg valid_full_path do
+          Ygg.add user
+        end
+        File.read(valid_full_path).should include(user.to_yaml[6,15])
+      end
+    end
+
+    context "closed session" do
+      it "should increment the last resource size by 1" do
+        no_interaction_done
+        do_demo_interaction
+        user = YggDemo::User.new
+        user.name = "Yvonna Malygas"
+        expect { Ygg.add user
+        }.to change { Ygg.records.length }.by(1)
+      end
+
+      it "should be the same the element passed and the last" do
+        do_demo_interaction
+        user = demo_user
+        Ygg.add user
+        Ygg.records.last.should be(user)
+      end
+
+      it "should not be present on the resource file" do
+        do_demo_interaction
+        user = YggDemo::User.new 
+        user.name = "Nemo Anonymous"
+        Ygg.add user
+        File.read(valid_full_path)
+          .should_not include(user.to_yaml[6,35])
+      end
+    end
+  end
+
+  describe ".save" do
+    it "should fail if no resource is available"
+    
+    it "should create the resource if doesn't exist"
+    
+    it "should be written in the file the last inserted data"
+  end
+  
+  describe ".records" do
+    context "no previous activity" do
+      it "should fail for no resource was found" do
+        no_interaction_done
+        expect { Ygg.records
+        }.to raise_error(
+          Ygg::NoInteractionDoneException,
+          "No events to load in the log." )
+      end
+    end    
+    
+    context "transaction done and closed" do
+      it "should return some data" do
+        do_interaction_with_block
+        Ygg.records.should_not be_empty
+      end
+    end
+  end
+  
+  describe ".path_to" do
+    it "should fail when no argument is passed" do
+      expect { Ygg.path_to
+      }.to raise_error( ArgumentError )
+    end
+    
+    context "symbol argument" do
+      it "should return combination of base_dir and the argument" do
+        no_interaction_done
+        Ygg.base_dir = full_base_path
+        Ygg.path_to(:resource).should == "#{full_base_path}/resource.ygg"
+      end
+    end
+    
+    context "string argument" do
+      it "should return the same string" do
+        Ygg.path_to("some/path").should == "some/path"
+      end
+    end
+  end
+  
+  describe ".resource" do
+    context "out of block" do
+      def fail_resource_fail!
+        expect { Ygg.resource
+        }.to raise_error(
+          Ygg::OutOfBlockException,
+          "The resource is not available outside an ygg block." )
+      end
+      
+      it "should fail when no session is opened" do
+        fail_resource_fail!
+      end
+      
+      it "should fail after a block was used" do
+        do_interaction_with_block
+        fail_resource_fail!
+      end
+    end
+  
+    context "no arguments passed" do
+      it "should return the current session" do
+        Ygg.ygg valid_full_path do
+          Ygg.resource.should be( Ygg.events.last )
+        end
+      end
+    end
+    
+    context ":path required" do
+      it "should return the current resource path" do
+        Ygg.ygg valid_full_path do
+          Ygg.resource(:path).should == valid_full_path
+        end
+      end
+    end
+  end
+  
+  describe ".events" do
+    context "ygg has done nothing yet" do
+      it "should fail" do
+        no_interaction_done
+        expect { Ygg.events 
+        }.to raise_error(
+          Ygg::NoInteractionDoneException,
+          "No events to load in the log.")
+      end
+    end
+    
+    context "ygg had one interaction" do
+      it "should return an array with at least one session" do
+        do_demo_interaction
+        Ygg.events.first.should be_a(Ygg::Session)
+      end
+    end
+  end
+  
+  describe ".reset" do
+    before :each do 
+      Ygg.reset
+    end
+    
+    it "should set base_dir as '.'" do
+      Ygg.base_dir.should == "."
+    end
+    
+    it "should make events empty" do
+      expect { Ygg.events 
+      }.to raise_error(
+        Ygg::NoInteractionDoneException,
+        "No events to load in the log.")
+    end
+  end
+
+  after :all do
+    reset_valid_file
+  end
+end

data/ygg.gemspec

@@ -12,6 +12,11 @@ Gem::Specification.new do |s|
   s.summary     = %q{Pure Ruby persistence solution}
   s.description = %q{Pure Ruby persistence solution}
 
+  s.add_dependency "metafun"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "cucumber"
+  
   s.rubyforge_project = "ygg"
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ygg
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-03 00:00:00.000000000 -03:00
+date: 2011-09-04 00:00:00.000000000 -03:00
 default_executable: 
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: metafun
+  requirement: &21890304 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21890304
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22215888 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22215888
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &22441776 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22441776
 description: Pure Ruby persistence solution
 email:
 - xavierviacanel@gmail.com
@@ -23,9 +56,39 @@ files:
 - Gemfile
 - README.rdoc
 - Rakefile
+- emulations/samples/event.ygg
+- emulations/samples/invalid_resource.ygg
+- emulations/samples/to_modify.ygg
+- emulations/samples/to_modify_2.ygg
+- emulations/samples/user.ygg
+- emulations/samples/valid.ygg
+- emulations/save_yaml_object.rb
+- emulations/tree.ygg
+- features/accessors.feature
+- features/dsl.feature
+- features/events.feature
+- features/simple_record.feature
+- features/steps/accessors.rb
+- features/steps/dsl.rb
+- features/steps/events.rb
+- features/steps/simple_record.rb
+- features/support/env.rb
+- features/support/hooks.rb
 - lib/ygg.rb
-- lib/ygg/base.rb
+- lib/ygg/bck/base.rb
+- lib/ygg/bck/branch.rb
+- lib/ygg/bck/exceptions.rb
+- lib/ygg/bck/link.rb
+- lib/ygg/bck/model.rb
+- lib/ygg/databundle.rb
+- lib/ygg/exceptions.rb
+- lib/ygg/record.rb
+- lib/ygg/session.rb
 - lib/ygg/version.rb
+- spec/spec_helper.rb
+- spec/ygg/databundle_spec.rb
+- spec/ygg/session_spec.rb
+- spec/ygg/ygg_spec.rb
 - ygg.gemspec
 has_rdoc: true
 homepage: ''