uspec 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6a6363a2a59ed141811ddbd906b6a47a1494a0b
+  data.tar.gz: 5d21b182f77d0d4101d4a4236775e527aa05972d
+SHA512:
+  metadata.gz: 28cd24aed39ea930141a5f0e72ed86c02221610ab610d8b8359e46d4002898b578a554bbf903b5f524e9552edf441f559ce004c356b4abd259215d3720f8df6b
+  data.tar.gz: e54033546d92f8f89651e49df226c293d973952d77d4fd6d9bda32fb3f8f876d6d54cd14e7f7306ca266f6d83d9812f3d7ca9d036c8a7e3baa8fa25e5549df56

data/.ruby-gemset

@@ -0,0 +1 @@
+uspec

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -1,11 +1,23 @@
 language: ruby
+
 rvm:
+  - 2.2.3
+  - 2.0.0
   - 1.9.3
   - 1.9.2
-  - rbx-19mode
+
+  - jruby-19mode
   - ruby-head
-script: bundle exec ruby uspec/uspec_spec.rb
+
 before_install:
   - gem update bundler
 before_script:
   - bundle exec gem list
+script: bundle exec uspec
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-19mode
+
+sudo: false

data/README.markdown

@@ -3,34 +3,76 @@ Uspec
 
 Uspec is a shiny little testing framework for your apps!
 
-    Anthony M. Cook 2013
-
 [![Build Status](https://travis-ci.org/acook/uspec.png?branch=master)](https://travis-ci.org/acook/uspec)
 [![Code Climate](https://codeclimate.com/github/acook/uspec.png)](https://codeclimate.com/github/acook/uspec)
-[![Still Maintained](http://stillmaintained.com/acook/uspec.png)](http://stillmaintained.com/acook/uspec)
 
 Philosophy / Why Uspec?
 -----------------------
 
-Unlike other testing frameworks there's no need for special matchers, there can only be one assertion per test, and you never have to worry that your tests lack assertions.
+> Uspec is just Ruby!
+
+Unlike other testing frameworks there's no need for special matchers, 
+there can only be one assertion per test, 
+and you never have to worry that your tests lack assertions.
+
+That's because when the `spec` block is evaluated the return value is used (in a very ruby-like way) 
+to determine the validity of the statement. Standard Ruby comparisons are your friend! 
+No more digging around in your test framework's documentation to figure out what matcher you're supposed to use.
+This also means *no monkey patching* core classes!
+
+Uspec's output is in beautiful ansi technicolor, 
+with red for failures, green for successes, and yellow for pending specs. Here's a screenshot:
+
+![Screenshot!](http://i.imgur.com/M2F5YvO.png)
+
+Uspec is tiny, painless, and easy to use. Download it and give it a shot. :)
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'uspec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uspec
+
+
+Quickstart
+----------
 
-That's because when the `spec` block is evaluated the return value is used (in a very ruby-like way) to determine the validity of the statement. Standard Ruby comparisons are your friend! No more digging around in your test framework's documentation to figure out what matcher you're supposed to use.
+0. Create a `spec` directory to keep your specs in.
+1. Name your specs ending with `_spec.rb`.
+2. Write some specs in Ruby using the `spec` method.
+2. Use the included `uspec` executable to run your specs.
 
-You can't tell here in the docs, but Uspec's output is in beautiful ansi technicolor, with red for failures, green for successes, and yellow for pending specs. Download it and give it a show, its painless and uber easy to use. :)
+**Hint:** A lot of people also put `require_relative 'spec_helper'` in their tests for global start up code.
 
 Usage
 -----
 
-I suggest creating a `uspec` directory in your project folder to put your specs in. Then you'll need this incantation:
-
-```ruby
-require 'uspec'
-extend Uspec
+``` 
+$ uspec --help
+uspec - minimalistic ruby testing framework
+usage: uspec [<file_or_path>...]
 ```
 
-You can slot it in the top of your test file, or if you have other setup code you can put it in a `uspec_helper.rb` and `relative_require 'uspec_helper'` in them instead.
+- Without arguments the `uspec` command will automatially look for `spec` directories and load any `*_spec.rb` files inside them. 
+- You can also pass in arbitrary files and it will attempt to run them as specs.
+- If you pass in directories `uspec` will find and run any specs inside them.
+- Uspec will return `0` if all specs pass and `255` if any fail.
+
+Syntax
+------
 
-Then all you have to do is put in your specs:
+Uspec is **just Ruby**. The DSL is minimal - there's only one method to remember!
+
+Writing a spec is easy:
 
 ```ruby
 spec 'AwesomeMcCoolname.generate creates a cool name' do
@@ -38,19 +80,32 @@ spec 'AwesomeMcCoolname.generate creates a cool name' do
 end
 ```
 
-If it passes:
+That's it!
+
+Output
+------
+
+Examples of Uspec's output below!
+
+### Success
+
+If a spec passes:
 
 ```
  -- AwesomeMcCoolname.generate creates a cool name: true
 ```
 
-If it fails:
+### Failure
+
+If a spec fails:
 
 ```
  -- AwesomeMcCoolname.generate creates a cool name: false
 ```
 
-If it throws an error:
+### Exception
+
+If the spec throws an error:
 
 ```
  -- AwesomeMcCoolname.generate creates a cool name: Exception
@@ -64,6 +119,8 @@ If it throws an error:
     uspec/awesome_mc_coolname_spec.rb:4:in `block in <main>'
 ```
 
+### Non-boolean values
+
 If you create a spec that doesn't return a boolean value (`nil` doesn't count either!) like this:
 
 ```ruby
@@ -83,7 +140,28 @@ Then Uspec will let you know:
     Integer < Numeric: 5
 ```
 
-Instead of `=~` (which returns either index or nil) Ruby has the nifty `include?` method, which returns a boolean:
+### Pending
+
+If you aren't ready to fill out a spec, maybe as a reminder to add functionality later, just leave off the block and it will be marked as `pending`:
+
+```ruby
+spec 'a feature I have not implemented yet'
+```
+
+When you run the test Uspec will helpfully display:
+
+```
+ -- a feature I have not implemented yet: pending
+```
+
+Tips & Tricks
+-------------
+
+Because there's no matchers and only one method there's no reference documentation to look at, so here are some ideas to get you going!
+
+### String matching
+
+Instead of `=~` (which returns either an `Integer` index or `nil`) Ruby has the nifty `include?` method, which returns a boolean:
 
 ```ruby
 spec 'AwesomeMcCoolname.generate creates a cool name' do
@@ -91,6 +169,8 @@ spec 'AwesomeMcCoolname.generate creates a cool name' do
 end
 ```
 
+### Regex matching
+
 If you really need to regex, you can always use Ruby's `!!` idiom to coerce a boolean out of any result,
 but its more precise to specify the index if you know it.
 And you can always toss in an `||` to drop in more information if a comparison fails too:
@@ -102,17 +182,7 @@ spec 'AwesomeMcCoolname.generate creates a cool name' do
 end
 ```
 
-If you aren't ready to fill out a spec, maybe as a reminder to add functionality later, just leave off the block and it will be marked as `pending`:
-
-```ruby
-spec 'a feature I have not implemented yet'
-```
-
-When you run the test Uspec will helpfully display:
-
-```
- -- a feature I have not implemented yet: pending
-```
+### Exceptions
 
 What if you want to test that an error has occured? Just use Ruby!
 
@@ -130,20 +200,43 @@ If there's no error, then Uspec will see the result of the method call (whatever
 If the wrong Exception is raised, then because of reraising (by just calling `raise` without parameters),
 Ruby will dutifully pass along the error for Uspec to display.
 
-Installation
-------------
+Assertions & Debugging
+----------------------
 
-Add this line to your application's Gemfile:
+You can also use `uspec` to track assertions in an application or any object you want. Every spec block you use will be tracked and recorded. It's really no problem at all to do.
 
-    gem 'uspec'
+You can load Uspec's features directly into a class and use its DSL:
 
-And then execute:
+```ruby
+require 'uspec'
 
-    $ bundle
+class MyFoo
+  extend Uspec::DSL
+  
+  def assert
+    spec 'foo is valid' do
+      false
+    end
+  end
+end
 
-Or install it yourself as:
+MyFoo.new.assert
+```
 
-    $ gem install uspec
+If there are any specs that fail, your application will exit with a `255``. 
+
+```
+$ ruby foo.rb
+ -- foo is valid: false
+$ echo $?
+255
+```
+
+Uspec is just Ruby
+------------------
+
+If for some reason you don't want to use the `uspec` command, you can `require 'uspec'` and `extend Uspec::DSL`. 
+From there you can just run the file with ruby: `ruby my_test_spec.rb`
 
 Contributing
 ------------
@@ -153,3 +246,8 @@ Contributing
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Author
+------
+
+> Anthony M. Cook 2013-2016

data/bin/uspec

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/uspec/exec'
+
+if (ARGV & %w{-h --help -? /? /help}).empty? then
+  Uspec::Exec.run_specs ARGV
+else
+  Uspec::Exec.usage
+end

data/lib/uspec.rb

@@ -6,7 +6,7 @@ require_relative 'uspec/stats'
 module Uspec
   def self.included object
     warn 'Use extend instead of include.'
-    exit
+    exit 2
   end
 
   def self.extended object

data/lib/uspec/dsl.rb

@@ -1,5 +1,6 @@
 module Uspec
   module DSL
+    module_function
     def spec description
       formatter = Uspec::Formatter.new
 

data/lib/uspec/exec.rb

@@ -0,0 +1,51 @@
+require 'pathname'
+require_relative '../uspec'
+
+class Uspec::Exec
+  class << self
+    def usage
+      warn "uspec - minimalistic ruby testing framework"
+      warn "usage: #{File.basename $0} [<file_or_path>...]"
+    end
+
+    def run_specs paths
+      uspec_exec = self.new paths
+      uspec_exec.run_paths
+    end
+  end
+
+  def initialize paths
+    @paths = paths
+    @pwd = Pathname.pwd.freeze
+  end
+
+  def paths
+    if @paths.empty? then
+      ['spec', 'uspec', 'test'].each do |path|
+        @paths << path if Pathname.new(path).directory?
+      end
+    end
+
+    @paths
+  end
+
+  def run_paths
+    paths.each do |path|
+      run @pwd.join path
+    end
+  end
+
+  def run path
+    if path.directory? then
+      Pathname.glob(path.join('**', '**_spec.rb')).each do |spec|
+        run spec
+      end
+    elsif path.exist? then
+      puts "#{path.basename path.extname}:"
+      Uspec::DSL.instance_eval(path.read, path.to_s)
+    else
+      warn "path not found: #{path}"
+    end
+  end
+
+end

data/lib/uspec/stats.rb

@@ -14,7 +14,8 @@ module Uspec
       end
 
       def exit_code
-        results.all?{|result| result == true} ? 0 : 255
+        failures = results.count{|result| !result }
+        failures > 255 ? 255 : failures
       end
     end
   end

data/lib/uspec/version.rb

@@ -1,3 +1,3 @@
 module Uspec
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/uspec/exec_spec.rb

@@ -0,0 +1,27 @@
+require_relative 'uspec_helper'
+
+spec 'shows usage' do
+  output = capture do
+    exec 'bin/uspec -h'
+  end
+
+  output.include? 'usage'
+end
+
+spec 'runs a path of specs' do
+  output = capture do
+    path = Pathname.new(__FILE__).parent.parent.join('example_specs').to_s
+    Uspec::Exec.run_specs Array(path)
+  end
+
+  output.include? 'I love passing tests'
+end
+
+spec 'runs an individual spec' do
+  output = capture do
+    path =  Pathname.new(__FILE__).parent.parent.join('example_specs', 'example_spec.rb').to_s
+    Uspec::Exec.run_specs Array(path)
+  end
+
+  output.include? 'I love passing tests'
+end

data/uspec/uspec_helper.rb

@@ -0,0 +1,20 @@
+require_relative '../lib/uspec'
+extend Uspec
+
+def capture
+  readme, writeme = IO.pipe
+  pid = fork do
+    $stdout.reopen writeme
+    $stderr.reopen writeme
+    readme.close
+
+    yield
+  end
+
+  writeme.close
+  output = readme.read
+  Process.waitpid(pid)
+
+  output
+end
+

data/uspec/uspec_spec.rb

@@ -1,21 +1,4 @@
-require_relative '../lib/uspec'
-extend Uspec
-
-def capture
-  readme, writeme = IO.pipe
-  pid = fork do
-    $stdout.reopen writeme
-    readme.close
-
-    yield
-  end
-
-  writeme.close
-  output = readme.read
-  Process.waitpid(pid)
-
-  output
-end
+require_relative 'uspec_helper'
 
 spec 'catches errors' do
   output = capture do
@@ -48,3 +31,27 @@ end
 spec 'should not define DSL methods on arbitrary objects' do
   !(Array.respond_to? :spec)
 end
+
+spec 'exit code is the number of failures' do
+  capture do
+    50.times do
+      spec 'fail' do
+        false
+      end
+    end
+  end
+
+  $?.exitstatus == 50 || $?
+end
+
+spec 'if more than 255 failures, exit status is 255' do
+  capture do
+    500.times do
+      spec 'fail' do
+        false
+      end
+    end
+  end
+
+  $?.exitstatus == 255 || $?
+end

metadata

@@ -1,62 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: uspec
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Anthony Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies: []
 description: Uspec is a shiny little spec framework for your apps! Unlike other testing
   frameworks there's no need for matchers, there can only be one assertion per test,
   and you never have to worry that your tests lack assertions.
 email:
 - anthonymichaelcook@gmail.com
-executables: []
+executables:
+- uspec
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- bin/uspec
 - example_specs/example_spec.rb
 - example_specs/spec_helper.rb
 - lib/uspec.rb
 - lib/uspec/dsl.rb
+- lib/uspec/exec.rb
 - lib/uspec/formatter.rb
 - lib/uspec/stats.rb
 - lib/uspec/version.rb
 - uspec.gemspec
+- uspec/exec_spec.rb
+- uspec/uspec_helper.rb
 - uspec/uspec_spec.rb
 homepage: http://github.com/acook/uspec#readme
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.6.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a shiny little spec framework for your apps!
 test_files: []
+has_rdoc: