quarry 0.3.0 → 0.4.0

data/doc/ri/Assertion/cdesc-Assertion.yaml

@@ -5,7 +5,30 @@ class_methods: []
 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Assertion object is a special subclass of Exception, used to raise assertion errors.
+  body: Assertion is a special subclass of Exception used to raise assertion errors.
+- !ruby/struct:SM::Flow::P 
+  body: "Assertions are generally invoked via the #assert or #should functors. For instance to assert that 4 == 4 use:"
+- !ruby/struct:SM::Flow::VERB 
+  body: "  4.assert == 4\n"
+- !ruby/struct:SM::Flow::P 
+  body: If the assertion does not hold true an Assertion exception will be raised.
+- !ruby/struct:SM::Flow::P 
+  body: You can also create your own assertion "macros" simply by defining applicable methods resuing previous assertion methods.
+- !ruby/struct:SM::Flow::VERB 
+  body: "  class Module\n    def should_be_enumerable(module)\n      should < Enumerable\n      instance_methods.should.include?('each')\n    end\n  end\n"
+- !ruby/struct:SM::Flow::P 
+  body: "As fancy as assertion functors may seem, under the hood they translate into quite simple code. Consider this valid macro:"
+- !ruby/struct:SM::Flow::VERB 
+  body: "  def assert_fail_every_time\n    raise Assertion, "this will fail every time"\n  end\n"
+- !ruby/struct:SM::Flow::P 
+  body: Not very useful, but completely valid.
+- !ruby/struct:SM::Flow::H 
+  level: 2
+  text: Concerning Nomenclature
+- !ruby/struct:SM::Flow::P 
+  body: Unfortunately there's a bit of rift in the naming scheme of assertion methods. With TDD the term 'assert' became the standard. However, with the advent of BDD, 'should' has become the dominant term.
+- !ruby/struct:SM::Flow::P 
+  body: If I had my druthers I would probably have picked 'must' since it is short and carries the semantics of enforcement.
 constants: []
 
 full_name: Assertion

data/doc/ri/Object/assert%21-i.yaml

@@ -1,12 +1,15 @@
 --- !ruby/object:RI::MethodDescription 
-aliases: []
-
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: refute
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Assert not an operational relationship.
+  body: Assert not an operational relationship. Read it as "assert not".
+- !ruby/struct:SM::Flow::VERB 
+  body: "  4.assert! == 4  #=> Assertion Error\n"
 - !ruby/struct:SM::Flow::P 
-  body: "4.assert! == 4 #=> Assertion Error"
+  body: "AUHTOR'S NOTE: This method would not be necessary if Ruby would allow +!=+ to be define as a method, or at least +!+ as a unary method."
 full_name: Object#assert!
 is_singleton: false
 name: assert!

data/doc/ri/Object/assert-i.yaml

@@ -1,6 +1,7 @@
 --- !ruby/object:RI::MethodDescription 
-aliases: []
-
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: should
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 

data/doc/ri/Object/assert_raises%21-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #refute_raises"
+full_name: Object#assert_raises!
+is_singleton: false
+name: assert_raises!
+params: (exception, &block)
+visibility: public

data/doc/ri/Object/assert_raises-i.yaml

@@ -0,0 +1,15 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: should_raise
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Provides a way to assert that a procedure raises an exception.
+- !ruby/struct:SM::Flow::VERB 
+  body: "  assert_raises(StandardError){ raise }\n"
+full_name: Object#assert_raises
+is_singleton: false
+name: assert_raises
+params: (exception, &block)
+visibility: public

data/doc/ri/Object/cdesc-Object.yaml

@@ -4,8 +4,6 @@ attributes: []
 class_methods: []
 
 comment: 
-- !ruby/struct:SM::Flow::P 
-  body: Copyright (c) 2008 Tiger Ops
 constants: []
 
 full_name: Object
@@ -16,5 +14,29 @@ instance_methods:
   name: assert
 - !ruby/object:RI::MethodSummary 
   name: assert!
