relevance-obsidian 0.0.5

data/History.txt

@@ -0,0 +1,11 @@
+2008-10-30
+  * Added Object#try
+  * Added meta extensions from Why
+  
+2008-04-11
+  * Updated documentation in README
+
+2008-03-28
+  * Added model_update_tracker
+  * Added example rails applicaion in branch example
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Relevance, Inc.
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+LICENSE
+Manifest.txt
+README.rdoc
+README.txt
+Rakefile
+lib/obsidian.rb
+lib/obsidian/extensions/object.rb
+lib/obsidian/extensions/try.rb
+lib/obsidian/rails/helper_test.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
+obsidian.gemspec
+test/obsidian_test.rb
+test/test_helper.rb
+test/units/obsidian/object_extensions_test.rb
+test/units/obsidian/rails/model_update_tracker_test.rb
+test/units/obsidian/spec/map_spec_helper_test.rb
+test/units/obsidian/spec/set_spec_helper_test.rb
+test/units/obsidian/spec_test.rb
+test/units/obsidian/try_test.rb

data/README.rdoc

@@ -0,0 +1,96 @@
+= Obsidian
+
+== DESCRIPTION
+
+Obsidian. It's metastable. 
+
+In the tangible world, obsidian is a naturally-occurring glass that is metastable at the earth's
+surface. It's commonly found within the margins of rhyolitic lava flows, where cooling of the lava is
+rapid. [1] In the slightly less tangible world of programming, <b>Obsidian</b> is home to chunks of
+Ruby code that we've found helpful. These bits of code are often found at the bottom of a mountain of
+yak hair, the occasionally-occurring product of simplifying various tasks.
+
+  1 http://en.wikipedia.org/wiki/Obsidian
+
+== FEATURES
+
+=== Model Update Tracker
+This library allows you to functionally test updates to models with clearer and more focused intent.
+It forces you to have a better understanding of how your objects interact and lets you demonstrate 
+that knowledge by specifying it in your tests.  For example, consider the following test which asserts
+that the code block persists an Asset record.  
+
+  assert_difference Asset :count do
+    post :create, :asset => {}
+  end
+
+Is it okay if the code block also persists a Location record? An AssetOwner record? Some other record?
+Chances are that the developer knows the answer to this question, but the test fails to capture that
+knowledge. Side effects matter, and our tests should adequately validate that the desired side effects
+(and <i>only</i> the desired side effects) are taking place. In the example below, assert_models_created
+allows us to validate that an Asset is created <i>and</i> that no other objects are inadvertently
+persisted.
+
+  assert_models_created(Asset) do
+    post :create, :asset => {}
+  end
+
+If the code block happened to create records other than just an Asset, a friendly test failure would let
+you know right away.
+
+Suppose, on the other hand, that you expect the creation of an Asset to <i>also</i> produce an AssetOwner
+and a Location. This is where you exercise your deep domain knowledge muscles and make your new
+Obsidian-powered test express and validate your intent.
+
+  assert_models_created(Asset, AssetOwner, Location) do
+    post: create, :asset => {}
+  end
+
+Now, if your code block fails to create the expected records, the above test would fail stating that it
+expected more to happen. If future changes to your code cause things to fall out of place, this test will
+catch that regression where the original assert_difference may not. In addition to assert_models_created,
+Model Update Tracker provides a whole host of other methods that provide similar functionality for
+asserting behavior related to updates, deletes, or even validating that nothing happened.
+
+* assert_models_created(models)
+* assert_models_updated(models)
+* assert_models_destroyed(models)
+* assert_no_models_created
+* assert_no_models_destroyed
+* assert_no_models_updated
+
+== INSTALL
+
+  sudo gem install obsidian
+
+== URLS
+
+* Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/obsidian
+* View Source: http://github.com/relevance/obsidian/tree/master
+* Git clone Source: git://github.com/relevance/obsidian.git
+* RDocs: http://thinkrelevance.rubyforge.org/obsidian/
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2008 Relevance, Inc. - http://thinkrelevance.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.txt

