obsidian 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,6 @@
+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

@@ -1,6 +1,7 @@
 History.txt
+LICENSE
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 lib/obsidian.rb
 lib/obsidian/rails/model_update_tracker.rb
@@ -10,6 +11,6 @@ lib/obsidian/spec/set_spec_helper.rb
 test/obsidian_test.rb
 test/test_helper.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
+test/units/obsidian/spec_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/Rakefile

@@ -8,7 +8,7 @@ require 'lib/obsidian'
 desc 'Default: run unit tests.'
 task :default => :test
 
-Hoe.new('obsidian', Obsidian::VERSION) do |p|
+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")
@@ -16,7 +16,23 @@ Hoe.new('obsidian', Obsidian::VERSION) do |p|
   p.summary = "It's metastable"
   p.author = "Relevance"
   p.email = "opensource@thinkrelevance.com"
-  p.url = "http://opensource.thinkrelevance.com"
+  p.url = "http://opensource.thinkrelevance.com"  
+  p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc$/
+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
 
 desc 'Test obsidian.'

data/lib/obsidian.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: obsidian
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-07 00:00:00 -04:00
+date: 2008-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,11 +30,11 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
+- LICENSE
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - lib/obsidian.rb
 - lib/obsidian/rails/model_update_tracker.rb
@@ -44,9 +44,9 @@ files:
 - test/obsidian_test.rb
 - test/test_helper.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
+- test/units/obsidian/spec_test.rb
 has_rdoc: true
 homepage: http://opensource.thinkrelevance.com
 post_install_message: 
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: thinkrelevance
-rubygems_version: 1.0.1
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: It's metastable

data/README.txt

@@ -1,76 +0,0 @@
-= 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.