fix 0.0.1.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e0bdb51428d1e9befcd3f876463ec42ecd33f24
-  data.tar.gz: 080b67c3571d376c76c11c7073a1905179a5e79e
+  metadata.gz: 74b5daa559c487d3ea7737a0fd4f58233759c7e2
+  data.tar.gz: 5991787e6e0961b202c12ea2574758cf17bf2755
 SHA512:
-  metadata.gz: e2cce45a87309814780a680087b0f8c6805ec87e53960c5e56d047894f5aeef544bc3053dcaed099c023a970cb5e585043aa8857937300ede5cd6a7eadd4c801
-  data.tar.gz: 7733c37958d09da34948aaf7b357874bfc9cfc647849aaf0baac451b6c0731b73c46c418d0a9424ace1171ad047ef95e568478f2f2d9fa6940f315bb1cc064d4
+  metadata.gz: 6902d25e683dd69f5a516a9a8b3b22a20695d0c168bd2acc1b76a65b509f4d08d5b690553452025ee925d395ad8b694211b8cfecbd024e3b06afd1362b7e16a6
+  data.tar.gz: 2bb3e3b8b59bff07f4092493d95d45c2b4ff590420b33adac42bf913346dcba4c3e6edafa6a67dac4b1bf0e11afad0342b37caf40015a1ff9c2abc188d3aa4d9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
-script: 'bundle exec rake test'
+script: 'bundle exec rake test:coverage'
 rvm:
-  - 2.1.2
+  - 2.0.0
+  - 2.1.3
+  - ruby-head

data/README.md

@@ -1,22 +1,24 @@
 # Fix
 
-Minimal and fast BDD framework for Ruby.
+[![Build Status](https://travis-ci.org/cyril/fix.rb.svg?branch=master)](https://travis-ci.org/cyril/fix.rb)
+[![Coverage Status](http://img.shields.io/coveralls/cyril/fix.rb.svg?branch=master)](https://coveralls.io/r/cyril/fix.rb)
+[![Dependency Status](https://gemnasium.com/cyril/fix.rb.svg)](https://gemnasium.com/cyril/fix.rb)
+[![Gem Version](http://img.shields.io/gem/v/fix.svg)](https://rubygems.org/gems/fix)
+[![Inline docs](http://inch-ci.org/github/cyril/fix.rb.svg?branch=master)](http://inch-ci.org/github/cyril/fix.rb)
+[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)](http://rubydoc.info/gems/fix/frames)
+[![License](http://img.shields.io/:license-MIT-38c800.svg)](http://cyril.mit-license.org/)
 
-![Fix](https://raw.githubusercontent.com/cyril/fix.rb/master/logo.svg)
+> A specing framework for Ruby.
 
-## Status
+## Contact
 
-[![Gem Version](https://badge.fury.io/rb/fix.png)](http://badge.fury.io/rb/fix)
-[![Build Status](https://secure.travis-ci.org/cyril/fix.rb.png?branch=master)](http://travis-ci.org/cyril/fix.rb?branch=master)
-[![Coverage](https://coveralls.io/repos/cyril/fix.rb/badge.png?branch=master)](https://coveralls.io/r/cyril/fix.rb)
-[![Code Climate](https://codeclimate.com/github/cyril/fix.rb.png)](https://codeclimate.com/github/cyril/fix.rb)
-[![Dependencies](https://gemnasium.com/cyril/fix.rb.png)](https://gemnasium.com/cyril/fix.rb)
-[![Inline docs](http://inch-ci.org/github/cyril/fix.rb.png)](http://inch-ci.org/github/cyril/fix.rb)
-![](https://ruby-gem-downloads-badge.herokuapp.com/fix?type=total)
+* Home page: http://fixrb.org/
+* Bugs/issues: https://github.com/cyril/fix.rb/issues
+* Support: https://stackoverflow.com/questions/tagged/fix-ruby
 
 ## Rubies
 
-__Fix__ supports Ruby (MRI) 2+.
+__Fix__ is supported by Ruby (MRI) 2+.
 
 ## Installation
 
@@ -28,67 +30,97 @@ gem 'fix'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install fix
+```shell
+$ gem install fix
+```
+
+## Philosophy
 
-## Usage
+### Minimalist
+
+With ~400 lignes of **simple code** built on top of [Spectus expectation library](cyril/spectus.rb), facilities such as benchmarking and mocking are not supported. Fix offers however a **consistent** syntax to **DRY** and focus your BDD.
+
+### Resistant
+
+While specs behave like **documents** which can be logic-less, their interpretation should not be questioned regardless of the version of Fix, preventing from software erosion. Also, Fix specs are complient with **[RFC 2119](http://tools.ietf.org/html/rfc2119)**.
 
-Given that you'd like to test the following class:
+### Complexity
+
+Monkey-patching, magic tricks and friends are not included. Instead, animated by **authentic** and **immutable** Ruby objects, unambiguous, understandable and structured specs are encouraged.
+
+### Objective
+
+After having loaded atomically the specs in read-only, the code to be tested can also be loaded and evaluated in **isolation** by Fix. There is a separation of concerns between the specs and the code.
+
+## Usage
 
 ```ruby
-# app.rb
-class Meme
-  def i_can_has_cheezburger?
-    "OHAI!"
+class Duck
+  def walks
+    "Klop klop!"
   end
 
-  def will_it_blend?
-    "YES!"
+  def swims
+    "Swoosh..."
+  end
+
+  def quacks
+    puts "Quaaaaaack!"
   end
 end
+
+@bird = Duck.new
 ```
 
-Define your tests as methods:
+> When I see a `#<Duck:0x007f96b285d6d0>` that ...
 
 ```ruby
-# spec.rb
-require "app"
-
-constant :Meme do
-  call :new do
-    scope "when asked about cheeseburgers" do
-      call :i_can_has_cheezburger? do
-        subject.should eql "OHAI!"
-      end
-    end
-  
-    scope "when asked about blending possibilities" do
-      call :will_it_blend? do
-        subject.should_not match /^no/i
-      end
-    end
+require 'fix'
+
+@duck_spec = Fix::Spec.new :duck do
+  on :swims do
+    it { SHALL eql: "Swoosh..." }
+    it { MAY capture_stdout: " ...\n" }
+  end
+
+  on :quacks do
+    it { SHOULD capture_stdout: "Quaaaaaack!\n" }
+  end
+
+  on :speaks do
+    it { MUST raise_exception: NoMethodError }
+  end
+
+  on :sings do
+    it { MAY eql: "♪... ♫..." }
   end
 end
-```
 
-And then, test it:
+case @duck_spec.valid? @bird
+  when true then puts "I call that #{@bird} a duck."
+  else warn 'WAT?'
+end
+```
 
 ```bash
-$ fix ./spec.rb 
-/Users/bob/spec.rb
-..
-Finished in 0.004397 seconds
-2 examples, 0 failures
+ruby test.rb
+# Run options: --seed 241686681690348892099960370893524466040
+# .....
+# Finished in 0.001033 seconds.
+# 5 tests, 0 failures, 0 errors
 ```
 
-PS: Thanks to the Minitest authors that I picked up the example.
+> I call that `#<Duck:0x007f96b285d6d0>` a duck.
 
 ## Contributing
 
-1. Fork it ( https://github.com/cyril/fix.rb/fork )
+1. [Fork it](https://github.com/cyril/fix.rb/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -96,8 +128,8 @@ PS: Thanks to the Minitest authors that I picked up the example.
 
 ## Versioning
 
-__Fix__ uses [Semantic Versioning 2.0.0](http://semver.org).
+__Fix__ follows [Semantic Versioning 2.0](http://semver.org/)
 
 ## Copyright
 
-Copyright 2014 Cyril Wack – Released under [MIT License](LICENSE.md)
+&copy; 2014 [Cyril Wack](https://plus.google.com/+CyrilWack?rel=author)

data/Rakefile

@@ -1 +1,18 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = File.join 'spec', '**', '*_spec.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task(:doc_stats) { ruby '-S yard stats' }
+task default: [:test, :doc_stats]

data/VERSION.semver

@@ -1 +1 @@
-0.0.1.pre
+0.1.0

data/example/duck/README.md

@@ -0,0 +1,9 @@
+# Duck example
+
+```bash
+$ ./test.rb
+Run options: --seed 122743552393459455928023127107893880649
+......
+Finished in 0.001181 seconds.
+6 tests, 0 failures, 0 errors
+```

data/example/duck/app.rb

@@ -0,0 +1,3 @@
+require_relative 'lib'
+
+@app = Duck.new

data/example/duck/lib.rb

@@ -0,0 +1,14 @@
+class Duck
+  def walks
+    "Quaaa... Klop klop!"
+  end
+
+  def swims
+    warn " ..."
+    "Quaaa.."
+  end
+
+  def quacks
+    puts "Quaaaaaack!"
+  end
+end

data/example/duck/spec.rb

@@ -0,0 +1,31 @@
+require 'fix'
+
+@spec = Fix::Spec.new :duck do
+  let(:word) { "Quaaa" }
+
+  on :swims do
+    it { MUST capture_stderr: " ...\n" }
+  end
+
+  on :quacks do
+    let(:quaaaaaack) { word + "aaack!\n" }
+
+    it { SHOULD capture_stdout: quaaaaaack }
+  end
+
+  its(:speaks) { MUST raise_exception: NoMethodError }
+
+  on :sings do
+    it { MAY eql: "♪... ♫..." }
+  end
+
+  on :walks do
+    let(:walks) { "#{word}... Klop klop!" }
+
+    it { MUST eql: walks }
+
+    on :split, '... ' do
+      its(:last) { MUST eql: "Klop klop!" }
+    end
+  end
+end

data/example/duck/test.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby -w
+
+require_relative 'app'
+require_relative 'spec'
+
+@spec.test @app

data/fix.gemspec

@@ -3,16 +3,20 @@ Gem::Specification.new do |spec|
   spec.version       = File.read('VERSION.semver')
   spec.authors       = ['Cyril Wack']
   spec.email         = ['cyril@sashite.com']
-  spec.summary       = %q{Fix and keep the green code.}
-  spec.description   = %q{Minimal and fast BDD framework for Ruby.}
-  spec.homepage      = 'https://github.com/cyril/fix.rb'
+  spec.summary       = %q{Specing framework.}
+  spec.description   = %q{A specing framework for Ruby.}
+  spec.homepage      = 'http://fixrb.org/'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency             'spectus',    '~> 1.0.0.pre'
+
+  spec.add_development_dependency 'bundler',    '~> 1.7'
+  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'coveralls',  '~> 0.7'
 end

data/lib/fix.rb

@@ -1,20 +1,6 @@
-%w(set thread).each {|lib| require lib }
-%w(
-  helper
-  base_matcher
-  expectation_target
-  call
-  constant
-  subject
-  spec
-).each {|path| require_relative File.join 'fix', path }
+require_relative File.join 'fix', 'spec'
+require_relative File.join 'fix', 'version'
 
+# Namespace for the Fix framework.
 module Fix
-  def constant *syms, &block
-    @@spec = Spec.new *syms, &block
-  end
-
-  def self.run
-    @@spec.run
-  end
 end

data/lib/fix/dsl.rb

@@ -0,0 +1,10 @@
+require_relative File.join 'helper', 'its_helper'
+require_relative File.join 'helper', 'on_helper'
+
+module Fix
+  module DSL
+    include Helper::ItsHelper
+    include Helper::LetWriterHelper
+    include Helper::OnHelper
+  end
+end

data/lib/fix/expectation.rb

@@ -0,0 +1,48 @@
+require_relative File.join 'expectation_set'
+require 'spectus'
+
+module Fix
+  class Expectation
+    include Spectus::DSL
+
+    def initialize positive, definition, *args
+      @positive           = positive
+      @matcher, @expected = definition.to_a.flatten 1
+      @args               = args
+
+      freeze
+
+      ExpectationSet.instance.add self
+    end
+
+    private
+
+    def pass? report
+      report.pass?
+    end
+
+    def presenter report, got
+      {
+        pass:       pass?(report),
+        negated:    report.negated,
+        matcher:    report.matcher,
+        expected:   report.expected,
+        exception:  report.exception,
+        got:        got
+      }
+    end
+
+    def meta subject
+      {
+        level:              level,
+        params:             subject.params,
+        challenge:          subject.challenge,
+        subject_exception:  subject.error
+      }
+    end
+
+    def target
+      @positive ? :to : :not_to
+    end
+  end
+end

data/lib/fix/expectation_high.rb

@@ -0,0 +1,26 @@
+require_relative File.join 'expectation'
+require_relative File.join 'subject'
+
+module Fix
+  class ExpectationHigh < Expectation
+    def evaluate front_object
+      subject = Subject.new front_object, *@args
+      got     = nil
+
+      Thread.new {
+        report = expect { got = subject.actual }.
+          public_send target, @matcher => @expected
+
+        data = presenter report, got
+
+        Hash[ data.to_a + meta(subject).to_a ]
+      }.value
+    end
+
+    private
+
+    def level
+      1
+    end
+  end
+end

data/lib/fix/expectation_low.rb

@@ -0,0 +1,44 @@
+require_relative File.join 'expectation_medium'
+
+module Fix
+  class ExpectationLow < ExpectationMedium
+    def evaluate front_object
+      subject = Subject.new front_object, *@args
+      got     = nil
+
+      Thread.new {
+        report = expect { got = subject.actual }.
+          public_send target, @matcher => @expected
+
+        data = presenter report, got, subject
+
+        Hash[ data.to_a + meta(subject).to_a ]
+      }.value
+    end
+
+    private
+
+    def pass? report, subject
+      if subject.implemented?
+        report.exception.nil?
+      else
+        true
+      end
+    end
+
+    def level
+      3
+    end
+
+    def presenter report, got, subject
+      {
+        pass:       pass?(report, subject),
+        negated:    report.negated,
+        matcher:    report.matcher,
+        expected:   report.expected,
+        exception:  report.exception,
+        got:        got
+      }
+    end
+  end
+end