assert 2.15.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 977f66c154b34e18051876043c6ef149048f3c24
-  data.tar.gz: 4ad230cae2d6fbe5895456d04f421843bbdb43e6
-SHA512:
-  metadata.gz: 9ea117fae5c227ae573763287d76156b11b923afa80b50c63223deb6f001605eac1eb55302f08f85ecc134eedf49efb90973cec640b6e1a11c75509100a8ccad
-  data.tar.gz: cf13653df60d7b5c295d2a43523923423998ae9c7b40f60bc95d95044af0577a96107d5d04a553d9de8c799bde111599d6656e2d678adcdee0ecb33750aa61e9
+--- 
+SHA1: 
+  data.tar.gz: 224cee40b0eced9582504764379f3f5dafae637c
+  metadata.gz: 5858e3f1715252601de72d47678dc9f215267254
+SHA512: 
+  data.tar.gz: 6b3d06c534eb907ae92c281b36de62967138bbc3788d536c92ad03b8d28d637dcf0ad0526fb66610dcc9b6cbc894a44e786c312bcfd6f93ae1ea29319f8aaf6f
+  metadata.gz: ed18f6eaea92fcec29d9b6b2200cb23704ad8b4090372493a81b67067b251176d71408231f8bc7e7c9de1a88c55cd854857d6fa153c67d79bf3a752b5fdb1df1

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rake', "~> 10.4.0"
 gem 'pry', "~> 0.9.0"

data/README.md

@@ -1,7 +1,5 @@
 # The Assert Testing Framework
 
-Test::Unit style testing framework, just better than Test::Unit.
-
 ## Usage
 
 ```ruby
@@ -34,29 +32,36 @@ Running tests in random order, seeded with "56382"
 * **Framework**: you define tests and the context they run in - Assert runs them.  Everything is pure ruby so use any 3rd party testing tools you like.  Create 3rd party tools that extend Assert behavior.
 * **First Class**: everything is a first class object and can be extended to your liking (and should be)
 * **MVC**: tests and how they are defined (M) and executed (C) are distinct from how you view the test results (V).
-* **Backwards compatible**: (assuming a few minor tweaks) with Test::Unit test suites
 
 ## What Assert is not
 
-* **Rspec**
-* **Unit/Functional/Integration/etc**: Assert is agnostic - you define whatever kinds of tests you like (one or more of the above) and assert runs them in context.
-* **Mock/Spec/BDD/etc**: Assert is the framework and there are a variety of 3rd party tools to do such things - feel free to use whatever you like.
+* **RSpec/spec-anything**: define tests using assertion statements
+* **Unit/Functional/Integration/etc**: Assert is agnostic - you define whatever kinds of tests you like (one or more of the above) and assert runs them in context
+* **Mock/Spec/BDD/etc**: Assert is the framework and there are a variety of 3rd party tools to do such things - feel free to use whatever you like
 
 ## Description
 
-Assert is a Test::Unit style testing framework.  This means you can write tests in Assert the same way you would with test-unit.
+Assert is an assertion style testing framework, meaning you use assertion statements to define your tests and create results.  Assert uses class-based contexts so if you want to nest your contexts, use inheritance.
 
-In addition, Assert adds some helpers and syntax sugar to enhance the way tests are written. Most are taken from ideas in [Shoulda](https://github.com/thoughtbot/shoulda) and [Leftright](https://github.com/jordi/leftright/).  Assert uses class-based contexts so if you want to nest your contexts, use inheritance.
+### Features
 
-**Note**: Assert is tested using itself.  The tests are a pretty good place to look for examples and usage patterns.
+* `assert` [executable](https://github.com/redding/assert#cli) for running tests
+* run tests by tab completing test file paths
+* run only test files that have been modified
+* random order test execution
+* class-based contexts
+* multiple before/setup & after/teardown blocks
+* around blocks
+* full backtrace for errors
+* optionally pretty print objects in failure descriptions
+* [stubbing API](https://github.com/redding/assert#stub)
+* [factory API](https://github.com/redding/assert#factory)
+* `skip` to skip tests
+* `Ctrl+c` stops tests and prints failures
 
 ## Defining tests
 
-TODO
-
-## Factory
-
-TODO
+**Note**: Assert is tested using itself.  The tests are a good place to look for examples and usage patterns.
 
 ## Stub
 
@@ -90,12 +95,13 @@ Assert.stub(myobj, :myval){ 'stub-meth' }
 Assert.stub(myobj, :myval).with(123){ |val| val.to_s }
 myobj.myval
   # => StubError: arity mismatch
-myobj.mymeth(123)
+myobj.myval(123)
   # => '123'
-myobj.mymeth(456)
-  # => StubError: `mymeth(456)` not stubbed.
+myobj.myval(456)
+  # => StubError: `myval(456)` not stubbed.
 
 Assert.unstub(myobj, :mymeth)
+Assert.unstub(myobj, :myval)
 
 myobj.mymeth
   # => 'meth'
@@ -105,15 +111,62 @@ myobj.myval(456)
   # => 456
 ```
 
