exemplar 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*swp
+.bundle/
+Gemfile.lock
+.rvmrc
+pkg/
+jeweler/

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+group :development do
+  gem 'test-unit', '2.0.9'
+  gem 'rr', :git => 'http://github.com/btakita/rr.git'
+end

data/README.rdoc

@@ -0,0 +1,7 @@
+== Getting started
+
+See <tt>examples/algebra.rb</tt> for a simple example.
+
+== License and Copyright
+
+All of the code is copyrighted by Google and is released under MIT license.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "exemplar"
+
+    gem.summary = "Makes writing examples easy and fun"
+
+    gem.email = "ratnikov@gmail.com"
+    gem.homepage = "http://github.com/ratnikov/exemplar"
+    gem.authors = [ "Dmitry Ratnikov" ]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList["test/**/*_test.rb"]
+  test.libs << 'test'
+  test.verbose = false
+end
+
+desc "Run the test suite"
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0
+:build: 

data/examples/algebra.rb

@@ -0,0 +1,28 @@
+require 'exemplar'
+
+class Exemplar::Example
+  # <tt>Exemplar::Example</tt> invoked <tt>rescue_error</tt> when it encounters an error during
+  # execution of an example. While the default implementation is logging a simple error message,
+  # it's possible to change that behavior by providing a handler of our own:
+  def rescue_error(error)
+    case error
+    when ZeroDivisionError then log("Tried to divide by a zero. Bah!")
+    when ArgumentError then log("Whoops, bad argument!")
+    else
+      log("Unknown error: %s" % error.inspect)
+    end
+  end
+end
+
+example "adding two numbers together" do
+  puts "1 + 5 = %s" % (1 + 5)
+end
+
+example "subtracting a number" do
+  puts "5 - 1 = %s" % (5 - 1 )
+end
+
+example "error catching" do
+  # this should be caught by our custom error rescuer
+  puts "5 / 0 = %s" % (5 / 0)
+end

data/exemplar.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{exemplar}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dmitry Ratnikov"]
+  s.date = %q{2010-08-16}
+  s.email = %q{ratnikov@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "examples/algebra.rb",
+     "exemplar.gemspec",
+     "lib/exemplar.rb",
+     "lib/exemplar/example.rb",
+     "lib/exemplar/loggable.rb",
+     "lib/exemplar/runner.rb",
+     "test/example_test.rb",
+     "test/runner_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ratnikov/exemplar}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Makes writing examples easy and fun}
+  s.test_files = [
+    "test/example_test.rb",
+     "test/runner_test.rb",
+     "test/test_helper.rb",
+     "examples/algebra.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/exemplar.rb

@@ -0,0 +1,3 @@
+require 'exemplar/loggable'
+require 'exemplar/example'
+require 'exemplar/runner'

data/lib/exemplar/example.rb

@@ -0,0 +1,58 @@
+module Exemplar
+  class Example
+    include Loggable
+
+    class << self
+      def before_callbacks
+        @before_callbacks ||= []
+      end
+
+      def before(*before_methods)
+        before_callbacks.push *before_methods
+      end
+
+      def examples
+        @examples ||= []
+      end
+    end
+
+    attr_reader :name, :options, :block
+
+    def initialize(name, options, block)
+      @name, @options, @block = name, options, block
+
+      self.class.examples << self
+    end
+
+    def run
+      log "Running example #{name}..."
+
+      block_return = run_before_callbacks && block.call(self)
+
+      log "Done running example #{name}"
+
+      block_return
+    rescue Exception => error
+      rescue_error(error)
+    end
+
+    private
+
+    def rescue_error(error)
+      log "Whoops, seems like something went wrong. Here's the error message: %s." % error.message
+      nil
+    end
+
+    def run_before_callbacks
+      self.class.before_callbacks.all? { |callback| send(callback) }
+    end
+
+    def runner
+      Exemplar::Runner
+    end
+  end
+end
+
+def example(name, options = nil, &block)
+  Exemplar::Example.new(name, options, block)
+end

data/lib/exemplar/loggable.rb

@@ -0,0 +1,17 @@
+module Exemplar
+  module Loggable
+    class << self
+      def log?
+        @log.nil? ? true : @log
+      end
+
+      def log=(log)
+        @log = log
+      end
+    end
+
+    def log(message)
+      puts message if Loggable.log?
+    end
+  end
+end

data/lib/exemplar/runner.rb

@@ -0,0 +1,45 @@
+require 'optparse'
+
+module Exemplar
+  class Runner
+    attr_reader :examples
+
+    def initialize(examples, options = nil)
+      @examples = examples
+      @match_regex = options && options[:match]
+    end
+
+    def run
+      examples.select { |example| run?(example) }.each { |example| example.run }
+    end
+
+    def run?(example)
+      @match_regex.nil? || example.name =~ @match_regex
+    end
+
+    def self.parse_options!(argv)
+      options = {}
+
+      OptionParser.new do |opt|
+        opt.banner = "Exemplar automatic example runner.\n"
+        opt.banner << "Usage: #{$0} [options]"
+
+        opt.on
+        opt.on("-e", "--example [REGEX]", "Run examples matching the regex.") do |regex|
+          options[:match] = Regexp.new(regex)
+        end
+
+        opt.on_tail
+      end.parse!(argv)
+
+      options
+    rescue OptionParser::ParseError => e
+      puts "%s. Run `#{$0} --help` for help." % e
+      exit false
+    end
+  end
+end
+
+Kernel.at_exit do
+  Exemplar::Runner.new(Exemplar::Example.examples, Exemplar::Runner.parse_options!(ARGV)).run
+end

data/test/example_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+module Exemplar
+  class ExampleTest < Test::Unit::TestCase
+    def test_declaring_example
+      test_example = example("test example", :foo => 'bar') {  }
+
+      assert_equal 'test example', test_example.name
+      assert_equal({ :foo => 'bar' }, test_example.options)
+
+      assert_equal [ test_example ], Example.examples, "Should register the example with the runner"
+    end
+
+    def test_running_example
+      test_example = example("test example") { |example| self.invoke_something(example); :block_return }
+
+      mock( self ).invoke_something(test_example)
+
+      assert_equal :block_return, test_example.run, "Should run the example block and return whatever it returns"
+    end
+
+    def test_before_callback
+      Example.before :do_foo
+
+      assert_equal [ :do_foo ], Example.before_callbacks, "Should register a callback"
+
+      example = example("test example") { :block_return }
+
+      mock( example ).do_foo.returns true
+
+      assert_equal :block_return, example.run
+    end
+
+    def test_before_callback_cancellation
+      Example.before :false_callback
+
+      example = example("test example") { flunk("Wasn't supposed to be run") }
+
+      mock( example ).false_callback.returns false
+
+      assert_equal false, example.run, "Should return that example failed to run"
+    end
+
+    def test_exception_handling
+      error = Exception.new "bad error"
+
+      example = example("erroring example") { raise error }
+
+      mock( example ).rescue_error(error).returns :rescue_return
+
+      assert_equal :rescue_return, example.run, "should return whatever rescue returned"
+    end
+  end
+end

data/test/runner_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+module Exemplar
+  class RunnerTest < Test::Unit::TestCase
+    def test_examples_running
+      run_examples = []
+
+      example1 = example("first test example") { |e| run_examples << e }
+      example2 = example("second test example") { |e| run_examples << e }
+
+      Runner.new([ example1, example2 ]).run
+
+      assert_equal [ example1, example2 ], run_examples, "Should run the examples in order declared"
+    end
+
+    def test_example_regex
+      foo = example("a foo example") { }
+      bar = example("a bar example") { }
+
+      # should run foo, but not run bar
+      mock( foo ).run.once 
+      mock( bar ).run.never
+
+      Runner.new([ foo, bar], { :match => /foo/ }).run
+    end
+
+    def test_parse_options!
+      assert_equal({ :match => /foo bar/ }, Runner.parse_options!([ '-e', 'foo bar' ]))
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+
+begin
+  require 'bundler'
+
+  Bundler.setup
+rescue LoadError => error
+  warn "Bundler doesn't seem to be installed. Please install bundler and run: bundle install"
+  exit
+end
+
+require 'test/unit'
+require 'rr'
+
+require 'exemplar'
+
+# disable the logging for the tests
+Exemplar::Loggable.log = false
+
+class << Exemplar::Runner
+
+  # stub out the option parsing to make sure it doesn't conflict with test/unit options
+  # Yea, it's ugly... :(
+  alias_method :default_parse_options!, :parse_options!
+  def parse_options!(args)
+    args == ARGV ? { } : default_parse_options!(args)
+  end
+end
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+
+  setup
+  def setup_examples
+    # make sure there aren't any lingering examples declared
+    Exemplar::Example.examples.clear
+  end
+
+  teardown
+  def teardown_callbacks
+    # clear the callbacks to avoid future test breakage
+    Exemplar::Example.before_callbacks.clear
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: exemplar
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dmitry Ratnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-16 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ratnikov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- examples/algebra.rb
+- exemplar.gemspec
+- lib/exemplar.rb
+- lib/exemplar/example.rb
+- lib/exemplar/loggable.rb
+- lib/exemplar/runner.rb
+- test/example_test.rb
+- test/runner_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ratnikov/exemplar
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Makes writing examples easy and fun
+test_files: 
+- test/example_test.rb
+- test/runner_test.rb
+- test/test_helper.rb
+- examples/algebra.rb