obsidian 0.0.1 → 0.0.2

data/Manifest.txt

@@ -4,6 +4,12 @@ README.txt
 Rakefile
 lib/obsidian.rb
 lib/obsidian/rails/model_update_tracker.rb
+lib/obsidian/spec.rb
+lib/obsidian/spec/map_spec_helper.rb
+lib/obsidian/spec/set_spec_helper.rb
 test/obsidian_test.rb
 test/test_helper.rb
-test/obsidian/rails/model_update_tracker_test.rb
+test/units/obsidian/rails/model_update_tracker_test.rb
+test/units/obsidian/spec_test.rb
+test/units/obsidian/spec/map_spec_helper_test.rb
+test/units/obsidian/spec/set_spec_helper_test.rb

data/lib/obsidian.rb

@@ -1,3 +1,3 @@
 module Obsidian
-  VERSION = '0.0.1'
-end
+  VERSION = '0.0.2'
+end

data/lib/obsidian/spec.rb

@@ -0,0 +1,32 @@
+require 'test/spec'
+
+module Obsidian
+  module Spec     
+    include Test::Unit::Assertions
+    def args_to_set(*args)
+      if args.size == 1
+        args.first.respond_to?(:to_set) ? args.first.to_set : Set.new([args.first])
+      else
+        args.to_set
+      end
+    end 
+    
+    # find the line in a stack trace above the one from method_name                     
+    def find_calling_line(trace, method_name)
+      trace.each_cons(2) do |line, next_line|
+        if /(.*):(\d+):in .(.*)'/ =~ line && 
+           $3 == method_name &&
+           /(.*):(\d+):in .(.*)'/ =~ next_line
+          return [$1,$2]
+        end
+      end
+      nil
+    end
+    
+    def read_calling_line(trace, method_name)
+      file, line_number = find_calling_line(trace, method_name)
+      File.readlines(file)[Integer(line_number) - 1].chop.strip if file
+    end   
+
+  end
+end

data/lib/obsidian/spec/map_spec_helper.rb

@@ -0,0 +1,48 @@
+require 'obsidian/spec'
+
+module Obsidian
+  module Spec 
+    class MappingMatcher
+      include Obsidian::Spec
+      def initialize(object)
+        @object = object.to_set  
+      end        
+      def map
+        self
+      end
+      def to(*args, &blk)
+        case args.size
+        when 0 then self
+        when 1 then  test("to", args.first, &blk)
+        else raise ArgumentError, "wrong number of arguments (#{args.size} for 0-1)"
+        end
+      end   
+      # for map.to.values.in 
+      def values
+        self
+      end
+      def in(*other, &blk)
+        test("in", *other, &blk)
+      end
+      def test(method, *other, &blk)
+        other = args_to_set(*other)
+        @object.each do |obj|
+          assert(other.include?(blk.call(obj)), 
+                 "Expected #{obj} to map to #{error_message(other)} at\n\t#{read_calling_line(caller,method)}")
+        end
+      end
+      def error_message(set)
+        (set.size == 1 ? set.to_a.first : set).inspect
+      end
+    end
+  end
+end
+
+class Test::Spec::Should
+  def all
+    Obsidian::Spec::MappingMatcher.new(@object)
+  end   
+  def map
+    Obsidian::Spec::MappingMatcher.new(@object)
+  end   
+end

data/lib/obsidian/spec/set_spec_helper.rb

@@ -0,0 +1,40 @@
+require 'obsidian/spec'
+require 'set'
+
+def Set(*args)
+  Set.new(args)
+end           
+
+module Obsidian
+  module Spec 
+    class SubsetMatcher
+      include Obsidian::Spec
+      def initialize(object) 
+        @object = object.to_set
+      end  
+      def of(*other)
+        other = args_to_set(*other)
+        assert(@object.proper_subset?(other) || @object==other, "Expected #{@object.inspect} to be a subset of #{other.inspect}")
+      end
+    end
+    class SupersetMatcher
+      include Obsidian::Spec
+      def initialize(object)
+        @object = object.to_set
+      end           
+      def of(*other)
+        other = args_to_set(*other)
+        assert(@object.proper_superset?(other) || @object==other, "Expected #{@object.inspect} to be a superset of #{other.inspect}")
+      end
+    end
+  end
+end
+
+class Test::Spec::Should
+  def subset
+    Obsidian::Spec::SubsetMatcher.new(@object)
+  end   
+  def superset
+    Obsidian::Spec::SupersetMatcher.new(@object)
+  end
+end

