specify 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c481008f53c158790b8973606e46818aa144aa2
-  data.tar.gz: d1650d893f25b1c2a58084d1309d25f159df06d5
+  metadata.gz: 69e28c76e85f675a58da7de545f6dabbbce8d096
+  data.tar.gz: 18fe6a1eba5d7f22d547d1d4c7b714e0f01127f2
 SHA512:
-  metadata.gz: 37b8be3fed44a9fea07ddf144bc20f80488ac04990d35176c3274467707fcc30bed0114d7bc28c4b79f823728df92f1680f08ecef1f53af6f6957c3b0f6656e0
-  data.tar.gz: ef72dc01b56e3deee8709ce44a0138f2f6a97b414a9a61c3a1832bf4879cee29357c1fe414ca15b1014a62bc551e411eb9d6a7ad25e972c5a17fc720ed2f9440
+  metadata.gz: c70699a694cc659c87a2084213da46efa23fc44c67fcd0d483a3e83a67d8053e744ccfd5865da9614cc9caef63f2438a140ad589fd3ee1bb5241bc5684a6ee8c
+  data.tar.gz: 5397feaf56d969fa864111c8e0bcac12b988ff7e12bcaa8a18b63d025a4ddebafbea4845e2816b4ab5982c607e60d4585837d0fc7440549339e8c560d881f316

data/README.md

