matrix_formatter 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGZjMWQ3ZWY2ZWVlZGQ5M2QzYzU1ZGI4NGNhZjE3YWNjMDM2Mzk3Mg==
+  data.tar.gz: !binary |-
+    YzA3NDQxZjU1ODQ2NmE4MGEwZTM1ZTMwNDMyNTU1YzE0ODZlNWMwNg==
+SHA512:
+  metadata.gz: !binary |-
+    MjBhMDM3ZGMxZWQyNmMxYTE3ZTI3MTI5NzQ2ODliMzVmZGZmYWJjN2Q5NjNj
+    YzU3MGM5ZDk4ZjJkZDU1YmFiM2ZmZjc3MTJhYjExM2M3NjlmNTJhZjlkYmI4
+    OWIzODc0MjIxMWFiYWMwNTMxMTExZmQyMmE3NDBkY2FiYjUxODU=
+  data.tar.gz: !binary |-
+    OGFlZjkzZGNiMDc3ZDNkYTFmYjE2YTQyY2FmOTQ1ODEzNGNlZmZjMjQxZjBi
+    MTVhMzEzOTljNWFlODBiZjFmMDViY2YyYjM2YTdjMWM2MmYxNDI4NTBlZDUz
+    MGYyOGY2YWQzZGMxZGI1NTQ3MTY3ZWZhOTQ2MjU4ODJhODk1YjI=

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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in matrix_formatter.gemspec
+gemspec
+gem 'pry'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Max Lincoln
+
+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,74 @@
+# MatrixFormatter
+
+Generates a Feature Matrix from specs following a certain pattern.
+
+Given tests like these:
+```ruby
+require 'matrix_formatter'
+
+implementors = ['LegacyWidget', 'HTML5Widget']
+RSpec.configure do |config|
+  config.matrix_implementors = ['LegacyWidget', 'HTML5Widget']
+end
+
+describe 'MVP Features' do
+  implementors.each do |implementor|
+    context implementor do
+      it 'creates a thing' do
+        fail if implementor.eql? implementors.first
+      end
+      it 'saves a thing' do
+        fail unless implementor.eql? implementors.first
+      end
+    end
+  end
+end
+
+describe 'Cool Features' do
+  implementors.each do |implementor|
+    context implementor do
+      it 'renders a nyan cat video' do
+        fail if implementor.eql? implementors.first
+      end
+      it 'does a headstand' do
+        fail unless implementor.eql? implementors.first
+      end
+      pending 'reads your mind'
+    end
+  end
+end
+```
+
+It will produce output like this:
+![Preview](//raw.github.com/maxlinc/matrix_formatter/master/sample_html.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'matrix_formatter'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Together with the documentation formatter:
+
+`rspec sample_spec.rb --format documentation --format MatrixFormatter::Formatters::HTMLFormatter --out matrix.html`
+
+or via .rspec:
+```rb
+--format documentation
+--format MatrixFormatter::Formatters::HTMLFormatter
+--out matrix.html
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/matrix_formatter.rb

@@ -0,0 +1,15 @@
+require "matrix_formatter/version"
+require "matrix_formatter/feature_matrix"
+
+# Formatters
+require 'matrix_formatter/formatters/base_formatter'
+require 'matrix_formatter/formatters/text_formatter'
+require 'matrix_formatter/formatters/markdown_formatter'
+# require 'matrix_formatter/formatters/html_formatter'
+
+require 'multi_json'
+require 'redcarpet'
+
+RSpec.configure do |c|
+  c.add_setting :matrix_implementors, :default => []
+end

data/lib/matrix_formatter/feature_matrix.rb

@@ -0,0 +1,27 @@
+module MatrixFormatter
+  class FeatureMatrix
+    attr_accessor :current_feature, :current_implementor, :current_product
+    attr_reader :implementors
+    attr_reader :results
+
+    def initialize
+      @implementors = RSpec.configuration.matrix_implementors
+      # results[product][feature][implementor]
+      @results = Hash.new { |product_hash, product_key|
+        product_hash[product_key] = Hash.new { |feature_hash, feature_key|
+          feature_hash[feature_key] = Hash.new { |implementor_hash, implementor_key|
+            implementor_hash[implementor_key] = Hash.new
+          }
+        }
+      }
+    end
+
+    def add_result state
+      @results[current_product][current_feature][current_implementor] = state
+    end
+
+    def to_json
+      MultiJson.encode @results
+    end
+  end
+end

data/lib/matrix_formatter/formatters/base_formatter.rb

@@ -0,0 +1,47 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+module MatrixFormatter
+  module Formatters
+    class BaseFormatter < RSpec::Core::Formatters::BaseFormatter
+      attr_accessor :matrix
+
+      def initialize(output)
+        super(output)
+        @matrix = matrix
+      end
+
+      def start(expected_example_count)
+        @matrix ||= MatrixFormatter::FeatureMatrix.new
+      end
+
+      def example_group_started(example_group)
+        description = example_group.description
+        if @matrix.implementors.include? description
+          @matrix.current_implementor = description
+        else
+          @matrix.current_product = description
+        end
+      end
+
+      def example_started(example)
+        @matrix.current_feature = example.description
+      end
+
+      def example_passed(example)
+        @matrix.add_result :passed
+      end
+
+      def example_failed(example)
+        @matrix.add_result :failed
+      end
+
+      def example_pending(example)
+        @matrix.add_result :pending
+      end
+
+      def dump_summary(duration, example_count, failure_count, pending_count)
+        # don't
+      end
+    end
+  end
+end

data/lib/matrix_formatter/formatters/html_formatter.rb

@@ -0,0 +1,61 @@
+require 'matrix_formatter'
+
+class MatrixFormatter::Formatters::HTMLFormatter < MatrixFormatter::Formatters::MarkdownFormatter
+  def start_dump
+    renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :tables => true)
+
+    @output.puts header
+    @output.puts renderer.render(markdown)
+    @output.puts footer
+  end
+
+  def header
+    """
+    <html>
+    <head>
+    <style type=\"text/css\">
+      td {
+          padding: 7px 10px;
+          vertical-align: top;
+          text-align: left;
+          border: 1px solid #ddd;
+      }
+      .passed {
+        color: green;
+      }
+      .failed {
+        color: red;
+      }
+      .pending {
+        color: blue;
+      }
+    </style>
+    </head>
+    <body>
+    """
+  end
+
+  def footer
+    """
+    </body>
+    <script type=\"text/javascript\">
+      var table = document.getElementsByTagName('table')[0];
+      var tbody = table.getElementsByTagName('tbody')[0];
+      var cells = tbody.getElementsByTagName('td');
+
+      for (var i=0, len=cells.length; i<len; i++){
+          if (cells[i].innerText === 'failed'){
+              cells[i].className = 'failed';
+          }
+          else if (cells[i].innerText === 'passed'){
+              cells[i].className = 'passed';
+          }
+          else if (cells[i].innerText === 'pending'){
+              cells[i].className = 'pending';
+          }
+      }
+    </script>
+    </html>
+    """
+  end
+end

data/lib/matrix_formatter/formatters/markdown_formatter.rb

@@ -0,0 +1,27 @@
+require 'matrix_formatter'
+
+class MatrixFormatter::Formatters::MarkdownFormatter < MatrixFormatter::Formatters::BaseFormatter
+  def markdown
+    buffer = StringIO.new
+    header_line = ['Feature Group', 'Feature', RSpec.configuration.matrix_implementors].join ' | '
+    buffer.puts header_line
+    buffer.puts header_line.gsub(/[^|]/, '-')
+
+    @matrix.results.each do |product, features|
+      # Only show the product on the first line
+      product_text = "**#{product}**"
+      features.each do |feature_key, feature_results|
+        states = RSpec.configuration.matrix_implementors.map { |implementor|
+          feature_results[implementor]
+        }
+        buffer.puts [product_text, "**#{feature_key}**", states].join ' | '
+        product_text = ''
+      end
+    end
+    buffer.string
+  end
+
+  def start_dump
+    @output.puts markdown
+  end
+end

data/lib/matrix_formatter/formatters/text_formatter.rb

@@ -0,0 +1,7 @@
+require 'matrix_formatter'
+
+class MatrixFormatter::Formatters::TextFormatter < MatrixFormatter::Formatters::BaseFormatter
+  def start_dump
+    @output.puts @matrix.to_json
+  end
+end

data/lib/matrix_formatter/version.rb

@@ -0,0 +1,3 @@
+module MatrixFormatter
+  VERSION = "0.0.1"
+end

data/matrix_formatter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matrix_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matrix_formatter"
+  spec.version       = MatrixFormatter::VERSION
+  spec.authors       = ["Max Lincoln"]
+  spec.email         = ["max@devopsy.com"]
+  spec.description   = "RSpec formatter that produces a feature matrix."
+  spec.summary       = "RSpec formatter that produces a feature matrix."
+  spec.homepage      = "http://github.com/maxlinc/matrix_formatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'redcarpet'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-fire"
+  spec.add_development_dependency "json_spec"
+end

data/sample_spec.rb

@@ -0,0 +1,34 @@
+require 'matrix_formatter'
+
+implementors = ['LegacyWidget', 'HTML5Widget']
+RSpec.configure do |config|
+  config.matrix_implementors = ['LegacyWidget', 'HTML5Widget']
+end
+
+describe 'MVP Features' do
+  implementors.each do |implementor|
+    context implementor do
+      it 'creates a thing' do
+        fail if implementor.eql? implementors.first
+      end
+      it 'saves a thing' do
+        fail unless implementor.eql? implementors.first
+      end
+    end
+  end
+end
+
+describe 'Cool Features' do
+  implementors.each do |implementor|
+    context implementor do
+      it 'renders a nyan cat video' do
+        fail if implementor.eql? implementors.first
+      end
+      it 'does a headstand' do
+        fail unless implementor.eql? implementors.first
+      end
+      pending 'reads your mind'
+    end
+  end
+end
+

data/spec/base_formatter_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'stringio'
+
+describe MatrixFormatter::Formatters::BaseFormatter do
+  let(:output) { StringIO.new }
+
+  let(:matrix) { instance_double("MatrixFormatter::FeatureMatrix") }
+
+  let(:implementors) { ['legacy', 'nextgen', 'mobile'] }
+  let(:formatter) do
+    formatter = MatrixFormatter::Formatters::BaseFormatter.new(output)
+    formatter.matrix = matrix
+    formatter.start(2)
+    formatter
+  end
+
+  let(:example_group) { class_double('RSpec::Core::ExampleGroup') }
+  let(:example) { instance_double('RSpec::Core::Example') }
+
+  describe '#example_group_started' do
+    context 'starting an implementor' do
+      it 'sets the current feature to the example description' do
+        matrix.should_receive(:implementors).and_return implementors
+        implementor = implementors.sample
+        example_group.should_receive(:description).and_return implementor
+        matrix.should_receive(:current_implementor=).with(implementor)
+        formatter.example_group_started example_group
+      end
+    end
+
+    it 'sets the current product to the example description' do
+      description = 'some cool product'
+      matrix.should_receive(:implementors).and_return implementors
+      example_group.should_receive(:description).and_return description
+      matrix.should_receive(:current_product=).with(description)
+      formatter.example_group_started example_group
+    end
+  end
+
+  describe '#example_started' do
+    it 'sets the current feature to the example description' do
+      description = 'some cool feature'
+      example.should_receive(:description).and_return description
+      matrix.should_receive(:current_feature=).with(description)
+      formatter.example_started example
+    end
+  end
+
+  [:passed, :failed, :pending].each do |status|
+    method = "example_#{status.to_s}"
+    describe "##{method}" do
+      it 'tells the FeatureMatrix that about the result' do
+        matrix.should_receive(:add_result).with(status)
+        formatter.send(method.to_sym, example)
+      end
+    end
+  end
+end

data/spec/feature_matrix_spec.rb

@@ -0,0 +1,41 @@
+describe MatrixFormatter::FeatureMatrix do
+  include JsonSpec::Helpers
+  subject(:matrix) { MatrixFormatter::FeatureMatrix.new }
+
+  before do
+    matrix.current_product = 'ProductA'
+    matrix.current_implementor = 'Implementor1'
+  end
+
+  describe '#add_result' do
+    it 'associates the result with the current product/feature/implementor' do
+      matrix.current_feature = 'Feature X'
+      matrix.add_result :passed
+      matrix.current_feature = 'Feature Y'
+      matrix.add_result :failed
+      results = matrix.instance_variable_get('@results')
+      results['ProductA']['Feature X']['Implementor1'].should eq(:passed)
+      results['ProductA']['Feature Y']['Implementor1'].should eq(:failed)
+    end
+  end
+
+  describe '#to_json' do
+    it 'displays the matrix as json' do
+      matrix.current_feature = 'Feature X'
+      matrix.add_result :passed
+      matrix.current_feature = 'Feature Y'
+      matrix.add_result :failed
+      expected = generate_normalized_json({
+        'ProductA' => {
+          'Feature X' => {
+            'Implementor1' => :passed
+          },
+          'Feature Y' => {
+            'Implementor1' => :failed
+          }
+        }
+      })
+      matrix.to_json.should be_json_eql(expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'matrix_formatter'
+require 'rspec/fire'
+require 'json_spec'
+
+RSpec.configure do |config|
+  config.include(RSpec::Fire)
+  # Unfortunely rspec-fire doesn't support expect, use should
+  # until it's fixed and merged into rspec 3.
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :should
+  end
+end
+
+RSpec::Fire.configure do |config|
+  config.verify_constant_names = true
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: matrix_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Lincoln
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec formatter that produces a feature matrix.
+email:
+- max@devopsy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matrix_formatter.rb
+- lib/matrix_formatter/feature_matrix.rb
+- lib/matrix_formatter/formatters/base_formatter.rb
+- lib/matrix_formatter/formatters/html_formatter.rb
+- lib/matrix_formatter/formatters/markdown_formatter.rb
+- lib/matrix_formatter/formatters/text_formatter.rb
+- lib/matrix_formatter/version.rb
+- matrix_formatter.gemspec
+- sample_html.png
+- sample_spec.rb
+- spec/base_formatter_spec.rb
+- spec/feature_matrix_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/maxlinc/matrix_formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: RSpec formatter that produces a feature matrix.
+test_files:
+- spec/base_formatter_spec.rb
+- spec/feature_matrix_spec.rb
+- spec/spec_helper.rb