rspec-compact-doc-formatter 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rspec-compact-doc-formatter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 De Marque inc.
+
+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,40 @@
+Rspec Compact Doc Formatter
+===============
+
+Compact yet descriptive Rspec format.
+
+Install
+-------
+
+```
+gem install rspec-compact-doc-formatter
+```
+
+If you want to use this formatter as your default formatter, simply put the options in your .rspec file:
+
+```
+--format RspecCompactDocFormatter
+```
+
+Rails 3
+-------
+
+In your Gemfile:
+
+```ruby
+group :test do
+  gem "rspec-compact-doc-formatter"
+end
+```
+
+Usage
+-----
+
+```
+rspec spec -f RspecCompactDocFormatter
+```
+
+Copyright
+---------
+
+Copyright (c) 2012 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rspec-compact-doc-formatter.rb

@@ -0,0 +1,130 @@
+require 'rspec/core/formatters/base_text_formatter'
+
+class RspecCompactDocFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  def initialize(output)
+    super(output)
+    @group_level = 0
+  end
+
+  def current_indentation
+    '  ' * @group_level
+  end
+
+  def dump_commands_to_rerun_failed_examples
+    # Hidden
+  end
+
+  def dump_pending
+    # Hidden
+  end
+
+  def example_group_started(example_group)
+    super(example_group)
+
+    description = example_group.description
+
+    if @group_level == 0
+      output_class_name description
+    elsif method_name?(description)
+      output_prelude_and_method description
+    elsif @method_position and @group_level > @method_position
+      nil
+    else
+      @prelude += description + ' '
+    end
+
+    @group_level += 1
+  end
+
+  def example_group_finished(example_group)
+    @group_level -= 1
+  end
+
+  def example_passed(example)
+    super(example)
+    output.puts passed_output(example)
+  end
+
+  def example_pending(example)
+    super(example)
+    output.puts pending_output(example, example.execution_result[:pending_message])
+  end
+
+  def example_failed(example)
+    super(example)
+    output.puts failure_output(example, example.execution_result[:exception])
+  end
+
+  def failure_output(example, exception)
+    one_liner_description example, 'red'
+  end
+
+  def method_name?(description)
+    description[0,1] == '#' or description[0,2] == '::'
+  end
+
+  def next_failure_index
+    @next_failure_index ||= 0
+    @next_failure_index += 1
+  end
+
+  def one_liner_description(example, color='green')
+    content = { :assertion => [], :result => '', :subject => 'it' }
+
+    if example_group
+      example_group.ancestors.reverse.each_with_index do |a, i|
+        if i <= @method_position
+          nil
+        elsif i != @method_position + 1 and a.description[0,4] == 'when'
+          content[:assertion] << ", #{a.description}"
+        elsif not ['and', 'having', 'when', 'with', 'without'].include? a.description.split(' ')[0] and (i+1) == example_group.ancestors.length
+          content[:subject] = a.description
+        else
+          content[:assertion] << " #{a.description}"
+        end
+      end
+    end
+
+    content[:subject] = "\e[35m#{content[:subject]}\e[0m "
+    content[:subject] = ', ' + content[:subject] if content[:assertion].length > 0
+
+    content[:result] = example.description.to_s.empty? ? 'FAILED' : example.description
+
+    return (@method_position == 1 ? '    ' : '      ') + content[:assertion].join + content[:subject] + self.send(color, content[:result])
+  end
+
+  def output_class_name(description)
+    output.puts "\n" + description
+    @prelude = ''
+  end
+
+  def output_prelude_and_method(description)
+    indent_method = @prelude.empty? ? '  ' : '    '
+
+    if @method_position and @method_position > 1
+      if @group_level == 1
+        output.puts " "
+      else
+        indent_method = '    '
+      end
+    end
+
+    if not @prelude.empty?
+      output.puts "\n  " + @prelude
+      @prelude = ''
+    end
+
+    output.puts indent_method + cyan(description)
+
+    @method_position = @group_level
+  end
+
+  def passed_output(example)
+    one_liner_description example, 'green'
+  end
+
+  def pending_output(example, message)
+    indent = (@method_position and @method_position > 1) ? '      ' : '    '
+    yellow("#{indent}#{example.description} (PENDING: #{message})")
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rspec-compact-doc-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152995160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2152995160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152994280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152994280
+description: Compact yet descriptive Rspec format.
+email:
+- sebastien@demarque.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/rspec-compact-doc-formatter.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/demarque/rspec-compact-doc-formatter
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rspec-compact-doc-formatter
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Compact yet descriptive Rspec format.
+test_files: []