+- !ruby/object:RI::MethodSummary 
+  name: assert_raises
+- !ruby/object:RI::MethodSummary 
+  name: assert_raises!
+- !ruby/object:RI::MethodSummary 
+  name: mock
+- !ruby/object:RI::MethodSummary 
+  name: refute
+- !ruby/object:RI::MethodSummary 
+  name: refute_raises
+- !ruby/object:RI::MethodSummary 
+  name: remove
+- !ruby/object:RI::MethodSummary 
+  name: remove
+- !ruby/object:RI::MethodSummary 
+  name: should
+- !ruby/object:RI::MethodSummary 
+  name: should_not
+- !ruby/object:RI::MethodSummary 
+  name: should_not_raise
+- !ruby/object:RI::MethodSummary 
+  name: should_raise
+- !ruby/object:RI::MethodSummary 
+  name: stub
 name: Object
 superclass: Object

data/doc/ri/{Quarry/Design/Specification/outline-i.yaml → Object/mock-i.yaml}

@@ -4,9 +4,9 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Outline Specification
-full_name: Quarry::Design::Specification#outline
+  body: Create mock object.
+full_name: Object#mock
 is_singleton: false
-name: outline
-params: (level=0)
+name: mock
+params: (mock_module=nil)
 visibility: public

data/doc/ri/Object/refute-i.yaml

@@ -0,0 +1,13 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: should_not
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #assert!"
+full_name: Object#refute
+is_singleton: false
+name: refute
+params: ()
+visibility: public

data/doc/ri/Object/refute_raises-i.yaml

@@ -0,0 +1,17 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: assert_raises!
+- !ruby/object:RI::AliasName 
+  name: should_not_raise
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Provides a way to assert that a procedure does not raise an exception.
+- !ruby/struct:SM::Flow::VERB 
+  body: "  refute_raises(StandardError){ raise }\n"
+full_name: Object#refute_raises
+is_singleton: false
+name: refute_raises
+params: (exception, &block)
+visibility: public

data/doc/ri/Object/remove-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: We can't remove the module per-say. So we have to just neuter it. This is a very weak solution, but it will suffice for the moment.
+full_name: Object#remove
+is_singleton: false
+name: remove
+params: (stub_module=nil)
+visibility: public

data/doc/ri/{Quarry/Design/check-c.yaml → Object/should-i.yaml}

@@ -4,9 +4,9 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: "TODO: make output compatible with unit_diff ?"
-full_name: Quarry::Design::check
-is_singleton: true
-name: check
+  body: "Alias for #assert"
+full_name: Object#should
+is_singleton: false
+name: should
 params: ()
 visibility: public

data/doc/ri/Object/should_not-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #refute"
+full_name: Object#should_not
+is_singleton: false
+name: should_not
+params: ()
+visibility: public

data/doc/ri/Object/should_not_raise-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #refute_raises"
+full_name: Object#should_not_raise
+is_singleton: false
+name: should_not_raise
+params: (exception, &block)
+visibility: public

data/doc/ri/Object/should_raise-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #assert_raises"
+full_name: Object#should_raise
+is_singleton: false
+name: should_raise
+params: (exception, &block)
+visibility: public

data/doc/ri/{Quarry/Mock/Object/mock-c.yaml → Object/stub-i.yaml}

@@ -4,9 +4,9 @@ aliases: []
 block_params: 
 comment: 
 - !ruby/struct:SM::Flow::P 
-  body: Mock a static repsonse.
-full_name: Quarry::Mock::Object::mock
-is_singleton: true
-name: mock
-params: ( sym, val )
+  body: Create a new stub.
+full_name: Object#stub
+is_singleton: false
+name: stub
+params: (stub_module=nil)
 visibility: public

data/doc/ri/{Module/cdesc-Module.yaml → Quarry/Break/cdesc-Break.yaml}

@@ -2,20 +2,22 @@
 attributes: 
 - !ruby/object:RI::Attribute 
   comment: 
-  name: docs
+  name: exception
   rw: R
-class_methods: []
-
+class_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: new
 comment: 
+- !ruby/struct:SM::Flow::H 
+  level: 1
+  text: Exception Break and Edit
 constants: []
 
-full_name: Module
+full_name: Quarry::Break
 includes: []
 
 instance_methods: 
 - !ruby/object:RI::MethodSummary 
-  name: doc
-- !ruby/object:RI::MethodSummary 
-  name: method_added
-name: Module
+  name: edit
+name: Break
 superclass: Object

data/doc/ri/Quarry/Break/edit-i.yaml

