rspec-illustrate 0.1.0

data/.gitignore

@@ -0,0 +1,10 @@
+.*.swp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-illustrate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Erik Schlyter
+
+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,86 @@
+# Rspec::Illustrate
+
+This is an RSpec extension gem that allows you to define illustrative objects in
+your examples that will be forwarded to the output formatter. This will allow
+your output spec to become more readable, illustrative, and explanatory.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-illustrate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-illustrate
+
+## Usage
+
+Within an example you use the `illustrate` statement to define an object that
+will be passed to the output formatter. You can also provide additional options
+if you want to set a label or define when the formatter should write the
+illustration (e.g. omit if the example fails, etc.)
+
+Given the file `./spec/array_spec.rb`:
+
+```ruby
+require 'rspec/illustrate'
+
+describe Array do
+  describe "#sort" do
+    it "should sort the array" do
+      given = [3, 1, 2]
+      expected = [1, 2, 3]
+      actual = given.sort
+
+      illustrate given.to_s, :label=>"Given the array"
+      illustrate expected.to_s, :label=>"After sort it looks like this"
+      illustrate actual.to_s, :show_when_passed=>false
+
+      expect(actual).to eq(expected)
+    end
+  end
+end
+```
+
+You execute RSpec with a formatter that takes the illustrations into
+consideration, i.e.:
+
+    $ rspec -f RSpec::Formatters::IllustratedDocumentationFormatter
+
+The output would be something like this:
+
+```
+Array
+  #sort
+    should sort the array
+    --- Given the array ---
+    [3, 1, 2]
+    --- After sort it looks like this ---
+    [1, 2, 3]
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/ErikSchlyter/rspec-illustrate/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format RSpec::Formatters::IllustratedDocumentationFormatter"
+end
+
+task :default => :spec

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/rspec/formatters/illustrated_documentation_formatter.rb

@@ -0,0 +1,81 @@
+RSpec::Support.require_rspec_core "formatters/documentation_formatter"
+require 'rspec/formatters/illustration_formatter.rb'
+
+RSpec.configure do |c|
+  c.add_setting(:illustration_passed_color,  :default => :cyan)
+  c.add_setting(:illustration_failed_color,  :default => :cyan)
+  c.add_setting(:illustration_pending_color, :default => :cyan)
+
+  color_map = RSpec::Core::Formatters::ConsoleCodes::CONFIG_COLORS_TO_METHODS
+  color_map[:illustration_passed]  = :illustration_passed_color
+  color_map[:illustration_failed]  = :illustration_failed_color
+  color_map[:illustration_pending] = :illustration_pending_color
+
+  c.add_setting(:illustration_formatter, :default =>
+                lambda {|illustration|
+                  label = illustration.has_key?(:label) ?
+                    "--- #{illustration[:label].to_s} ---\n" : ""
+
+                  return label << illustration[:content].to_s
+                })
+end
+
+module RSpec
+  module Formatters
+    include RSpec::Core::Formatters
+
+    class IllustratedDocumentationFormatter < DocumentationFormatter
+      include RSpec::Formatters
+
+      # This registers the notifications this formatter supports, and tells
+      # us that this was written against the RSpec 3.x formatter API.
+      RSpec::Core::Formatters.register self, :example_passed,
+                                             :example_failed,
+                                             :example_pending
+
+      def initialize(output)
+        super(output)
+      end
+
+      def example_passed(passed)
+        super(passed)
+        write_illustrations(passed, :show_when_passed, :illustration_passed)
+      end
+
+      def example_failed(failure)
+        super(failure)
+        write_illustrations(failure, :show_when_failed, :illustration_failed)
+      end
+
+      def example_pending(pending)
+        super(pending)
+        write_illustrations(pending, :show_when_pending, :illustration_pending)
+      end
+
+      def write_illustrations(notification, filter_key, color_type)
+        illustrations = filter(illustrations_of(notification), filter_key)
+        return if illustrations.empty?
+
+        output.puts colored(indented(formatted(illustrations)), color_type)
+      end
+
+      def colored(text, color_type)
+        RSpec::Core::Formatters::ConsoleCodes.wrap(text, color_type)
+      end
+
+      def indented(text)
+        current_indentation << text.gsub(/\n/, "\n#{current_indentation}")
+      end
+
+      def formatted(illustrations)
+        formatter_proc = RSpec.configuration.illustration_formatter
+
+        illustrations.collect{|illustration|
+          formatter_proc.call(illustration)
+        }.join("\n")
+      end
+
+    end
+  end
+end
+

data/lib/rspec/formatters/illustration_formatter.rb

@@ -0,0 +1,18 @@
+
+module RSpec
+  module Formatters
+
+    def illustrations_of(notification)
+      notification.example.metadata[:illustrations]
+    end
+
+    module_function :illustrations_of
+
+    def filter(illustrations, filter_key)
+      illustrations.select{|illustration| illustration[filter_key]}
+    end
+
+    module_function :filter
+
+  end
+end

data/lib/rspec/illustrate.rb

@@ -0,0 +1,31 @@
+require 'rspec/illustrate/version'
+require 'rspec/core'
+
+module RSpec
+  module Illustrate
+
+    def illustrate(content, *args)
+      illustration = { :content => content,
+                       :show_when_passed  => true,
+                       :show_when_failed => true,
+                       :show_when_pending => true }
+
+      args.each{|arg|
+        illustration[arg] = true if arg.is_a?(Symbol)
+        illustration.merge!(arg) if arg.kind_of?(Hash)
+      }
+
+      RSpec.current_example.metadata[:illustrations] << illustration
+      content
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include RSpec::Illustrate
+  c.before do
+    RSpec.current_example.metadata[:illustrations] = []
+  end
+end
+
+RSpec::SharedContext.send(:include, RSpec::Illustrate)

data/lib/rspec/illustrate/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Illustrate
+    VERSION = "0.1.0"
+  end
+end

data/rspec-illustrate.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/illustrate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-illustrate"
+  spec.version       = Rspec::Illustrate::VERSION
+  spec.authors       = ["Erik Schlyter"]
+  spec.email         = ["erik@erisc.se"]
+
+  spec.summary       = %q{RSpec extension gem for including illustrative objects in your specs.}
+  spec.description   = %q{A plugin to RSpec that allows you to define illustrative objects in your examples that will be forwarded to the output formatter. This will allow your output spec to become more readable, illustrative, and explanatory.}
+  spec.homepage      = "https://github.com/ErikSchlyter/rspec-illustrate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rspec-core', '~> 3.2.1'
+  spec.add_dependency 'rspec-expectations', '~> 3.2.0'
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rspec-illustrate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Erik Schlyter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A plugin to RSpec that allows you to define illustrative objects in your
+  examples that will be forwarded to the output formatter. This will allow your output
+  spec to become more readable, illustrative, and explanatory.
+email:
+- erik@erisc.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/rspec/formatters/illustrated_documentation_formatter.rb
+- lib/rspec/formatters/illustration_formatter.rb
+- lib/rspec/illustrate.rb
+- lib/rspec/illustrate/version.rb
+- rspec-illustrate.gemspec
+homepage: https://github.com/ErikSchlyter/rspec-illustrate
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2309836766520635955
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2309836766520635955
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: RSpec extension gem for including illustrative objects in your specs.
+test_files: []