exemplor 2010.2.0 → 3000.1.0

data/examples/assertion_success_and_info.rb

@@ -2,10 +2,10 @@ require 'exemplor'
 
 eg 'Some successes, then an info' do
   list = [1, 2, 3]
-  Check(list.first).is(1)
-  Check(list[1]).is(2)
-  Check(list.last) # the info one
-  Check(list[2]).is(3)
+  Assert(list.first ==1)
+  Assert(list[1] == 2)
+  Show(list.last) # the info one
+  Assert(list[2] == 3)
 end
 
 __END__
@@ -13,15 +13,12 @@ __END__
 - name: Some successes, then an info
   status: info (with checks)
   result: 
-  - name: list.first
+  - name: list.first ==1
     status: success
-    result: 1
-  - name: list[1]
+  - name: list[1] == 2
     status: success
-    result: 2
   - name: list.last
     status: info
     result: 3
-  - name: list[2]
-    status: success
-    result: 3
+  - name: list[2] == 3
+    status: success

data/examples/check_parsing.rb

@@ -5,29 +5,26 @@ eg.helpers do
 end
 
 eg "plain call" do
-  Check(foo)
+  Show(foo)
 end
 
 eg "whitespace after the call (seriously)" do
-  Check(foo) 
+  Show(foo) 
 end
 
 eg "comment after the call" do
-  Check(foo) # comment!
+  Show(foo) # comment!
 end
 
 eg "with brackets" do
-  Check(String.new('test'))
-end
-
-eg "with brackets and is" do
-  Check(String.new('test')).is("test")
+  Show(String.new('test'))
 end
 
 eg "with disambiguation" do
-  Check(foo)['bar'].is('bar')
+  Show(foo)['bar']
 end
 
+
 __END__
 
 - name: plain call
@@ -54,15 +51,9 @@ __END__
   - name: String.new('test')
     status: info
     result: test
-- name: with brackets and is
-  status: success
-  result: 
-  - name: String.new('test')
-    status: success
-    result: test
 - name: with disambiguation
-  status: success
+  status: info (with checks)
   result: 
   - name: foo bar
-    status: success
+    status: info
     result: bar

data/examples/checking_nil.rb

@@ -1,11 +1,13 @@
 require 'exemplor'
 
+# this is kind of a compromise, looking for better ideas
+
 eg "checking nil works correctly" do
-  Check(nil)
+  Show(nil)
 end
 
 eg "asserting for nil works correctly" do
-  Check(nil).is(nil)
+  Assert(nil == nil)
 end
 
 __END__
@@ -19,6 +21,5 @@ __END__
 - name: asserting for nil works correctly
   status: success
   result: 
-  - name: nil
-    status: success
-    result:
+  - name: nil == nil
+    status: success

data/examples/failure_halts_execution.rb

@@ -2,7 +2,7 @@ require 'exemplor'
 
 eg 'Failures halt execution' do
   list = [1, 2, 3]
-  Check(list.first).is(1_000_000) # fail!
+  Assert(list.first == 1_000_000) # fail!
   raise "foo" # we never get here
 end
 
@@ -11,7 +11,5 @@ __END__
 - name: Failures halt execution
   status: failure
   result: 
-  - name: list.first
-    status: failure
-    expected: 1000000
-    actual: 1
+  - name: list.first == 1_000_000
+    status: failure

data/examples/foobar.rb

@@ -0,0 +1,9 @@
+require 'exemplor'
+
+eg "foo" do
+  "foo"
+end
+
+eg "bar" do
+  "bar"
+end

data/examples/helpers.rb

@@ -16,4 +16,4 @@ __END__
 
 - name: Example calling helper
   status: info (no checks)
-  result: foo
+  result: foo

data/examples/{with_checks.rb → multi_show.rb}

@@ -2,9 +2,9 @@ require 'exemplor'
 
 eg 'Accessing different parts of an array' do
   list = [1, 2, 3]
-  Check(list.first)
-  Check(list[1])
-  Check(list.last)
+  Show(list.first)
+  Show(list[1])
+  Show(list.last)
 end
 
 __END__

data/examples/no_checks_non_string.rb

@@ -15,4 +15,4 @@ __END__
 - name: Non-string return values get converted to yaml
   status: info (no checks)
   result: !ruby/object:MyClass 
-    foo: bar
+    foo: bar

data/examples/{check_with_disambiguation.rb → show_with_disambiguation.rb}

@@ -2,9 +2,9 @@ require 'exemplor'
 
 eg 'Array appending' do
   list = [1, 42]
-  Check(list.last)["before append"]
+  Show(list.last)["before append"]
   list << 2
-  Check(list.last)["after append"]
+  Show(list.last)["after append"]
 end
 
 __END__

data/examples/{dumping_classes.rb → showing_classes.rb}

@@ -5,7 +5,7 @@ eg "class name is printed when example returns a class" do
 end
 
 eg "class name is printed when check is given a class" do
-  Check(Object)
+  Show(Object)
 end
 
 __END__

data/examples/simple_show.rb

@@ -0,0 +1,15 @@
+require 'exemplor'
+
+eg 'Showing the value of some expression' do
+  list = [1, 2, 3]
+  Show(list.first)
+end
+
+__END__
+
+- name: Showing the value of some expression
+  status: info (with checks)
+  result: 
+  - name: list.first
+    status: info
+    result: 1

data/examples/ten_percent_failures.rb

@@ -1,12 +1,12 @@
 require 'exemplor'
 
-eg { Check(1).is(1) }
-eg { Check(2).is(2) }
-eg { Check(3).is(3) }
-eg { Check(4).is(4) }
-eg { Check(5).is(5) }
-eg { Check(6).is(6) }
-eg { Check(7).is(7) }
-eg { Check(8).is(8) }
-eg { Check(9).is(9) }
-eg { Check(false).is(true) }
+eg { Assert(1 == 1) }
+eg { Assert(2 == 2) }
+eg { Assert(3 == 3) }
+eg { Assert(4 == 4) }
+eg { Assert(5 == 5) }
+eg { Assert(6 == 6) }
+eg { Assert(7 == 7) }
+eg { Assert(8 == 8) }
+eg { Assert(9 == 9) }
+eg { Assert(false == true) }

data/examples/with_setup.rb

@@ -4,11 +4,11 @@ eg.setup { @str = "foo" }
 
 eg 'Modified env' do
   @str << " bar"
-  Check(@str).is("foo bar")
+  Assert(@str == 'foo bar')
 end
 
 eg 'Unmodified env' do
-  Check(@str).is("foo")
+  Assert(@str == 'foo')
 end
 
 __END__
@@ -16,12 +16,10 @@ __END__
 - name: Modified env
   status: success
   result: 
-  - name: "@str"
+  - name: "@str == 'foo bar'"
     status: success
-    result: foo bar
 - name: Unmodified env
   status: success
   result: 
-  - name: "@str"
-    status: success
-    result: foo
+  - name: "@str == 'foo'"
+    status: success

data/lib/checker.rb

@@ -1,12 +1,9 @@
 module Exemplor
   class Check
 
-    attr_reader :expectation, :value, :status
-
     def initialize(name, value)
       @name  = name
       @value = value
-      @status = :info
     end
 
     def [](disambiguate)
@@ -18,13 +15,8 @@ module Exemplor
       @name + (defined?(@disambiguate) ? " #{@disambiguate}" : '')
     end
 
-    # might be better to use throw here
-    class Failure < StandardError; end
-
-    def is(expectation)
-      @expectation = expectation
-      @status = (value == expectation) ? :success : :failure
-      raise Failure if failure?
+    def is(arg)
+      warn "Check().is() doesn't assert anymore, use Assert()"
     end
 
     def success?
@@ -40,4 +32,32 @@ module Exemplor
     end
 
   end
+
+  class Show < Check
+
+    attr_reader :value
+
+    def status
+      :info
+    end
+
+  end
+
+  class Assert < Check
+
+    attr_reader :status
+
+    # todo remove
+    attr_reader :value
+
+    # might be better to use throw here
+    class Failure < StandardError; end
+
+    def run
+      @status = !!@value ? :success : :failure
+      raise Failure if failure?
+    end
+
+  end
+
 end

data/lib/environment.rb

@@ -1,6 +1,6 @@
 module Exemplor
 
-  class ExampleEnv
+  class Environment
 
     class << self
 
@@ -24,7 +24,7 @@ module Exemplor
             [env._status, render_checks(env._checks)]
           end
 
-        rescue Check::Failure => failure
+        rescue Assert::Failure => failure
           [:failure, render_checks(env._checks)]
         rescue Object => error
           [:error, render_error(error)]
@@ -55,26 +55,13 @@ module Exemplor
       end
 
       def render_checks(checks)
-        failure = nil
-        out = []
-        checks.each do |check|
-          failure = check if check.failure?
-          break if failure
-          out << OrderedHash do |o|
+        checks.map do |check|
+          OrderedHash do |o|
             o['name'] = check.name
             o['status'] = check.status.to_s
-            o['result'] = render_value check.value
+            o['result'] = render_value check.value if check.info?
           end
         end
-        if failure
-          out << OrderedHash do |o|
-            o['name'] = failure.name
-            o['status'] = failure.status.to_s
-            o['expected'] = failure.expectation
-            o['actual'] = render_value failure.value
-          end
-        end
-        out
       end
 
       def render_error(error)
@@ -93,15 +80,37 @@ module Exemplor
       @_checks = []
     end
 
+    def Show(value)
+      name = extract_argstring_from :Show, caller
+      check = Show.new(name, value)
+      _checks << check
+      check
+    end
+
+    def Assert(value)
+      name = extract_argstring_from :Assert, caller
+      check = Assert.new(name, value)
+      _checks << check
+      check.run
+      check
+    end
+
     def Check(value)
-      file, line_number = caller.first.match(/^(.+):(\d+)/).captures
-      line = File.readlines(file)[line_number.to_i - 1].strip
-      name = line[/Check\((.+?)\)\s*($|#|\[|\.is.+)/,1]
-      check = Check.new(name, value)
+      warn "Check is depreciated, use Show"
+      name = extract_argstring_from :Check, caller
+      check = Show.new(name, value)
       _checks << check
       check
     end
 
+    def extract_argstring_from name, call_stack
+      file, line_number = call_stack.first.match(/^(.+):(\d+)/).captures
+      line = File.readlines(file)[line_number.to_i - 1].strip
+      argstring = line[/#{name}\((.+?)\)\s*($|#|\[|\})/,1]
+      raise "unable to extract name for #{name} from #{file} line #{line_number}:\n  #{line}" unless argstring
+      argstring
+    end
+
     def _status
       (:success if _checks.all? { |c| c.success? }) ||
        :infos
@@ -110,6 +119,6 @@ module Exemplor
   end
 
   def environment
-    ExampleEnv
+    Environment
   end
 end

data/lib/examples.rb

@@ -30,6 +30,7 @@ module Exemplor
   class Examples
 
     def initialize
+      # TODO: no OrderedHash here
       @examples = OrderedHash.new
     end
 
@@ -44,7 +45,7 @@ module Exemplor
       examples_to_run = @examples.select { |name,_| name =~ patterns }
       return 0 if examples_to_run.empty?
       examples_to_run.each do |name, code|
-        result = ResultPrinter.new(name, *ExampleEnv.run(&code))
+        result = ResultPrinter.new(name, *Environment.run(&code))
         fails +=1 if result.failure?
         puts($stdout.tty? ? result.fancy : result.yaml)
       end

data/lib/exemplor.rb

@@ -1,6 +1,5 @@
 # -- Implementation
 
-require 'orderedhash'
 require 'yaml'
 
 module Exemplor
@@ -17,6 +16,8 @@ module Exemplor
 
 end
 
+require Exemplor.path('/../vendor/orderedhash-0.0.6/lib/orderedhash')
+
 require Exemplor.path('/ext')
 require Exemplor.path('/checker')
 require Exemplor.path('/result_printer')