macros4cuke 0.3.12 → 0.3.13

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AsciiComments:
+  Enabled: false
+
+CaseIndentation:
+  Enabled: false
+
+DefWithParentheses:  
+  Enabled: false
+  
+EmptyLines:
+  Enabled: false
+
+  
+StringLiterals:
+  Enabled: false
+
+TrailingWhitespace:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.13 / 2013-05-14
+* [NEW] File `.rubocop.yml` Added.
+* [CHANGE] Many source files changed to please Rubocop.
+
 ## 0.3.12 / 2013-05-14
 * [NEW] File `.ruby-gemset` Added (for RVM users).
 * [NEW] File `.ruby-version` Added (for RVM users).

data/examples/demo/features/step_definitions/use_macro_steps.rb

@@ -1,8 +1,11 @@
+# encoding: utf-8
 # File: use_macro_steps.rb
-# Place a copy of this file in the feature/step_definitions folder of your own Cucumber-based project.
+# Place a copy of this file in the feature/step_definitions folder
+# of your own Cucumber-based project.
 
 # The following require will load the step definitions from Macros4Cuke.
-# This allows feature file authors to use macro steps in their Cucumber scenarios.
+# This allows feature file authors to use macro steps 
+# in their Cucumber scenarios.
 require 'macros4cuke/../macro_steps'
 
 # End of file

data/examples/demo/features/support/env.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8	You should see a paragraph character: §
+# encoding: utf-8
 # File: env.rb
 
 

data/examples/demo/features/support/macro_support.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8	You should see a paragraph character: §
+# encoding: utf-8
 # File: macro_support.rb
 # Purpose: Add the support for macros in Cucumber.
-# This file is meant to be put next to the 'env.rb' file of your Cucumeber project.
+# This file is meant to be put next to the 'env.rb' file
+# of your Cucumeber project.
 
 
 # Macros4Cuke step one: Load modules and classes from the gem.

data/examples/i18n/fr/features/step_definitions/use_macro_steps.rb

@@ -9,18 +9,21 @@ end
 
 
 Quand(/^j(?:e |')\[((?:[^\\\]]|\\.)+)\]$/) do |macro_phrase|
-  invoke_macro(macro_phrase)  # This will call the macro with the given phrase
+  # This will call the macro with the given phrase
+  invoke_macro(macro_phrase)
 end
 
 
 Quand(/^j(?:e |')\[([^\]]+)\]:$/) do |macro_phrase, table_argument|
   # Ensure that the second argument is of the correct type
   unless table_argument.kind_of?(Cucumber::Ast::Table)
-     raise Macros4Cuke::DataTableNotFound, "This step must have a data table as an argument."
+    error_message = "This step must have a data table as an argument."
+    raise Macros4Cuke::DataTableNotFound, error_message
   end
 
   # This will call the macro with the given phrase.
-  # The second argument consists of an array with couples of the kind: [argument name, actual value]
+  # The second argument consists of an array with couples
+  # of the kind: [argument name, actual value]
   invoke_macro(macro_phrase, table_argument.raw)
 end
 

data/examples/i18n/fr/features/support/macro_support.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8	You should see a paragraph character: §
 # File: macro_support.rb
 # Purpose: Add the support for macros in Cucumber.
-# This file is meant to be put next to the 'env.rb' file of your Cucumeber project.
+# This file is meant to be put next to the 'env.rb' file
+# of your Cucumeber project.
 
 
 # Macros4Cuke step one: Load modules and classes from the gem.

data/features/step_definitions/demo_steps.rb

@@ -1,17 +1,18 @@
+# encoding: utf-8
 # File: demo_steps.rb
 # A few step definitions for demo and testing purpose.
 
 When(/^I landed in the homepage$/) do
-  trace_steps << %Q|Invoked step: ... I landed in the homepage|
+  trace_steps << 'Invoked step: ... I landed in the homepage'
 end
 
 When(/^I click "([^"]*)"$/) do |element|
-  trace_steps << %Q|Invoked step: ... I click "#{element}"|
+  trace_steps << "Invoked step: ... I click \"#{element}\""
 end
 
 
 When(/^I fill in "(.*?)" with "(.*?)"$/) do |element, text|
-  trace_steps << %Q|Invoked step: ... I fill in "#{element}" with "#{text}"|
+  trace_steps << "Invoked step: ... I fill in \"#{element}\" with \"#{text}\""
 end
 
 

data/features/step_definitions/use_macro_steps.rb

@@ -1,8 +1,11 @@
+# encoding: utf-8
 # File: use_macro_steps.rb
-# Place a copy of this file in the feature/step_definitions folder of your own Cucumber-based project.
+# Place a copy of this file in the feature/step_definitions folder
+# of your own Cucumber-based project.
 
 # The following require will load the step definitions from Macros4Cuke.
-# This allows feature file authors to use macro steps in their Cucumber scenarios.
+# This allows feature file authors to use macro steps 
+# in their Cucumber scenarios.
 require 'macros4cuke/../macro_steps'
 
 # End of file

data/features/support/env.rb

@@ -1,11 +1,13 @@
 # encoding: utf-8	You should see a paragraph character: §
 # File: env.rb
-# Purpose: Allow Cucumber to load the sample application configuration and hooks.
-# It also demonstrate what to do in your env.rb file to use the Macros4Cuke gem.
+# Purpose: Allow Cucumber to load the sample application configuration
+# and hooks.
+# It also demonstrate what to do in your env.rb file 
+# to use the Macros4Cuke gem.
 
 begin
   require 'simplecov'
-rescue LoadError
+rescue LoadError => exc
   # Gobble silently the exception if simplecov isn't installed.
 end
 

data/features/support/macro_support.rb

@@ -1,7 +1,8 @@
-# encoding: utf-8	You should see a paragraph character: §
+# encoding: utf-8
 # File: macro_support.rb
 # Purpose: Add the support for macros in Cucumber.
-# This file is meant to be put next to the 'env.rb' file of your Cucumeber project.
+# This file is meant to be put next to the 'env.rb' file 
+# of your Cucumeber project.
 
 
 # Macros4Cuke step one: Load modules and classes from the gem.

data/lib/macros4cuke/constants.rb

@@ -1,24 +1,27 @@
+# encoding: utf-8
 # File: constants.rb
 # Purpose: definition of Macros4Cuke constants.
 
 module Macros4Cuke # Module used as a namespace
-	# The version number of the gem.
-	Version = '0.3.12'
+  # The version number of the gem.
+  Version = '0.3.13'
 
   # Brief description of the gem.
   Description = "Macros for Cucumber"
 
-	# Constant Macros4Cuke::RootDir contains the absolute path of Rodent's root directory. Note: it also ends with a slash character.
-	unless defined?(RootDir)
-    # The initialisation of constant RootDir is guarded in order to avoid multiple initialisation (not allowed for constants)
+  # Constant Macros4Cuke::RootDir contains the absolute path of Rodent's
+  # root directory. Note: it also ends with a slash character.
+  unless defined?(RootDir)
+  # The initialisation of constant RootDir is guarded in order 
+  # to avoid multiple initialisation (not allowed for constants)
 
     # The root folder of Macros4Cuke.
-		RootDir = begin
+    RootDir = begin
       require 'pathname'	# Load Pathname class from standard library
       rootdir = Pathname(__FILE__).dirname.parent.parent.expand_path()
       rootdir.to_s() + '/'	# Append trailing slash character to it
     end
-	end
+  end
 end # module
 
 # End of file

data/lib/macros4cuke/macro-collection.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # File: macro-collection.rb
 # Purpose: Implementation of the MacroCollection class.
 
@@ -7,8 +8,9 @@ require_relative "macro-step"
 module Macros4Cuke # Module used as a namespace
 
 # Represents a container of macros.  
-# It gathers all the macros encountered by Cucumber while "executing" the feature files.
-# @note This is a singleton class (i.e. there is only one macro collection object).
+# It gathers all the macros encountered by Cucumber while "executing"
+# the feature files.
+# @note This is a singleton class: there is only one macro collection object.
 class MacroCollection
   include Singleton # Use the Singleton design pattern.
 
@@ -19,9 +21,11 @@ class MacroCollection
 public
   # Add a new macro.
   # Pre-condition: there is no existing macro with the same key.
-  # @param aPhrase [String] The text that is enclosed between the square brackets.
+  # @param aPhrase [String] The text that is enclosed between 
+  # the square brackets.
   # @param aTemplate [String] A text that consists of a sequence of sub-steps.
-  # @param useTable [boolean] A flag indicating whether a table should be used to pass actual values.
+  # @param useTable [boolean] A flag indicating whether a table should be 
+  # used to pass actual values.
   def add_macro(aPhrase, aTemplate, useTable)
     new_macro = MacroStep.new(aPhrase, aTemplate, useTable)
     
@@ -38,7 +42,8 @@ public
   # and (optionally) given a table of values.
   # Return the rendered steps as a text.
   # @param aPhrase [String] an instance of the macro phrase.
-  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value]. 
+  # @param rawData [Array or nil] An Array with coupples of the form:
+  # [macro argument name, a value]. 
   #   Multiple rows with same argument name are acceptable.
   # @return [String]
   def render_steps(aPhrase, rawData = nil)
@@ -52,7 +57,8 @@ public
 
 
   # Clear/remove all macro definitions from the collection.
-  # Post-condition: we are back to the same situation as no macro was ever defined.
+  # Post-condition: we are back to the same situation as 
+  # no macro was ever defined.
   def clear()
     macro_steps.clear()
   end
@@ -67,7 +73,8 @@ public
 private
   # Retrieve the macro, given a phrase.
   def find_macro(aMacroPhrase, useTable)
-    return macro_steps[MacroStep::macro_key(aMacroPhrase, useTable, :invokation)]
+    key = MacroStep.macro_key(aMacroPhrase, useTable, :invokation)
+    return macro_steps[key]
   end
 
 end # class

data/lib/macros4cuke/macro-step-support.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # File: macro-step-support.rb
 
 require_relative "exceptions"
@@ -10,28 +11,35 @@ module Macros4Cuke # Module used as a namespace
 #   
 #   require 'macros4cuke'  
 #   ...  
-#   World(Macros4Cuke::MacroStepSupport) # Extend the world object with this module.
+#   # Extend the world object with this module.
+#   World(Macros4Cuke::MacroStepSupport) 
 #    
 module MacroStepSupport
 public
 
   # Add a new macro.
   # Pre-condition: there is no existing macro with the same key.
-  # @param aPhrase [String] The text that is enclosed between the square brackets [...].
-  # @param aTemplate [String] The text template that consists of a sequence of sub-steps.
-  # @param useTable [boolean] A flag that indicates whether a table should be used to pass actual values.
+  # @param aPhrase [String] The text that is enclosed between 
+  # the square brackets [...].
+  # @param aTemplate [String] The text template that consists of a sequence
+  # of sub-steps.
+  # @param useTable [boolean] A flag that indicates whether a table should be
+  # used to pass actual values.
   def add_macro(aPhrase, aTemplate, useTable)
-    MacroCollection::instance.add_macro(aPhrase, aTemplate, useTable)
+    MacroCollection.instance.add_macro(aPhrase, aTemplate, useTable)
   end
 
 
   # Invoke a macro with given phrase and (optionally) a table of values
-  # @param aPhraseInstance [String] an instance of the macro phrase. That is, the text between [...] and with zero or more actual values.
-  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value].
+  # @param aPhraseInstance [String] an instance of the macro phrase. 
+  # That is, the text between [...] and with zero or more actual values.
+  # @param rawData [Array or nil] An Array with coupples of the form: 
+  # [macro argument name, a value].
   # Multiple rows with same argument name are acceptable.  
   def invoke_macro(aPhraseInstance, rawData = nil)
     # Generate a text rendition of the step to be executed.
-    rendered_steps = MacroCollection::instance.render_steps(aPhraseInstance, rawData)
+    collection = MacroCollection.instance()
+    rendered_steps = collection.render_steps(aPhraseInstance, rawData)
     
     # Let Cucumber execute the sub-steps
     steps(rendered_steps)
@@ -39,9 +47,10 @@ public
 
 
   # Clear (remove) all the macro-step definitions.
-  # After this, we are in the same situation when no macro-step was ever defined.
+  # After this, we are in the same situation when no macro-step 
+  # was ever defined.
   def clear_macros()
-    MacroCollection::instance.clear()
+    MacroCollection.instance.clear()
   end
 
 end # module

data/lib/macros4cuke/macro-step.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # File: macro-step.rb
 # Purpose: Implementation of the MacroStep class.
 
@@ -99,7 +100,8 @@ class MacroStep
   # Render the steps from the template, given the values
   # taken by the parameters
   # @param aPhrase [String] an instance of the macro phrase.
-  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value].
+  # @param rawData [Array or nil] An Array with coupples of the form: 
+  # [macro argument name, a value].
   #   Multiple rows with same argument name are acceptable.
   def expand(aPhrase, rawData)
     params = validate_params(aPhrase, rawData)