@@ -0,0 +1,96 @@
+= Obsidian
+
+== DESCRIPTION
+
+Obsidian. It's metastable. 
+
+In the tangible world, obsidian is a naturally-occurring glass that is metastable at the earth's
+surface. It's commonly found within the margins of rhyolitic lava flows, where cooling of the lava is
+rapid. [1] In the slightly less tangible world of programming, <b>Obsidian</b> is home to chunks of
+Ruby code that we've found helpful. These bits of code are often found at the bottom of a mountain of
+yak hair, the occasionally-occurring product of simplifying various tasks.
+
+  1 http://en.wikipedia.org/wiki/Obsidian
+
+== FEATURES
+
+=== Model Update Tracker
+This library allows you to functionally test updates to models with clearer and more focused intent.
+It forces you to have a better understanding of how your objects interact and lets you demonstrate 
+that knowledge by specifying it in your tests.  For example, consider the following test which asserts
+that the code block persists an Asset record.  
+
+  assert_difference Asset :count do
+    post :create, :asset => {}
+  end
+
+Is it okay if the code block also persists a Location record? An AssetOwner record? Some other record?
+Chances are that the developer knows the answer to this question, but the test fails to capture that
+knowledge. Side effects matter, and our tests should adequately validate that the desired side effects
+(and <i>only</i> the desired side effects) are taking place. In the example below, assert_models_created
+allows us to validate that an Asset is created <i>and</i> that no other objects are inadvertently
+persisted.
+
+  assert_models_created(Asset) do
+    post :create, :asset => {}
+  end
+
+If the code block happened to create records other than just an Asset, a friendly test failure would let
+you know right away.
+
+Suppose, on the other hand, that you expect the creation of an Asset to <i>also</i> produce an AssetOwner
+and a Location. This is where you exercise your deep domain knowledge muscles and make your new
+Obsidian-powered test express and validate your intent.
+
+  assert_models_created(Asset, AssetOwner, Location) do
+    post: create, :asset => {}
+  end
+
+Now, if your code block fails to create the expected records, the above test would fail stating that it
+expected more to happen. If future changes to your code cause things to fall out of place, this test will
+catch that regression where the original assert_difference may not. In addition to assert_models_created,
+Model Update Tracker provides a whole host of other methods that provide similar functionality for
+asserting behavior related to updates, deletes, or even validating that nothing happened.
+
+* assert_models_created(models)
+* assert_models_updated(models)
+* assert_models_destroyed(models)
+* assert_no_models_created
+* assert_no_models_destroyed
+* assert_no_models_updated
+
+== INSTALL
+
+  sudo gem install obsidian
+
+== URLS
+
+* Log bugs, issues, and suggestions on Trac: http://opensource.thinkrelevance.com/wiki/obsidian
+* View Source: http://github.com/relevance/obsidian/tree/master
+* Git clone Source: git://github.com/relevance/obsidian.git
+* RDocs: http://thinkrelevance.rubyforge.org/obsidian/
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2008 Relevance, Inc. - http://thinkrelevance.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'hoe'
+require 'lib/obsidian'
+
+hoe = Hoe.new('obsidian', Obsidian::VERSION) do |p|
+  p.rubyforge_name = "thinkrelevance"
+  p.description = "It's metastable"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.name = 'obsidian'
+  p.summary = "It's metastable"
+  p.author = "Relevance"
+  p.email = "opensource@thinkrelevance.com"
+  p.url = "http://opensource.thinkrelevance.com"  
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc$/
+  p.test_globs = "test/**/*_test.rb"
+end
+
+# Override RDoc to use allison template, and also use our .rdoc README as the main page instead of the default README.txt
+Rake::RDocTask.new(:docs) do |rd|
+  gem "allison"
+  gem "markaby"
+  rd.main = "README.rdoc"
+  # rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ and not ENV['NODOT']
+  rd.rdoc_dir = 'doc'
+  files = hoe.spec.files.grep(hoe.rdoc_pattern)
+  files -= ['Manifest.txt']
+  rd.rdoc_files.push(*files)
+
+  title = "#{hoe.name}-#{hoe.version} Documentation"
+  title = "#{hoe.rubyforge_name}'s " + title if hoe.rubyforge_name != hoe.name
+end
+
+begin
+  require 'rcov'
+  require "rcov/rcovtask"
+
+  namespace :coverage do
+    rcov_output = ENV["CC_BUILD_ARTIFACTS"] || 'tmp/coverage'
+    rcov_exclusions = %w{
+    }.join(',')
+  
+    desc "Delete aggregate coverage data."
+    task(:clean) { rm_f "rcov_tmp" }
+  
+    Rcov::RcovTask.new(:unit => :clean) do |t|
+      t.test_files = FileList['test/**/*_test.rb']
+      t.rcov_opts = ["--sort coverage", "--aggregate 'rcov_tmp'", "--html", "--rails", "--exclude '/Library'"]
+      t.output_dir = rcov_output + '/unit'
+    end
+  
+    desc "Generate and open coverage report"
+    task(:all => [:unit]) do
+      system("open #{rcov_output}/unit/index.html") if PLATFORM['darwin']
+    end
+  end
+rescue LoadError
+  if RUBY_PLATFORM =~ /java/
+    puts 'running in jruby - rcov tasks not available'
+  else
+    puts 'sudo gem install rcov # if you want the rcov tasks'
+  end
+end
+ 

data/lib/obsidian/rails/helper_test.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+
+module Obsidian::Rails    
+  module HelperTest
+    # include all the fun dependancies needed to test helpers
+    def helper_test helper_under_test = nil
+      include ActionView::Helpers::CaptureHelper
+      include ActionView::Helpers::DateHelper
+      include ActionView::Helpers::UrlHelper 
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::AssetTagHelper
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::FormOptionsHelper
+      include ActionView::Helpers::FormTagHelper
+      include ApplicationHelper
+      include helper_under_test if helper_under_test
+    end
+    
+  end
+end
+
+Test::Unit::TestCase.extend Obsidian::Rails::HelperTest

data/lib/obsidian/rails/model_update_tracker.rb

@@ -0,0 +1,182 @@
+if defined? RAILS_ENV
+  raise "For testing only!" unless RAILS_ENV=="test"  
+end
+  
+module Obsidian::Rails    
+  module ModelUpdateTracker
+    class Delta
+      attr_accessor :committed, :uncommitted
+      def initialize
+        reset
+      end
+
+      def reset
+        @committed = []
+        @uncommitted = []
+      end
+
+      def << (obj)
+        @uncommitted << obj
+      end
+
+      def transaction_committed
+        @committed = @committed + @uncommitted
+        @uncommitted = []
+      end
+
+      def transaction_rolled_back
+        @uncommitted = []
+      end
+
+      def instances
+        @committed + @uncommitted
+      end
+
+      def class_names
+        set = instances.inject(Set.new) do |set,inst|
+          set << inst.class.to_s
+          set
+        end
+        set
+      end
+    end
+    class << self
+      attr_accessor :created_delta, :destroyed_delta, :updated_delta
+      def reset
+        created_delta.reset
+        destroyed_delta.reset
+        updated_delta.reset
+      end    
+
+      def after_create(model)         
+        log("Model create #{model} is a #{model.class}")
+        created_delta << model
+      end
+
+      def after_update(model)         
+        log("Model update #{model}")
+        updated_delta << model
+      end
+
+      def after_destroy(model)
+        log("Model destroy #{model}")
+        destroyed_delta << model
+      end
+
+      def after_transaction_commit
+        log("Commit transaction")
+        created_delta.transaction_committed
+        updated_delta.transaction_committed
+        destroyed_delta.transaction_committed
+      end
+
+      def after_transaction_rollback
+        log("Rollback of transaction}")
+        created_delta.transaction_rolled_back
+        updated_delta.transaction_rolled_back
+        destroyed_delta.transaction_rolled_back
+      end             
+
+      def after_transaction_exception
+        log("Exception in transaction}")
+        created_delta.transaction_rolled_back
+        updated_delta.transaction_rolled_back
+        destroyed_delta.transaction_rolled_back
+      end             
+
+      def log(msg)
+        # puts msg 
+      end
+    end
+    self.created_delta = Delta.new
+    self.updated_delta = Delta.new
+    self.destroyed_delta = Delta.new
+    self.reset     
+  end
+end
+
+# not using normal after save hooks because of initialization order issues
+class ActiveRecord::Base
+  def create_with_model_update_tracker(*args,&blk)
+    result = create_without_model_update_tracker(*args,&blk)
+    Obsidian::Rails::ModelUpdateTracker.after_create(self) if result
+    result
+  end
+
+  alias_method_chain :create, :model_update_tracker
+
+  def update_with_model_update_tracker(*args,&blk)
+    result = update_without_model_update_tracker(*args,&blk)
+    Obsidian::Rails::ModelUpdateTracker.after_update(self) if result
+    result
+  end
+
+  alias_method_chain :update, :model_update_tracker
+
+  def destroy_with_model_destroy_tracker(*args,&blk)
+    result = destroy_without_model_destroy_tracker(*args,&blk)
+    Obsidian::Rails::ModelUpdateTracker.after_destroy(self) if result
+    result
+  end
+
+  alias_method_chain :destroy, :model_destroy_tracker
+end
+
+class Test::Unit::TestCase       
+  def assert_no_models_created(&blk)
+    assert_models_created(&blk)
+  end
+
+  def assert_no_models_destroyed(&blk)
+    assert_models_destroyed(&blk)
+  end
+
+  def assert_no_models_updated(&blk)
+    assert_models_updated(&blk)
+  end
+
+  def assert_models_destroyed(*models, &blk)
+    Obsidian::Rails::ModelUpdateTracker.reset
+    blk.call
+    assert_equal(Set.new(models.map(&:to_s)), Obsidian::Rails::ModelUpdateTracker.destroyed_delta.class_names)
+  end
+
+  def assert_models_updated(*models, &blk)
+    Obsidian::Rails::ModelUpdateTracker.reset
+    blk.call
+    assert_equal(Set.new(models.map(&:to_s)), Obsidian::Rails::ModelUpdateTracker.updated_delta.class_names)
+  end
+
+  def assert_models_created(*models, &blk)
+    Obsidian::Rails::ModelUpdateTracker.reset
+    blk.call
+    assert_equal(Set.new(models.map(&:to_s)), Obsidian::Rails::ModelUpdateTracker.created_delta.class_names)
+  end
+end             
+
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module DatabaseStatements
+      def transaction_with_model_update_tracker(*args,&blk)
+        transaction_without_model_update_tracker(*args,&blk)
+      rescue
+        Obsidian::Rails::ModelUpdateTracker.after_transaction_exception
+        raise
+      end
+
+      def rollback_db_transaction_with_model_update_tracker
+        rollback_db_transaction_without_model_update_tracker
+        Obsidian::Rails::ModelUpdateTracker.after_transaction_rollback
+      end
+
+      def commit_db_transaction_with_model_update_tracker
+        commit_db_transaction_without_model_update_tracker
+        Obsidian::Rails::ModelUpdateTracker.after_transaction_commit
+      end
+
+      alias_method_chain :transaction, :model_update_tracker
+      alias_method_chain :rollback_db_transaction, :model_update_tracker
+      alias_method_chain :commit_db_transaction, :model_update_tracker
+    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/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.rb

@@ -0,0 +1,3 @@
+module Obsidian
+  VERSION = '0.0.5'
+end

data/obsidian.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{obsidian}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Relevance"]
+  s.date = %q{2008-10-30}
+  s.description = %q{It's metastable}
+  s.email = %q{opensource@thinkrelevance.com}
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.rdoc", "README.txt", "Rakefile", "lib/obsidian.rb", "lib/obsidian/rails/helper_test.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", "obsidian.gemspec", "test/obsidian_test.rb", "test/test_helper.rb", "test/units/obsidian/rails/model_update_tracker_test.rb", "test/units/obsidian/spec/map_spec_helper_test.rb", "test/units/obsidian/spec/set_spec_helper_test.rb", "test/units/obsidian/spec_test.rb", "test/units/obsidian/object_extensions_test.rb", "test/units/obsidian/try_test.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://opensource.thinkrelevance.com}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{thinkrelevance}
+  s.rubygems_version = %q{1.3.0}
+  s.summary = %q{It's metastable}
+  s.test_files = ["test/obsidian_test.rb", "test/units/obsidian/object_extensions_test.rb", "test/units/obsidian/rails/model_update_tracker_test.rb", "test/units/obsidian/spec/map_spec_helper_test.rb", "test/units/obsidian/spec/set_spec_helper_test.rb", "test/units/obsidian/spec_test.rb", "test/units/obsidian/try_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 1.8.1"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.8.1"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.8.1"])
+  end
+end

data/test/obsidian_test.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+basedir = File.dirname(__FILE__)
+$:.unshift "#{basedir}/../lib"
+require 'rubygems' 
+gem 'test-spec'
+gem 'activesupport'
+gem 'actionpack'
+gem 'activerecord'
+
+require 'test/spec'
+require 'mocha'    
+require 'ostruct'
+require 'activerecord'
+require 'obsidian'

data/test/units/obsidian/object_extensions_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), "../..", "test_helper.rb")
+require 'obsidian/extensions/object'
+
+describe "object extensions" do
+  it "should get metaclass" do
+    obj = Object.new
+    metaklass = (class << obj; self; end;)
+    obj.metaclass.should == metaklass
+  end
+  
+  it "should be able to add methods to the meta class" do
+    obj = Object.new
+    obj.meta_def(:speak) { "bark!" }
+    obj.should.respond_to :speak
+
+    another_obj = Object.new
+    another_obj.should.not.respond_to :speak
+  end
+  
+  class Foo; end
+  
+  it "should be able to define instance methods from the class" do
+    Foo.class_def(:hi) { "hello!" }
+    Foo.new.hi.should == "hello!"
+    Foo.should.not.respond_to :hi
+  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
+

data/test/units/obsidian/try_test.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), "../..", "test_helper.rb")
+require 'obsidian/extensions/try'
+
+describe "try object extension" do
+
+  it "is equivalent to @foo ? @foo.meth : nil" do
+    ["my string", Array.new, nil].each do |val|
+      @foo = val
+      @foo.try(:length).should == (@foo ? @foo.length : nil)
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: relevance-obsidian
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- Relevance
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.1
+    version: 
+description: It's metastable
+email: opensource@thinkrelevance.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.rdoc
+- README.txt
+- Rakefile
+- lib/obsidian.rb
+- lib/obsidian/rails/helper_test.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
+- obsidian.gemspec
+- test/obsidian_test.rb
+- test/test_helper.rb
+- test/units/obsidian/rails/model_update_tracker_test.rb
+- test/units/obsidian/spec/map_spec_helper_test.rb
+- test/units/obsidian/spec/set_spec_helper_test.rb
+- test/units/obsidian/spec_test.rb
+- test/units/obsidian/object_extensions_test.rb
+- test/units/obsidian/try_test.rb
+has_rdoc: true
+homepage: http://opensource.thinkrelevance.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thinkrelevance
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: It's metastable
+test_files: 
+- test/obsidian_test.rb
+- test/units/obsidian/object_extensions_test.rb
+- test/units/obsidian/rails/model_update_tracker_test.rb
+- test/units/obsidian/spec/map_spec_helper_test.rb
+- test/units/obsidian/spec/set_spec_helper_test.rb
+- test/units/obsidian/spec_test.rb
+- test/units/obsidian/try_test.rb