rainbow_documentation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa58903a3711010f6212d27aadb0b7b64a1d942a
+  data.tar.gz: 006311a6bd1c919457e3b6db6653070c43379c05
+SHA512:
+  metadata.gz: 34d783590e41596ee9189f557b4d46ea657e425d9b005448724652c5b4817bc1037445bf364285bc5f43866144458bf1f2bd320314788f41105b05ddcd11078d
+  data.tar.gz: 39e588bca4aa2866f079c04f7c22028630096c047e817c9449a91a0f2b9ccd0e3548081b56d6085f8ef4b33942ab7c59afeff8ba9bbd8c0d66dba593499e30f1

data/LICENSE

@@ -0,0 +1,19 @@
+
+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,15 @@
+# rainbow_documentation
+A documentation for RSpec that keeps things colourful
+
+Simply add it to your Gemfile using 
+
+```ruby
+gem 'rainbow_documentation', git: 'https://github.com/andrea-capri/rainbow_documentation'
+```
+
+and add the following to RSpec through the .rspec file
+
+```
+--color
+--format RainbowDocumentation
+```

data/lib/rainbow_documentation/version.rb

@@ -0,0 +1,4 @@
+class RainbowDocumentation
+  VERSION = '0.0.1'.freeze
+  RELEASE_DATE = '2016-04-26'.freeze
+end

data/lib/rainbow_documentation.rb

@@ -0,0 +1,83 @@
+require 'rspec'
+require 'rspec/core/formatters/base_text_formatter'
+
+class RainbowDocumentation < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register self,
+                                   :example_group_started,
+                                   :example_group_finished,
+                                   :example_passed,
+                                   :example_pending,
+                                   :example_failed
+
+  COLOR = [
+    34, #:blue,
+    94, #:light_blue,
+    36, #:cyan
+    96, #:light_cyan
+    35, #:magenta
+    95, #:light_magenta
+    37 #:light_white]
+  ].freeze
+
+  def initialize(output)
+    super
+    @output = output
+    @group_level = 0
+  end
+
+  def example_group_started(notification)
+    @output.puts wrap("#{current_indentation}#{notification.group.description.strip}", @group_level)
+    @group_level += 1
+  end
+
+  def example_group_finished(_notification)
+    @group_level -= 1
+  end
+
+  def example_passed(passed)
+    @output.puts passed_output(passed.example)
+  end
+
+  def example_pending(pending)
+    @output.puts pending_output(pending.example, pending.example.execution_result.pending_message)
+  end
+
+  def example_failed(failure)
+    @output.puts failure_output(failure.example, failure.example.execution_result.exception)
+  end
+
+  private
+
+  def passed_output(example)
+    RSpec::Core::Formatters::ConsoleCodes.wrap("#{current_indentation} -> #{example.description.strip}",
+                                               :success)
+  end
+
+  def pending_output(example, message)
+    RSpec::Core::Formatters::ConsoleCodes.wrap("#{current_indentation} -> #{example.description.strip} (PENDING: #{message})",
+                                               :pending)
+  end
+
+  def failure_output(example, _exception)
+    RSpec::Core::Formatters::ConsoleCodes.wrap("#{current_indentation} -> #{example.description.strip} " \
+                                               "(FAILED - #{next_failure_index})",
+                                               :failure)
+  end
+
+  def next_failure_index
+    @next_failure_index ||= 0
+    @next_failure_index += 1
+  end
+
+  def current_indentation
+    ' ' * @group_level
+  end
+
+  def wrap(text, code)
+    if RSpec.configuration.color_enabled?
+      "\e[#{COLOR[code]}m#{text}\e[0m"
+    else
+      text
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: rainbow_documentation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrea Capri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "\n    Colorizes the example output strings without changing the color
+  of pending and error output\n    See https://github.com/andrea-capri/rainbow_wrapper
+  for more details.\n  "
+email:
+- andrea.a.capri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rainbow_documentation/version.rb
+- lib/rainbow_documentation.rb
+homepage: 
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: A wrapper for RSpec that keeps things colourful
+test_files: []