graham 0.0.0 → 0.0.2

data/README.md

@@ -5,32 +5,32 @@ Graham is a tiny-yet-useful testing library based on Mallow - in fact it _is_ Ma
 * TestRocket was too minimal
 * RSpec was too verbose (not to mention ridiculous overkill)
 
-## How i graham ##
+## How does one graham ##
 
-Graham test cases are instance methods on classes defined in Graham's namespace:
+Graham test cases are instance methods on arbitrary classes:
 ```ruby
-  class Graham::TestCases
+  class TestCases
     def initialize
       @number = 1
     end
-    def Case1
+    def one_squared
       @number ** 2
     end
-    def Case2
+    def dividing_one_by_zero
       @number / 0
     end
-    def Case3
+    def calling_a_nonexistent_method
       Graham.this_is_not_a_method
     end
   end
 ```
 Then test your cases:
 ```ruby
-  Graham.test(:TestCases) do |that|
-    that.Case1.is_such_that { self == 1 }
-    that.Case2.is_a(Fixnum).such_that {self > 1}
-    that.Case3.does_not_raise_an_exception
-  end #=> {:Case1=>true, :Case2=>#<ZeroDivisionError>, :Case3=>false}
+  Graham.test(TestCases) do |that|
+    that.one_squared.is 1
+    that.dividing_by_zero.returns_a(Fixnum).such_that {self > 1}
+    that.calling_a_nonexistent_method.does_not_raise_an_exception
+  end #=> {:one_squared=>true, :dividing_by_zero=>#<ZeroDivisionError>, :calling_a_nonexistent_method=>false}
 ```
-Calling Graham#pp instead will call Graham#test and run the output through Graham's built-in pretty printer.
+Calling Graham::pp instead will call Graham::test and run the output through Graham's built-in pretty printer.
 

data/graham.gemspec

@@ -3,7 +3,7 @@ require 'rake'
 require 'graham/version'
 
 graham = Gem::Specification.new do |spec|
-  spec.add_dependency 'mallow'
+  spec.add_dependency 'mallow', '>=0.0.4'
   spec.name        = 'graham'
   spec.version     = Graham::VERSION
   spec.author      = 'feivel jellyfish'

data/lib/graham.rb

@@ -19,9 +19,6 @@ require 'graham/version'
 #    that.test3.returns_a Numeric
 #  } #=> {:test1=>true, :test2=>false, :test3=>#<ZeroDivisionError>}
 #
-# A side effect of this approach is that you can use RDoc to document your
-# tests, gauge coverage, etc.
-#
 # === N.B.
 # Since a Graham test is basically a Mallow pattern matcher, only the first
 # test on a case will actually be executed, as subsequent invocations of the
@@ -47,40 +44,24 @@ require 'graham/version'
 module Graham
   autoload :PP,       'graham/pp'
   autoload :RakeTask, 'graham/rake_task'
-  # Namespace for test cases; see documentation for Graham
-  class Cases; end
+  autoload :DSL,      'graham/dsl'
   class << self
     # A convenience method that builds and executes a Graham::Core
     # in the given namespace (defaults to Cases). See documentation for
     # Graham for more on usage.
-    def test(ns=self::Cases, &b)
-      ns=const_get(ns) if ns.is_a? Symbol
-      Graham::Core.build(ns, &b).test
+    def test(ns, &b)
+      DSL.build_core(ns, &b).test
     end
-    # A convenience methods that calls ::test and passes the output to a
+    # A convenience method that calls ::test and passes the output to a
     # pretty printer.
-    def pp(ns=self::Cases, &b)
+    def pp(ns, &b)
       PP.new(test ns,&b).pp
     end
-
-    def compose(ns=nil, *test_groups)
-
-    end
-
-    alias test_in test
-
-    private
-    def ns_compose(test_groups)
-      test_groups.map do |ns, tests|
-        [ ns, tests.map {|test| test ns, &test} ]
-      end
-    end
-
   end
 
   class Core < Mallow::Core
     attr_accessor :cases
-    def initialize(*args)
+    def initialize
       @cases = []
       super
     end
@@ -89,7 +70,7 @@ module Graham
       [e.name] << begin
         super e
         true
-      rescue Mallow::DeserializationException
+      rescue Mallow::MatchException
         false
       rescue => err
         err
@@ -97,82 +78,6 @@ module Graham
     end
 
     def test; Hash[_fluff @cases] end
-    def self.build(ns, &b); DSL.build ns, &b end
-  end
-
-  class DSL < Mallow::DSL
-
-    def self.build(ns)
-      yield(dsl = new(ns))
-      dsl.finish!
-    end
-
-    def initialize(ns)
-      @core, @cases = Core.new, ns.new
-      reset!
-    end
-
-    def method_missing(msg, *args, &b)
-      case msg.to_s
-      when /^((and|that)_)+(.+)$/
-        respond_to?($3)? send($3, *args, &b) : super
-      else
-        core.cases << (_case = @cases.method msg) rescue super
-        rule!._this _case
-      end
-    end
-
-    def _where(&b); push b, :conditions              end
-    def _this(o);   _where {|e|e==o}                 end
-    def where(&b);  _where {|e| preproc(b)[e.call] } end
-
-    def raises(x=nil)
-      _where {
-        begin
-          call
-          false
-        rescue x => e
-          true
-        rescue   => e
-          x ? raise(e) : true
-        end
-      }
-    end
-
-    def does_not_raise(x=nil)
-      _where {
-        begin
-          call
-          true
-        rescue x => e
-          false
-        rescue   => e
-          x ? raise(e) : false
-        end
-      }
-    end
-
-    alias is      this
-    alias returns this
-
-    alias is_such_that where
-    alias such_that    where
-    alias and          where
-    alias that         where
-
-    alias raises_an           raises
-    alias raises_a            raises
-    alias raises_an_exception raises
-
-    alias returns_                    does_not_raise
-    alias does_not_raise_a            does_not_raise
-    alias does_not_raise_an           does_not_raise
-    alias does_not_raise_an_exception does_not_raise
-
-    alias is_a       a
-    alias is_an      a
-    alias returns_a  a
-    alias returns_an a
-
   end
 end
+

data/lib/graham/dsl.rb

@@ -0,0 +1,77 @@
+module Graham
+  class DSL < Mallow::BasicDSL
+    include Mallow::DSL::Matchers
+    def self.build_core(ns)
+      yield(dsl = new(ns))
+      dsl.finish!
+    end
+
+    def initialize(ns)
+      @core, @ns = Core.new, ns.new
+      reset!
+    end
+
+    def method_missing(msg, *args, &b)
+      case msg.to_s
+      when /^((and|that)_)+(.+)$/
+        respond_to?($3)? send($3, *args, &b) : super
+      else
+        core.cases << (_case = @ns.method msg)
+        rule!._where {|e|e==_case}
+      end
+    end
+
+    def _where(&b); push b, :conditions              end
+    def where(&b);  _where {|e| preproc(b)[e.call] } end
+
+    def raises(x=nil)
+      _where {
+        begin
+          call
+          false
+        rescue x => e
+          true
+        rescue   => e
+          x ? raise(e) : true
+        end
+      }
+    end
+
+    def does_not_raise(x=nil)
+      _where {
+        begin
+          call
+          true
+        rescue x => e
+          false
+        rescue   => e
+          x ? raise(e) : false
+        end
+      }
+    end
+
+    alias is      this
+    alias returns this
+
+    alias is_such_that where
+    alias such_that    where
+    alias that         where
+    alias and          where
+
+    alias raises_an           raises
+    alias raises_a            raises
+    alias raises_an_exception raises
+
+    alias returns_                    does_not_raise
+    alias does_not_raise_a            does_not_raise
+    alias does_not_raise_an           does_not_raise
+    alias does_not_raise_an_exception does_not_raise
+
+    alias is_a       a
+    alias is_an      a
+    alias returns_a  a
+    alias returns_an a
+
+  end
+end
+