-Assert comes with a simple stubbing API - all it does is replace method calls.  In general it tries
-to be friendly and complain if stubbing doesn't match up with the object/method being stubbed:
+Assert comes with a stubbing API - all it does is replace method calls.  In general it tries to be friendly and complain if stubbing doesn't match up with the object/method being stubbed:
 
 * each stub takes a block that is called in place of the method
 * complains if you stub a method that the object doesn't respond to
 * complains if you stub with an arity mismatch
-* no methods added to `Object`
+* no methods are added to `Object` to support stubbing
 * stubs are auto-unstubbed on test teardown
 
+## Factory
+
+```ruby
+require 'assert/factory'
+
+Assert::Factory.integer    #=> 15742
+Assert::Factory.integer(3) #=> 2
+Assert::Factory.float      #=> 87.2716908041922
+Assert::Factory.float(3)   #=> 2.5466638138805
+
+Assert::Factory.date       #=> #<Date: 4915123/2,0,2299161>
+Assert::Factory.time       #=> Wed Sep 07 10:37:22 -0500 2016
+Assert::Factory.datetime   #=> #<DateTime: 302518290593/43200,0,2299161>
+
+Assert::Factory.string     #=> "boxsrbazeq"
+Assert::Factory.string(3)  #=> "rja"
+Assert::Factory.text       #=> "khcwyizmymajfzzxlfwz"
+Assert::Factory.text(3)    #=> "qcy"
+Assert::Factory.slug       #=> "licia"
+Assert::Factory.slug(3)    #=> "luu"
+Assert::Factory.hex        #=> "48797adb33"
+Assert::Factory.hex(3)     #=> "2fe"
+Assert::Factory.url        #=> "/cdqz/hqeq/zbsl"
+Assert::Factory.email      #=> "vyojvtxght@gmrin.com"
+
+Assert::Factory.file_name  #=> "kagahm.ybb"
+Assert::Factory.path       #=> "jbzf/omyk/vbha"
+Assert::Factory.dir_path   #=> "fxai/lwnq/urqu"
+Assert::Factory.file_path  #=> "bcno/pzxg/gois/mpvlfo.wdr"
+
+Assert::Factory.binary     #=> "\000\000\003S"
+Assert::Factory.boolean    #=> false
+```
+
+`Assert::Factory` is an API for generating randomized data.  The randomization is tied to the runner seed so re-running tests with the same seed should produce the same random values.
+
+You can also extend on your own factory class:
+
+```ruby
+module Factory
+  extend Assert::Factory
+
+  def self.data
+    { Factory.string => Factory.string }
+  end
+end
+```
+
 ## CLI
 
 ```sh
@@ -139,7 +192,7 @@ As an example, say your test folder has a file structure like so:
 * `$ assert test/complex/fast_tests.rb` - runs all tests in fast_tests.rb
 * `$ assert test/basic test/comp` - runs all tests in basic_tests.rb, complex_tests.rb, fast_tests.rb and slow_tests.rb
 
-All you need to do is pass some sort of existing file path (hint: use tab-completion) and Assert will find any test files and run the tests in them.
+All you need to do is pass some sort of existing file path (use tab-completion!) and Assert will find any test files and run the tests in them.
 
 ## Configuring Assert
 
@@ -149,25 +202,25 @@ Assert.configure do |config|
 end
 ```
 
-Assert uses a config pattern for specifying settings.  Using this pattern, you can configure settings, extensions, custom views, etc.  Settings can be configured in 4 different scopes and are applied in this order: User, Local, CLI, ENV.
+Assert uses a config pattern for specifying settings.  Using this pattern, you can configure settings, extensions, custom views, etc.  Settings can be configured in 4 different scopes and are applied in this order: User, Local, ENV, CLI.
 
 ### User settings
 
-Assert will look for and require the file `$HOME/.assert/init.rb`.  Use this file to specify user settings.  User settings can be overridden by Local, CLI, and ENV settings.
+Assert will look for and require the file `$HOME/.assert/init.rb`.  Use this file to specify user settings.  User settings can be overridden by Local, ENV, and CLI settings.
 
 ### Local settings
 
-Assert will look for and require the file `./.assert.rb`.  Use this file to specify project settings.  Local settings can be overridden by CLI, and ENV settings.
+Assert will look for and require the file `./.assert.rb`.  Use this file to specify project settings.  Local settings can be overridden by ENV, and CLI settings.
 
 To specify a custom local settings file path, use the `ASSERT_LOCALFILE` env var.
 
-### CLI settings
+### ENV settings
 
-Assert accepts options from its CLI.  Use these options to specify runtime settings.  CLI settings can be overridden by ENV settings.
+Assert uses ENV vars to drive certain settings.  Use these vars to specify specific environment settings.  ENV settings can be overridden by CLI settings.
 
-### ENV settings
+### CLI settings
 
-Assert uses ENV vars to drive certain settings.  Use these vars to specify absolute runtime settings.  ENV settings are always applied last and cannot be overridden.
+Assert accepts options from its CLI.  Use these options to specify absolute runtime settings.  CLI settings are always applied last and cannot be overridden.
 
 ## Running Tests
 
@@ -203,7 +256,7 @@ end
 
 ### Test Order
 
-The default runner object runs tests in random order.  To run tests in a consistant order, specify a custom runner seed:
+The default runner object runs tests in random order.  To run tests in a consistant order, pass a custom runner seed:
 
 In user/local settings file:
 
@@ -213,16 +266,34 @@ Assert.configure do |config|
 end
 ```
 
+Using an ENV var:
+
+```sh
+$ ASSERT_RUNNER_SEED=1234 assert
+```
+
 Using the CLI:
 
 ```sh
 $ assert [-s|--runner-seed] 1234
 ```
 
-Using an ENV var:
+### Run a single test
+
+You can choose to run just a single test so that you can focus on making it pass without the overhead/noise from the output of the other tests in the file.
+
+It is recommended that you only use this setting from the CLI.  To run just a single test, pass its file path and line number:
 
 ```sh
-$ ASSERT_RUNNER_SEED=1234 assert
+$ assert [-t|--single-test] ./path/for/tests.rb:123
+```
+
+**Note**: by default Assert outputs, in the details of each non-passing result, the cmd to re-run the result's test:
+
+```
+FAIL: should pass
+./test/unit/test_tests.rb:124
+assert -t ./test/unit/test_tests.rb:123
 ```
 
 ### Verbose Output
@@ -456,7 +527,7 @@ end
 However, the view handler you use is itself configurable.  Define you own view handler class and specify it in your user/local settings:
 
 ```ruby
-class MyCustomView < Assert::View::Base
+class MyCustomView < Assert::View
   # define your view here...
 end
 
@@ -467,7 +538,7 @@ end
 
 ### Anatomy of a View
 
-A view class handles the logic and templating of test result output.  A view class should inherit from `Assert::View::Base`.  This defines default callback handlers for the test runner and gives access to a bunch of common helpers for reading test result data.
+A view class handles the logic and templating of test result output.  A view class should inherit from `Assert::View`.  This defines default callback handlers for the test runner and gives access to a bunch of common helpers for reading test result data.
 
 Each view should implement the callback handler methods to output information at different points during the running of a test suite.  Callbacks have access to any view methods and should output information using `puts` and `prints`.  See the `DefaultView` template for a usage example.
 
@@ -534,7 +605,7 @@ Tests produce results as they are executed.  Every `assert` statement produces a
 
 ### View
 
-A `View` object is responsible for rendering test result output.  Assert provides a `Assert::View::Base` object to provide common helpers and default runner callback handlers for building views.  Assert also provides an `Assert::DefaultView` that it renders its output with.  See the "Viewing Test Results" section below for more details.
+A `View` object is responsible for rendering test result output.  Assert provides a `Assert::View` object to provide common helpers and default runner callback handlers for building views.  Assert also provides an `Assert::DefaultView` that it renders its output with.  See the "Viewing Test Results" section below for more details.
 
 ### Macro
 
