spectroscope 0.1.0

data/.ruby

@@ -0,0 +1,53 @@
+---
+source:
+- Profile
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+requirements:
+- name: rubytest
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: reap
+  groups:
+  - build
+  development: true
+- name: mast
+  groups:
+  - build
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/proutils/spectroscope.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/spectroscope
+  code: http://github.com/rubyworks/spectroscope
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+name: spectroscope
+title: Spectroscope
+version: 0.1.0
+summary: RSpec-like BDD on RubyTest
+created: '2012-02-22'
+description: Spectroscope is a BDD framework built on RubyTest designed to emulate
+  RSpec in most respects. It is assertion framework independent so any number of assertion
+  systems can be used, such as Assay or AE.
+organization: RubyWorks
+date: '2012-02-23'

data/COPYING.rdoc

@@ -0,0 +1,36 @@
+= COPYRIGHT
+
+== NOTICES
+
+=== Spectra
+
+Copyright:: (c) 2011 RubyWorks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/spectra
+
+
+== LICENSES
+
+=== BSD-2-Clause
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice,
+          this list of conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/HISTORY.md

@@ -0,0 +1,10 @@
+# Release History
+
+## 0.1.0 / 2012-02-27
+
+This is the first usable release of Spectroscope.
+
+Changes:
+
+* Happy Birthday.
+

data/LICENSE.txt

@@ -0,0 +1,25 @@
+Spectra, Copyright 2012 Rubyworks. All rights reserved.
+
+BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,77 @@
+# Spectroscope
+
+FreeBSD Copyright (c) 2012 Rubyworks
+
+[Homepage](http://rubyworks.github.com/spectroscope) /
+[Report Issue](http://github.com/rubyworks/spectroscope/issues) /
+[Source Code](http://github.com/rubyworks/spectroscope)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/spectroscope.png)](http://travis-ci.org/rubyworks/spectroscope)
+
+
+## Description
+
+Spectroscope is an RSpec-style BDD framework that runs on top of the [Ruby Test](http://rubyworks.github.com/rubytest),
+the Ruby universal test harness. It supports all of RSpec's syntax, with a
+few exceptions.
+
+
+## Installation
+
+  $ gem install spectroscope
+
+
+## Instruction
+
+### Writing Specifications
+
+Specifications are written as block of `describe` and `it` definitions.
+
+Here's RSpec classic example:
+
+    describe Order do
+      it "sums the prices of its line items" do
+        order = Order.new
+        order.add_entry(LineItem.new(:item => Item.new(
+          :price => Money.new(1.11, :USD)
+        )))
+        order.add_entry(LineItem.new(:item => Item.new(
+          :price => Money.new(2.22, :USD),
+          :quantity => 2
+        )))
+        order.total.should eq(Money.new(5.55, :USD))
+      end
+    end
+
+Spectroscope only handle the specification structure, it does not provide an
+assertions system. For that use any of a number of available libraries,
+such [Assay-RSpec](http://rubyworks.github.com/assay-rspec) or [AE](http://rubyworks.github.com/ae).
+You can require these in a helper script, or in Ruby Test configuration (see below).
+
+### Running Specifications
+
+Running specification is done with the `rubytest` command line utility.
+
+    $ rubytest -Ilib -rae/should spec/*_spec.rb
+
+To make things simpler, create a `.test` configuration file.
+
+    require 'ae/should'
+
+    Test.run :default do |run|
+      run.files << 'spec/*_spec.rb'
+    end
+
+Then simply use:
+
+    $ rubytest
+
+
+## Copyrights
+
+Copyright (c) 2012 Rubyworks
+
+Spectroscope is distributable according to the terms of the **FreeBSD** license.
+
+See COPYING.rdoc for details.
+

data/lib/spectroscope.rb

@@ -0,0 +1,68 @@
+$TEST_SUITE ||= []
+
+module Spectroscope
+
+  require 'spectroscope/world'
+  require 'spectroscope/hooks'
+  require 'spectroscope/example'
+  require 'spectroscope/context'
+
+  # The DSL module extends the toplevel.
+  #
+  module DSL
+
+    #
+    # Define an example group.
+    #
+    def describe(topic, *tags, &block)
+      settings = {}
+
+      if Class === topic
+        settings[:subject] = topic
+        settings[:label]   = topic.name
+      else
+        settings[:label]   = topic
+      end
+
+      $TEST_SUITE << Spectroscope::Context.new(settings, &block)
+    end
+
+    #
+    #
+    #
+    def shared_examples_for(label, &block)
+      Spectroscope.shared_examples[label] = block
+    end
+  end
+
+  #
+  # Store for shared examples.
+  #
+  # @return [Hash] shared examples
+  #
+  def self.shared_examples
+    @shared_examples ||= {}
+  end
+
+  #
+  # Access to project metadata.
+  #
+  # @return [Hash] metadata
+  #
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load_file(File.dirname(__FILE__), '/spectrascope.yml')
+    )
+  end
+
+  #
+  # If constant is missing, check for it in project metadata.
+  #
+  def self.const_missing(name)
+    metadata[name.to_s.downcase] || super(name)
+  end
+
+end
+
+extend Spectroscope::DSL

data/lib/spectroscope.yml

@@ -0,0 +1,53 @@
+---
+source:
+- Profile
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+requirements:
+- name: rubytest
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: reap
+  groups:
+  - build
+  development: true
+- name: mast
+  groups:
+  - build
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/proutils/spectroscope.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/spectroscope
+  code: http://github.com/rubyworks/spectroscope
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+name: spectroscope
+title: Spectroscope
+version: 0.1.0
+summary: RSpec-like BDD on RubyTest
+created: '2012-02-22'
+description: Spectroscope is a BDD framework built on RubyTest designed to emulate
+  RSpec in most respects. It is assertion framework independent so any number of assertion
+  systems can be used, such as Assay or AE.
+organization: RubyWorks
+date: '2012-02-23'

data/lib/spectroscope/context.rb

@@ -0,0 +1,431 @@
+module Spectroscope
+
+  # This is the BDD form of a test case. It encapsulates a collection
+  # of examples.
+  #
+  # This is the `describe` in your specs.
+  #
+  class Context
+
+    #
+    # The parent context in which this describe resides.
+    #
+    attr :parent
+
+    #
+    # A description of the describe clause.
+    #
+    attr :label
+
+    #
+    # A target class, if any.
+    #
+    attr :subject
+
+    #
+    # Array and/or metadata Hash of tags.
+    #
+    attr :tags
+
+    #
+    # List of examples and sub-specifications.
+    #
+    attr :specs
+
+    #
+    # The before and after hooks.
+    #
+    attr :hooks
+
+    #
+    # Skip critera.
+    #
+    # @return [Array<String,Proc>]
+    #
+    attr :skips
+
+    #
+    # Omit criteria.
+    #
+    # @return [Array<String,Proc>]
+    #
+    attr :omits
+
+    #
+    # DSL module for evaluating `describe` blocks.
+    #
+    attr :scope
+
+    #
+    # A test case +target+ is a class or module.
+    #
+    def initialize(settings={}, &block)
+      @parent  = settings[:parent]
+      @subject = settings[:subject]
+      @label   = settings[:label]
+      @tags    = settings[:tags]
+      #@skips  = settings[:skips]
+      #@hooks  = settings[:hooks]
+
+      if @parent
+        @hooks = parent.hooks.clone
+        @skips = parent.skips.clone
+        @omits = parent.omits.clone
+      else
+        @hooks = Hooks.new
+        @skips = []
+        @omits = []
+      end
+
+      @specs = []
+
+      @scope = Scope.new(self)
+
+      evaluate(&block)
+    end
+
+    #
+    # Evalute a block of code in the context of the Context's scope.
+    # When finished it iterates over `omits` and `skips`, removing and
+    # marks examples to be skipped respectively.
+    #
+    def evaluate(&block)
+      @scope.module_eval(&block)
+
+      specs.delete_if do |spec|
+        omits.any?{ |reason, block| block.call(spec) }
+      end
+
+      specs.each do |spec|
+        skips.each do |reason, block|
+          if spec.match?(match)
+            spec.skip = reason
+          end
+        end
+      end
+    end
+
+    #
+    # Shared runtime scope for specs.
+    #
+    def it_scope
+      @it_scope ||= Example::Scope.new(self)
+    end
+
+    #
+    # Add `it` or sub-`describe` to group.
+    #
+    def <<(spec)
+      @specs << spec
+    end
+
+    #
+    # Iterate over each test and subcase.
+    #
+    def each(&block)
+      specs.each(&block)
+    end
+
+    #
+    # Run before-all and after-all advice around yeilding
+    # to test runss.
+    #
+    def call
+      hooks.run(self, :before, :all, it_scope)
+      yield
+      hooks.run(self, :after,  :all, it_scope)
+    end
+
+    #
+    # Number of specs plus subcases.
+    #
+    def size
+      specs.size
+    end
+
+    #
+    # Ruby Test supports `type` to describe the nature of
+    # the underlying test system.
+    #
+    def type
+      'describe'
+    end
+
+    alias :inspect :to_s
+
+    #
+    # Returns the subject/label as string.
+    #
+    def to_s
+      label.to_s
+    end
+
+    #
+    # Skip this group?
+    #
+    def skip?
+      @skip
+    end
+
+    #
+    #
+    #
+    def skip=(reason)
+      @skip = reason
+    end
+
+    #
+    # Run test in the parent of this case.
+    #
+    # @param [TestProc] test
+    #   The test unit to run.
+    #
+    def run(test, &block)
+      #hooks[:before].each do |match, block|
+      #  next if Symbol == match
+      #  if test.match?(match)
+      #    scope.instance_exec(test, &block) #block.call(unit)
+      #  end
+      #end
+
+      block.call
+
+      #hooks[:after].each do |match, block|
+      #  next if Symbol == match
+      #  if test.match?(match)
+      #    scope.instance_exec(test, &block) #block.call(unit)
+      #  end
+      #end
+    end
+
+    # Context scope is used for defining sepcifications.
+    #
+    class Scope < World
+
+      #
+      # Setup new evaluation scope.
+      #
+      def initialize(group)
+        @_group = group
+        @_hooks = group.hooks
+        @_skips = group.skips
+        @_omits = group.omits
+
+        if group.parent
+          include(group.parent.scope)
+        end
+      end
+
+      #
+      # Create a new sub-specification.
+      #
+      def describe(topic, *tags, &block)
+        settings = {}
+        settings[:parent]  = @_group
+        settings[:subject] = @_group.subject
+        settings[:tags]    = tags
+
+        if Class === topic
+          settings[:subject] = topic
+          settings[:label]   = topic.name
+        else
+          settings[:label]   = topic
+        end
+
+        group = Context.new(settings, &block)
+
+        @_group.specs << group
+
+        return group
+      end
+
+      alias_method :context, :describe
+
+      #
+      # Create an example behavior.
+      #
+      # If tags or keys are given, so must a label.
+      #
+      def it(label=nil, *tags, &procedure)
+        keys = (Hash===tags ? tags.pop : {})
+
+        settings = {
+          :parent => @_group,
+          :hooks  => @_hooks,
+          :skips  => @_skips,
+          :omits  => @_omits,
+          :topic  => @_topic,
+          :label  => label,
+          :tags   => tags,
+          :keys   => keys
+        }
+
+        spec = Example.new(settings, &procedure)
+       
+        @_group.specs << spec
+
+        spec
+      end
+
+      #
+      #
+      #
+      alias_method :example, :it
+
+      #
+      # Define before procedure.
+      #
+      # @example
+      #   describe '#puts' do
+      #     it "gives standard output" do
+      #       puts "Hello"
+      #     end
+      #
+      #     before do
+      #       $stdout = StringIO.new
+      #     end
+      #
+      #     after do
+      #       $stdout = STDOUT
+      #     end
+      #   end
+      #
+      # @param [Symbol] which
+      #   Must be either `:all` or `:each`, the later being the default.
+      #
+      # @param [Array<Symbol>] tags
+      #   List of match critera that must be matched
+      #   against tags to trigger the before procedure.
+      #
+      def before(which=:each, *tags, &procedure)
+        @_hooks.add(:before, which, *tags, &procedure)
+      end
+
+      #
+      # Define a _complex_ after procedure. The #before method allows
+      # before procedures to be defined that are triggered by a match
+      # against the unit's target method name or _aspect_ description.
+      # This allows groups of specs to be defined that share special
+      # teardown code.
+      #
+      # @example
+      #   describe '#puts' do
+      #     it "gives standard output (@stdout)" do
+      #       puts "Hello"
+      #     end
+      #
+      #     before do
+      #       $stdout = StringIO.new
+      #     end
+      #
+      #     after do
+      #       $stdout = STDOUT
+      #     end
+      #   end
+      #
+      # @param [Symbol] which
+      #   Must be either `:all` or `:each`, the later being the default.
+      #
+      # @param [Array<Symbol>] tags
+      #   List of match critera that must be matched
+      #   to trigger the after procedure.
+      #
+      def after(which=:each, *tags, &procedure)
+        @_hooks.add(:after, which, *tags, &procedure)
+      end
+
+      #
+      # Mark specs or sub-cases to be skipped.
+      #
+      # @example
+      #   it "should do something" do
+      #     ...
+      #   end
+      #   skip(/something/, "reason for skipping") if jruby?
+      #
+      def skip(reason, &block)
+        @_skips << [reason, block]
+      end
+
+      #
+      # Mark specs or sub-cases to be omitted. Omitting a test is different
+      # from skipping, in tha the later is still sent up to the test harness,
+      # where as omitted tests never get added at all.
+      #
+      # @example
+      #   it "should do something" do
+      #     ...
+      #   end
+      #   omit(/something/) if jruby?
+      #
+      def omit(reason=true, &block)
+        @_omits << [reason, block]
+      end
+
+      #
+      #
+      #
+      def let(name, &block)
+        define_method(name) do
+          #_let[name] ||= block.call
+          @_let.fetch(name){ |k| @_let[k] = instance_eval(&block) }
+        end
+      end
+
+      #
+      #
+      #
+      def let!(name, &block)
+        let(name, &block)
+        before { __send__(name) }
+      end
+
+      #
+      #
+      #
+      def subject(topic=nil, &block)
+        @_topic = topic
+        define_method(:subject, &block)
+      end
+
+      #
+      # Subject-oriented example.
+      #
+      # RSpec itself wraps this whole thing in another `describe(invocation)`
+      # clause, but that seems completely extraneous.
+      #
+      def its(invocation, &block)
+        case invocation
+        when Symbol
+          it(invocation.to_s) do
+            subject.__send__(invocation).instance_eval(&block)
+          end
+        else
+          it(invocation.to_s) do
+            #eval("subject.#{invocation}", binding).instance_eval(&block)
+            calls = invocation.to_s.split('.')
+            calls.inject(subject){ |s,m| s.__send__(invocation) }.instance_eval(&block)
+          end
+        end
+      end
+
+      #
+      #
+      #
+      #def shared_examples_for(label, &block)
+      #  @_shared_examples[label] = block
+      #end
+
+      #
+      #
+      #
+      def it_behaves_like(label)
+        proc = Spectroscope.shared_examples[label]
+        module_eval(&proc)
+      end
+
+    end
+
+  end
+
+end