data/lib/graham/pp.rb

@@ -1,6 +1,6 @@
-# A trivial pretty printer for test output.
-# TODO: replace with something better
 module Graham
+  # A trivial pretty printer for test output.
+  # TODO: replace with something better
   class PP
     attr_reader :results
     attr_accessor :bt, :out, :color

data/lib/graham/version.rb

@@ -1,3 +1,3 @@
 module Graham
-  VERSION = '0.0.0'
+  VERSION = '0.0.2'
 end

data/test/case/control.rb

@@ -1,10 +1,10 @@
-class Graham::Cases
-  def NinetyNine; 99 end
-  def NameError; raise Asdf.qwer.ty / 0 end
+class Cases
+  def the_number_99; 99 end
+  def raising_a_name_error; raise Asdf.qwer.ty / 0 end
 end
 
-Graham.pp {|that|
-  that.NinetyNine.returns_a(Fixnum).such_that {self==99}.and_that_is 99
-  that.NameError.raises.and_raises_a NameError
+Graham.pp(Cases) {|that|
+  that.the_number_99.returns_a(Fixnum).such_that {self==99}.and_that_is 99
+  that.raising_a_name_error.raises.and_raises_a NameError
 }
 

data/test/case/test.rb

@@ -1,12 +1,12 @@
-class Graham::Cases
+class Cases
   def DocTest1; 4 + 5 end
   def DocTest2; 'test'.upcase end
   def DocTest3; 1/0  end
-  def RDocExample
-    Graham.test { |that|
+  def rdoc_example
+    Graham.test(Cases) { |that|
       that.DocTest1.returns_a(Fixnum).such_that {self < 100}
       that.DocTest2.returns 'TeST'
-      that.DocTest3.returns_a Numeric
+      that.DocTest3.returns_a(Numeric)
     }
   end
 
@@ -22,8 +22,8 @@ class Graham::Cases
   def ReadmeCase3
     Graham.this_is_not_a_method
   end
-  def ReadmeExample
-    Graham.test do |that|
+  def readme_example
+    Graham.test(Cases) do |that|
       that.ReadmeCase1.is_such_that { self == 1 }
       that.ReadmeCase2.is_a(Fixnum).such_that {self > 1}
       that.ReadmeCase3.does_not_raise_an_exception
@@ -31,27 +31,27 @@ class Graham::Cases
   end
 end
 
-class Graham::Namespace
-  def Namespacing; self end
+class Namespace
+  def namespacing; self end
 end
 
-Graham.pp do |that|
-  that.RDocExample.returns_a(Hash).of_size(3).such_that {
+Graham.pp(Cases) do |that|
+  that.rdoc_example.returns_a(Hash).of_size(3).such_that {
     self[:DocTest1] == true  and
     self[:DocTest2] == false and
     self[:DocTest3].is_a? ZeroDivisionError
   }
-  that.ReadmeExample.returns_a(Hash).of_size(3).such_that {
+  that.readme_example.returns_a(Hash).of_size(3).such_that {
     self[:ReadmeCase1] == true and
     self[:ReadmeCase2].is_a? ZeroDivisionError and
     self[:ReadmeCase3] == false
   }
 end
 
-Graham.pp(:Namespace) do |that|
-  that.Namespacing.is_such_that {
-    self.class == Graham::Namespace
-  }.and {!respond_to? :DocExample
-  }.and { respond_to? :Namespacing}
+Graham.pp(Namespace) do |that|
+  that.namespacing.is_such_that {
+    self.class == Namespace
+  }.and {!respond_to? :rdoc_example
+  }.and { respond_to? :namespacing}
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graham
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mallow
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
 description: Miniature test engine based on Mallow
 email: feivel@sdf.org
 executables: []
@@ -39,6 +39,7 @@ files:
 - lib/graham/rake_task.rb
 - lib/graham/pp.rb
 - lib/graham/version.rb
+- lib/graham/dsl.rb
 - Rakefile
 - test/case/control.rb
 - test/case/test.rb