testrocket 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e62650b45a99c697c146ea300cb0c6f03a53b9b8
-  data.tar.gz: 2aecec4e6db2fc1f5a36b488f4212b2dbc420cd1
+SHA256:
+  metadata.gz: bc8e7c8a771afae93f8ada5b324550864bc2bd1f8412a54a7098f440abee3791
+  data.tar.gz: 77dc8625ffc92a8c67fa23416be68b76d8a64516306d4f6e720d9da49f1941c2
 SHA512:
-  metadata.gz: a8161afc11c7646e6144196bf51a512b1aab39da67a80225146dfb9c995c1a488ee022c8b69248996117b8c11988e097117f58402e9b1941cd3a766578151a89
-  data.tar.gz: 56b62f8767679d0bf04f6e73fad121e1be6a3baeb81d208933df9087526e10a342078455c8b86467420a6043b8aa3e9cd3bd09f2d3b919118f42d8e82fcf3b3b
+  metadata.gz: aeb2b9ca986a41655129ad22ff7bd8368da5ddf52bbb0cf92ebd60398910e8cf3257b2ac77f6384e11052a53fe50787b687f4813ec788b952239abfb9da0fc53
+  data.tar.gz: 46400342d55f2bcee7d6be7d5ead3c540607cc372ea7608290e82fa624aaa957a329136b860aa16a9a867f47602e2a958c04ae4239610b252fce7d7632b4b479

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.vscode

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in testrocket.gemspec
 gemspec

data/HISTORY

@@ -1,7 +1,21 @@
-0.0.1 - August 10, 2011
+1.0.0 - October 2, 2019
 
-- Initial release
+- Breaking change: TestRocker now uses refinements to stop it polluting Object.
+
+0.1.0 - February 2, 2015
+
+- Switched default output to STDERR instead of STDOUT
+- Moved the methods that do the work into a TestRocket::Live module so...
+- .. a module called TestRocket::Dummy has been added so TestRocket isn't used in production situations
+- Extra tests for showing the location of a failing, passing, or pending test
+- Reversed HISTORY order
+- Merged VERSION constant into main module file
+- Removed the Jenkins CI stuff as I can't remember anything about it
 
 0.0.2 - May 31, 2014
 
 - Finally pushed extra syntax version to rubygems.org ;-)
+
+0.0.1 - August 10, 2011
+
+- Initial release

data/LICENSE

@@ -1,9 +1,9 @@
 This is a modified MIT license.
 
