reason 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rson.gemspec
+gemspec
+gem "bundler"
+gem "cucumber"
+gem "rspec"
+gem "aruba"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steve Yadlowsky
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Because
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'because'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install because
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/features/because.feature

@@ -0,0 +1,50 @@
+Feature: `before` clause for describing tests
+  As a behaviour driven developer
+  In order to keep track of why specifications are required
+  I want a way to document the reason for a test.
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+    """
+    require "rubygems"
+    require "bundler/setup"
+    require "reason"
+    RSpec.configure do |config|
+      config.include Reason::Explanations
+    end
+    """
+
+  Scenario: Simple test with a reason
+    Given a file named "spec/simple_spec.rb" with:
+    """
+    require "spec_helper"
+
+    describe String do
+      subject { "a simple string" }
+
+      it { should respond_to(:to_s) }
+      because "sometimes symbols and strings both get to_s called on them"
+    end
+    """
+    When I run `rspec spec`
+    Then the example should pass
+
+  Scenario: More complex matchers with a reason
+    Given a file named "spec/simple_spec.rb" with:
+    """
+    require "spec_helper"
+
+    describe String do
+      subject { "a simple string" }
+      let(:welcome_message) { "Hello" }
+      let(:name) { "Steve Yadlowsky" }
+
+      it "should support concatenation" do
+        greeting = welcome_message + ", " + name
+        greeting.should == "Hello, Steve Yadlowsky"
+      end
+      because "NaturalLanguageProcessor uses this in its .greeting_generator method"
+    end
+    """
+    When I run `rspec spec`
+    Then the example should pass

data/features/documentation.feature

@@ -0,0 +1,41 @@
+Feature: Documentation formatter support
+  As a behaviour driven developer
+  When I use `because` to enforce contracts
+  I need to be able to see it in my documentation output
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+    """
+    require "rubygems"
+    require "bundler/setup"
+    require "reason"
+    RSpec.configure do |config|
+      config.include Reason::Explanations
+    end
+    """
+
+  Scenario: Displaying reason for an "it" block
+  Scenario: More complex matchers with a reason
+    Given a file named "spec/simple_spec.rb" with:
+    """
+    require "spec_helper"
+
+    describe String do
+      subject { "a simple string" }
+      let(:welcome_message) { "Hello" }
+      let(:name) { "Steve Yadlowsky" }
+
+      it "should support concatenation" do
+        greeting = welcome_message + ", " + name
+        greeting.should == "Hello, Steve Yadlowsky"
+      end
+      because "NaturalLanguageProcessor uses this in its .greeting_generator method"
+    end
+    """
+    When I run `rspec spec --format documentation`
+    Then it should pass with:
+    """
+    String
+      should support concatenation
+      -> because NaturalLanguageProcessor uses this in its .greeting_generator method
+    """

data/features/step_definitions/additional_cli_steps.rb

@@ -0,0 +1,4 @@
+Then /^the example(?:s)? should(?: all)? pass$/ do
+  step %q{the output should contain "0 failures"}
+  step %q{the exit status should be 0}
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'aruba/cucumber'
+require 'bundler/setup'
+# require 'rson'

data/lib/reason/version.rb

@@ -0,0 +1,5 @@
+module Reason
+  def self.version
+    "0.0.1"
+  end
+end

data/lib/reason.rb

@@ -0,0 +1,51 @@
+require "reason/version"
+require "rubygems"
+require "rspec/core/formatters/documentation_formatter"
+# require "rson/because"
+module Reason
+  module Explanations
+    def because(reason)
+      example_group = self.examples.last
+      Reason::Explanations.add(example_group, reason)
+    end
+    def self.included(mod)
+      mod.extend self
+    end
+    def self.explanations
+      @explanations ||= Hash.new
+    end
+    def self.add(example, reason)
+      explanations[example] ||= Array.new
+      explanations[example] << reason
+    end
+    def self.print_for(example, options={})
+      depth = options[:depth] || 0
+      indentation = "  " * depth
+      "#{indentation}-> because #{explanations[example].join("\n#{indentation}->")}"
+    end
+  end
+end
+
+module RSpec
+  module Core
+    module Formatters
+      class DocumentationFormatter < BaseTextFormatter
+        alias_method :old_passed, :example_passed
+        def example_passed(example)
+          old_passed(example)
+          output.puts yellow(Reason::Explanations.print_for(example, :depth => @group_level))
+        end
+        alias_method :old_pending, :example_pending
+        def example_pending(example)
+          old_pending(example)
+          output.puts yellow(Reason::Explanations.print_for(example, :depth => @group_level))
+        end
+        alias_method :old_failed, :example_failed
+        def example_failed(example)
+          old_failed(example)
+          output.puts yellow(Reason::Explanations.print_for(example, :depth => @group_level))
+        end
+      end
+    end
+  end
+end

data/reason.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/reason/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Steve Yadlowsky"]
+  gem.email         = ["steve.yadlowsky@mylookout.com"]
+  gem.description   = %q{Give meaning to your specifications}
+  gem.summary       = %q{RSpec unit tests are about enforcing a contract between interacting objects. Manage these contracts when writing your specs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "reason"
+  gem.require_paths = ["lib"]
+  gem.version       = Reason.version
+
+  gem.add_runtime_dependency "rspec"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: reason
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Steve Yadlowsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Give meaning to your specifications
+email: 
+- steve.yadlowsky@mylookout.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/because.feature
+- features/documentation.feature
+- features/step_definitions/additional_cli_steps.rb
+- features/support/env.rb
+- lib/reason.rb
+- lib/reason/version.rb
+- reason.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RSpec unit tests are about enforcing a contract between interacting objects. Manage these contracts when writing your specs
+test_files: 
+- features/because.feature
+- features/documentation.feature
+- features/step_definitions/additional_cli_steps.rb
+- features/support/env.rb