rspec-by 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 530feafb2ba4d8e165d3a81eb827ec803ac4094c
+  data.tar.gz: 31148428b190d923d725d1ac6204c4060da170e2
+SHA512:
+  metadata.gz: cf740d5e8e9ea7e20330d41a18ed725fb61fe4d7a2a969125e56369963b8284db431f5b2fa2d56134ebe72abd776ade1756d225a17ac39b85d531aea57014914
+  data.tar.gz: b4cbe3c83717f535e208be70751d6b03d26dda461d1ba1ea2c47fd8f02a742ec48db015c2379bc882e7817d38222be99a08c3c6c81b1b485ff8a5dd27eb83aa2

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+-r rspec/by -f RSpec::By::Formatter --colour

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rspec"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mike Williams
+
+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 @@
+An RSpec formatter that provides nice message outputs akin to cucumber steps.

data/lib/rspec/by/core_ext.rb

@@ -0,0 +1,53 @@
+require "rspec/core"
+require "rspec/core/formatters/documentation_formatter"
+
+# monkey patching rspec
+module RSpec::Core
+  class Reporter
+    if defined?(NOTIFICATIONS)
+      NOTIFICATIONS.push("by_started", "by_finished")
+    end
+
+    def by_started(message)
+      notify :by_started, message
+    end
+
+    def by_ended(message = '')
+      notify :by_ended, message
+    end
+  end
+
+  unless defined?(Reporter::NOTIFICATIONS)
+    class Formatters::DocumentationFormatter
+      def by_started(message)
+      end
+      def by_ended(message = '')
+      end
+    end
+  end
+
+  class ExampleGroup
+    def by message, level=0
+      pending(message) unless block_given?
+      begin
+        @by_reporter.by_started(message)
+        yield
+      ensure
+        @by_reporter.by_ended
+      end
+    end
+
+    alias and_by by
+  end
+
+  class Example
+    private
+    
+    alias :start_without_reporter :start
+
+    def start(reporter)
+      start_without_reporter(reporter)
+      @example_group_instance.instance_variable_set(:@by_reporter, reporter)
+    end
+  end
+end

data/lib/rspec/by/formatter.rb

@@ -0,0 +1,96 @@
+require "rspec/core/formatters/documentation_formatter"
+
+##
+# This class formats RSpec to puts failing tests instantly with some
+# nice outputting/benchmarking. Useful for longer suites.
+# Known issue: when by statements are nested, the output gets muddled
+
+module RSpec
+  module By
+    class Formatter < RSpec::Core::Formatters::DocumentationFormatter
+      RSpec::Core::Formatters.register self,
+                                   :example_failed,
+                                   :example_started,
+                                   :example_passed,
+                                   :by_started,
+                                   :by_ended
+
+      RIGHT_MARGIN = 80
+
+      def initialize(output)
+        super(output)
+        @failed_examples = []
+        @by_message_length = 0
+      end
+
+      def example_started(notification)
+        output.puts(
+          "#{current_indentation}Example: #{notification.example.description}")
+        @group_level += 1
+        @example_began = @during = RSpec::Core::Time.now
+      end
+
+      def example_passed(passed)
+        @group_level -= 1
+        passed_msg = indent("Passed")
+        end_msg = end_tm.rjust(RIGHT_MARGIN - passed_msg.length, ' ')
+        output.puts RSpec::Core::Formatters::ConsoleCodes.wrap(
+                      "#{passed_msg}#{end_msg}", :success)
+      end
+
+      def example_failed(failure)
+        @group_level -= 1
+        output.puts("#{current_indentation}Failed in #{end_tm}")
+        @failed_examples << failure.example
+        output.puts failure.fully_formatted(@failed_examples.size)
+        output.puts
+      end
+
+      def by_started message
+        res = indent message
+        @by_message_length = res.length
+        output.print by_output(res)
+      end
+
+      def by_ended(message)
+        message += during_tm
+        output.puts by_output(message.rjust(RIGHT_MARGIN - @by_message_length, ' '))
+      end
+
+      def indent message
+        "#{current_indentation}#{message}"
+      end
+
+      def by_output message
+        RSpec::Core::Formatters::ConsoleCodes.wrap(message, :cyan)
+      end
+
+      def during_tm
+        temp = RSpec::Core::Time.now
+        delta = temp - @during
+        @during = temp
+        format_time(delta)
+      end
+
+      def end_tm
+        delta = RSpec::Core::Time.now - @example_began
+        format_time(delta)
+      end
+
+      def format_time(duration)
+        if duration > 60
+          minutes = duration.to_i / 60
+          seconds = duration - minutes * 60
+          "#{minutes}m #{format_seconds(seconds)}s"
+        else
+          "#{format_seconds(duration)}s"
+        end
+      end
+
+      def format_seconds(float, precision = nil)
+        precision ||= (float < 1) ? 5 : 2
+        sprintf("%.#{precision}f", float)
+      end
+    end
+  end
+end