data/test/units/obsidian/rails/model_update_tracker_test.rb

@@ -0,0 +1,126 @@
+require File.join(File.dirname(__FILE__), "../../..", "test_helper.rb")
+require 'obsidian/rails/model_update_tracker'
+include Obsidian::Rails::ModelUpdateTracker
+
+describe "ModelUpdateTracker" do
+  describe "Delta" do
+    it "adds uncommitted objects with <<" do
+      delta = Delta.new
+      delta << "Foo"
+      delta.uncommitted.should == ["Foo"]
+    end     
+    
+    it "moves uncommitted objects to committed on commit" do
+      delta = Delta.new
+      delta << "Foo"
+      delta.transaction_committed
+      delta << "Bar"
+      delta.transaction_committed
+      delta << "Quux"
+      delta.committed.should == ["Foo", "Bar"]
+      delta.uncommitted.should == ["Quux"]
+    end
+
+    it "moves uncommitted objects to committed on rollback" do
+      delta = Delta.new
+      delta << "Foo"
+      delta.transaction_rolled_back
+      delta.committed.should == []
+      delta.uncommitted.should == []
+    end                             
+    
+    it "gathers both committed and uncommitted changes into instances" do
+      delta = Delta.new
+      delta.committed = ["Foo"]
+      delta.uncommitted = ["Bar"]
+      delta.instances.should == ["Foo", "Bar"]
+    end       
+    
+    it "gathers the class names of modified instances" do
+      delta = Delta.new
+      delta.committed = ["String"]
+      delta.uncommitted = [10]
+      delta.class_names.should == Set.new(["Fixnum", "String"])
+    end
+  end
+  
+  before do
+    @tracker = Obsidian::Rails::ModelUpdateTracker 
+    @tracker.reset
+  end
+  
+  it "reset clears all the deltas" do
+    @tracker.after_create("Foo")
+    @tracker.after_update("Bar")
+    @tracker.after_destroy("Quux")
+    @tracker.reset
+    @tracker.created_delta.instances.should == []
+    @tracker.updated_delta.instances.should == []
+    @tracker.destroyed_delta.instances.should == []
+  end
+  
+  describe "Data access callbacks" do
+    before do
+      @tracker = Obsidian::Rails::ModelUpdateTracker 
+      @tracker.reset
+    end
+
+    it "after_create bumps the created_delta" do
+      @tracker.after_create("Foo")
+      @tracker.created_delta.instances.should == ["Foo"]
+      @tracker.updated_delta.instances.should == []
+      @tracker.destroyed_delta.instances.should == []
+    end
+
+    it "after_update bumps the updated_delta" do
+      @tracker.after_update("Foo")
+      @tracker.created_delta.instances.should == []
+      @tracker.updated_delta.instances.should == ["Foo"]
+      @tracker.destroyed_delta.instances.should == []
+    end
+
+    it "after_destroyed bumps the destroyed_delta" do
+      @tracker.after_destroy("Foo")
+      @tracker.created_delta.instances.should == []
+      @tracker.updated_delta.instances.should == []
+      @tracker.destroyed_delta.instances.should == ["Foo"]
+    end
+  end
+
+  describe "Transaction callbacks" do
+    before do
+      @tracker = Obsidian::Rails::ModelUpdateTracker 
+      @tracker.reset
+    end
+
+    it "after_transaction_commit commits all the deltas" do
+      @tracker.after_create("Foo")
+      @tracker.after_update("Bar")
+      @tracker.after_destroy("Quux")
+      @tracker.after_transaction_commit
+      @tracker.created_delta.committed.should == ["Foo"]
+      @tracker.updated_delta.committed.should == ["Bar"]
+      @tracker.destroyed_delta.committed.should == ["Quux"]
+    end
+
+    it "after_transaction_rollback rolls back all the deltas" do
+      @tracker.after_create("Foo")
+      @tracker.after_update("Bar")
+      @tracker.after_destroy("Quux")
+      @tracker.after_transaction_rollback
+      @tracker.created_delta.instances.should == []
+      @tracker.updated_delta.instances.should == []
+      @tracker.destroyed_delta.instances.should == []
+    end
+
+    it "after_transaction_exception rolls back all the deltas" do
+      @tracker.after_create("Foo")
+      @tracker.after_update("Bar")
+      @tracker.after_destroy("Quux")
+      @tracker.after_transaction_exception
+      @tracker.created_delta.instances.should == []
+      @tracker.updated_delta.instances.should == []
+      @tracker.destroyed_delta.instances.should == []
+    end
+  end
+end