@@ -0,0 +1,11 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: []
+
+full_name: Quarry::Break#edit
+is_singleton: false
+name: edit
+params: ()
+visibility: public

data/doc/ri/Quarry/Break/new-c.yaml

@@ -0,0 +1,11 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: []
+
+full_name: Quarry::Break::new
+is_singleton: true
+name: new
+params: (exception)
+visibility: public

data/doc/ri/Quarry/Extract/cdesc-Extract.yaml

@@ -0,0 +1,26 @@
+--- !ruby/object:RI::ClassDescription 
+attributes: []
+
+class_methods: []
+
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Extractor is a tool for extracting code from embedded comment blocks.
+- !ruby/struct:SM::Flow::P 
+  body: "TODO:"
+- !ruby/struct:SM::Flow::VERB 
+  body: "  - Should extract_block handle more than the first matching block?\n  - How can we handle embedded code in standard comments? Eg. #\n"
+constants: []
+
+full_name: Quarry::Extract
+includes: []
+
+instance_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: create_test
+- !ruby/object:RI::MethodSummary 
+  name: extract_test_from_file
+- !ruby/object:RI::MethodSummary 
+  name: test_extract
+name: Extract
+superclass: 

data/doc/ri/Quarry/Extract/create_test-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Generate the test.
+full_name: Quarry::Extract#create_test
+is_singleton: false
+name: create_test
+params: (testing, file)
+visibility: private

data/doc/ri/Quarry/Extract/extract_test_from_file-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Extract test from a file's testing comments.
+full_name: Quarry::Extract#extract_test_from_file
+is_singleton: false
+name: extract_test_from_file
+params: (file)
+visibility: private

data/doc/ri/Quarry/Extract/test_extract-i.yaml

@@ -0,0 +1,18 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Extract unit tests. This task scans every package script looking for sections of the form:"
+- !ruby/struct:SM::Flow::VERB 
+  body: "    =begin test\n      ...\n    =end\n"
+- !ruby/struct:SM::Flow::P 
+  body: With appropriate headers, it copies these sections to files in your project's test/ dir, which then can be run using the Ratchet test task. The exact directory layout of the files to be tested is reflected in the test directory. You can then use project.rb's test task to run the tests.
+- !ruby/struct:SM::Flow::VERB 
+  body: "    files      Files to extract ['lib/**/*.rb']\n    output     Test directory   ['test/']\n"
+full_name: Quarry::Extract#test_extract
+is_singleton: false
+name: test_extract
+params: (files=nil)
+visibility: public

data/doc/ri/Quarry/Mock/Delegator/cdesc-Delegator.yaml

@@ -0,0 +1,20 @@
+--- !ruby/object:RI::ClassDescription 
+attributes: []
+
+class_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: new
+comment: 
+- !ruby/struct:SM::Flow::H 
+  level: 1
+  text: Mock::Delegator
+constants: []
+
+full_name: Quarry::Mock::Delegator
+includes: []
+
+instance_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: method_missing
+name: Delegator
+superclass: Object

data/doc/ri/Quarry/{Design/Specification/Context → Mock/Delegator}/method_missing-i.yaml

@@ -3,8 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
-full_name: Quarry::Design::Specification::Context#method_missing
+full_name: Quarry::Mock::Delegator#method_missing
 is_singleton: false
 name: method_missing
-params: (relation, *description, &specification)
+params: (s, *a, &b)
 visibility: public

data/doc/ri/Quarry/{Design/specification-c.yaml → Mock/Delegator/new-c.yaml}

@@ -3,8 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
-full_name: Quarry::Design::specification
+full_name: Quarry::Mock::Delegator::new
 is_singleton: true
-name: specification
-params: (description, &specification)
+name: new
+params: (object, mock_module)
 visibility: public

data/doc/ri/{Module/method_added-i.yaml → Quarry/Mock/Setter/%3d%3d-i.yaml}

@@ -3,8 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
-full_name: Module#method_added
+full_name: Quarry::Mock::Setter#==
 is_singleton: false
-name: method_added
-params: (meth)
+name: ==
+params: (result)
 visibility: public

data/doc/ri/Quarry/Mock/Setter/cdesc-Setter.yaml

