quickie 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rvmrc

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1.0
+  - Initial Release.

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    quickie (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  quickie!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Michael Dvorkin
+twitter.com/mid
+%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+
+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, 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 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.

data/README.md

@@ -0,0 +1,86 @@
+## Quickie ##
+Quickie is micro library for quick in-place testing of your Ruby code. It adds two useful
+methods: <code>Object#should</code> and <code>Object#should\_not</code> for positive and
+negative assertions. With Quickie you can conveniently bundle tests together with your
+Ruby code, typically within <code>if $0 == \_\_FILE\_\_</code> conditional statement.
+
+### System Requirements ###
+Ruby 1.9.2 or later.
+
+### Installation ###
+    # Installing as Ruby gem
+    $ gem install quickie
+
+    # Cloning the repository
+    $ git clone git://github.com/michaeldv/quickie.git
+
+### Usage Example ###
+
+    $ cat > sample.rb
+    class Account                             # Back account class.
+      attr_reader :balance                    # Current account balance.
+      
+      def initialize(amount)                  # Open the account.
+        @balance = amount                     # Accept initial deposit.
+      end
+      
+      def deposit(amount)                     # Accept account deposit.
+        @balance += amount                    # Update current balance.
+      end
+      
+      def withdraw(amount)                    # Withdraw from the account.
+        cash = [ @balance, amount ].min       # Can't withdraw more than the balance.
+        @balance -= cash                      # Update current balance.
+        cash
+      end
+      
+      def status                              # Display account status.
+        "Current balance: $#{balance}"
+      end
+    end
+
+    if $0 == __FILE__                         # Execute only when running current Ruby file.
+      require "quickie"                       # Require the gem.
+      
+      acc = Account.new(100)                  # Deposit $100 when opening the account.
+      acc.balance.should == 100               # Initial balance should be $100.
+      acc.deposit(200)                        # Deposit $200 more.
+      acc.balance.should != 100               # The balance should get updated.
+      acc.balance.should == 300               # It should be $100 + $200 = $300.
+      
+      String.should === acc.status            # Account#status returns a string.
+      acc.status.should_not =~ /\$$/          # Status string should contain the balance.
+      acc.status.should =~ /\$\d+$/           # The balance is one or more digits.
+      
+      acc.withdraw(500).should == 300         # Withdrawal that exeeds the balance is not allowed.
+      acc.balance.should == 0                 # Current balance should drop to zero.
+      acc.status.should !~ /\$[1-9]+$/        # Status no longer shows positive number.
+      acc.status.should =~ /\$0$/             # It shows $0.
+    end
+    ^D
+    $ ruby sample.rb 
+    ..........
+    
+    Passed: 10, not quite: 0, total tests: 10.
+
+### Testing Quickie ###
+Quickie code is tested by the Quickie itself.
+
+    $ ruby test/quickie_test.rb
+    ....................
+    
+    Passed: 20, not quite: 0, total tests: 20.
+
+### Note on Patches/Pull Requests ###
+* Fork the project on Github.
+* Make your feature addition or bug fix.
+* Add test for it, making sure $ ruby test/*.rb all pass.
+* Commit, do not mess with Rakefile, version, or history.
+* Send me a pull request.
+
+### License ###
+
+    Copyright (c) 2011-12 Michael Dvorkin
+    twitter.com/mid
+    %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+    Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/quickie/core_ext/object.rb

@@ -0,0 +1,13 @@
+# Copyright (c) 2011-12 Michael Dvorkin
+#
+# Quickie is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+class Object
+  [ :should, :should_not ].each do |verb|
+    define_method verb do
+      Quickie::Matcher.new(self, verb)
+    end
+    alias_method :"#{verb}_be", verb
+  end
+end

data/lib/quickie/matcher.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2011-12 Michael Dvorkin
+#
+# Quickie is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module Quickie
+  class Hell < RuntimeError
+    def oops
+      puts "\n#{message.chomp} in #{backtrace[2].sub(':', ', line ').sub(':', ' ')}"
+    end
+  end
+
+  class Matcher
+    def initialize(object, verb)
+      @object = object
+      @should = (verb == :should)
+      %w[ == === =~ > >= < <= => ].each do |operator|
+        self.class.override operator
+      end
+    end
+
+    private
+
+    #--------------------------------------------------------------------------
+    def self.override(operator)
+      define_method(operator) do |expected|
+        evaluate(operator, nil, expected)
+      end
+
+      negative_operator = case operator[0]
+      when '<' then operator.sub('<',  '>')
+      when '>' then operator.sub('>',  '<')
+      else          operator.sub(/^=/, '!')
+      end
+
+      return unless @object.respond_to?(negative_operator)
+
+      define_method(negative_operator) do |expected|
+        evaluate(operator, negative_operator, expected)
+      end
+    end
+
+    #--------------------------------------------------------------------------
+    def evaluate(operator, negative_operator, expected)
+      actual = !!@object.__send__(operator, expected)
+      actual ^= 1 if (!@should && !negative_operator) || (@should && negative_operator)
+
+      if actual
+        report :success
+      else
+        report :failure
+        raise Hell, lyrics(negative_operator || operator, expected)
+      end
+
+    rescue Hell => e
+      e.oops
+    end
+
+    #--------------------------------------------------------------------------
+    def lyrics(operator, expected)
+      format = "expected: %s %s\n  actual: %s %s"
+      format.sub!(":", " not:").sub!("\n", "\n    ") unless @should
+      format % [ operator, expected.inspect, ' ' * operator.size, @object.inspect ]
+    end
+
+    #--------------------------------------------------------------------------
+    def report(status)
+      print '.' if status == :success
+      Runner.update(status)
+    end
+  end
+end

data/lib/quickie/runner.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2011-12 Michael Dvorkin
+#
+# Quickie is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module Quickie
+  class Runner
+    @@stats = Hash.new(0)
+
+    def self.update(status)
+      at_exit {
+        puts "\n\nPassed: #{@@stats[:success]}, not quite: #{@@stats[:failure]}, total tests: #{@@stats.values.inject(:+)}."
+      } if @@stats.empty?
+
+      @@stats[status] += 1
+    end
+  end
+end

data/lib/quickie/version.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2011-12 Michael Dvorkin
+#
+# Quickie is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module Quickie
+  def self.version
+    '0.1.0'
+  end
+end

data/lib/quickie.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2011-12 Michael Dvorkin
+#
+# Quickie is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+#
+# Check Ruby version in case someone is playng with cloned source repo. Note
+# that quickie.gemspec explicitly sets required_ruby_version to ">= 1.9.2".
+#
+abort "Quickie requires Ruby 1.9.2 or later" if RUBY_VERSION < "1.9.2"
+
+require File.dirname(__FILE__) + "/quickie/runner"
+require File.dirname(__FILE__) + "/quickie/matcher"
+require File.dirname(__FILE__) + "/quickie/version"
+require File.dirname(__FILE__) + "/quickie/core_ext/object"

data/test/quickie_test.rb

@@ -0,0 +1,112 @@
+# Copyright (c) 2011-12 Michael Dvorkin
+#
+# Quickie is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+require "stringio"
+require File.expand_path(File.dirname(__FILE__) + "/../lib/quickie")
+
+# Use Quickie to test itself. The methodology is as follows:
+#
+#   1. Write regular Quickie test.
+#   2. Capture the output of the test.
+#   3. Make sure captured output matches the expectation.
+#
+# In addition, we hack the Quickie stats so that captured tests are not
+# counted in the actual results.
+#--------------------------------------------------------------------------
+def capture
+  stats = Quickie::Runner.class_variable_get('@@stats')
+  captured = StringIO.new
+  standard, $stdout = $stdout, captured
+  yield
+  captured.string
+ensure
+  $stdout = standard
+  if captured.string == '.'
+    stats[:success] -= 1
+  else
+    stats[:failure] -= 1
+  end
+  Quickie::Runner.class_variable_set('@@stats', stats)
+end
+
+#--------------------------------------------------------------------------
+class String
+  def fix(line)
+    self.sub!(/^/, "\n")            # Insert newline.
+    self.sub!("?", line.to_s)       # Insert actual line number.
+    self.sub!(/\n+Passed.+$/, "")   # Ignore the stats.
+    self
+  end
+end
+
+# Should - passing specs.
+#--------------------------------------------------------------------------
+capture { "abc".should == "abc" }.should == "."
+capture { "abc".should != "xyz" }.should == "."
+capture { "abc".should =~ /AB/i }.should == "."
+capture { "abc".should !~ /XY/i }.should == "."
+capture { 1234567.should_be > 0 }.should == "."
+
+# Should Not - passing specs.
+#--------------------------------------------------------------------------
+capture { "abc".should_not != "abc" }.should == "."
+capture { "abc".should_not == "xyz" }.should == "."
+capture { "abc".should_not !~ /AB/i }.should == "."
+capture { "abc".should_not =~ /XY/i }.should == "."
+capture { 1234567.should_not_be < 0 }.should == "."
+
+# Should - failing specs.
+#--------------------------------------------------------------------------
+capture { "abc".should != "abc" }.should == <<-EOS.fix(__LINE__)
+expected: != "abc"
+  actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { "abc".should == "xyz" }.should == <<-EOS.fix(__LINE__)
+expected: == "xyz"
+  actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { "abc".should !~ /AB/i }.should == <<-EOS.fix(__LINE__)
+expected: !~ /AB/i
+  actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { "abc".should =~ /XY/i }.should == <<-EOS.fix(__LINE__)
+expected: =~ /XY/i
+  actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { 1234567.should_be < 0 }.should == <<-EOS.fix(__LINE__)
+expected: < 0
+  actual:   1234567 in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+# Should Not - failing specs.
+#--------------------------------------------------------------------------
+capture { "abc".should_not == "abc" }.should == <<-EOS.fix(__LINE__)
+expected not: == "abc"
+      actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { "abc".should_not != "xyz" }.should == <<-EOS.fix(__LINE__)
+expected not: != "xyz"
+      actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { "abc".should_not =~ /AB/i }.should == <<-EOS.fix(__LINE__)
+expected not: =~ /AB/i
+      actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { "abc".should_not !~ /XY/i }.should == <<-EOS.fix(__LINE__)
+expected not: !~ /XY/i
+      actual:    "abc" in test/quickie_test.rb, line ? in `block in <main>'
+EOS
+
+capture { 1234567.should_not_be > 0 }.should == <<-EOS.fix(__LINE__)
+expected not: > 0
+      actual:   1234567 in test/quickie_test.rb, line ? in `block in <main>'
+EOS

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: quickie
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Dvorkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-03 00:00:00.000000000 Z
+dependencies: []
+description: Quickie adds Object#should and Object#should_not methods for quick testing
+  of your Ruby code
+email: mike@dvorkin.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- README.md
+- lib/quickie/core_ext/object.rb
+- lib/quickie/matcher.rb
+- lib/quickie/runner.rb
+- lib/quickie/version.rb
+- lib/quickie.rb
+- test/quickie_test.rb
+- .gitignore
+homepage: http://github.com/michaeldv/quickie
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: quickie
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Micro framework for in-place testing of Ruby code
+test_files: []