scampi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d87e08f77eb962d0a96b49fae22b76e3a557335b8b3c935dabc94c0359b474e2
-  data.tar.gz: 2d5b13dc5de16fe05273dd1863d273509ff00b75a1a0d7e9f72f330a3ff70b8f
+  metadata.gz: 5ab326398426699068726dee799fa312709c6d44bfffb607de4c467d0a52a2ad
+  data.tar.gz: e3937c018adbf534d156bffc262001cee773ac741abb5a0b7d950b075e125153
 SHA512:
-  metadata.gz: c42747d107699bbccbbe14764bda1f910f35cf8b7c11492bb5180268dc33fd92afa052d57afcc5f34c7757796bcc21ed2c759eaa10c579ef39b688f7a44a2abc
-  data.tar.gz: bc2e9579188b196604b8560231bf531238ba577158a3e38d085e24ceb78674230b77940ae3c94248233b0b1274591fde5c673be2bbf4d0bde586b3a724467bf7
+  metadata.gz: 719acff10a6ca528087b0b5dde1b375e85c33c9c9aa16a1eab184cd26073f845d1c3a4a96c2dcdaf71d5480e74ccd8a8c7c3feeaed9bf908f7442d380bd15af9
+  data.tar.gz: 5a23a60fae7c9181bb425799ce76f5c9555739ad2748270ec3a1066fbed54ccdaf424f0aa100813eaa93cbab03a8ade669d8fbeb0ddb109dfcd95851ea4a5fee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scampi (0.1.1)
+    scampi (0.1.2)
       colorize-extended
 
 GEM
@@ -22,7 +22,7 @@ DEPENDENCIES
 CHECKSUMS
   colorize (1.1.0) sha256=30b5237f0603f6662ab8d1fc2bd4a96142b806c6415d79e45ef5fdc6a0cfc837
   colorize-extended (0.1.0) sha256=e8c39986e41ee2e14623c8fa02cf851ef4b83d2fe1392daa2b4d81f0df7bedc9
-  scampi (0.1.1)
+  scampi (0.1.2)
 
 BUNDLED WITH
   4.0.7

data/README.md