@@ -0,0 +1,18 @@
+--- !ruby/object:RI::ClassDescription 
+attributes: []
+
+class_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: new
+comment: []
+
+constants: []
+
+full_name: Quarry::Mock::Setter
+includes: []
+
+instance_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: ==
+name: Setter
+superclass: Object

data/doc/ri/Quarry/Mock/Setter/new-c.yaml

@@ -0,0 +1,10 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+full_name: Quarry::Mock::Setter::new
+is_singleton: true
+name: new
+params: (table, interface)
+visibility: public

data/doc/ri/Quarry/Mock/__table__-i.yaml

@@ -0,0 +1,11 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: []
+
+full_name: Quarry::Mock#__table__
+is_singleton: false
+name: __table__
+params: ()
+visibility: public

data/doc/ri/Quarry/Mock/cdesc-Mock.yaml

@@ -1,15 +1,25 @@
 --- !ruby/object:RI::ClassDescription 
-attributes: []
-
-class_methods: []
-
+attributes: 
+- !ruby/object:RI::Attribute 
+  comment: 
+  name: object
+  rw: R
+class_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: new
 comment: 
+- !ruby/struct:SM::Flow::H 
+  level: 1
+  text: Mock
 constants: []
 
 full_name: Quarry::Mock
 includes: []
 
-instance_methods: []
-
+instance_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: __table__
+- !ruby/object:RI::MethodSummary 
+  name: method_missing
 name: Mock
-superclass: 
+superclass: Module

data/doc/ri/Quarry/Mock/method_missing-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "TODO: Ruby has retry, but I need continue!"
+full_name: Quarry::Mock#method_missing
+is_singleton: false
+name: method_missing
+params: (meth, *args, &block)
+visibility: public

data/doc/ri/Quarry/{Design/outline-c.yaml → Mock/new-c.yaml}

@@ -3,8 +3,8 @@ aliases: []
 
 block_params: 
 comment: 
-full_name: Quarry::Design::outline
+full_name: Quarry::Mock::new
 is_singleton: true
-name: outline
+name: new
 params: ()
 visibility: public

data/doc/ri/Quarry/Spec/Comment/cdesc-Comment.yaml

@@ -0,0 +1,33 @@
+--- !ruby/object:RI::ClassDescription 
+attributes: 
+- !ruby/object:RI::Attribute 
+  comment: 
+  name: lineno
+  rw: R
+- !ruby/object:RI::Attribute 
+  comment: 
+  name: parent
+  rw: R
+- !ruby/object:RI::Attribute 
+  comment: 
+  name: text
+  rw: R
+class_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: new
+comment: 
+- !ruby/struct:SM::Flow::H 
+  level: 1
+  text: Comment
+constants: []
+
+full_name: Quarry::Spec::Comment
+includes: []
+
+instance_methods: 
+- !ruby/object:RI::MethodSummary 
+  name: macro?
+- !ruby/object:RI::MethodSummary 
+  name: type
+name: Comment
+superclass: Object

data/doc/ri/Quarry/Spec/Comment/macro%3f-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: "Alias for #type"
+full_name: Quarry::Spec::Comment#macro?
+is_singleton: false
+name: macro?
+params: ()
+visibility: public

data/doc/ri/Quarry/Spec/Comment/new-c.yaml

@@ -0,0 +1,10 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+full_name: Quarry::Spec::Comment::new
+is_singleton: true
+name: new
+params: (parent, text, lineno)
+visibility: public

data/doc/ri/Quarry/Spec/Comment/type-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: 
+- !ruby/object:RI::AliasName 
+  name: macro?
+block_params: 
+comment: []
+
+full_name: Quarry::Spec::Comment#type
+is_singleton: false
+name: type
+params: ()
+visibility: public

data/doc/ri/Quarry/Spec/Config/after-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Run at the end of a specification step.
+full_name: Quarry::Spec::Config#after
+is_singleton: false
+name: after
+params: ()
+visibility: public

data/doc/ri/Quarry/Spec/Config/after_spec-i.yaml

@@ -0,0 +1,12 @@
+--- !ruby/object:RI::MethodDescription 
+aliases: []
+
+block_params: 
+comment: 
+- !ruby/struct:SM::Flow::P 
+  body: Run at the end of a specification.
+full_name: Quarry::Spec::Config#after_spec
+is_singleton: false
+name: after_spec
+params: ()
+visibility: public