relevance-obsidian 0.0.5 → 0.0.6

data/Rakefile

@@ -2,36 +2,24 @@ require 'rubygems'
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require 'hoe'
+require 'echoe'
 require 'lib/obsidian'
 
-hoe = Hoe.new('obsidian', Obsidian::VERSION) do |p|
+echoe = Echoe.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.summary = "It's metastable"
+  p.description = "Bits of Ruby code we've found helpful for simplifying various tasks"
   p.url = "http://opensource.thinkrelevance.com"  
   p.rdoc_pattern = /^(lib|bin|ext)|txt|rdoc$/
-  p.test_globs = "test/**/*_test.rb"
+  rdoc_template = `allison --path`.strip << ".rb"
+  p.rdoc_template = rdoc_template
 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
+echoe.spec.add_development_dependency "echoe"
+echoe.spec.add_development_dependency "allison"
+echoe.spec.add_development_dependency "markaby"
 
 begin
   require 'rcov'

data/lib/obsidian/extensions/object.rb

@@ -0,0 +1,31 @@
+# Metaclass goodness thanks to why:
+# see: http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
+module Obsidian
+  module Extensions
+    module Object
+      # The hidden singleton lurks behind everyone
+      def metaclass
+        class << self
+          self
+        end
+      end
+
+      def meta_eval &blk
+        metaclass.instance_eval &blk
+      end
+
+      # Adds methods to a metaclass
+      def meta_def name, &blk
+        meta_eval { define_method name, &blk }
+      end
+
+      # Defines an instance method within a class
+      def class_def name, &blk
+        class_eval { define_method name, &blk }
+      end
+      
+    end
+  end
+end
+
+Object.class_eval { include Obsidian::Extensions::Object }

data/lib/obsidian/extensions/try.rb

@@ -0,0 +1,16 @@
+module Obsidian
+  module Extensions
+    module Try
+      # Instead of
+      #    @person ? @person.name : nil
+      # Use try:
+      #    @person.try(:name)
+      def try(method)
+        send method if respond_to? method
+      end
+      
+    end
+  end
+end
+
+Object.class_eval { include Obsidian::Extensions::Try }

data/lib/obsidian.rb

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

data/obsidian.gemspec

@@ -1,22 +1,20 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{obsidian}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   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.date = %q{2008-11-13}
   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.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "LICENSE", "Manifest.txt", "README.rdoc", "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"]
   s.has_rdoc = true
   s.homepage = %q{http://opensource.thinkrelevance.com}
-  s.rdoc_options = ["--main", "README.txt"]
+  s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{thinkrelevance}
-  s.rubygems_version = %q{1.3.0}
+  s.rubygems_version = %q{1.3.1}
   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"]
 
@@ -25,11 +23,11 @@ Gem::Specification.new do |s|
     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"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
     else
-      s.add_dependency(%q<hoe>, [">= 1.8.1"])
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
     end
   else
-    s.add_dependency(%q<hoe>, [">= 1.8.1"])
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: relevance-obsidian
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Relevance
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-30 00:00:00 -07:00
+date: 2008-11-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.1
+        version: 1.8.2
     version: 
 description: It's metastable
 email: opensource@thinkrelevance.com
@@ -30,15 +30,16 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 files: 
 - 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
@@ -47,18 +48,18 @@ files:
 - 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/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
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/Manifest.txt

@@ -1,23 +0,0 @@
-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.txt

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