@@ -9,11 +9,13 @@
 
 [![Gitter chat](https://badges.gitter.im/jnyman/specify.png)](https://gitter.im/jnyman/specify)
 [![endorse](https://api.coderwall.com/jnyman/endorsecount.png)](https://coderwall.com/jnyman)
-[![Stories in Ready](https://badge.waffle.io/jnyman/specify.png?label=ready&title=Ready)](https://waffle.io/jnyman/specify)
 
-Specify is a BDD-style micro-framework.
+> _"Simplicity is the ultimate sophistication."_
+> -- <cite>Leonardo DaVinci</cite>
 
-Specify is a very thin wrapper around RSpec that provides a Gherkin-style syntax for use with test examples.
+Specify is a test solution development tool that acts as a BDD-style micro-framework.
+
+Specify provides a very thin wrapper around RSpec that provides a Gherkin-style syntax for use with test examples.
 
 ## Installation
 
@@ -33,119 +35,25 @@ Or install it yourself as:
 
 ## Usage
 
-To use Specify you simply have to require it within your `spec_helper` file.
-
-While Specify does provide a Gherkin-like syntax, there is no parsing of a Gherkin feature and step definition matching. Just as in RSpec, everything is in one place: the Ruby file. The benefit here is that you don't have to change the text in two places (feature file and step definition file) every time you change something. Further, there are no more matchers to sync up with natural language. Specify uses plain Ruby helper methods coupled with various patterns.
-
-### Integration Tests
-
-RSpec's mode of action is that all examples should be completely independent. This is in line with its focus as primarily a unit-based testing framework. For integration purposes, this means if you want to use RSpec you have to write a sequence of examples, each of which repeats the behavior of all previous examples. Another alternative is that you could write one single large example that performs the entire set of actions. The problem in that case is that there is no independent reporting of each step.
-
-This is why tools like Cucumber end up being used.
-
-However the only benefit there is the ability to execute some examples in sequence and skip subsequent steps after a failure.
-
-So that's the goal of Specify: provide just the good parts of Cucumber and skipping all the questionable parts. At minimum this means the ability to chain examples into a series of steps that run in sequence and which stop when a step fails. The idea is to assemble a series of tests that should all pass, but where completely isolating them is not sensible. Hooking this into RSpec, this would make RSpec less unit and more integration.
-
-### Example
-
-Consider this example of a standard RSpec example group:
+To use Specify you simply have to require it within your `spec_helper` file:
 
 ```ruby
-describe 'Basic Spec Structure' do
-  context 'when simple logic tests are applied' do
-    it 'will agree that true almost certainly not false' do
-      expect(true).to_not be false
-    end
-
-    it 'will agree that true is pretty definitely true' do
-      expect(true).to be true
-    end
-  end
-end
-
-describe 'Simple Scenarios' do
-  context 'with an instance variable' do
-    it 'will establish a variable' do
-      @active = 'testing'
-      expect(@active).to eq 'testing'
-    end
-
-    it 'will reference the instance variable' do
-      puts "@active = #{@active}"
-      expect(@active).to eq 'testing'
-    end
-  end
-end
+require 'specify'
 ```
 
-Now consider how this can work with Specify. You will have a "steps" block. Within that, all examples run in order of specification. State is preserved between examples within the "steps" block. If any example inside the "steps" block fails, all remaining steps will be marked as pending and thus skipped.
+Then you simply run your `rspec` command as normal against your test suite.
 
-```ruby
-context 'when simple logic tests are applied' do
-  steps do
-    Given 'true is almost certainly not false' do
-      expect(true).to_not be false
-    end
-
-    Given 'true is pretty definitely true' do
-      expect(true).to be true
-    end
-  end
-end
-
-context 'Simple Scenarios' do
-  steps 'with an instance variable' do
-    When 'it establishes an instance variable' do
-      @active = 'testing'
-      expect(@active).to eq 'testing'
-    end
-
-    Then 'that instance variable can be referenced' do
-      puts "@active = #{@active}"
-      expect(@active).to eq 'testing'
-    end
-  end
-end
-```
+## Why Specify?
 
-### Shared Steps
+Specify provides an internal DSL, similar to the [RSpec Story Runner](https://github.com/dchelimsky/rspec-stories), which was the predecessor of the [Cucumber](http://cukes.info/) external DSL provided by [Gherkin](http://cukes.info/gherkin.html).
 
-You can use `shared_steps` to define a block that will be evaluated in the context of an example. The example must use the `include_steps` directive. Here is an example of some shared steps:
+Behavior Driven Development (or even just good Test Driven Development) practices put emphasis on communication. Tools like Cucumber focus on allowing communication via a test description language, structured by Gherkin keywords. However, while the ideas of Gherkin are nice, tools like Cucumber abstract away the nuts and bolts of your tests.
 
-```ruby
-shared_steps 'login' do |email, password|
-  When 'I go to login page' do
-    puts 'Go to the login page'
-  end
-  
-  When 'I put credentials' do
-    puts "Email: #{email}, Password: #{password}"
-  end
-end
-
-shared_steps 'invalid login' do
-  Then 'I should see login error' do
-    puts 'Expect a login error'
-  end
-end
-```
+Abstraction can be a good thing but Cucumber gives you no choice in the matter. It hides code blocks behind a "call by regular expression" invocation mechanism instead of making those code blocks readily available in the acceptance test description.
 
-Here is how those steps can be used:
+Specify lets you write as much logic beside your specifications as you want by leveraging the RSpec ecosystem with the addition of a Gherkin-like syntax.
 
-```ruby
-context 'action' do
-  steps 'User provides wrong email' do
-    include_steps 'login', 'jeff', 'invalid'
-    include_steps 'invalid login'
-  end
-
-  steps 'User provides wrong password' do
-    include_steps 'login', 'jeff@example.com', 'testing'
-    include_steps 'invalid login'
-  end
-end
-```
+The [wiki](https://github.com/jnyman/specify/wiki) contains more information about Specify.
 
 ## Contributing
 
@@ -157,7 +65,7 @@ To work on Specify:
 4. Push the branch. (`git push origin my-new-feature`)
 5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
 
-## Authors
+## Author
 
 * [Jeff Nyman](http://testerstories.com)
 

data/lib/specify/rspec/example_group.rb

@@ -16,33 +16,45 @@ module RSpec
         instance_exec(*args, &shared_block)
       end
 
+      def Test(message, options={}, &block)
+        Action :test, message, options, &block
+      end
+
+      def Step(message, options={}, &block)
+        Action :step, message, options, &block
+      end
+
       def Given(message, options={}, &block)
-        Step :given, message, options, &block
+        Action :given, message, options, &block
       end
 
       def When(message, options={}, &block)
-        Step :when, message, options, &block
+        Action :when, message, options, &block
       end
 
       def Then(message, options={}, &block)
-        Step :then, message, options, &block
+        Action :then, message, options, &block
       end
 
       def And(message, options = {}, &block)
-        Step :and, message, options, &block
+        Action :and, message, options, &block
       end
 
       def But(message, options = {}, &block)
-        Step :but, message, options, &block
+        Action :but, message, options, &block
       end
 
       def _(message, options = {}, &block)
-        Step :_, message, options, &block
+        Action :_, message, options, &block
+      end
+
+      def it(message, options = {}, &block)
+        Action :it, message, options, &block
       end
 
       private
 
-      def Step(type, message, options = {}, &block)
+      def Action(type, message, options = {}, &block)
         ::RSpec.world.reporter.example_step_started(self, type, message, options)
 
         if block_given? && !options[:pending]

data/lib/specify/spec.rb

@@ -3,6 +3,9 @@ module Specify
     def self.included(base)
       base.instance_eval do
         alias :Background :before
+        alias :Setup :before
+        alias :Teardown :after
+        alias :Ability :context
       end
     end
   end
@@ -16,4 +19,8 @@ def self.Ability(*args, &block)
   describe(*args, &block)
 end
 
+def self.Story(*args, &block)
+  describe(*args, &block)
+end
+
 RSpec.configuration.include Specify::Spec

data/lib/specify/version.rb

@@ -1,3 +1,3 @@
 module Specify
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/specify.rb

@@ -1,21 +1,17 @@
-require 'specify/version'
-
-module Specify
-end
-
 require 'rspec/core'
-require 'rspec/core/example_group'
-require 'rspec/core/reporter'
 require 'rspec/core/world'
+require 'rspec/core/reporter'
 require 'rspec/core/formatters'
+require 'rspec/core/example_group'
 require 'rspec/core/formatters/console_codes'
 require 'rspec/core/formatters/documentation_formatter'
 
 require 'specify/spec'
-require 'specify/rspec/example_group'
-require 'specify/rspec/notification'
-require 'specify/rspec/reporter'
+require 'specify/version'
 require 'specify/rspec/world'
+require 'specify/rspec/reporter'
+require 'specify/rspec/notification'
+require 'specify/rspec/example_group'
 require 'specify/rspec/documentation_formatter'
 
 RSpec::Core::ExampleGroup.send :include, RSpec::Specify::ExampleGroup
@@ -34,8 +30,9 @@ if formatter = RSpec.world.reporter.find_registered_formatter(RSpec::Core::Forma
   )
 end
 
-
 RSpec::Core::ExampleGroup.define_example_method :steps, with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :tests, with_steps: true
+
 RSpec::Core::ExampleGroup.define_example_method :Scenario, with_steps: true
 
 require 'specify/rspec/shared_steps'

data/spec/shared_steps_spec.rb

@@ -30,7 +30,7 @@ shared_steps 'pull steps' do
   end
 end
 
-context 'duplicate shared steps' do
+Story 'duplicate shared steps' do
   it 'will raise an error' do
     expect {
       shared_steps 'duplicate' do

data/spec/steps_spec.rb

@@ -27,17 +27,32 @@ Ability 'specify steps' do
         @generic = 'Generic value'
       end
 
+      it 'it' do
+        @it = 'It value'
+      end
+
+      Test 'test' do
+        @test = 'Test value'
+      end
+
+      Step 'step' do
+        @step = 'Step value'
+      end
+
       expect(@context).to eq('Given value')
       expect(@action).to eq('When value')
       expect(@result).to eq('Then value')
       expect(@and).to eq('And value')
       expect(@but).to eq('But value')
       expect(@generic).to eq('Generic value')
+      expect(@it).to eq('It value')
+      expect(@test).to eq('Test value')
+      expect(@step).to eq('Step value')
     end
   end
 
   describe 'Steps without blocks' do
-    steps 'will be pending' do
+    tests 'will be pending' do
       Given 'step without block'
       When  'step without block'
       Then  'step without block'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specify
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n
-  \ Specify 0.3.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  \ Specify 0.4.0 has been installed.\n\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::)\n  "
 rdoc_options: []
 require_paths: