exemplor 2010.0.1 → 2010.0.2

data/Rakefile

@@ -17,7 +17,7 @@ rescue LoadError
 end
 
 task :examples do
-  ruby "examples.rb"
+  ruby  "-rubygems", "examples.rb"
 end
 
 task :test => :examples

data/VERSION

@@ -1 +1 @@
-2010.0.1
+2010.0.2

data/examples.rb

@@ -6,17 +6,17 @@ require 'exemplor'
 eg.helpers do
 
   def run_example(name, args = nil)
-    `ruby -Ilib examples/#{name}.rb#{' ' + args if args}`
+    `ruby -rubygems -Ilib examples/#{name}.rb#{' ' + args if args}`
   end
 
   def extract_expected(name)
     File.read("examples/#{name}.rb").split('__END__').last
   end
-  
+
   def expected_and_actual(example_name)
     [extract_expected(example_name).strip, run_example(example_name).strip]
   end
-  
+
   def check_output_matches_expected_for(example_name)
     expected_output, output = expected_and_actual(example_name)
     Check(output).is(expected_output)
@@ -25,7 +25,7 @@ eg.helpers do
 end
 
 eg "version matches file" do
-  version = `ruby -Ilib -e "require 'exemplor' ; print Exemplor.version"`
+  version = `ruby -rubygems -Ilib -e "require 'exemplor' ; print Exemplor.version"`
   Check(version).is(File.read(__FILE__.sub('examples.rb','VERSION')))
 end
 
@@ -45,6 +45,7 @@ eg { check_output_matches_expected_for :check_with_disambiguation }
 eg { check_output_matches_expected_for :assertion_success }
 eg { check_output_matches_expected_for :assertion_failure }
 eg { check_output_matches_expected_for :assertion_success_and_failure }
+eg { check_output_matches_expected_for :assertion_success_and_info }
 eg { check_output_matches_expected_for :helpers }
 eg { check_output_matches_expected_for :with_setup }
 eg { check_output_matches_expected_for :checking_nil }

data/examples/assertion_success_and_info.rb

@@ -0,0 +1,27 @@
+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)
+end
+
+__END__
+
+- name: Some successes, then a fail
+  status: failure
+  result: 
+  - name: list.first
+    status: success
+    result: 1
+  - name: list[1]
+    status: success
+    result: 2
+  - name: list.last
+    status: info
+    result: 3
+  - name: list[2]
+    status: success
+    result: 3

data/lib/exemplor.rb

@@ -18,64 +18,64 @@ class String
 end
 
 module Exemplor
-  
+
   def self.version() File.read(__FILE__.sub('lib/exemplor.rb','VERSION')) end
-  
+
   class ExampleDefinitionError < StandardError ; end
-  
+
   class Check
-    
+
     attr_reader :expectation, :value
-    
+
     def initialize(name, value)
       @name  = name
       @value = value
     end
-    
+
     def [](disambiguate)
       @disambiguate = disambiguate
       self
     end
-    
+
     def name
       @name + (defined?(@disambiguate) ? " #{@disambiguate}" : '')
     end
-    
+
     def is(expectation)
       @expectation = expectation
     end
-    
+
     def status
       return :info unless defined? @expectation
       @value == @expectation ? :success : :failure
     end
-    
+
     def success?
       status == :success
     end
-    
+
     def failure?
       status == :failure
     end
-    
+
     def info?
       status == :info
     end
-    
+
   end
-  
+
   class ResultPrinter
-    
+
     attr_reader :name,:status,:result,:stderr
-    
+
     def initialize(name,status,result,stderr)
       @name,@status,@result,@stderr = name,status,result,stderr
     end
-    
+
     def failure?
       [:error,:failure].include?(self.status)
     end
-    
+
     def yaml
       hsh = OrderedHash do |o|
         o['name'] = self.name
@@ -88,7 +88,7 @@ module Exemplor
       end
       YAML.without_header([hsh])# prints an array
     end
-    
+
     def fancy
       # •∙ are inverted in my terminal font (Incosolata) so I'm swapping them
       require 'term/ansicolor'
@@ -96,7 +96,8 @@ module Exemplor
       when :info : blue format_info("• #{name}", result)
       when :infos
         formatted_result = result.map do |r|
-          format_info("• #{r['name']}", r['result']).rstrip
+          # TODO: successful ones should be green
+          format_info("#{{'success' => '✓', 'info' => '•' }[r['status']]} #{r['name']}", r['result']).rstrip
         end.join("\n")
         blue("∙ #{name}\n#{formatted_result.indent}")
       when :success
@@ -114,30 +115,30 @@ module Exemplor
         color(:red, "☠ #{name}\n#{class_and_message.indent}\n#{backtrace.indent}")
       end
     end
-    
+
     def blue(str) color(:blue,str) end
     def green(str) color(:green,str) end