data/lib/rspec/by/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module By
+    VERSION = "0.0.5"
+  end
+end

data/lib/rspec/by.rb

@@ -0,0 +1,2 @@
+require "rspec/by/formatter"
+require "rspec/by/version"

data/rspec-by.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path("../lib/rspec/by/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'rspec-by'
+  s.version       = RSpec::By::VERSION
+  s.date          = '2016-03-30'
+  s.summary       = "RSpec formatter"
+  s.description   = "An RSpec formatter that provides step-like message output"
+  s.authors       = ["Masaki Matsuo"]
+  s.email         = 'masaki.matsuo@pnmac.com'
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.homepage      = 'https://github.com/sleepn247/rspec-by'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency("rspec-core", ">= 3")
+end

data/spec/rspec/by/formatter_spec.rb

@@ -0,0 +1,106 @@
+require "rspec/by/core_ext"
+require "stringio"
+
+module RSpec::By
+  RSpec.describe Formatter do
+
+    def undent(raw)
+      if raw =~ /\A( +)/
+        indent = $1
+        raw.gsub(/^#{indent}/, '').gsub(/ +$/, '')
+      else
+        raw
+      end
+    end
+
+    def normalize_durations(output)
+      output.gsub(/(\d?m )?\d+\.\d+s/) do |dur|
+        $1 == 'm' ? "nm n.nns" : "n.nnnnns"
+      end
+    end
+
+    def remove_color(output)
+      output.gsub(/\e\[(\d+)(;\d+)*m/, '')
+    end
+
+    def reporter
+      @reporter ||= setup_reporter
+    end
+
+    def setup_reporter(*streams)
+      config.add_formatter described_class, *streams
+      @formatter = config.formatters.first
+      @reporter = config.reporter
+    end
+
+    def config
+      @configuration ||=
+        begin
+          config = RSpec::Core::Configuration.new
+          config.output_stream = formatter_output
+          config
+        end
+    end
+
+    def formatter_output
+      @formatter_output ||= StringIO.new
+    end
+
+    def formatter
+      @formatter ||=
+        begin
+          setup_reporter
+          @formatter
+        end
+    end
+
+    it "outputs correctly" do
+      group = RSpec.describe("root")
+      context1 = group.describe("context 1")
+      context1.example("nested example 1.1"){}
+      context1.example("nested example 1.2") do
+        by('knock knock') {}
+        and_by("who's there?") {}
+        and_by('by') {}
+        and_by('by who?') {}
+        and_by('by by') {}
+      end
+
+      context11 = context1.describe("context 1.1")
+      context11.example("nested example 1.1.1"){}
+      context11.example("nested example 1.1.2"){}
+
+      context2 = group.describe("context 2")
+      context2.example("nested example 2.1"){}
+      context2.example("nested example 2.2"){}
+
+      group.run(reporter)
+
+      output = normalize_durations(formatter_output.string)
+      output = remove_color(output)
+      expect(output).to eq(normalize_durations("
+root
+  context 1
+    Example: nested example 1.1
+    Passed                                                              0.00022s
+    Example: nested example 1.2
+      knock knock                                                       0.00022s
+      who's there?                                                      0.00022s
+      by                                                                0.00022s
+      by who?                                                           0.00022s
+      by by                                                             0.00022s
+    Passed                                                              0.00022s
+    context 1.1
+      Example: nested example 1.1.1
+      Passed                                                            0.00022s
+      Example: nested example 1.1.2
+      Passed                                                            0.00022s
+  context 2
+    Example: nested example 2.1
+    Passed                                                              0.00022s
+    Example: nested example 2.2
+    Passed                                                              0.00022s
+"))
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: rspec-by
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Masaki Matsuo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: An RSpec formatter that provides step-like message output
+email: masaki.matsuo@pnmac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- lib/rspec/by.rb
+- lib/rspec/by/core_ext.rb
+- lib/rspec/by/formatter.rb
+- lib/rspec/by/version.rb
+- rspec-by.gemspec
+- spec/rspec/by/formatter_spec.rb
+homepage: https://github.com/sleepn247/rspec-by
+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.6.2
+signing_key: 
+specification_version: 4
+summary: RSpec formatter
+test_files:
+- spec/rspec/by/formatter_spec.rb