@@ -560,4 +631,4 @@ If submitting a Pull Request, please:
 
 One note: please respect that Assert itself is intended to be the flexible, base-level, framework-type logic that should change little if at all.  Pull requests for niche functionality or personal testing philosphy stuff will likely not be accepted.
 
-If you wish to extend Assert for your niche purpose/desire/philosophy, please do so in it's own gem (preferrably named `assert-<whatever>`) that uses Assert as a dependency.  When you do, tell us about it and we'll add it to this README with a short description.
+If you wish to extend Assert for your niche purpose/desire/philosophy, please do so in it's own gem (preferrably named `assert-<whatever>`) that uses Assert as a dependency.

data/assert.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version     = Assert::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.description = %q{Test::Unit style testing framework, just better than Test::Unit.}
-  gem.summary     = %q{Test::Unit style testing framework, just better than Test::Unit.}
+  gem.summary     = %q{Assertion style testing framework.}
+  gem.description = %q{Assertion style testing framework.}
   gem.homepage    = "http://github.com/redding/assert"
   gem.license     = 'MIT'
 

data/lib/assert/assert_runner.rb

@@ -13,11 +13,12 @@ module Assert
       Assert::CLI.bench('Apply settings') do
         apply_user_settings
         apply_local_settings
-        apply_option_settings(test_options)
         apply_env_settings
+        apply_option_settings(test_options)
       end
 
-      files = test_files(test_paths.empty? ? [*self.config.test_dir] : test_paths)
+      paths = test_paths.empty? ? [*self.config.test_dir] : test_paths
+      files = lookup_test_files(paths)
       init(files, path_of(self.config.test_dir, files.first))
     end
 
@@ -33,15 +34,20 @@ module Assert
       end
 
       # load the test files
-      self.config.view.fire(:before_load, test_files)
-      Assert::CLI.bench("Require #{test_files.count} test files") do
+      runner, suite, view = self.config.runner, self.config.suite, self.config.view
+      runner.before_load(test_files)
+      suite.before_load(test_files)
+      view.before_load(test_files)
+      Assert::CLI.bench("Require #{test_files.size} test files") do
         test_files.each{ |p| require p }
       end
       if self.config.debug
         puts Assert::CLI.debug_msg("Test files:")
         test_files.each{ |f| puts Assert::CLI.debug_msg("  #{f}") }
       end
-      self.config.view.fire(:after_load)
+      runner.after_load
+      suite.after_load
+      view.after_load
     end
 
     def run
@@ -62,17 +68,19 @@ module Assert
       safe_require(ENV['ASSERT_LOCALFILE'] || path_of(LOCAL_SETTINGS_FILE, Dir.pwd))
     end
 
-    def apply_option_settings(options)
-      self.config.apply(options)
-    end
-
     def apply_env_settings
       self.config.runner_seed ENV['ASSERT_RUNNER_SEED'].to_i if ENV['ASSERT_RUNNER_SEED']
     end
 
-    def test_files(test_paths)
+    def apply_option_settings(options)
+      self.config.apply(options)
+    end
+
+    def lookup_test_files(test_paths)
       file_paths = if self.config.changed_only
         changed_test_files(test_paths)
+      elsif self.config.single_test?
+        globbed_test_files(self.config.single_test_file_path)
       else
         globbed_test_files(test_paths)
       end
@@ -101,9 +109,8 @@ module Assert
       require settings_file if File.exists?(settings_file)
     end
 
-    # this method inspects a test path and finds the test dir path.
-
     def path_of(segment, a_path)
+      # this method inspects a test path and finds the test dir path.
       full_path = File.expand_path(a_path || '.', Dir.pwd)
       seg_pos = full_path.index(segment_regex(segment))
       File.join(seg_pos && (seg_pos > 0) ? full_path[0..(seg_pos-1)] : full_path, segment)

data/lib/assert/assertions.rb

@@ -179,6 +179,7 @@ module Assert
       desc = exceptions.last.kind_of?(String) ? exceptions.pop : nil
       err = RaisedException.new(exceptions, &block)
       assert(err.raised?, desc){ err.msg }
+      err.exception
     end
     alias_method :assert_raise, :assert_raises
 

data/lib/assert/cli.rb

