spectroscope 0.1.0

data/lib/spectroscope/example.rb

@@ -0,0 +1,243 @@
+module Spectroscope
+
+  # Example behavior.
+  #
+  # This is the `it` in your specs.
+  #
+  class Example
+
+    #
+    # Defines a specification procedure.
+    #
+    def initialize(options={}, &procedure)
+      @parent = options[:parent]
+      @label  = options[:label]
+      @hooks  = options[:hooks]
+      @skip   = options[:skip]
+      @tags   = options[:tags]
+      @keys   = options[:keys]
+      @topic  = options[:topic]
+
+      @procedure = procedure || lambda{ raise NotImplementedError } # pending
+
+      @tested = false
+    end
+
+  public
+
+    #
+    # The parent testcase to which this test belongs.
+    #
+    attr :parent
+
+    #
+    # Before and after advice.
+    #
+    attr :hooks
+
+    #
+    # Description of example.
+    #
+    attr :label
+
+    #
+    # List of identifying tags attached to example. These should
+    # be a list of Symbols, with an optional Symbol=>Object tail element.
+    #
+    attr :tags
+
+    #
+    # A map of Symbol => Object, which is taken from the end of `tags`.
+    # Unlike tags, keys allow key-value relationships, rather than just
+    # symbolic names.
+    #
+    def keys
+      Hash === tags.last ? tags.last : {}
+    end
+
+    #
+    # In RSpec data keys are called metadata.
+    #
+    alias_method :metadata, :keys
+
+    #
+    # Test procedure, in which test assertions should be made.
+    #
+    attr :procedure
+
+    #
+    # RubyTest supports `type` to describe the way in which the underlying
+    # framework represents tests.
+    #
+    def type
+      'it'
+    end
+
+    #
+    # Skip this spec?
+    #
+    def skip?
+      @skip
+    end
+
+    #
+    # Set +true+ to skip, or String to skip with reason.
+    #
+    def skip=(reason)
+      @skip = reason
+    end
+
+    #
+    #
+    #
+    def tested?
+      @tested
+    end
+
+    #
+    #
+    #
+    def tested=(boolean)
+      @tested = !!boolean
+    end
+
+    #
+    # Return label string.
+    #
+    # @return [String]
+    #
+    def to_s
+      label.to_s
+    end
+
+    #
+    # Ruby Test looks for `topic` as the desciption of the subject.
+    #
+    def topic
+      @topic.to_s
+    end
+
+    #
+    # The shared It::Scope from the parent.
+    #
+    def scope
+      @scope ||= Scope.new(parent)
+    end
+
+    #
+    #def arguments
+    #  @arguments
+    #end
+
+    #
+    #def arguments=(args)
+    #  @arguments = args
+    #end
+
+    #
+    # If +match+ is a Regexp or String, match against label.
+    # If +match+ is a Hash, match against keys.
+    # If +match+ is a Symbol, match against tags.
+    #
+    def match?(match)
+      case match
+      when Regexp, String
+        match === label
+      when Hash
+        match.any?{ |k,m| m === keys[k] }
+      else
+        tags.include?(match.to_sym)
+      end
+    end
+
+    #
+    # Execute example.
+    #
+    def call
+      parent.run(self) do
+        hooks.run(self, :before, :each, scope) #if hooks
+        scope.instance_exec(&procedure)  # TODO: can it take any argument(s) ?
+        hooks.run(self, :after,  :each, scope) #if hooks
+      end
+    end
+
+    #
+    # Example can be converted to a Proc object.
+    #
+    # @return [Proc]
+    #
+    def to_proc
+      lambda{ call }
+    end
+
+
+    # Example::Scope is used by Context to create a shared scope
+    # for running examples.
+    #
+    class Scope < World
+
+      #
+      # @param [Context] group
+      #
+      def initialize(group)
+        @_group = group
+        extend group.scope
+        #include group.scope
+        #extend self
+        @_let ||= {}
+      end
+
+      #
+      # @raise [NotImplementedError] Example is a "todo".
+      #
+      def pending(message=nil)
+        raise NotImplementedError.new(message)
+      end
+
+      #
+      #
+      #
+      def subject
+        @_subject ||= (
+          if defined?(super)
+            super || described_class.new
+          else
+            described_class.new
+          end
+        )
+      end
+
+    private
+
+      #
+      # Handle implicit subject.
+      #
+      def method_missing(s, *a, &b)
+        subject.__send__(s, *a, &b)  # public_send
+      end
+
+      #if method_defined?(:should)
+      #  # Handle implicit subject on should.
+      #  # @todo Same for method_missing ?
+      #  def should(*a,&b)
+      #    subject.should(*a,&b)
+      #  end
+      #end
+
+      #
+      # @todo Maybe deprecate. It seems silly.
+      #
+      def described_class
+        case @_group.subject
+        when Class
+          @_group.subject
+        else
+          raise NoMethodError, "undefined method `described_class` for #{self}"
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/spectroscope/hooks.rb

@@ -0,0 +1,104 @@
+module Spectroscope
+
+  # Context advice.
+  #
+  class Hooks
+
+    #
+    # New case instance.
+    #
+    def initialize
+      @hooks_all  = {:before=>[], :after=>[]}
+      @hooks_each = {:before=>[], :after=>[]}
+    end
+
+    #
+    def initialize_copy(original)
+      original.hooks_all do |tense, hooks|
+        hooks_all[tense] = hooks.clone
+      end
+      original.hooks_each do |tense, hooks|
+        hooks_each[tense] = hooks.clone
+      end
+    end
+
+    #
+    def add(tense, range, *tags, &proc)
+      case range
+      when :all
+        raise ArgumentError, "tagged #{tense}-all advice is useless" unless tags.empty?
+        @hooks_all[tense]  << Hook.new(tense, range, *tags, &proc)
+      when :each
+        @hooks_each[tense] << Hook.new(tense, range, *tags, &proc)
+      else
+        raise ArgumentError, "range must be :all or :each"
+      end
+    end
+
+    #
+    def run(target, tense, range, scope)
+      case range
+      when :all
+        hooks_all[tense].each do |hook|
+          scope.instance_eval(&hook)
+        end
+      when :each
+        hooks_each[tense].each do |hook|
+          scope.instance_eval(&hook) if hook.match?(target)
+        end
+      else
+        raise ArgumentError, "range must be :all or :each"
+      end
+    end
+
+  private
+
+    #
+    #def validate(tense, scope)
+    #  raise ArgumentError unless tense == :before or tense == :after
+    #  raise ArgumentError unless scope == :all    or tense == :each
+    #end
+
+  protected
+
+    #
+    attr :hooks_all
+
+    #
+    attr :hooks_each
+
+    # Encapsulates a hook procedure along with it's match tags.
+    #
+    class Hook
+
+      ## A brief description of the advice (optional).
+      #attr :subject
+
+      def initialize(tense, scope, *tags, &proc)
+        @tense = tense
+        @scope = scope
+        @tags  = tags
+        @proc  = proc
+      end
+
+      #
+      # Check for matching subjects or tags for each advice.
+      #
+      def match?(it)
+        return true if @tags.empty?
+
+        @tags.any? do |t|
+          it.match?(t)
+        end
+      end
+
+      #
+      def to_proc
+        @proc
+      end
+
+    end
+
+  end
+
+end

data/lib/spectroscope/world.rb

@@ -0,0 +1,7 @@
+module Spectroscope
+
+  #
+  class World < Module
+  end
+
+end

data/spec/hooks_spec.rb

@@ -0,0 +1,83 @@
+describe "hooks" do
+
+  describe "before advice" do
+
+    before :each do
+      @x = 1
+    end
+
+    it "has setup" do
+      @x.should == 1
+    end
+
+  end
+
+
+  describe "after advice" do
+
+    it "does something" do
+      @x = 1
+    end
+
+    after :each do
+      raise unless @x == 1
+    end
+
+  end
+
+
+  describe "can have more than one before and after" do
+
+    before :each do
+      @x = 1
+    end
+
+    before :each do
+      @y = 2
+    end
+
+    it "has setup" do
+      @x.should == 1
+      @y.should == 2
+    end
+
+  end
+
+
+  describe "advice can be filtered on label" do
+
+    it "is general" do
+      @special.should == nil
+    end
+
+    it "is special" do
+      @special.should == true
+    end
+
+    before :each, /special/ do
+      @special = true
+    end
+
+    after :each, /special/ do
+      @special = nil
+    end
+
+  end
+
+  describe "advice is inherited by sub-examples" do
+
+    before :each do
+      @z = 3
+    end
+
+    describe "sub-example" do
+
+      it "has setup" do
+        @z.should == 3
+      end
+
+    end
+
+  end
+
+end

data/spec/let_spec.rb

@@ -0,0 +1,34 @@
+describe Spectroscope::Context::Scope do
+
+  describe "#let" do
+    count = 0
+
+    let(:counter) { count += 1 }
+
+    it "memoizes the value" do
+      counter.should == 1
+      counter.should == 1
+    end
+
+    it "is not cached across examples" do
+      counter.should == 2
+    end
+  end
+
+  describe "#let!" do
+    order = []
+    count = 0
+
+    let!(:counter) do
+      order << :let!
+      count += 1
+    end
+
+    it "calls the helper method in a before hook" do
+      order << :example
+      order.should == [:let!, :example]
+      counter.should == 1
+    end
+  end
+
+end