obsidian 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+2008-03-28
+  * Added model_update_tracker
+  * Added example rails applicaion in branch example
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/obsidian.rb
+lib/obsidian/rails/model_update_tracker.rb
+test/obsidian_test.rb
+test/test_helper.rb
+test/obsidian/rails/model_update_tracker_test.rb

data/README.txt

@@ -0,0 +1,76 @@
+= Obsidian
+
+http://opensource.thinkrelevance.com
+
+== DESCRIPTION:
+
+Obsidian. It's metastable. 
+Chunks of Ruby code we have found helpful.
+
+== FEATURES/PROBLEMS:
+
+=== 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 let's you demonstrate 
+that knowledge by putting it in your tests.  For example instead of writing a test like so
+
+assert_difference Asset :count do
+  post :create, :asset => {}
+end
+
+you would write your test like so
+
+assert_models_created(Asset) do
+  post :create, :asset => {}
+end
+
+Now if an asset really created multiple other objects such as an asset owner and a location the above
+test would fail stating that it expected more to happen.  This is where you excercise your deep domain
+knowledge muscles and make your new obsidian powered test pass.
+
+assert_models_saved(Asset, AssetOwner, Location) do
+  post: create, :asset => {}
+end
+
+You have just done youself a great service.  If for some reason you change code that affects your 
+object model and things fall out of place this test will catch that regression error where the original
+assert_difference may not.  There are also a whole host of other methods you can use with model update
+tracker that provide functionality for updates, deletes, and no_difference assertions.
+
+* 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:
+
+git clone git://github.com/relevance/obsidian.git
+rake gem
+sudo gem install pkg/#{pkg_name}
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Relevance, Inc.
+
+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,58 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'hoe'
+require 'lib/obsidian'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+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"
+end
+
+desc 'Test obsidian.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+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.rb

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

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/test/obsidian/rails/model_update_tracker_test.rb

@@ -0,0 +1,50 @@
+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

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,14 @@
+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'
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: obsidian
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Relevance
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-04 00:00:00 -04: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.5.1
+    version: 
+description: It's metastable
+email: opensource@thinkrelevance.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/obsidian.rb
+- lib/obsidian/rails/model_update_tracker.rb
+- test/obsidian_test.rb
+- test/test_helper.rb
+- test/obsidian/rails/model_update_tracker_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.0.1
+signing_key: 
+specification_version: 2
+summary: It's metastable
+test_files: 
+- test/test_helper.rb