@@ -36,6 +36,9 @@ module Assert
         option 'changed_ref', 'reference for changes, use with `-c` opt', {
           :abbrev => 'r', :value => ''
         }
+        option 'single_test', 'only run the test on the given file/line', {
+          :abbrev => 't', :value => ''
+        }
         option 'pp_objects', 'pretty-print objects in fail messages', {
           :abbrev => 'p'
         }

data/lib/assert/config.rb

@@ -1,6 +1,7 @@
+require 'assert/default_runner'
+require 'assert/default_suite'
 require 'assert/default_view'
-require 'assert/runner'
-require 'assert/suite'
+require 'assert/file_line'
 require 'assert/utils'
 
 module Assert
@@ -21,13 +22,14 @@ module Assert
     settings :view, :suite, :runner
     settings :test_dir, :test_helper, :test_file_suffixes
     settings :changed_proc, :pp_proc, :use_diff_proc, :run_diff_proc
-    settings :runner_seed, :changed_only, :changed_ref, :pp_objects
-    settings :capture_output, :halt_on_fail, :profile, :verbose, :list, :debug
+    settings :runner_seed, :changed_only, :changed_ref, :single_test
+    settings :pp_objects, :capture_output, :halt_on_fail, :profile
+    settings :verbose, :list, :debug
 
     def initialize(settings = nil)
-      @suite  = Assert::Suite.new(self)
       @view   = Assert::DefaultView.new(self, $stdout)
-      @runner = Assert::Runner.new(self)
+      @suite  = Assert::DefaultSuite.new(self)
+      @runner = Assert::DefaultRunner.new(self)
 
       @test_dir    = "test"
       @test_helper = "helper.rb"
@@ -42,6 +44,7 @@ module Assert
       @runner_seed    = begin; srand; srand % 0xFFFF; end.to_i
       @changed_only   = false
       @changed_ref    = ''
+      @single_test    = ''
       @pp_objects     = false
       @capture_output = false
       @halt_on_fail   = true
@@ -59,6 +62,21 @@ module Assert
           self.send(name.to_s, settings[name])
         end
       end
+      @single_test_file_line = nil
+    end
+
+    def single_test?
+      !self.single_test.empty?
+    end
+
+    def single_test_file_line
+      @single_test_file_line ||= Assert::FileLine.parse(
+        File.expand_path(self.single_test, Dir.pwd)
+      )
+    end
+
+    def single_test_file_path
+      self.single_test_file_line.file if self.single_test_file_line
     end
 
   end

data/lib/assert/config_helpers.rb

@@ -2,10 +2,22 @@ module Assert
 
   module ConfigHelpers
 
+    def runner; self.config.runner; end
+    def suite;  self.config.suite;  end
+    def view;   self.config.view;   end
+
     def runner_seed
       self.config.runner_seed
     end
 
+    def single_test?
+      self.config.single_test?
+    end
+
+    def single_test_file_line
+      self.config.single_test_file_line
+    end
+
     def count(type)
       self.config.suite.count(type)
     end
@@ -18,43 +30,18 @@ module Assert
       self.count(:pass) == self.count(:results)
     end
 
-    # get the formatted suite run time
-    def run_time(format = '%.6f')
+    def formatted_run_time(format = '%.6f')
       format % self.config.suite.run_time
     end
 
-    # get the formatted suite test rate
-    def test_rate(format = '%.6f')
+    def formatted_test_rate(format = '%.6f')
       format % self.config.suite.test_rate
     end
 
-    # get the formatted suite result rate
-    def result_rate(format = '%.6f')
+    def formatted_result_rate(format = '%.6f')
       format % self.config.suite.result_rate
     end
 
-    # get a uniq list of contexts for the test suite
-    def suite_contexts
-      @suite_contexts ||= self.config.suite.tests.inject([]) do |contexts, test|
-        contexts << test.context_info.klass
-      end.uniq
-    end
-
-    def ordered_suite_contexts
-      self.suite_contexts.sort{ |a,b| a.to_s <=> b.to_s }
-    end
-
-    # get a uniq list of files containing contexts for the test suite
-    def suite_files
-      @suite_files ||= self.config.suite.tests.inject([]) do |files, test|
-        files << test.context_info.file
-      end.uniq
-    end
-
-    def ordered_suite_files
-      self.suite_files.sort{ |a,b| a.to_s <=> b.to_s }
-    end
-
     def show_test_profile_info?
       !!self.config.profile
     end