-Copyright © 2011-2012 Peter Cooper (http://peterc.org/)
+Copyright © 2011-2019 Peter Cooper (http://peterc.org/)
 
 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, sub-license, 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 every other copyright notice found in this software, and all the attributions in every file, 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 NON-INFRINGEMENT. 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.
+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 NON-INFRINGEMENT. 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

@@ -4,7 +4,7 @@
     | |_|  __|__ \ |_| | | (_) | (__|   <|  __/ |_
      \__|\___|___/\__|_|  \___/ \___|_|\_\\___|\__|
 
-Testrocket is a super simple (as simple as it gets really) testing library for Ruby 1.9 and higher.
+Testrocket is a super simple (as simple as it gets really) testing library for Ruby 2.0 and higher.
 
 It was initially developed for [a CodeBrawl contest](http://codebrawl.com/articles/contest-rundown-ruby-testing-libraries) and it won! People asked me to release it 'for real' so here we are.
 
@@ -12,12 +12,16 @@ To install:
 
     gem install testrocket
 
+.. or add it to your `Gemfile` in the usual way.
+
 As yet there are no useful bits and pieces for creating test files (look at the example, it's easy!) or Rake tasks. But it's all crazy simple. A few things may be added later on.
 
+*Note: Prior to version 1, TestRocket extended built-in classes to work, but has (in 2019) been modernized to use refinements to avoid it clashing with third party libraries in real world scenarios (yes, people use this library in real world code!)*
+
 Dependencies
 ------------
 
-- Ruby 1.9 or higher
+- Ruby 2.1 or higher
 - minitest/spec (part of MRI 1.9+ standard library)
 
 Example
@@ -25,6 +29,7 @@ Example
 
 ```ruby
 require 'testrocket'
+using TestRocket
 
 # BASIC USAGE
 # +-> { block that should succeed }
@@ -45,10 +50,36 @@ require 'testrocket'
 !-> { "use this for descriptive output and to separate your test parts" }
 ```
 
+As well as running tests in separate test files in the 'traditional' way, TestRocket can also be used 'inline' with real world code. A trivial example:
+
+```ruby
+class YourClass
+  using TestRocket
+
+  def initialize
+  end
+
+  def does_something
+    # ...
+  end
+
+  +->{  # a test for does_something goes here }
+
+  def does_something_else
+    # ...
+  end
+
+  +->{  # a test for does_something_else goes here }
+  -->{  # a test for does_something_else goes here }
+end
+```
+
+In this way, your class is tested each time you run the app in development or test modes. Note that if TestRocket detects `RACK_ENV` is `production`, `RAILS_ENV` is production or Rails is running and `Rails.env.production?` is true, the usual TestRocket methods will simply pass straight through so as to not impede performance on the loading of your app.
+
 Other Features
 --------------
 
-By default, output is written to STDOUT (as well as returned by the test expressions themselves). You can override where test output goes like so:
+By default, output is written to STDERR (as well as returned by the test expressions themselves). You can override where test output goes like so:
 
 ```ruby
 TestRocket.out = File.new('/dev/null', 'w')
@@ -56,9 +87,13 @@ TestRocket.out = File.new('/dev/null', 'w')
 
 TestRocket.out also supports Logger instances.
 
-Authors
+Credits
 -------
 
 Initial concept and maintenance by Peter Cooper
 
 Extra concepts and code by Christoph Grabo
+
+Thanks to Gary Bernhardt for often praising and shining attention on TestRocket :-)
+
+Thanks to Serge Bedzhyk for modernizing the library to use refinements.

data/lib/testrocket.rb

@@ -1,18 +1,37 @@
+# frozen_string_literal: true
+
+##
+# TestRocket Module to refine lambdas an use them for lightweight tests
+#
 module TestRocket
-  extend Module.new { attr_accessor :out }
+  VERSION = '1.0.0'
 
-  def _test(a, b); send((call rescue()) ? a : b) end
+  extend Module.new { attr_accessor :out }
 
-  def +@; _show _test :_pass, :_fail end
-  def -@; _show _test :_fail, :_pass end
-  def ~; _show _pend;               end
-  def !; _show _desc;               end
+  refine Proc do
+    # Include TestRocket methods WITHOUT implementation selected
+    Proc.send :include, TestRocket
 
-  def _show(r); (TestRocket.out || $>) << r + "\n"; r end
-  def _pass; "     OK" end
-  def _fail; "   FAIL @ #{source_location * ':'}" end
-  def _pend; "PENDING '#{call}' @ #{source_location * ':'}" end
-  def _desc; "   FIRE '#{call}'!" end
-end
+    # If we're in a production environment, the tests shall do nothing.
+    if ENV['RACK_ENV'] == 'production' ||
+       (defined?(Rails) && Rails.env.production?) ||
+       ENV['RAILS_ENV'] == 'production'
+      def _test(a, b); end
+      def _show(r); end
+      def _pend; end
+      def _desc; end
+    else
+      def _test(a, b); send((call rescue()) ? a : b) end
+      def _show(r); (TestRocket.out || STDERR) << r + "\n"; r end
+      def _pass; '     OK' end
+      def _fail; "   FAIL @ #{source_location * ':'}" end
+      def _pend; "PENDING '#{call}' @ #{source_location * ':'}" end
+      def _desc; "   FIRE '#{call}'!" end
+    end
 
-Proc.send :include, TestRocket
+    def +@; _show _test :_pass, :_fail end
+    def -@; _show _test :_fail, :_pass end
+    def ~; _show _pend end
+    def !; _show _desc end
+  end
+end

data/test/test_testrocket.rb

@@ -1,33 +1,66 @@
 require_relative 'helper'
 
-describe TestRocket do
-  it "should find emptiness non-truthful by default" do
-    (+->{}).must_match(/FAIL/)
-  end
-  
-  it "should pass a simple positive assertion" do
-    (+->{ 2 + 2 == 4 }).must_match(/OK/)
-  end
+class RefinementTest
+  using TestRocket
 
-  it "should pass a simple negative assertion" do
-    (-->{ 2 + 2 == 5 }).must_match(/OK/)
-  end
-  
-  it "should fail a simple erroneous assertion" do
-    (+->{ 2 + 2 == 5 }).must_match(/FAIL/)
-  end
+  def self.test!
+    describe TestRocket do
+      it 'should find emptiness non-truthful by default' do
+        (+->{}).must_match(/FAIL/)
+        (+->{}).must_match("#{__FILE__}:#{__LINE__}")
+      end
 
-  it "should fail a simple correct assertion assumed to fail" do
-    (-->{ 2 + 2 == 4 }).must_match(/FAIL/)
-  end
-  
-  it "should give a pending notice" do
-    (~->{ "a pending test" }).must_match(/PENDING/)
-    (~->{ "a pending test" }).must_match(/a pending test/)
+      it 'should pass a simple positive assertion' do
+        (+->{ 2 + 2 == 4 }).must_match(/OK/)
+      end
+
+      it 'should pass a simple negative assertion' do
+        (-->{ 2 + 2 == 5 }).must_match(/OK/)
+      end
+
+      it 'should fail a simple erroneous assertion' do
+        (+->{ 2 + 2 == 5 }).must_match(/FAIL/)
+        (+->{ 2 + 2 == 5 }).must_match("#{__FILE__}:#{__LINE__}")
+      end
+
+      it 'should fail a simple correct assertion assumed to fail' do
+        (-->{ 2 + 2 == 4 }).must_match(/FAIL/)
+        (-->{ 2 + 2 == 4 }).must_match("#{__FILE__}:#{__LINE__}")
+      end
+
+      it 'should give a pending notice' do
+        (~->{ 'a pending test' }).must_match(/PENDING/)
+        (~->{ 'a pending test' }).must_match(/a pending test/)
+        (~->{ 'a pending test' }).must_match("#{__FILE__}:#{__LINE__}")
+      end
+
+      it 'should fire a description rocket' do
+        (!->{ 'a description' }).must_match(/FIRE/)
+        (!->{ 'a description' }).must_match(/a description/)
+      end
+
+      it 'would influence Ruby Proc if TestRocket used explitly' do
+        (
+          ok = ->() { nil }
+          !ok
+        ).must_match(/FIRE/)
+      end
+    end
   end
-  
-  it "should fire a description rocket" do
-    (!->{ "a description" }).must_match(/FIRE/)
-    (!->{ "a description" }).must_match(/a description/)
+end
+
+class NoRefinementTest
+  def self.test!
+    describe 'Without `using TestRocket`' do
+      it 'should not influence global Ruby scope and other libs' do
+        (
+          ok = ->() { nil }
+          !ok
+        ).must_equal(false)
+      end
+    end
   end
 end
+
+RefinementTest.test!
+NoRefinementTest.test!

data/testrocket.gemspec

@@ -1,21 +1,21 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "testrocket/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'testrocket'
 
 Gem::Specification.new do |s|
-  s.name        = "testrocket"
-  s.version     = Testrocket::VERSION
+  s.name        = 'testrocket'
+  s.version     = TestRocket::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Peter Cooper","Christoph Grabo"]
-  s.email       = ["git@peterc.org","chris@dinarrr.com"]
-  s.homepage    = "http://github.com/peterc/testrocket"
+  s.authors     = ['Peter Cooper', 'Christoph Grabo']
+  s.email       = %w[git@peterc.org chris@dinarrr.com]
+  s.homepage    = 'http://github.com/peterc/testrocket'
   s.summary     = %q{A super lightweight lamdba-based testing library for Ruby}
   s.description = %q{A super lightweight lamdba-based testing library for Ruby}
 
-  s.rubyforge_project = "testrocket"
+  s.rubyforge_project = 'testrocket'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testrocket
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Cooper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-31 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies: []
 description: A super lightweight lamdba-based testing library for Ruby
 email:
@@ -20,15 +20,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
-- Gemfile.travis
 - HISTORY
 - LICENSE
 - README.md
 - Rakefile
 - lib/testrocket.rb
-- lib/testrocket/version.rb
 - test/helper.rb
 - test/test_testrocket.rb
 - testrocket.gemspec
@@ -51,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: testrocket
-rubygems_version: 2.2.0
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A super lightweight lamdba-based testing library for Ruby

data/.travis.yml

@@ -1,7 +0,0 @@
-rvm:
-  - 1.9.2
-gemfile: gemfiles/Gemfile.travis
-notifications:
-  recipients:
-    - chris@dinarrr.com
-

data/Gemfile.travis

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-gem "rake" # added for travis-ci.org
-
-# Specify your gem's dependencies in testrocket.gemspec
-gemspec

data/lib/testrocket/version.rb

@@ -1,3 +0,0 @@
-module Testrocket
-  VERSION = "0.0.2"
-end