-    
+
     def color(color, str)
       [Term::ANSIColor.send(color), str, Term::ANSIColor.reset].join
     end
-    
+
     # whatahack
     def format_info(str, result)
       YAML.without_header({'FANCY' => result}).sub('FANCY', str)
     end
-    
+
   end
-  
+
   class ExampleEnv
-    
+
     class << self
-      
+
       alias_method :helpers, :class_eval
       attr_accessor :setup_block
-      
+
       def setup(&blk) self.setup_block = blk end
-      
+
       # runs the block in the example environment, returns triple:
       # [status, result, stderr]
       def run(&code)
@@ -145,13 +146,13 @@ module Exemplor
         stderr = StringIO.new
         status, result = begin
           real_stderr = $stderr ; $stderr = stderr # swap stderr
-          
+
           env.instance_eval(&self.setup_block) if self.setup_block
           value = env.instance_eval(&code)
-          result = env._status == :info ? 
+          result = env._status == :info ?
             render_value(value) : render_checks(env._checks)
           [env._status, result]
-          
+
         rescue Object => error
           [:error, render_error(error)]
         ensure
@@ -159,14 +160,14 @@ module Exemplor
         end
         [status, result, stderr.rewind && stderr.read]
       end
-      
+
       # -- these "render" methods could probably be factored away
-      
+
       # yaml doesn't want to print a class
       def render_value(value)
         value.kind_of?(Class) ? value.inspect : value
       end
-      
+
       def render_checks(checks)
         failure = nil
         out = []
@@ -197,15 +198,15 @@ module Exemplor
           o['backtrace'] = error.backtrace
         end
       end
-      
+
     end
-    
+
     attr_accessor :_checks
-    
+
     def initialize
       @_checks = []
     end
-    
+
     def Check(value)
       file, line_number = caller.first.match(/^(.+):(\d+)/).captures
       line = File.readlines(file)[line_number.to_i - 1].strip
@@ -214,26 +215,26 @@ module Exemplor
       _checks << check
       check
     end
-    
+
     def _status
       (:info    if _checks.empty?) ||
-      (:infos   if _checks.all? { |c| c.info? }) ||
+      (:failure if _checks.any? { |c| c.failure? }) ||
       (:success if _checks.all? { |c| c.success? }) ||
-      (:failure if _checks.any? { |c| c.failure? })
+       :infos
     end
-    
+
   end
-  
+
   class Examples
-    
+
     def initialize
       @examples = OrderedHash.new
     end
-    
+
     def add(name, &body)
       @examples[name] = body
     end
-    
+
     def run(patterns)
       fails = 0
       # unoffically supports multiple patterns
@@ -247,33 +248,33 @@ module Exemplor
       end
       (fails.to_f/examples_to_run.size)*100
     end
-    
+
     def list(patterns)
       patterns = Regexp.new(patterns.join('|'))
       list = @examples.keys.select { |name| name =~ patterns }
       print YAML.without_header(list)
     end
-    
+
   end
-  
+
   class << self
-    
+
     def examples
       @examples ||= Examples.new
     end
-    
+
     def extract_example_file(caller_trace)
       @example_file ||= caller_trace.first.split(":").first
     end
-    
+
     # attr_reader :example_file
-    
+
     def run_directly?
       @example_file == $0
     end
-    
+
   end
-  
+
 end
 
 # Defines an example. After definition, an example is an entry in the
@@ -301,4 +302,4 @@ at_exit do
       exit Exemplor.examples.run(args)
     end
   end
-end 
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: exemplor
 version: !ruby/object:Gem::Version 
-  version: 2010.0.1
+  prerelease: false
+  segments: 
+  - 2010
+  - 0
+  - 2
+  version: 2010.0.2
 platform: ruby
 authors: 
 - Myles Byrne
@@ -9,29 +14,37 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 +11:00
+date: 2010-03-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: orderedhash
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 6
         version: 0.0.6
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: term-ansicolor
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
         version: 1.0.3
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: myles@myles.id.au
 executables: []
@@ -40,6 +53,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README
+- TODO
 files: 
 - .gitignore
 - README
@@ -51,6 +65,7 @@ files:
 - examples/assertion_failure.rb
 - examples/assertion_success.rb
 - examples/assertion_success_and_failure.rb
+- examples/assertion_success_and_info.rb
 - examples/check_parsing.rb
 - examples/check_with_disambiguation.rb
 - examples/checking_nil.rb
@@ -76,18 +91,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A light-weight, low-fi way to provide executable usage examples of your code.
@@ -96,6 +113,7 @@ test_files:
 - examples/assertion_failure.rb
 - examples/assertion_success.rb
 - examples/assertion_success_and_failure.rb
+- examples/assertion_success_and_info.rb
 - examples/check_parsing.rb
 - examples/check_with_disambiguation.rb
 - examples/checking_nil.rb