rspec_html_formatter 0.0.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem 'rspec-core', '>= 2.8.0'
+gem 'rouge', '>= 1.6.1'
+gem 'activesupport', '>= 4.1.4'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.0)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.2.0)
+    highline (1.6.21)
+    i18n (0.6.11)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rouge (1.6.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4.1.4)
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  rouge (>= 1.6.1)
+  rspec (~> 2.8.0)
+  rspec-core (>= 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kingsley Hendrickse
+
+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,70 @@
+# Publish pretty [rspec](http://rspec.info/) reports
+
+This is a ruby Rspec custom formatter which generates pretty html reports showing the results of rspec tests. This gem was build to use Rspec 2.8.0. If you want to use it with newer
+versions of Rspec then you need to include the rspec legacy formatters - see below for instructions.
+
+## Install
+
+```
+  gem install rspec_reports_formatter
+```
+
+ideally just add it to your bundler Gemfile as follows:
+
+```ruby
+ gem 'rspec_reports_formatter'
+```
+
+## Use
+When running your rspec tests with rspec 2.8.0 just use the custom formatter:
+
+This should work:
+
+```
+ rspec -f RspecHtmlFormatter spec
+```
+
+If not you can explicitly add in a require as follows:
+
+```
+ rspec --require rspec_html_formatter.rb --format RspecHtmlFormatter spec
+```
+
+If you are using a more recent version of Rspec (3.0.0 onwards) then you must include the legacy formatter gem into your project by adding it to your Gemfile:
+
+```ruby
+
+# Your gemfile
+group :development do
+  gem 'rspec','~> 3.0.0.rc1'
+  gem 'bundler', '~> 1.0'
+  gem 'rspec-legacy_formatters'
+  gem 'rspec_html_formatter'
+end
+
+```
+
+Then use it at the command line:
+
+```
+ rspec --require rspec/legacy_formatters -f RspecHtmlFormatter spec
+```
+It will probably throw out some deprecation warnings. Sorry. I will probably make a version of this reporting specifically for rspec 3.0.0 and onwards at some point.
+
+
+![example overview report]
+(https://raw.githubusercontent.com/kingsleyh/rspec_reports_formatter/master/.README/rspec_reports_overview.png)
+
+![example report]
+(https://raw.githubusercontent.com/kingsleyh/rspec_reports_formatter/master/.README/rspec_reports_report.png)
+
+If you want to provide some generated documentation for the tests you can put comments in the rspec tests like this:
+
+```ruby
+  #-> Given I have ordered a vegetarian pizza
+  #-> When I eat the pizza
+  #-> Then my tummy is full
+
+```
+
+The #-> notation is picked up and passed through a Gherkin syntax highlighter. So it was designed to use with Given,When,Then. But in theory you can put other text there too.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "rspec_html_formatter"
+  gem.homepage = "http://github.com/kingsleyh/rspec_html_formatter"
+  gem.license = "MIT"
+  gem.summary = %Q{Rspec custom formatter to generate pretty html results}
+  gem.description = %Q{Rspec custom formatter to generate pretty html results}
+  gem.email = "kingsleyhendrickse@me.com"
+  gem.authors = ["Kingsley Hendrickse"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rspec_html_formatter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/rspec_html_formatter.rb

@@ -0,0 +1,233 @@
+require 'rspec/core/formatters/base_formatter'
+require 'active_support'
+require 'active_support/core_ext/numeric'
+require 'active_support/inflector'
+require 'fileutils'
+require 'rouge'
+require 'erb'
+
+I18n.enforce_available_locales = false
+
+class Oopsy
+  attr_reader :klass, :message, :backtrace, :highlighted_source, :explanation, :backtrace_message
+
+  def initialize(exception, file_path)
+    @exception = exception
+    @file_path = file_path
+    unless @exception.nil?
+      @klass = @exception.class
+      @message = @exception.message.encode('utf-8')
+      @backtrace = @exception.backtrace
+      @backtrace_message = @backtrace.select { |r| r.match(@file_path) }.join('').encode('utf-8')
+      @highlighted_source = process_source
+      @explanation = process_message
+    end
+  end
+
+  private
+
+  def process_source
+    data = @backtrace_message.split(':')
+    file_path = data.first
+    line_number = data[1].to_i
+    lines = File.readlines(file_path)
+    start_line = line_number-2
+    end_line = line_number+3
+    source = lines[start_line..end_line].join("").sub(lines[line_number-1].chomp, "--->#{lines[line_number-1].chomp}")
+
+    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight', line_numbers: true, start_line: start_line+1)
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(source))
+
+  end
+
+  def process_message
+    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(@message))
+  end
+
+end
+
+class Example
+
+  attr_reader :description, :full_description, :run_time, :duration, :status, :exception, :file_path, :metadata, :spec
+
+  def initialize(example)
+    @description = example.description
+    @full_description = example.full_description
+    @execution_result = example.execution_result
+    @run_time = (@execution_result[:run_time]).round(5)
+    @duration = @execution_result[:run_time].to_s(:rounded, precision: 5)
+    @status = @execution_result[:status].to_s
+    @metadata = example.metadata
+    @file_path = @metadata[:file_path]
+    @exception = Oopsy.new(example.exception, @file_path)
+    @spec = nil
+  end
+
+  def has_exception?
+    !@exception.klass.nil?
+  end
+
+  def has_spec?
+    !@spec.nil?
+  end
+
+  def set_spec(spec)
+    @spec = spec
+  end
+
+  def klass(prefix='label-')
+    class_map = {passed: "#{prefix}success", failed: "#{prefix}danger", pending: "#{prefix}warning"}
+    class_map[@status.to_sym]
+  end
+
+end
+
+class Specify
+
+  def initialize(examples)
+    @examples = examples
+  end
+
+  def process
+    lines = File.readlines(@examples.first.file_path)
+    @examples.each_with_index do |e, i|
+      start_line = e.metadata[:line_number]
+      end_line = @examples[i+1].nil? ? lines.size : @examples[i+1].metadata[:line_number] - 1
+      code_block = lines[start_line..end_line]
+      spec = code_block.select { |l| l.match(/#->/) }.join('')
+      if !spec.split.empty?
+        formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
+        lexer = Rouge::Lexers::Gherkin.new
+        formatted_spec = formatter.format(lexer.lex(spec.gsub('#->', '')))
+        e.set_spec(formatted_spec)
+      end
+    end
+    @examples
+  end
+end
+
+class RspecHtmlFormatter < RSpec::Core::Formatters::BaseFormatter
+
+  REPORT_PATH = './rspec_html_reports'
+
+  def initialize(io_standard_out)
+    create_reports_dir
+    create_resources_dir
+    copy_resources
+    @all_groups = {}
+  end
+
+  def example_group_started(example_group)
+    @example_group = {}
+    @group_examples = []
+    @group_example_count = 0
+    @group_example_success_count = 0
+    @group_example_failure_count = 0
+    @group_example_pending_count = 0
+  end
+
+  def example_started(example)
+    @group_example_count += 1
+  end
+
+  def example_passed(example)
+    @group_example_success_count += 1
+    @group_examples << Example.new(example)
+  end
+
+  def example_failed(example)
+    @group_example_failure_count += 1
+    @group_examples << Example.new(example)
+  end
+
+  def example_pending(example)
+    @group_example_pending_count += 1
+    @group_examples << Example.new(example)
+  end
+
+  def example_group_finished(example_group)
+    File.open("#{REPORT_PATH}/#{example_group.description.parameterize}.html", 'w') do |f|
+
+      @passed = @group_example_success_count
+      @failed = @group_example_failure_count
+      @pending = @group_example_pending_count
+
+      duration_values = @group_examples.map { |e| e.run_time }
+
+      duration_keys = duration_values.size.times.to_a
+      if duration_values.size < 2
+        duration_values.unshift(duration_values.first)
+        duration_keys = duration_keys << 1
+      end
+
+      @title = example_group.description
+      @durations = duration_keys.zip(duration_values)
+      @summary_duration = duration_values.inject(0) { |sum, i| sum + i }.to_s(:rounded, precision: 5)
+      @examples = Specify.new(@group_examples).process
+
+      class_map = {passed: 'success', failed: 'danger', pending: 'warning'}
+      statuses = @examples.map { |e| e.status }
+      status = statuses.include?('failed') ? 'failed' : (statuses.include?('passed') ? 'passed' : 'pending')
+      @all_groups[example_group.description.parameterize] = {
+          group: example_group.description,
+          examples: @examples.size,
+          status: status,
+          klass: class_map[status.to_sym],
+          passed: statuses.select { |s| s == 'passed' },
+          failed: statuses.select { |s| s == 'failed' },
+          pending: statuses.select { |s| s == 'pending' },
+          duration: @summary_duration
+      }
+
+      template_file = File.read(File.dirname(__FILE__) + '/../templates/report.erb')
+
+      f.puts ERB.new(template_file).result(binding)
+
+    end
+
+  end
+
+  def close
+    File.open("#{REPORT_PATH}/overview.html", 'w') do |f|
+      @overview = @all_groups
+
+      @passed = @overview.values.map { |g| g[:passed].size }.inject(0) { |sum, i| sum + i }
+      @failed = @overview.values.map { |g| g[:failed].size }.inject(0) { |sum, i| sum + i }
+      @pending = @overview.values.map { |g| g[:pending].size }.inject(0) { |sum, i| sum + i }
+
+      duration_values = @overview.values.map { |e| e[:duration] }
+
+      duration_keys = duration_values.size.times.to_a
+      if duration_values.size < 2
+        duration_values.unshift(duration_values.first)
+        duration_keys = duration_keys << 1
+      end
+
+      @durations = duration_keys.zip(duration_values.map{|d| d.to_f.round(5)})
+      @summary_duration = duration_values.map{|d| d.to_f.round(5)}.inject(0) { |sum, i| sum + i }.to_s(:rounded, precision: 5)
+      @total_examples = @passed + @failed + @pending
+      template_file = File.read(File.dirname(__FILE__) + '/../templates/overview.erb')
+      f.puts ERB.new(template_file).result(binding)
+    end
+  end
+
+
+  private
+  def create_reports_dir
+    FileUtils.rm_rf(REPORT_PATH) if File.exists?(REPORT_PATH)
+    FileUtils.mkpath(REPORT_PATH)
+  end
+
+  def create_resources_dir
+    file_path = REPORT_PATH + '/resources'
+    FileUtils.mkdir_p file_path unless File.exists?(file_path)
+  end
+
+  def copy_resources
+    FileUtils.cp_r(File.dirname(__FILE__) + '/../resources', REPORT_PATH)
+  end
+
+end