tryouts 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a4341b114113a2302709a5d550682346092cc677c7dbc5933c6d7a3e139fa6
-  data.tar.gz: 7e1f1e8fed19debc6e2b7766e76510c7904c1b565ae6c841571a0c005fbc755f
+  metadata.gz: 964b15141b2d2a8658bb5beee61ef9618ad478b8c29a4c91c5595dfb7ac92323
+  data.tar.gz: b33744a232df6dd0020deef5ea682217481ba6fc17d6d1336ccb9dc314080052
 SHA512:
-  metadata.gz: 0d6cb90fb7b6e14cbbff68fd5aa5f0d46e93453490a088cdd613cbaf5f10522409a784015fbe5215fcc27c730003a7d3f380df3c303d8f7f6e0293522ae2df45
-  data.tar.gz: 68f3f1202acf7f7e661435372bf4470462ff254cf2f25dd76902e4a01817d46a40a06e54e8b2a59acfb49c59520682234e19527a6745af0370d45c4cd675e278
+  metadata.gz: 4116e1c5918e226ec2232a55cd4dfdc8ff034948ceafa03ca3cdaecee6df4aa2f7d1dc5598eed66074f0c2e22c71492b7fab83c83b8869165897be69cabf4e9c
+  data.tar.gz: 826761b6d51762fb214380d05d438ab70b029bab4c7a138b59909ac096bcdc5bc79d7aed6c6f2509d728b6ea59f8ea03201fb42e6e77002fef1cd47a7635ec7d

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2010 Solutious Inc, Delano Mandelbaum
+MIT License
+
+Copyright (c) 2011-2024 Delano Mandelbaum
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -7,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# Tryouts v2.3.0 (2024-04-04)
+
+**Ruby tests that read like documentation.**
+
+A simple test framework for Ruby code that uses introspection to allow defining checks in comments.
+
+## Installation
+
+One of:
+* In your Gemfile: `gem 'tryouts'`
+* As a gem: `gem install tryouts`
+* From source:
+
+```bash
+  $ git clone git://github.com/tryouts/tryouts.git
+```
+
+## Usage
+
+```bash
+  # Run all tests accessible from the current directory (e.g. ./try, ./tryouts))
+  $ try
+
+  # Run a single test file
+  $ try try/10_utils_try.rb
+
+  # Command arguments
+  $ try -h
+  Usage: try [options]
+      -V, --version                    Display the version
+      -q, --quiet                      Run in quiet mode
+      -v, --verbose                    Run in verbose mode
+      -f, --fails                      Show only failing tryouts
+      -D, --debug                      Run in debug mode
+      -h, --help                       Display this help
+```
+
+### Exit codes
+
+When all tests pass, try exits with a 0. An exit code of 1 or more indicates the number of failing tests.
+
+
+## Writing tests
+
+```ruby
+  ## A very simple test
+  1 + 1
+  #=> 2
+
+  ## The test description can spread
+  ## across multiple lines. The same
+  ## is true for test definitions.
+  a = 'foo'
+  b = 'bar'
+  a + b
+  #=> 'foobar'
+
+  ## A test will pass when its return
+  ## value equals the expectation.
+  'foo'.class
+  #=> String
+
+  ## The expectations are evaluated as well.
+  81
+  #=> 9 * 9
+
+  ## Here's an example of testing errors
+  begin
+    raise RuntimeError
+  rescue RuntimeError
+    :success
+  end
+  #=> :success
+```
+
+For real world examples, see [Onetimesecret](https://github.com/onetimesecret/onetimesecret/) tryouts.
+
+
+### Test setup / cleanup
+
+Put the setup code at the top of the file, and cleanup code at the bottom. Like this:
+
+```ruby
+  # This is called before all tests
+  require 'gibbler'
+  Gibbler.digest_type = Digest::SHA256
+
+
+  ## This is a single testcase
+    :anything.gibbler
+  #=> '8574309'
+
+
+  # This will be called after all tests
+  Gibbler.digest_type = Digest::SHA1
+```
+
+__
+
+
+## Thanks
+
+* [cloudhead](https://github.com/cloudhead)
+* [mynyml](https://github.com/mynyml)
+* [Syntenic](https://syntenic.com/) for the hackfest venue.
+* [AlexPeuchert](https://www.rubypulse.com/) for the screencast.
+* Christian Michon for suggesting a better default output format.
+
+*This collision was brought to you by Montreal.rb.*

data/exe/try

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/tryouts'
+
+# Add local lib directories to the load path
+Dir.glob(File.join(Dir.pwd, '{lib,..,lib}')).each { |dir| $LOAD_PATH.unshift(dir) }
+
+# Parse command-line arguments
+options = { quiet: false, noisy: false, fails: false }
+OptionParser.new do |opts|
+  opts.on('-V', '--version', 'Display the version') { puts "Tryouts: #{Tryouts::VERSION}"; exit }
+  opts.on('-q', '--quiet', 'Run in quiet mode') { options[:quiet] = true }
+  opts.on('-v', '--verbose', 'Run in verbose mode') { options[:noisy] = true }
+  opts.on('-f', '--fails', 'Show only failing tryouts') { options[:fails] = true }
+  opts.on('-D', '--debug', 'Run in debug mode') { Tryouts.debug = true }
+  opts.on('-h', '--help', 'Display this help') { puts opts; exit }
+end.parse!
+
+# Set Tryouts options
+Tryouts.quiet = options[:quiet]
+Tryouts.noisy = options[:noisy]
+Tryouts.fails = options[:fails]
+
+# Find tryouts path
+if ARGV.empty?
+  paths = Dir.glob(
+    ['./{try,tryouts/,.}/*_{try,tryouts}.rb'],
+    base: Dir.pwd,
+    sort: true  # deterministic order
+  )
+
+else
+  paths = ARGV
+end
+
+exit Tryouts.run_all(*paths)

data/exe/tryouts

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+load File.expand_path("../try", __FILE__)

data/lib/tryouts/version.rb

@@ -0,0 +1,13 @@
+class Tryouts
+  module VERSION
+    def self.to_s
+      load_config
+      [@version[:MAJOR], @version[:MINOR], @version[:PATCH]].join('.')
+    end
+    alias_method :inspect, :to_s
+    def self.load_config
+      require 'yaml'
+      @version ||= YAML.load_file(File.join(TRYOUTS_LIB_HOME, '..', 'VERSION.yml'))
+    end
+  end
+end

data/lib/tryouts.rb

@@ -4,30 +4,18 @@ unless defined?(TRYOUTS_LIB_HOME)
   TRYOUTS_LIB_HOME = File.expand_path File.dirname(__FILE__)
 end
 
-class Tryouts
-  module VERSION
-    def self.to_s
-      load_config
-      [@version[:MAJOR], @version[:MINOR], @version[:PATCH]].join('.')
-    end
-    alias_method :inspect, :to_s
-    def self.load_config
-      require 'yaml'
-      @version ||= YAML.load_file(File.join(TRYOUTS_LIB_HOME, '..', 'VERSION.yml'))
-    end
-  end
-end
-
+require_relative 'tryouts/version'
 
 class Tryouts
   @debug = false
   @quiet = false
   @noisy = false
+  @fails = false
   @container = Class.new
   @cases = []
   @sysinfo = nil
   class << self
-    attr_accessor :debug, :container, :quiet, :noisy
+    attr_accessor :debug, :container, :quiet, :noisy, :fails
     attr_reader :cases
 
     def sysinfo
@@ -48,6 +36,12 @@ class Tryouts
 
       msg 'Ruby %s @ %-40s' % [RUBY_VERSION, Time.now], $/
 
+      if Tryouts.debug?
+        Tryouts.debug "Found #{paths.size} files:"
+        paths.each { |path| Tryouts.debug "  #{path}" }
+        Tryouts.debug
+      end
+
       batches.each do |batch|
 
         path = batch.path.gsub(/#{Dir.pwd}\/?/, '')
@@ -55,7 +49,7 @@ class Tryouts
         vmsg '%-60s %s' % [path, '']
 
         before_handler = Proc.new do |t|
-          if Tryouts.noisy
+          if Tryouts.noisy && !Tryouts.fails
             vmsg Console.reverse(' %-58s ' % [t.desc.to_s])
             vmsg t.test.inspect, t.exps.inspect
           end
@@ -64,19 +58,19 @@ class Tryouts
         batch.run(before_handler) do |t|
           if t.failed?
             failed_tests += 1
-            if Tryouts.noisy
+            if Tryouts.noisy && Tryouts.fails
               vmsg Console.color(:red, t.failed.join($/)), $/
             else
               msg ' %s (%s:%s)' % [Console.color(:red, "FAIL"), path, t.exps.first]
             end
-          elsif t.skipped? || !t.run?
+          elsif (t.skipped? || !t.run?) && !Tryouts.fails
             skipped_tests += 1
             if Tryouts.noisy
               vmsg Console.bright(t.skipped.join($/)), $/
             else
               msg ' SKIP (%s:%s)' % [path, t.exps.first]
             end
-          else
+          elsif !Tryouts.fails
             if Tryouts.noisy
               vmsg Console.color(:green, t.passed.join($/)), $/
             else

metadata

@@ -1,41 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: tryouts
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-04-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: sysinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-description: 'Tryouts: Don''t waste your time writing tests'
-email: delano@solutious.com
+date: 2024-06-18 00:00:00.000000000 Z
+dependencies: []
+description: A simple test framework for Ruby code that uses introspection to allow
+  defining checks in comments.
+email: gems@solutious.com
 executables:
 - try
+- tryouts
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
-- Rakefile
-- bin/try
+- README.md
+- exe/try
+- exe/tryouts
 - lib/tryouts.rb
-homepage: http://github.com/delano/tryouts
+- lib/tryouts/version.rb
+homepage: https://github.com/delano/tryouts
 licenses:
 - MIT
 metadata: {}
@@ -47,7 +37,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.8
+      version: 2.7.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -57,5 +47,5 @@ requirements: []
 rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
-summary: Don't waste your time writing tests
+summary: Ruby tests that read like documentation.
 test_files: []

data/Rakefile

@@ -1,63 +0,0 @@
-require "rubygems"
-require "rake"
-require "rake/clean"
-require 'yaml'
-
-begin
-  require 'hanna/rdoctask'
-rescue LoadError
-  require 'rake/rdoctask'
-end
- 
-config = YAML.load_file("VERSION.yml")
-task :default => ["build"]
-CLEAN.include [ 'pkg', 'doc' ]
-name = "stella"
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |gem|
-    gem.version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
-    gem.name = "tryouts"
-    gem.rubyforge_project = gem.name
-    gem.summary = "Don't waste your time writing tests"
-    gem.description = gem.summary
-    gem.email = "delano@solutious.com"
-    gem.homepage = "http://github.com/delano/tryouts"
-    gem.authors = ["Delano Mandelbaum"]
-    gem.add_dependency("sysinfo",      ">= 0.7.3")
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-
-Rake::RDocTask.new do |rdoc|
-  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}}"
-  rdoc.rdoc_dir = "doc"
-  rdoc.title = "stella #{version}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("LICENSE.txt")
-  rdoc.rdoc_files.include("bin/*.rb")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-
-# Rubyforge Release / Publish Tasks ==================================
-
-#about 'Publish website to rubyforge'
-task 'publish:rdoc' => 'doc/index.html' do
-  sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/"
-end
-
-#about 'Public release to rubyforge'
-task 'publish:gem' => [:package] do |t|
-  sh <<-end
-    rubyforge add_release -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
-    rubyforge add_file -o Any -a CHANGES.txt -f -n README.md #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
-  end
-end
-
-
-

data/bin/try

@@ -1,47 +0,0 @@
-#!/usr/bin/ruby
-
-#
-# Tryouts - Don't waste your time writing tests
-# 
-# Usage:
-# 
-#      $ try 
-#      $ try -q 
-#      $ try -v
-#      $ try path/2/file.rb
-#      $ try -q path/2/file.rb path/2/another.rb
-#
-
-# Put our local lib in first place
-BASE_PATH = File.expand_path File.join(File.dirname(__FILE__), '..')
-lib_dir = File.join(BASE_PATH, 'lib')
-$:.unshift lib_dir
-
-require 'tryouts'
-
-# Help out the requires in the tryouts
-[File.join(Dir.pwd, 'lib'), File.join(Dir.pwd, '..', 'lib')].each do |dir|
-  $:.unshift dir
-end
-
-unless ARGV.delete('-V').nil?
-  puts "Tryouts: #{Tryouts::VERSION}"
-  exit
-end
-
-Tryouts.quiet = !ARGV.delete('-q').nil?  # eg try -q [PATH]
-Tryouts.noisy = !ARGV.delete('-v').nil?  # eg try -v [PATH]
-
-if ARGV.empty?
-  paths = Dir.glob(File.join(Dir.pwd, '{try,tryouts}', '*_{try,tryouts}.rb'))
-  paths += Dir.glob(File.join(Dir.pwd, '*_{try,tryouts}.rb'))
-else
-  paths = ARGV
-end
-
-#Tryouts.quiet
-#Tryouts.debug = true
-#Tryouts.container = self
-
-exit Tryouts.run_all(*paths)
-