data/test/units/obsidian/spec/map_spec_helper_test.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), "../../..", "test_helper.rb")
+require 'obsidian/spec/map_spec_helper'
+          
+describe "to" do
+  it "should reject wrong number of arguments" do
+    m = Obsidian::Spec::MappingMatcher.new([1])
+    lambda{m.to(1,2)}.should.raise(ArgumentError)
+  end
+end
+
+describe "should.map.to" do
+
+  it "should be able to check agains single values" do 
+    [1,2,3].should.all.map.to(true) {|item| item < 10}
+  end
+
+  it "should give a great error message" do 
+    err = lambda{[1,12,3].should.all.map.to(true) {|item| item < 10}}.should.raise(Test::Unit::AssertionFailedError)
+    err.message.should == <<-END.chop
+Expected 12 to map to true at
+\terr = lambda{[1,12,3].should.all.map.to(true) {|item| item < 10}}.should.raise(Test::Unit::AssertionFailedError).
+<false> is not true.
+END
+  end
+
+end
+
+describe "should.be.in" do
+
+  it "should be able check against multiple values" do 
+    [1,2,3].should.map.to.values.in(2,4,6) {|item| item * 2}
+  end
+
+  it "should not care about order" do 
+    [1,2,3].should.map.to.values.in(6,4,2) {|item| item * 2}
+  end
+
+  it "should give a great error message" do
+    err = lambda{[1,2,3].should.map.to.values.in(2,4) {|item| item * 2}}.should.raise(Test::Unit::AssertionFailedError)
+    err.message.should == <<-END.chop
+Expected 3 to map to #<Set: {2, 4}> at
+\terr = lambda{[1,2,3].should.map.to.values.in(2,4) {|item| item * 2}}.should.raise(Test::Unit::AssertionFailedError).
+<false> is not true.
+END
+  end
+  
+end

data/test/units/obsidian/spec/set_spec_helper_test.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "../../..", "test_helper.rb")
+require 'obsidian/spec/set_spec_helper'
+
+describe "Set extensions for spec" do
+  it "Set acts as a constructor function to approximate a literal syntax for sets" do
+    Set(1,2,3).should == Set.new([1,2,3])  
+  end
+end
+
+describe "should.be.subset.of" do
+  it "succeeds for subset" do
+    [1,2].should.be.subset.of([1,2,3])
+  end
+  
+  it "succeeds for equal set" do
+    (1..3).should.be.subset.of([1,2,3])
+  end
+
+  it "will splat args for convenience" do
+    (1..3).should.be.subset.of(1,2,3)
+  end
+  
+  it "fails for non-subset" do
+    err = lambda{Set(0,5).should.be.subset.of([1,2,3])}.should.raise(Test::Unit::AssertionFailedError)
+    err.message.should == "Expected #<Set: {5, 0}> to be a subset of #<Set: {1, 2, 3}>.\n<false> is not true."
+  end
+end
+
+describe "should.be.superset.of" do
+  it "succeeds for superset" do
+    [1,2,3].should.be.superset.of([1,2])
+  end
+  
+  it "succeeds for equal set" do
+    (1..3).should.be.superset.of([1,2,3])
+  end
+
+  it "will splat args for convenience" do
+    (1..3).should.be.superset.of(1,2,3)
+  end
+  
+  it "fails for non-superset" do
+    err = lambda {Set(1,2).should.be.superset.of([1,2,3])}.should.raise(Test::Unit::AssertionFailedError)
+    err.message.should == "Expected #<Set: {1, 2}> to be a superset of #<Set: {1, 2, 3}>.\n<false> is not true."
+  end
+end

