higher_expectations 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,7 @@
+== 0.0.2 2008-08-15
+
+* Cleans up documentation, provides must_be_an syntax sugar, buildable gem
+
 == 0.0.1 2008-08-14
 
 * 1 major enhancement:

data/Manifest.txt

@@ -7,7 +7,7 @@ config/hoe.rb
 config/requirements.rb
 lib/higher_expectations.rb
 lib/instance_methods.rb
-lib/version.rb
+lib/higher_expectations/version.rb
 script/console
 script/console.cmd
 script/destroy

data/README.txt

@@ -1,6 +1,6 @@
 = higher_expectations
 
-* http://higher_expectations.rubyforge
+* http://higher-expect.rubyforge.org
 
 == DESCRIPTION:
 
@@ -29,23 +29,23 @@ end
 * Please note that this is alpha software
 * Provides a set of usefull methods for determining what an object is at runtime, and raising an exception
 * Avoids creating these methods in Object directly, and instead extends the objects passed in (although it does add them directly to Numeric due to constraints in Ruby's Numeric implementation)
-* Allows for method changing and provides a dose of syntactic sugar
+* Allows for method chaining to provide a dose of syntactic sugar
 
 == SYNOPSIS:
 
-Imagine you have a method to calculate sunrise buried within a 1D planet simulator codebase.  Throughout the codebase, validations are used to check data input, and there is a well thought-out and well written test suite.
+Imagine you have a method to calculate sunrise buried within a 1D planet simulator codebase.  Throughout the codebase, validations are used to check data input, and there is a well thoughtout and well written test suite.
 
   def calc_sunrise(day, month)
     sunrise = (day - 50000)/month   # arbitrary calculation that assumes day is a number and not negative
   end
 
-However, Joey your coworker hacks and calls the following function:
+However, Joey your coworker hacks away and calls the following function:
 
   PlanetEarth.sunrise = calc_sunrise(-5, 1)
 
 Code executes, no exceptions are raised, but earths sunrise changes to a weird value.  No amount of unit testing, specing, validating outside the model would have stopped Joey from making this hambone maneuver.
 
-Now you could have said something like:
+Checking the arguments within the method would have prevented this:
 
 def calc_sunrise(day, month)
   raise ArgumentError.new("day must be numeric") unless day.kind_of?(Numeric)
@@ -56,24 +56,29 @@ def calc_sunrise(day, month)
   ...sunrise calc...
 end
 
-Drudgery, duplication, error prone, etc. etc.  Wouldn't you like to do this instead?
+But writing this sort of code is slow and error prone.  Wouldn't you like to do this instead?
 
-include HigherExpectations  # somewhere in the class
-def calc_sunrise(day, month)
-    has_expectations(day, month)    # attach expectation methods to each object
-    day.must_be(Numeric)            # day must be numeric or an exception will be raise
-    day.must_be_in_range(1..31)     # day must be in range or exception
-    month.must_be(Numeric).and_must_be_in_range(1..31)  # a neat combination of both
-    month.must_be_nil rescue nil                        # since it raises an exception, its trappable, allowing for more flexible handling
-  ...sunrise calc
+require 'higher_expectations'
+class PlanetCalculations
+  include HigherExpectations
+  def calc_sunrise(day, month)
+      has_expectations(day, month)    # attach expectation methods to each object
+      day.must_be_an(Integer)          # day must kind_of? Integer or an exception will be raised
+      day.must_be_in_range(1..31)     # day must be in the given range or exception
+      # a neat combination of both
+      month.must_be_an(Integer).and_must_be_in_range(1..31)
+      # since it raises an exception, its trappable, allowing for more flexible handling
+      month.must_be_nil rescue ArgumentError nil
+    ...sunrise calc
+  end
 end
 
-...or even cleaner.
+...without comments:
 
 def calc_sunrise(day,month)
   has_expectations(day,month)
-  *args.map{|a| a.must_be(Numeric).and_must_be_in_range(1..31)}
-  month.must_be_nil
+  day.must_be_a(Integer).and_must_be_in_range(1..31)
+  month.must_be_a(Integer).and_must_be_in_range(1..31
   ...sunrise calc...
 end
 

data/Rakefile

@@ -1,4 +1,24 @@
 require 'config/requirements'
 require 'config/hoe' # setup Hoe + all gem configuration
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+begin
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new("spec") do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+  end
+
+  task :test do
+    Rake::Task['spec'].invoke
+  end
+
+  Spec::Rake::SpecTask.new("rcov_spec") do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', '^spec,/gems/']
+  end
+end

data/lib/{version.rb → higher_expectations/version.rb}

@@ -2,7 +2,7 @@ module HigherExpectations
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/higher_expectations.rb

@@ -17,10 +17,10 @@ require 'instance_methods'
 module HigherExpectations
   VERSION = '0.1.0'
 
-  # Should be called at method entrance
-  # instead of spaming up entire Object class method space, extend each given object with expectation methods
+  # Should be called at method entrance, extends each given object with expectation methods
   def has_expectations(*objects)
     objects.map do |obj|
+      #next if obj.respond_to?(:raise_ae)  # skip objects that have already instance methods
       begin
         obj.extend(HigherExpectations::InstanceMethods)
       # TypeErrors are generated when trying to extend Numeric objects, which are not and cannot be singeltons and hence cannot get new methods.  

data/lib/instance_methods.rb

@@ -45,7 +45,9 @@ module HigherExpectations
       end
       self
     end
-    alias :and_must_be_a :must_be_a
+    alias :must_be_an :must_be_a
+
+
     
     # value(s)  must not be in a specific class or set of klasses
     def must_not_be_a(*klasses)
@@ -54,7 +56,9 @@ module HigherExpectations
       end
       self
     end
+    alias :must_not_be_an :must_not_be_a
     alias :and_must_not_be_a :must_not_be_a
+    alias :and_must_not_be_an :must_not_be_a
 
     # value(s)  must be in a specific numeric range
     def must_be_in_range(range)

data/spec/instance_methods_spec.rb

@@ -6,7 +6,7 @@ end
 #
 # Todo: a clever implementation that DRYs up the below, while leaving it readable and producing a decent specdoc
 #
-describe "InstanceMethods" do
+describe "HigherExpectation::InstanceMethods" do
   include HigherExpectations
   before(:each) do
     @number = 1

data/website/index.html

@@ -1,11 +1,86 @@
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<title>higher_expectations</title>
-		
-	</head>
-	<body id="body">
-		<p>This page has not yet been created for RubyGem <code>higher_expectations</code></p>
-		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
-	</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      higher_expectations
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>higher_expectations</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/higher_expectations"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/higher_expectations" class="numbers">0.0.2</a>
+    </div>
+    <h1>&amp;#x2192; &#8216;higher_expectations&#8217;</h1>
+<h2>What</h2>
+<h2>Installing</h2>
+<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">higher_expectations</span></pre></p>
+<h2>The basics</h2>
+<h2>Demonstration of usage</h2>
+<h2>Forum</h2>
+<p><a href="http://groups.google.com/group/higher_expectations">http://groups.google.com/group/higher_expectations</a></p>
+<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; higher_expectations</p>
+<h2>How to submit patches</h2>
+<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
+<p>The trunk repository is <code>svn://rubyforge.org/var/svn/higher_expectations/trunk</code> for anonymous access.</p>
+<p><span class="caps">OOOORRRR</span></p>
+<p>You can fetch the source from either:</p>
+<ul>
+	<li>rubyforge: <span class="caps">MISSING</span> IN <span class="caps">ACTION</span></li>
+</ul>
+<p><span class="caps">TODO</span> &#8211; You can not created a RubyForge project, OR have not run <code>rubyforge config</code><br />
+yet to refresh your local rubyforge data with this projects&#8217; id information.</p>
+<p>When you do this, this message will magically disappear!</p>
+<p>Or you can hack website/index.txt and make it all go away!!</p>
+<ul>
+	<li>github: <a href="http://github.com/GITHUB_USERNAME/higher_expectations/tree/master">http://github.com/GITHUB_USERNAME/higher_expectations/tree/master</a></li>
+</ul>
+<pre>git clone git://github.com/GITHUB_USERNAME/higher_expectations.git</pre>
+<p><span class="caps">TODO</span> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
+<ul>
+	<li>gitorious: <a href="git://gitorious.org/higher_expectations/mainline.git">git://gitorious.org/higher_expectations/mainline.git</a></li>
+</ul>
+<pre>git clone git://gitorious.org/higher_expectations/mainline.git</pre>
+<h3>Build and test instructions</h3>
+<pre>cd higher_expectations
+rake test
+rake install_gem</pre>
+<h2>License</h2>
+<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+<h2>Contact</h2>
+<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/higher_expectations">forum</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 14th August 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: higher_expectations
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 date: 2008-08-14 00:00:00 -04:00
 summary: description of gem
 require_paths: 
@@ -39,7 +39,7 @@ files:
 - config/requirements.rb
 - lib/higher_expectations.rb
 - lib/instance_methods.rb
-- lib/version.rb
+- lib/higher_expectations/version.rb
 - script/console
 - script/console.cmd
 - script/destroy