@@ -0,0 +1,91 @@
+# Scampi
+
+A small Ruby test framework forked from [Bacon](https://github.com/chneukirchen/bacon) with built-in [TAP (Test Anything Protocol)](https://testanything.org/) output.
+
+## Usage
+
+Tests can live alongside your code using the `test` block — it only runs when the file is executed directly or via `scampi`:
+
+```ruby
+# greet.rb
+def greet(name) = "hello #{name}"
+
+test do
+  it "equality and matching" do
+    greet("world").should == "hello world"
+    greet("world").should.equal "hello world"
+    greet("world").should =~ /hello/
+    greet("world").should.match(/hello/)
+  end
+
+  it "negation" do
+    greet("world").should.not == "goodbye"
+    greet("world").should.not.match(/goodbye/)
+  end
+
+  it "predicates" do
+    [].should.be.empty
+    nil.should.be.nil
+    true.should.be.true
+    false.should.be.false
+  end
+
+  it "type checks" do
+    "hello".should.be.kind_of String
+    "hello".should.be.instance_of String
+    "hello".should.respond_to :upcase
+  end
+
+  it "identity" do
+    s = "hello"
+    s.should.be.identical_to s
+    s.should.be.same_as s
+  end
+
+  it "comparisons" do
+    5.should.be > 3
+    5.should.be >= 5
+    3.should.be < 5
+    5.should.be <= 5
+  end
+
+  it "collections" do
+    [1, 2, 3].should.include 2
+  end
+
+  it "numeric closeness" do
+    3.14.should.be.close 3.1, 0.05
+  end
+
+  it "custom matchers" do
+    palindrome = lambda { |obj| obj == obj.reverse }
+    "racecar".should.be.a palindrome
+  end
+
+  it "satisfy" do
+    10.should.satisfy { |n| n.even? }
+  end
+
+  describe "exceptions and flow" do
+    it "raises" do
+      lambda { raise "boom" }.should.raise
+      lambda { raise "boom" }.should.raise(RuntimeError)
+      lambda { 1 + 1 }.should.not.raise
+    end
+
+    it "throws" do
+      lambda { throw :halt }.should.throw(:halt)
+    end
+
+    it "detects change" do
+      i = 0
+      lambda { i += 1 }.should.change { i }
+    end
+  end
+end
+```
+
+```
+$ ruby greet.rb
+$ scampi greet.rb
+```

data/exe/scampi

@@ -7,7 +7,7 @@ require 'scampi'
 ENV["TEST"] = "true"
 
 files = if ARGV.empty?
-  Dir.glob("test/**/*.rb")
+  `rg -l "^test do$" test`.split("\n")
 else
   ARGV.flat_map { |pattern| Dir.glob(pattern) }
 end

data/lib/scampi/monkey_patches.rb

@@ -58,4 +58,16 @@ module Kernel
   def shared(name, &block)
     Scampi::Shared[name] = block
   end
+
+  # Allow `it` at the top level (outside a describe block).
+  # Wraps the spec in an anonymous context derived from the caller's filename.
+  def it(description, &block)
+    loc = caller_locations(1, 1).first
+    file = loc.path || loc.absolute_path || "(unknown)"
+    ctx_name = File.basename(file, File.extname(file))
+    ctx = Scampi::Context.new(ctx_name) {}
+    ctx.it(description, &block)
+    ctx.register
+    Scampi.queue << ctx
+  end
 end

data/lib/scampi/version.rb

@@ -1,5 +1,5 @@
 module Scampi
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end
 
 require_relative '../rubygems_plugin'

data/scampi.gemspec

@@ -19,7 +19,7 @@ http://github.com/general-intelligence-systems/scampi
   s.bindir          = 'exe'
   s.executables     = ['scampi']
   s.require_path    = 'lib'
-  s.extra_rdoc_files = ['README.rdoc']
+  s.extra_rdoc_files = ['README.md']
   s.test_files      = []
 
   s.add_dependency 'colorize-extended'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scampi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nathan K
@@ -34,13 +34,13 @@ executables:
 - scampi
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
 - ".envrc"
 - COPYING
 - Gemfile
 - Gemfile.lock
-- README.rdoc
+- README.md
 - Rakefile
 - bin/increment-version
 - bin/release-gem

data/README.rdoc

@@ -1,290 +0,0 @@
-= Bacon -- small RSpec clone.
-
-   "Truth will sooner come out from error than from confusion."
-                                               ---Francis Bacon
-
-Bacon is a small RSpec clone weighing less than 350 LoC but
-nevertheless providing all essential features.
-
-
-== Whirl-wind tour
-
-    require 'bacon'
-    
-    describe 'A new array' do
-      before do
-        @ary = Array.new
-      end
-      
-      it 'should be empty' do
-        @ary.should.be.empty
-        @ary.should.not.include 1
-      end
-    
-      it 'should have zero size' do
-        @ary.size.should.equal 0
-        @ary.size.should.be.close 0.1, 0.5
-      end
-    
-      it 'should raise on trying fetch any index' do
-        lambda { @ary.fetch 0 }.
-          should.raise(IndexError).
-          message.should.match(/out of array/)
-    
-        # Alternatively:
-        should.raise(IndexError) { @ary.fetch 0 }
-      end
-    
-      it 'should have an object identity' do
-        @ary.should.not.be.same_as Array.new
-      end
-    
-      # Custom assertions are trivial to do, they are lambdas returning a
-      # boolean vale:
-      palindrome = lambda { |obj| obj == obj.reverse }
-      it 'should be a palindrome' do
-        @ary.should.be.a palindrome
-      end
-    
-      it 'should have super powers' do
-        should.flunk "no super powers found"
-      end
-    end
-
-Now run it:
-
-    $ bacon whirlwind.rb
-    A new array
-    - should be empty
-    - should have zero size
-    - should raise on trying fetch any index
-    - should have an object identity
-    - should be a palindrome
-    - should have super powers [FAILED]
-    
-    Bacon::Error: no super powers found
-    	./whirlwind.rb:39: A new array - should have super powers
-    	./whirlwind.rb:38
-    	./whirlwind.rb:3
-    
-    6 specifications (9 requirements), 1 failures, 0 errors
-
-If you want shorter output, use the Test::Unit format:
-
-    $ bacon -q whirlwind.rb
-    .....F
-    Bacon::Error: no super powers found
-    	./whirlwind.rb:39: A new array - should have super powers
-    	./whirlwind.rb:38
-    	./whirlwind.rb:3
-    
-    6 tests, 9 assertions, 1 failures, 0 errors
-
-It also supports TAP:
-
-    $ bacon -p whirlwind.rb
-    ok 1        - should be empty
-    ok 2        - should have zero size
-    ok 3        - should raise on trying fetch any index
-    ok 4        - should have an object identity
-    ok 5        - should be a palindrome
-    not ok 6    - should have super powers: FAILED
-    # Bacon::Error: no super powers found
-    # 	./whirlwind.rb:39: A new array - should have super powers
-    # 	./whirlwind.rb:38
-    # 	./whirlwind.rb:3
-    1..6
-    # 6 tests, 9 assertions, 1 failures, 0 errors
-
-    $ bacon -p whirlwind.rb | taptap -q
-    Tests took 0.00 seconds.
-    FAILED tests 6
-       6) should have super powers: FAILED
-
-    Failed 1/6 tests, 83.33% okay.
-
-(taptap is included with scampi)
-
-As of Bacon 1.1, it also supports Knock:
-
-    $ bacon -k whirlwind.rb
-    ok - should be empty
-    ok - should have zero size
-    ok - should raise on trying fetch any index
-    ok - should have an object identity
-    ok - should be a palindrome
-    not ok - should have super powers: FAILED
-    # Bacon::Error: no super powers found
-    # 	./whirlwind.rb:39: A new array - should have super powers
-    # 	./whirlwind.rb:38
-    # 	./whirlwind.rb:3
-
-    $ bacon -k whirlwind.rb | kn-sum
-    6 tests, 1 failed (83.3333% succeeded)
-
-(knock is available from http://github.com/chneukirchen/knock/)
-
-
-== Implemented assertions
-
-* should.<predicate> and should.be.<predicate>
-* should.equal
-* should.match
-* should.be.identical_to / should.be.same_as
-* should.raise(*exceptions) { }
-* should.change { }
-* should.throw(symbol) { }
-* should.satisfy { |object| }
-
-
-== Added core predicates
-
-* Object#true?
-* Object#false?
-* Proc#change?
-* Proc#raise?
-* Proc#throw?
-* Numeric#close?
-
-
-== before/after
-
-before and after need to be defined before the first specification in
-a context and are run before and after each specification.
-
-As of Bacon 1.1, before and after do nest in nested contexts.
-
-
-== Shared contexts
-
-You can define shared contexts in Bacon like this:
-
-    shared "an empty container" do
-      it "should have size zero" do
-      end
-
-      it "should be empty" do
-      end
-    end
-
-    context "A new array" do
-      behaves_like "an empty container"
-    end
-
-These contexts are not executed on their own, but can be included with
-behaves_like in other contexts.  You can use shared contexts to
-structure suites with many recurring specifications.
-
-
-== Matchers
-
-Custom matchers are simply lambdas returning a boolean value, for
-example:
-
-  def shorter_than(max_size)
-    lambda { |obj| obj.size < max_size }
-  end
-
-  [1,2,3].should.be shorter_than(5)
-
-You can use modules and extend to group matchers for use in multiple
-contexts.
-
-
-== bacon standalone runner
-
-  -s, --specdox            do AgileDox-like output (default)
-  -q, --quiet              do Test::Unit-like non-verbose output
-  -p, --tap                do TAP (Test Anything Protocol) output
-  -k, --knock              do Knock output
-  -o, --output FORMAT      do FORMAT (SpecDox/TestUnit/Tap) output
-  -Q, --no-backtrace       don't print backtraces  
-  -a, --automatic          gather tests from ./test/, include ./lib/
-  -n, --name NAME          runs tests matching regexp NAME
-  -t, --testcase TESTCASE  runs tests in TestCases matching regexp TESTCASE
-
-If you don't want to use the standalone runner, run
-Bacon.summary_on_exit to install an exit handler showing the summary.
-
-
-== Object#should
-
-You can use Object#should outside of contexts, where the result of
-assertion will be returned as a boolean.  This is nice for
-demonstrations, quick checks and doctest tests.
-
-    >> require 'bacon'
-    >> (1 + 1).should.equal 2
-    => true
-    >> (6*9).should.equal 42
-    => false
-
-
-== Converting specs
-
-spec-converter is a simple tool to convert test-unit or dust style
-tests to test/spec specs.
-
-It can be found at https://github.com/relevance/spec_converter.
-
-
-== Thanks to
-
-* Michael Fellinger, for fixing Bacon for 1.9 and various improvements.
-* Gabriele Renzi, for implementing Context#should.
-* Yossef Mendelssohn, for nested contexts.
-* everyone contributing bug fixes.
-
-
-== History
-
-* January 7, 2008: First public release 0.9.
-
-* July 6th, 2008: Second public release 1.0.
-  * Add Context#should as a shortcut for Context#it('should ' + _).
-  * describe now supports multiple arguments for better organization.
-  * Empty specifications are now erroneous.
-  * after-blocks run in the case of exceptions too.
-  * Bug fixes.
-
-* November 30th, 2008: Third public release 1.1.
-  * Nested before/after.
-  * Add -Q/--no-backtraces to not show details about failed specifications.
-  * Add Knock output.
-  * Bug fixes.
-
-* December 21th, 2012: Fourth public release 1.2.0.
-  * #satisfy will not pass arguments anymore to the block, use lexical scope.
-  * Fixed Context#change?.
-  * Add support for finding specs named like spec/**/*_spec.rb.
-  * Contexts nest properly.
-  * Timer in TestUnitOutput.
-  * Nested output for SpecDoxOutput.
-  * Small cleanups and more tests.
-
-
-== Contact
-
-Please mail bugs, suggestions and patches to
-<mailto:chneukirchen@gmail.com>.
-
-Git repository (patches rebased on HEAD are most welcome):
-http://github.com/chneukirchen/bacon
-git://github.com/chneukirchen/bacon.git
-
-
-== Copying
-
-Copyright (C) 2007, 2008, 2012 Christian Neukirchen <purl.org/net/chneukirchen>
-
-Bacon is freely distributable under the terms of an MIT-style license.
-See COPYING or http://www.opensource.org/licenses/mit-license.php.
-
-
-== Links
-
-Behavior-Driven Development:: <http://behaviour-driven.org/>
-RSpec:: <http://rspec.rubyforge.org/>
-test/spec:: <http://test-spec.rubyforge.org/>
-
-Christian Neukirchen:: <http://chneukirchen.org/>