proverbs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e9a8eac26fbc73b47d7eeef6f7eeec9dad5c276
-  data.tar.gz: ee01be7d32988cf29517920342ccf3d67d3226a8
+  metadata.gz: b993f96f749a9378b7b3e6af864002b4c6aa5f10
+  data.tar.gz: 2dbca7a6c81f52a8f30c4b0b69bf7039659a8bfe
 SHA512:
-  metadata.gz: 7b34b3b3212d64609d476cc9a675e8d4fd2777cb068e06ccc35a6d02fd8734d0d4691b983890f2e6938b9aa844c3aa7f1def128517b863a3bf06236826dae547
-  data.tar.gz: 9ec480382465b2da380005ec0ed9b6032e11d7caad4a193c5faba295dd424df2a7948451fd94fb5c7c1e82f23171c1223a864b15fb8214466fe12648020a4f37
+  metadata.gz: 8f2eda0cccd87f5d2de1d09391e5cea43122730d4776c0118e6a71e57c439c3afefde4a8ab1faeefea3d594372b68a98cee14fc562e3694ecf42089a6a85842c
+  data.tar.gz: 5b66f27525a208377f014e5671ec82c0e6454b7b613962caf89d9336d5f96d7bf7aa1aafb4afd46c4aa88fc211706f6226227370ace8efc16da00cd9e206842c

data/.hound.yml

@@ -67,6 +67,12 @@ Metrics/ParameterLists:
 Metrics/LineLength:
   Enabled: false
 
+# Changing this due to how Proverbs ties in with RSpec and my
+# desire not to break apart functionality that does in fact
+# belong together.
+Metrics/AbcSize:
+  Max: 22
+
 # This is necessary in order to allow the method names to have
 # uppercase, in order to match Gherkin.
 Style/MethodName:

data/README.md

@@ -1,11 +1,24 @@
 # Proverbs
 
+[![Gem Version](https://badge.fury.io/rb/proverbs.svg)](http://badge.fury.io/rb/proverbs)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/data_builder/blob/master/LICENSE.txt)
+
+[![Dependency Status](https://gemnasium.com/jeffnyman/proverbs.png)](https://gemnasium.com/jeffnyman/proverbs)
+
 > _Let not mercy and truth forsake thee: bind them about thy neck;
 > write them upon the table of thine heart._
 >
 >     **Proverbs 3:3**
 
+A proverb is basically a simple and concrete saying. The idea is that it expresses a truth based on common sense or experience. Here I'm simply extending that idea to apply to how tools like RSpec use simple, concrete sayings -- in a particular context -- to express a truth. The "truth" in this case is the observable of a test.
+
+Proverbs provides a very thin wrapper around RSpec that provides for more syntax possibilities and thus allows different modes of expression.
 
+More specifically, Proverbs 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). A goal of many of these tools is to put an emphasis on communication and they do so by making it somewhat easy to encode that communication as expressions. Tools like Cucumber focus on allowing communication via a description language that is structured by Gherkin keywords.
+
+However, while the ideas behind Gherkin are viable, tools like Cucumber abstract away the nuts and bolts of your tests. 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 test description.
+
+Proverbs 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. Beyond that, the syntax is not just limited to Gherkin.
 
 ## Installation
 
@@ -31,7 +44,13 @@ You can also install Tapestry just as you would any other gem:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use Proverbs you simply have to require it within your `spec_helper` file:
+
+```ruby
+require 'proverbs'
+```
+
+You can then use the DSL that Proverbs provides to structure your tests. Once you've done that, then you simply run your `rspec` command as normal against your test suite.
 
 ## Development
 
@@ -55,6 +74,17 @@ To contribute to Proverbs:
 
 * [Jeff Nyman](http://testerstories.com)
 
+## Credits
+
+Proverbs has been inspired by the following projects:
+
+* [maniok_bdd](https://github.com/21croissants/maniok_bdd)
+* [rspec-gherkin](https://github.com/sheerun/rspec-gherkin)
+* [rspec example steps](https://github.com/railsware/rspec-example_steps)
+* [rspec-steps](https://github.com/LRDesign/rspec-steps)
+* [rspec-given](https://github.com/jimweirich/rspec-given)
+* [XSpec](https://github.com/xaviershay/xspec)
+
 ## License
 
 Proverbs is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.

data/lib/proverbs.rb

@@ -7,6 +7,7 @@ require "rspec/core/formatters/console_codes"
 require "rspec/core/formatters/documentation_formatter"
 
 require "proverbs/version"
+require "proverbs/contexts"
 require "proverbs/rspec/world"
 require "proverbs/rspec/reporter"
 require "proverbs/rspec/notification"
@@ -19,19 +20,25 @@ RSpec::Core::World.send        :include, RSpec::Proverbs::World
 
 RSpec::Core::Formatters::DocumentationFormatter.send :include, RSpec::Proverbs::DocumentationFormatter
 
-# This one is from rspec-examples
-## RSpec::Core::ExampleGroup.define_example_method :Steps, with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :Scenario,  with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :Behavior,  with_steps: true
 
-RSpec::Core::ExampleGroup.define_example_method :Scenario, with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :steps, with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :rules, with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :tests, with_steps: true
+RSpec::Core::ExampleGroup.define_example_method :facts, with_steps: true
 
 formatter = RSpec.world.reporter.find_registered_formatter(RSpec::Core::Formatters::DocumentationFormatter)
-RSpec.world.reporter.register_listener(
-  formatter,
-  :example_started,
-  :example_step_passed,
-  :example_step_pending,
-  :example_step_failed
-) if formatter
+
+if formatter
+  RSpec.world.reporter.register_listener(
+    formatter,
+    :example_started,
+    :example_step_passed,
+    :example_step_pending,
+    :example_step_failed
+  )
+end
 
 require "proverbs/rspec/shared_steps"
 include RSpec::Proverbs::SharedSteps

data/lib/proverbs/contexts.rb

@@ -0,0 +1,39 @@
+module Proverbs
+  module Contexts
+    def self.included(caller)
+      caller.instance_eval do
+        alias :Background :before
+        alias :Setup      :before
+        alias :Teardown   :after
+
+        alias :Feature   :context
+        alias :Ability   :context
+        alias :Story     :context
+        alias :Workflow  :context
+        alias :Component :context
+      end
+    end
+  end
+end
+
+def self.Feature(*args, &block)
+  describe(*args, &block)
+end
+
+def self.Ability(*args, &block)
+  describe(*args, &block)
+end
+
+def self.Story(*args, &block)
+  describe(*args, &block)
+end
+
+def self.Component(*args, &block)
+  describe(*args, &block)
+end
+
+def self.Workflow(*args, &block)
+  describe(*args, &block)
+end
+
+RSpec.configuration.include Proverbs::Contexts

data/lib/proverbs/rspec/documentation_formatter.rb

@@ -45,11 +45,10 @@ module RSpec
           full_message = "#{current_indentation}  #{keyword.capitalize} #{notification.message}" unless no_keyword_display.include?(keyword)
           full_message = "#{current_indentation}  #{notification.message}" if no_keyword_display.include?(keyword)
 
-          if notification.options[:pending] && notification.options[:pending] != true
-            full_message << " (PENDING: #{notification.options[:pending]})"
-          else
-            full_message << ' (PENDING)'
-          end
+          pending_check = notification.options[:pending] && notification.options[:pending]
+
+          full_message << " (PENDING: #{notification.options[:pending]})" unless pending_check
+          full_message << ' (PENDING)' if pending_check
 
           output.puts Core::Formatters::ConsoleCodes.wrap(full_message, :pending)
         end

data/lib/proverbs/rspec/example_group.rb

@@ -35,6 +35,34 @@ module RSpec
         action :but, message, options, &block
       end
 
+      def rule(message, options = {}, &block)
+        action :rule, message, options, &block
+      end
+
+      def fact(message, options = {}, &block)
+        action :fact, message, options, &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 it(message, options = {}, &block)
+        action :it, message, options, &block
+      end
+
+      def specify(message, options = {}, &block)
+        action :specify, message, options, &block
+      end
+
+      def example(message, options = {}, &block)
+        action :example, message, options, &block
+      end
+
       private
 
       def action(type, message, options = {}, &_block)
@@ -44,7 +72,7 @@ module RSpec
         if block_given? && !options[:pending]
           begin
             yield
-          rescue Exception => e
+          rescue StandardError => e
             ::RSpec.world.reporter.example_step_failed(self, type, message, options)
             raise e
           end

data/lib/proverbs/version.rb

@@ -1,3 +1,3 @@
 module Proverbs
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proverbs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-25 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,6 +120,7 @@ files:
 - bin/console
 - bin/setup
 - lib/proverbs.rb
+- lib/proverbs/contexts.rb
 - lib/proverbs/rspec/documentation_formatter.rb
 - lib/proverbs/rspec/example_group.rb
 - lib/proverbs/rspec/notification.rb
@@ -133,7 +134,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ Proverbs 0.1.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  \ Proverbs 0.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::)\n  "
 rdoc_options: []
 require_paths: