uninhibited 0.1.0

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Bernerd Schaefer
+
+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,31 @@
+# Uninhibited
+
+Inspired by [unencumbered](http://github.com/hashrocket/unencumbered),
+Unhibited gives painless Cucumber-style syntax for RSpec integration tests.
+
+Here's a sample feature in Uninhibited:
+
+    require "spec_helper"
+
+    Feature "User creates a vurl" do
+      Given "I am on the home page" do
+        visit root_path
+      end
+
+      When "I submit a valid vurl" do
+        fill_in "vurl_url", :with => 'http://example.com'
+        click_button 'Vurlify!'
+      end
+
+      Then "I should be on the vurl stats page" do
+        current_url.should == stats_url(Vurl.last.slug)
+      end
+
+      And "I should see a success message" do
+        response.body.should include('Vurl was successfully created')
+      end
+
+      And "my vurl was created" do
+        Vurl.last.url.should == 'http://example.com'
+      end
+    end

data/lib/uninhibited.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require 'uninhibited/background_metadata'
+require 'uninhibited/feature'
+require 'uninhibited/formatter'
+require 'uninhibited/object_extensions'
+require 'uninhibited/version'
+
+module Uninhibited
+
+  # Set up Uninhibited's required features, and configures RSpec as necessary.
+  def self.setup
+    Object.send(:include, Uninhibited::ObjectExtensions)
+
+    RSpec::Core::Metadata.send(:include, BackgroundMetadata)
+
+    config = RSpec.configuration
+    config.filter[:include_background] = true if config.filter
+    config.formatter = Uninhibited::Formatter
+  end
+
+end
+
+Uninhibited.setup

data/lib/uninhibited/background_metadata.rb

@@ -0,0 +1,28 @@
+module Uninhibited
+  # Extension for RSpec::Core::Metadata to include background step definitions
+  # even when running filtered actions.
+  module BackgroundMetadata
+
+    # When running a filtered set of steps, we still want to run the background
+    # steps, so we need a custom method for handling this case.
+    def all_apply_or_background?(filters)
+      if filters[:include_background] && self[:background]
+        true
+      else
+        rspec_all_apply?(filters.reject { |k,| k == :include_background })
+      end
+    end
+
+    private
+
+    # @param [RSpec::Core::Metadata] base rspec's metadata class
+    # @api private
+    def self.included(base)
+      base.class_eval <<-RUBY
+        alias rspec_all_apply? all_apply?
+        alias all_apply? all_apply_or_background?
+      RUBY
+    end
+
+  end
+end

data/lib/uninhibited/feature.rb

@@ -0,0 +1,169 @@
+module Uninhibited
+
+  # Features
+  # @todo complete
+  module Feature
+
+    # Defines a new Scenario group
+    #
+    #   Feature "User signs in" do
+    #     Scenario "success" do
+    #       Given "I on the login page"
+    #       When "I fill in my email and password"
+    #     end
+    #   end
+    #
+    # This will be printed like so:
+    #
+    #   Feature: User signs in
+    #     Scenario: success
+    #       Given I am on the login page
+    #       When I fill in my email and password
+    #
+    # @param args the description, metadata, etc. as RSpec's #describe method
+    # takes.
+    # @param example_group_block the block to be executed within the feature
+    def Scenario(*args, &example_group_block)
+      describe("Scenario:", *args) do
+        instance_eval(&example_group_block) if block_given?
+      end
+    end
+
+    # Defines a new Background group
+    #
+    #   Feature "Something" do
+    #     Background do
+    #       Given "I..."
+    #     end
+    #     Scenario "success" do
+    #       When "I..."
+    #     end
+    #     Scenario "failure" do
+    #       When "I..."
+    #     end
+    #   end
+    #
+    # This will be printed like so:
+    #
+    #   Feature: User signs in
+    #     Background:
+    #       Given I...
+    #     Scenario: success
+    #       When I...
+    #     Scenario: failure
+    #       When I...
+    #
+    # @param args the description, metadata, etc. as RSpec's #describe method
+    # takes.
+    # @param example_group_block the block to be executed within the feature
+    def Background(*args, &example_group_block)
+      describe("Background:", *args) do
+        metadata[:background] = true
+
+        instance_eval(&example_group_block) if block_given?
+      end
+    end
+
+    # Defines a new Given example
+    #
+    #   Given "I am on the home page" do
+    #     visit root_path
+    #   end
+    #
+    # @param [String] desc the description
+    # @param [Hash] options the metadata for this example
+    # @param block the example's code
+    def Given(desc=nil, options={}, &block)
+      example("Given #{desc}", options, &block)
+    end
+
+    # Defines a new When example
+    #
+    #   When "I click Home" do
+    #     click_link "Home"
+    #   end
+    #
+    # @param [String] desc the description
+    # @param [Hash] options the metadata for this example
+    # @param block the example's code
+    def When(desc=nil, options={}, &block)
+      example("When #{desc}", options, &block)
+    end
+
+    # Defines a new Then example
+    #
+    #   Then "I see a welcome message" do
+    #     page.should have_content("Welcome!")
+    #   end
+    #
+    # @param [String] desc the description
+    # @param [Hash] options the metadata for this example
+    # @param block the example's code
+    def Then(desc=nil, options={}, &block)
+      example("Then #{desc}", options, &block)
+    end
+
+    # Defines a new And example
+    #
+    #   And "I am on the home page" do
+    #     visit root_path
+    #   end
+    #
+    # @param [String] desc the description
+    # @param [Hash] options the metadata for this example
+    # @param block the example's code
+    def And(desc=nil, options={}, &block)
+      example("And #{desc}", options, &block)
+    end
+
+    # Defines a new But example
+    #
+    #   But "I am on the home page" do
+    #     visit root_path
+    #   end
+    #
+    # @param [String] desc the description
+    # @param [Hash] options the metadata for this example
+    # @param block the example's code
+    def But(desc=nil, options={}, &block)
+      example("But #{desc}", options, &block)
+    end
+
+    # Skip examples after the example provided.
+    #
+    # @param [ExampleGroup] example_group the example group of example
+    # @param [Example] example the example to skip after
+    #
+    # @api private
+    def skip_examples_after(example_group, example)
+      examples = example_group.descendant_filtered_examples.flatten
+      examples[examples.index(example)..-1].each do |e|
+        e.metadata[:pending] = true
+        e.metadata[:skipped] = true
+      end
+    end
+
+    private
+
+    # Extends an ExampleGroup with the features required for running
+    # Uninhibited specs.
+    #
+    # @param [ExampleGroup] base the example group
+    # @api private
+    def self.extended(base)
+      base.metadata[:feature] = true
+
+      base.after(:each) do
+        if example.instance_variable_get(:@exception)
+          if example.example_group.metadata[:background]
+            self.class.skip_examples_after(self.class.ancestors[1], example)
+          else
+            self.class.skip_examples_after(self.class, example)
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/uninhibited/formatter.rb

@@ -0,0 +1,88 @@
+module Uninhibited
+
+  # Custom formatter for displaying the results of a feature.
+  class Formatter < RSpec::Core::Formatters::DocumentationFormatter
+
+    # the number of skipped examples
+    # @attr [Integer]
+    attr_accessor :skipped_count
+
+    # the skipped examples
+    # @attr_reader [Array]
+    attr_reader :skipped_examples
+
+    # Builds a new formatter for outputting Uninhibited features.
+    #
+    # @api rspec
+    # @param [IO] output the output stream
+    def initialize(output)
+      super
+      @skipped_examples = []
+      @skipped_count = 0
+    end
+
+    # Adds the pending example to skipped examples array if it was skipped,
+    # otherwise it delegates to super.
+    #
+    # @api rspec
+    def example_pending(example)
+      if example_group.metadata[:feature] && example.metadata[:skipped]
+        @skipped_examples << pending_examples.delete(example)
+        @skipped_count += 1
+        output.puts cyan("#{current_indentation}#{example.description}")
+      else
+        super
+      end
+    end
+
+    # Stubbed method to return the summary as provided, since the summary will
+    # already be colorized.
+    #
+    # @return [String] the output summary
+    #
+    # @api rspec
+    def colorise_summary(summary)
+      summary
+    end
+
+    # Generates a colorized summary line based on the supplied arguments.
+    #
+    #   formatter.summary_line(1, 0, 0)
+    #   # => 1 example (0 failures)
+    #
+    #   formatter.summary_line(2, 1, 1)
+    #   # => 2 examples (1 failure, 1 pending)
+    #
+    #   formatter.skipped_count += 1
+    #   formatter.summary_line(2, 0, 0)
+    #   # => 2 examples (1 failure, 1 skipped)
+    #
+    # @param [Integer] example_count the total examples run
+    # @param [Integer] failure_count the failed examples
+    # @param [Integer] pending_count the pending examples
+    #
+    # @return [String] the formatted summary line
+    #
+    # @api rspec
+    def summary_line(example_count, failure_count, pending_count)
+      pending_count -= skipped_count
+      summary = pluralize(example_count, "example")
+      summary << " ("
+      summary << red(pluralize(failure_count, "failure"))
+      summary << ", " << yellow("#{pending_count} pending") if pending_count > 0
+      summary << ", " << cyan("#{skipped_count} skipped") if skipped_count > 0
+      summary << ")"
+      summary
+    end
+
+    # Generate a string to output to the terminal with cyan coloration
+    #
+    # @param  [String] text the text to be colorized
+    # @return [String] colorized text
+    def cyan(text)
+      color(text, "\e[36m")
+    end
+
+  end
+
+end

data/lib/uninhibited/object_extensions.rb

@@ -0,0 +1,29 @@
+module Uninhibited
+
+  # Extension methods to be included in the global object space
+  # for defining features.
+  module ObjectExtensions
+
+    # Defines a new feature:
+    #
+    #   Feature "User signs in" do
+    #     Given "..."
+    #     When  "..."
+    #     Then  "..."
+    #   end
+    #
+    # @param args the description, metadata, etc. as RSpec's #describe method
+    # takes.
+    # @param example_group_block the block to be executed within the feature
+    #
+    # @return [Feature] the new example group
+    def Feature(*args, &example_group_block)
+      describe(*args) do
+        extend Uninhibited::Feature
+        instance_eval(&example_group_block) if block_given?
+      end
+    end
+
+  end
+
+end

data/lib/uninhibited/version.rb

@@ -0,0 +1,3 @@
+module Uninhibited
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: uninhibited
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bernerd Schaefer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: ""
+email: bj.schaefer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/uninhibited/background_metadata.rb
+- lib/uninhibited/feature.rb
+- lib/uninhibited/formatter.rb
+- lib/uninhibited/object_extensions.rb
+- lib/uninhibited/version.rb
+- lib/uninhibited.rb
+- README.md
+- MIT_LICENSE
+has_rdoc: true
+homepage: http://bernerdschaefer.github.com/uninhibited
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: uninhibited
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: []
+