data/test/units/obsidian/spec_test.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), "../..", "test_helper.rb")
+require 'obsidian/spec'
+include Obsidian::Spec
+
+describe "Obsidian::Spec args_to_set" do
+  it "can convert a single scalar to a set" do
+    args_to_set(:scalar).should == Set.new([:scalar])
+  end
+
+  it "can convert a single collection to a set" do
+    args_to_set([:a, :b]).should == Set.new([:a, :b])
+  end
+
+  it "can convert multiple scalars to a set" do
+    args_to_set(:a, :b).should == Set.new([:a, :b])
+  end     
+end
+
+describe "Obsidian::Spec find_calling_line" do
+  def nest_2(name)
+    find_calling_line(caller, name)
+  end  
+  def nest_1(name)
+    nest_2(name)
+  end  
+  it "can parse a stack trace to find the caller of a method" do  
+    file, line_no = nest_1("nest_1")   
+    file.should.match %r{spec_test.rb$} 
+    line_no.should.match /^\d+$/
+  end
+  it "returns nil if a method does not exist" do  
+    file, line_no = nest_1("not_a_real_method_name")
+    file.should.be nil
+    line_no.should.be nil
+  end
+end
+
+describe "Obsidian::Spec read_calling_line" do
+  def nest_2(name)   
+    read_calling_line(caller, name)
+  end  
+  def nest_1(name)
+    nest_2(name)
+  end  
+  it "can parse a stack trace to find the caller of a method" do  
+    nest_1("nest_1").should.match /nest_1\("nest_1"\)/
+  end
+  it "returns nil if a method does not exist" do  
+    nest_1("not_a_real_method_name").should.be nil
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: obsidian
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-04 00:00:00 -04:00
+date: 2008-04-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,9 +38,15 @@ files:
 - Rakefile
 - lib/obsidian.rb
 - lib/obsidian/rails/model_update_tracker.rb
+- lib/obsidian/spec.rb
+- lib/obsidian/spec/map_spec_helper.rb
+- lib/obsidian/spec/set_spec_helper.rb
 - test/obsidian_test.rb
 - test/test_helper.rb
-- test/obsidian/rails/model_update_tracker_test.rb
+- test/units/obsidian/rails/model_update_tracker_test.rb
+- test/units/obsidian/spec_test.rb
+- test/units/obsidian/spec/map_spec_helper_test.rb
+- test/units/obsidian/spec/set_spec_helper_test.rb
 has_rdoc: true
 homepage: http://opensource.thinkrelevance.com
 post_install_message: 

data/test/obsidian/rails/model_update_tracker_test.rb

@@ -1,50 +0,0 @@
-require File.join(File.dirname(__FILE__), "../..", "test_helper.rb")
-require 'obsidian/rails/model_update_tracker'
-include Obsidian::Rails::ModelUpdateTracker
-
-describe "ModelUpdateTracker" do
-  describe "Runtime" do
-    xit "Raises an error if anything but test environment is running" 
-  end
-
-  describe "Delta" do
-    it "adds uncommitted objects with <<" do
-      delta = Delta.new
-      delta << "Foo"
-      delta.uncommitted.should == ["Foo"]
-    end     
-    
-    it "moves uncommitted objects to committed on commit" do
-      delta = Delta.new
-      delta << "Foo"
-      delta.transaction_committed
-      delta << "Bar"
-      delta.transaction_committed
-      delta << "Quux"
-      delta.committed.should == ["Foo", "Bar"]
-      delta.uncommitted.should == ["Quux"]
-    end
-
-    it "moves uncommitted objects to committed on rollback" do
-      delta = Delta.new
-      delta << "Foo"
-      delta.transaction_rolled_back
-      delta.committed.should == []
-      delta.uncommitted.should == []
-    end                             
-    
-    it "gathers both committed and uncommitted changes into instances" do
-      delta = Delta.new
-      delta.committed = ["Foo"]
-      delta.uncommitted = ["Bar"]
-      delta.instances.should == ["Foo", "Bar"]
-    end       
-    
-    it "gathers the class names of modified instances" do
-      delta = Delta.new
-      delta.committed = ["String"]
-      delta.uncommitted = [10]
-      delta.class_names.should == Set.new(["Fixnum", "String"])
-    end
-  end
-end