@@ -109,7 +111,8 @@ class MacroStep
 private
   # Build a Hash from the given raw data.
   # @param aPhrase [String] an instance of the macro phrase.
-  # @param rawData [Array or nil] An Array with coupples of the form: [macro argument name, a value].
+  # @param rawData [Array or nil] An Array with coupples of the form: 
+  # [macro argument name, a value].
   # Multiple rows with same argument name are acceptable.
   def validate_params(aPhrase, rawData)
     macro_parameters = {}
@@ -169,28 +172,35 @@ private
   end
   
   # Return the substeps text after some transformation
-  # [theSubstepsSource] The source text of the steps to be expanded upon macro invokation.
+  # [theSubstepsSource] The source text of the steps 
+  # to be expanded upon macro invokation.
   def preprocess(theSubstepsSource)
     # Split text into lines
     lines = theSubstepsSource.split(/\r\n?|\n/)
     
-    # Reject comment lines. This necessary because Cucumber::RbSupport::RbWorld#steps complains when it sees a comment.
+    # Reject comment lines. This is necessary because
+    # Cucumber::RbSupport::RbWorld#steps complains when it sees a comment.
     processed = lines.reject { |a_line| a_line =~ /\s*#/ }
     
     return processed.join("\n")
   end
   
-  # Check for inconsistencies between the argument names in the phrase and the substeps part.
+  # Check for inconsistencies between the argument names 
+  # in the phrase and the substeps part.
   def validate_phrase_args(thePhraseArgs, substepsVars)
     # Error when the phrase names an argument that never occurs in the substeps
     thePhraseArgs.each do |phrase_arg|
-      raise UselessPhraseArgument.new(phrase_arg) unless substepsVars.include? phrase_arg
-    end
-    
-    # Error when a substep has an argument that never appears in the phrase and the macro-step does not use data table.
+      unless substepsVars.include? phrase_arg
+        raise UselessPhraseArgument.new(phrase_arg)
+      end
+    end 
+    # Error when a substep has an argument that never appears in the phrase 
+    # and the macro-step does not use data table.
     unless use_table?
       substepsVars.each do |substep_arg|
-        raise UnreachableSubstepArgument.new(substep_arg) unless thePhraseArgs.include? substep_arg
+        unless thePhraseArgs.include? substep_arg
+          raise UnreachableSubstepArgument.new(substep_arg)
+        end
       end      
     end
   
@@ -198,7 +208,8 @@ private
   end
   
   
-  # Return true, if the macro-step requires a data table to pass actual values of the arguments.
+  # Return true, if the macro-step requires a data table 
+  # to pass actual values of the arguments.
   def use_table?()
     return key =~ /_T$/
   end

data/lib/macros4cuke/templating/engine.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # File: engine.rb
 # Purpose: Implementation of the MacroStep class.
 

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 # File: spec_helper.rb
 # Purpose: utility file that is loaded by all our RSpec files
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macros4cuke
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -81,6 +81,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .rubocop.yml
 - .rspec
 - .ruby-gemset
 - .ruby-version