exemplor 2000.1.0 → 2000.2.0

data/README

@@ -40,7 +40,7 @@ The simplest possible example:
 
 The 'i' stands for 'info' which means the example ran without error.
 
-Inspecting a few values, by default `Check` prints it's argument and the value of the argument:
+Inspecting a few values, by default `Check` prints its argument and the value of the argument:
                                 
     eg 'Accessing different parts of an array' do
       list = [1, 2, 3]
@@ -58,7 +58,7 @@ Inspecting a few values, by default `Check` prints it's argument and the value o
 
 The capital 'I' means all checks were 'info' checks.
 
-Call's to `Check` with the same argument can be disambiguated with `[]`:
+Calls to `Check` with the same argument can be disambiguated with `[]`:
 
     eg 'Array appending' do
       list = [1, 42]
@@ -137,7 +137,7 @@ Running with `--list` or `-l` lists all examples:
     - called with --l arg
     - called with some other arg (always interpreted as a regex)
 
-Otherwise the first argument is taken as a regex and only examples who's titles match are run:
+Otherwise the first argument is taken as a regex and only examples whose titles match are run:
     
     $> ruby examples.rb called
     (s) called with --list arg: 

data/Rakefile

@@ -1,9 +1,11 @@
+task :default => [:test]
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gs|
     gs.name     = "exemplor"
     gs.homepage = "http://github.com/quackingduck/exemplor"
-    gs.summary  = "A light-weight, low-fi way to provide executable usage examples or your code."
+    gs.summary  = "A light-weight, low-fi way to provide executable usage examples of your code."
     gs.email    = "myles@myles.id.au"
     gs.authors  = ["Myles Byrne"]
     gs.add_dependency('orderedhash', '>= 0.0.6')
@@ -15,7 +17,7 @@ rescue LoadError
 end
 
 task :examples do
-  exec "ruby examples.rb"
+  ruby "examples.rb"
 end
 
 task :test => :examples

data/VERSION

@@ -1 +1 @@
-2000.1.0
+2000.2.0

data/examples.rb

@@ -51,6 +51,11 @@ eg { check_output_matches_expected_for :checking_nil }
 eg { check_output_matches_expected_for :dumping_classes }
 eg { check_output_matches_expected_for :check_parsing }
 
+eg "exit status is percent of issues that failed or errored" do
+  run_example :ten_percent_failures
+  Check($?.exitstatus).is(10)
+end
+
 eg "called with --list arg" do
   list = YAML.load(run_example(:with_setup, '--list'))
   Check(list).is(["Modified env", "Unmodified env"])

data/examples/ten_percent_failures.rb

@@ -0,0 +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) }

data/exemplor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{exemplor}
-  s.version = "2000.1.0"
+  s.version = "2000.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Myles Byrne"]
-  s.date = %q{2009-10-30}
+  s.date = %q{2009-11-03}
   s.email = %q{myles@myles.id.au}
   s.extra_rdoc_files = [
     "README"
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
      "examples/no_checks.rb",
      "examples/no_checks_non_string.rb",
      "examples/oneliner.rb",
+     "examples/ten_percent_failures.rb",
      "examples/with_checks.rb",
      "examples/with_setup.rb",
      "exemplor.gemspec",
@@ -42,7 +43,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{A light-weight, low-fi way to provide executable usage examples or your code.}
+  s.summary = %q{A light-weight, low-fi way to provide executable usage examples of your code.}
   s.test_files = [
     "examples/an_error.rb",
      "examples/assertion_failure.rb",
@@ -56,6 +57,7 @@ Gem::Specification.new do |s|
      "examples/no_checks.rb",
      "examples/no_checks_non_string.rb",
      "examples/oneliner.rb",
+     "examples/ten_percent_failures.rb",
      "examples/with_checks.rb",
      "examples/with_setup.rb"
   ]

data/lib/exemplor.rb

@@ -1,4 +1,3 @@
-require 'rubygems' # TODO: remove
 require 'orderedhash'
 require 'yaml'
 
@@ -66,12 +65,9 @@ module Exemplor
       @_checks = []
     end
     
-    # fragile. doesnt work with calls like
-    # Check(get('/'))
-    # Check foo
     def Check(value)
       file, line_number = caller.first.match(/^(.+):(\d+)/).captures
-      line = File.read(file).map[line_number.to_i - 1]
+      line = File.readlines(file)[line_number.to_i - 1].strip
       name = line[/Check\((.+?)\)\s*($|#|\[|\.is.+)/,1]
       check = Check.new(name, value)
       _checks << check
@@ -93,15 +89,18 @@ module Exemplor
     end
     
     def run(patterns)
+      fails = 0
       # unoffically supports multiple patterns
       patterns = Regexp.new(patterns.join('|'))
-      @examples.each do |name, body|
-        if name =~ patterns
-          status, out, stderr = run_example(body)
-          print_yaml("#{status_icon(status)} #{name}" => out)
-          print_stderr stderr
-        end
+      examples_to_run = @examples.select { |name,_| name =~ patterns }
+      return 0 if examples_to_run.empty?
+      examples_to_run.each do |name, body|
+        status, out, stderr = run_example(body)
+        print_yaml("#{status_icon(status)} #{name}" => out)
+        print_stderr stderr
+        fails +=1 if [:error,:failure].include?(status)
       end
+      (fails.to_f/examples_to_run.size)*100
     end
     
     def list(patterns)
@@ -160,7 +159,7 @@ module Exemplor
         else
           status = :infos if env._checks.all? { |check| check.info? }
           status = :success if env._checks.all? { |check| check.success? }
-          status = :fail if env._checks.any? { |check| check.failure? }          
+          status = :failure if env._checks.any? { |check| check.failure? } 
           render_checks(env._checks)
         end
       rescue Object => error
@@ -222,8 +221,8 @@ def eg(name = nil, &example)
   return Exemplor::Example if name.nil? && example.nil?
   if name.nil?
      file, line_number = caller.first.match(/^(.+):(\d+)/).captures
-     line = File.read(file).map[line_number.to_i - 1]
-     name = line[/^\s*eg\s*\{\s*(.+?)\s*\}\s*$/,1] if name.nil?
+     line = File.readlines(file)[line_number.to_i - 1].strip
+     name = line[/^eg\s*\{\s*(.+?)\s*\}$/,1] if name.nil?
      raise Exemplor::ExampleDefinitionError, "example at #{caller.first} has no name so must be on one line" if name.nil?
   end
   Exemplor.examples.add(name, &example)
@@ -234,6 +233,6 @@ at_exit do
   if args.delete('--list') || args.delete('-l')
     Exemplor.examples.list(args)
   else
-    Exemplor.examples.run(args)
+    exit Exemplor.examples.run(args)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: exemplor
 version: !ruby/object:Gem::Version 
-  version: 2000.1.0
+  version: 2000.2.0
 platform: ruby
 authors: 
 - Myles Byrne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-30 00:00:00 +11:00
+date: 2009-11-03 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - examples/no_checks.rb
 - examples/no_checks_non_string.rb
 - examples/oneliner.rb
+- examples/ten_percent_failures.rb
 - examples/with_checks.rb
 - examples/with_setup.rb
 - exemplor.gemspec
@@ -90,7 +91,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A light-weight, low-fi way to provide executable usage examples or your code.
+summary: A light-weight, low-fi way to provide executable usage examples of your code.
 test_files: 
 - examples/an_error.rb
 - examples/assertion_failure.rb
@@ -104,5 +105,6 @@ test_files:
 - examples/no_checks.rb
 - examples/no_checks_non_string.rb
 - examples/oneliner.rb
+- examples/ten_percent_failures.rb
 - examples/with_checks.rb
 - examples/with_setup.rb