macros4cuke 0.4.09 → 0.5.03

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzVhNDZmNmRmNzk0MDExYTMzOGM2NTVhNzA1OGEyOWNkZmNkZmRjYw==
+    OTA1NWJhMjkxZGJhMjA3MTExOTNkOTEyYmYzNWNhYjJkYjkxYTllNA==
   data.tar.gz: !binary |-
-    ZmM2MDc4NzJkODk0YzkyZjVlOTdlZGZlMThjZGQzNTg5ODRmOGE5OA==
+    ODRlMTdiNDAyM2JhMTUwNmU0ZjVmZjcwOTBhYjY3MDA0NDhkMzQwNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZGZkZjkxZGRlMzRiMGNkMGVhOWVlZmFlMWIzZTk0YjcyYTYzY2Y5OTU1YzQw
-    NzFiYWE3Nzg1MDg2MThkYzk3NTQ2ODE2MzYzYzMyNGVkMmY4ZGQ5NDYwNWYx
-    MTJjNzViYzVmMjQwOGY4NTM5Yzk4NWE4NmZjZjM5MDYyMTFhNzE=
+    ODAzYWYyNWYzNGFlOTA2N2NmYzBlYmZkZWIwZWE2NTI2M2YyMmJiNjA2MzQx
+    NzhlMGVhNDg4NzBjOGE3YThkYTRhMTExNjZlNzZlMzA2Y2IxODQ0ZGY5MTIy
+    ZjBiNjhkMWVhYzAxNjU0MGRkNGFiMGMwYWMwNmEwY2IzZTExOTY=
   data.tar.gz: !binary |-
-    ZGFiYjI0NWI3ODdmMTcwMzY5ZmNhM2IwYjY2ZWQ2OTBiMWYyOTFkMjdmNjJk
-    YWRhNWMzZTFkYTY2NjkxYTk2OGZiMzY3YjIwY2JkZDZiNTcyOWNiMGQ5ZGE0
-    ZjQyMDA0MzQwZGNkMWU3YmIzOWEzMzMwYjVhNzZhMzUwOGRmYzQ=
+    ZTY1MTE5MzM3OTQ1MmIyMzg5ZjU4ZTJmYzM5ODM3YzU1MmRkZTRkZGZlNWUy
+    ZjczOGExNTA3NDg3MzY2NWJlYzMxNjE4ZGRiYzY3ZmU2YzA4OGE1OWNjZTA3
+    ZDBkOGI5Y2YwZjZmZmY3MTExMTY2YTdjMjNjYTU2ODBlMWMxMGY=

data/.travis.yml

@@ -8,10 +8,10 @@ rvm:
   - jruby-head
   - rbx
 
-# Workaround issue of jruby-19mode configuration on Travis CI 
+# Workaround issue of jruby-head configuration on Travis CI 
 matrix:
   allow_failures:
-    - rvm: rbx
+    - rvm: jruby-head
 
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 0.5.03 / 2014-04-01
+* [CHANGE] File `README.md`: Updated the installation steps.
+* [CHANGE] Files `macro_support.rb` renamed to `use_macros4cuke.rb`
+
+### 0.5.02 / 2014-03-31
+* [CHANGE] File `.travis.yml`: Allow build failure with Travis' jruby-head (Travis build scripts miss Bundler install)
+
+### 0.5.01 / 2014-03-31
+* [CHANGE] File `macros4cuke`: Removal of command-line option echoing.
+
+### 0.5.00 / 2014-03-31
+* [NEW] Added macros4cuke "executable". The CLI simplifies the installation of macros in Cucumber projects.
+* [NEW] File `cucumber.rb`: require only this file in order to integrate `Macros4Cuke` in your Cucumber project.
+* [CHANGE] File `macros4cuke.gemspec`: Added `bin` and `templates` dirs.
+* [NEW] File `exceptions.rb`: New command-line related exception classes.
+
+
 ### 0.4.09 / 2014-03-13
 * [CHANGE] Updated source files to comply to Rubocop 0.19.
 * [CHANGE] File `.rubocop.yml`: Disabled FileName cop.

data/README.md

@@ -73,39 +73,58 @@ Nicely formatted documentation extracted from these feature files is also availa
 
 ## Setup ##
 ### Pre-requisites ###
+
 Macros4Cuke works with:  
-- MRI Ruby 1.9.x and 2.0.x.  
-- JRuby (was tested with version 1.7.3 and above).
+- MRI Ruby 1.9.x, 2.0.x and 2.1.x.  
+- JRuby (was tested with version 1.7.3 and above),  
+- Rubinius 2.x
+
+Macros4Cuke requires Cucumber.
 
 ### Installation ###
-The macros4cuke gem is fairly standard:  
+The macros4cuke gem installation is fairly standard.  
+If you have a `Gemfile`, add `macros4cuke` to it. Otherwise, install the gem like this:
+ 
 ```bash  
 $[sudo] gem install macros4cuke
 ```
 
-### Configuring up your Cucumber projects ####
-  
-* Step 1: Add support for macros in an existing Cucumber project    
-  
+### Configuring your Cucumber projects ####
+The procedure to add support for macros in an existing Cucumber project
+was simplified since version 0.5.00. 
+ 
+There are two possible ways to do it:  
+- By editing manually a support file; or,  
+- Let Macros4cuke configure your project.   
+ 
+#### Alternative 1: manually add one line in a support file  
+Require the library in one of your ruby files under `features/support` (e.g. `env.rb`):  
+ 
 ```ruby
 # /features/support/env.rb
-# Add the two next lines
-require 'macros4cuke'  
-World(Macros4Cuke::MacroStepSupport)
-```  
-  
-* Step 2: Import the macro-management steps  
-In your `/features/step_definitions/` folder:  
-  - The cleanest is to create a Ruby file (say, 'use\_macro\_steps.rb') with the line:  
-  
-```ruby  
-require 'macros4cuke/../macro_steps'
-```  
-  - Alternatively, you could directly add the require in one of your step definition file.
- 
-  
+# Add the next single line
+require 'macros4cuke/cucumber'  
+``` 
+
 That's it! Now you can start writing macros in your Cucumber project.
 
+#### Alternative 2: let macros4cuke configure your project
+
+Use the following command-line:
+```bash  
+$[sudo] macros4cuke --setup project_path
+```
+
+Where __project_path__ is the location of your Cucumber project.  
+In case the working directory of the shell/command prompt is
+already the directory containing the Cucumber project, then the
+command-line is simply:  
+```bash  
+$[sudo] macros4cuke --setup .
+``` 
+
+Notice that ending dot above means "the current directory".
+
 
 ## Getting started ##
 Working with a macro-step is a two-stages process:  

data/bin/macros4cuke

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# File: macros4cuke
+# The 'executable' of the Macros4Cuke library.
+
+mydir = File.dirname(__FILE__)
+lib_dir = mydir + '/../lib'
+$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'macros4cuke' # Load the Cukedep::Application class	
+
+# The application's entry point
+app = Macros4Cuke::Application.new
+app.run!(ARGV.dup)
+
+# End of file

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

@@ -0,0 +1,12 @@
+# encoding: utf-8	You should see a paragraph character: §
+# File: use_macros4cuke.rb
+# Purpose: Add the support for macros in Cucumber.
+# This file is meant to be put next to the 'env.rb' file
+# of your Cucumber project.
+
+
+# Load modules, classes and step definitions from the macros4cuke gem
+require 'macros4cuke/cucumber'
+
+
+# End of file

data/examples/i18n/fr/features/demo01-fr.feature

@@ -3,6 +3,7 @@ Fonctionnalité: Macro-pas
   Afin d'écrire des scénarios plus facilement
   En tant qu'utilisateur de Cucumber
   Je souhaite pouvoir créer des macro-étapes
+  
 
 Scénario: Définition d'un macro-pas (de scénario)
   Etant donné que je crée le pas "Quand j'[imprime le texte <un_texte>]" qui équivaut à:
@@ -13,6 +14,11 @@ Scénario: Définition d'un macro-pas (de scénario)
   
 Scénario: Utilisation d'un macro-pas (de scénario)
   Quand j'[imprime le texte "Bonjour!"]
+  Alors je m'attends à voir:
+  """
+Bonjour!
+
+  """
   
 Scénario: Définition d'un macro-pas appelant des macro-pas!
   Etant donné que je crée le pas "Quand j'[imprime le texte <un_texte> trois fois]" qui équivaut à:
@@ -24,4 +30,11 @@ Scénario: Définition d'un macro-pas appelant des macro-pas!
   
 Scénario: Utilisation du dernier macro-pas (de scénario)
   Quand j'[imprime le texte "Trois fois!" trois fois]
+  Alors je m'attends à voir:
+  """
+Trois fois!
+Trois fois!
+Trois fois!
+
+  """
   

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

@@ -1,5 +1,6 @@
 # encoding: utf-8
 # Quelques définitions de pas de scénarios Cucumber.
+
 require 'stringio'
 
 Quand(/^j'imprime "(.*?)" à l'écran$/) do |some_text|
@@ -11,4 +12,8 @@ Quand(/^je garde "(.*?)" en mémoire$/) do |some_text|
   @output.puts some_text
 end
 
+Alors(/^je m'attends à voir:$/) do |result|
+  @output.string.should == result
+end
+
 # End of file

data/examples/i18n/fr/features/step_definitions/{use_macro_steps.rb → macro_steps_fr.rb}

@@ -1,5 +1,6 @@
 # encoding: utf-8
-# Définitions de pas de scénarios utilisant Macros4Cuke.
+# "Traduction" en Français des macro-pas de Macros4Cuke
+# Ce sont des définitions de pas faisant directement appel à l'API de Macros4Cuke
 
 
 Etantdonné(/^que je crée le pas "(?:Soit|Quand|Alors) j(?:e |')\[((?:[^\\\]]|\\.)+)\](:?)" qui équivaut à:$/) do |macro_phrase, colon_capture, template|
@@ -17,7 +18,7 @@ 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)
-    error_message = 'This step must have a data table as an argument.'
+    error_message = 'Ce pas doit avoir un tableau comme paramètre.'
     fail(Macros4Cuke::DataTableNotFound, error_message)
   end
 

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

@@ -0,0 +1,12 @@
+# encoding: utf-8	You should see a paragraph character: §
+# File: use_macros4cuke.rb
+# Purpose: Add the support for macros in Cucumber.
+# This file is meant to be put next to the 'env.rb' file
+# of your Cucumber project.
+
+
+# Load modules, classes and step definitions from the macros4cuke gem
+require 'macros4cuke/cucumber'
+
+
+# End of file

data/examples/i18n/nl/cucumber.yml

@@ -0,0 +1,6 @@
+default: --strict -v -b  --format progress features
+html: --strict -v -b  --format html --out result.html features
+usage: --strict -v -b  --format usage --out usage.txt features
+
+
+

data/examples/i18n/nl/features/demo01-nl.feature

@@ -0,0 +1,40 @@
+# language: nl
+Functionaliteit: Macro-stappen
+  Om gemakkelijker scenarios te kunnen schrijven
+  Als Cucumber-gebruiker
+  Wil ik macro-stappen kunnen definieëren en toepassen
+
+Scenario: Definitie van een macro-stap (van een scenario)
+  Gegeven dat ik de stap "Als ik [de tekst <een_tekst> print]" definieër als:
+  """
+    Als ik "<een_tekst>" op het scherm afdruk
+    En ik bewaar "<een_tekst>" in geheugen
+  """
+  
+Scenario: Gebruik van de macro-stap
+  Als ik [de tekst "Hallo" print]
+  Dan verwacht ik te zien:
+  """
+Hallo
+
+  """
+
+  
+Scenario: Definitie van een macro-stap dat macro-stap(pen) gebruikt
+  Gegeven dat ik de stap "Als ik [de tekst <een_tekst> drie keer print]" definieër als:
+  """
+  Als ik [de tekst "<een_tekst>" print]
+  Als ik [de tekst "<een_tekst>" print]
+  Als ik [de tekst "<een_tekst>" print] 
+  """
+  
+Scenario: Gebruik van laatste macro-step
+  Als ik [de tekst "Drie maal!" drie keer print]
+  Dan verwacht ik te zien:
+  """
+Drie maal!
+Drie maal!
+Drie maal!
+
+  """
+  

data/examples/i18n/nl/features/step_definitions/demo_steps.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+# Een paar stappen definities.
+
+require 'stringio'
+
+
+Als(/^ik "(.*?)" op het scherm afdruk$/) do |some_text|
+  $stderr.puts some_text
+end
+
+
+Als(/^ik bewaar "(.*?)" in geheugen$/) do |some_text|
+  @output ||= StringIO.new('')
+  @output.puts some_text
+end
+
+Dan(/^verwacht ik te zien:$/) do |result|
+  @output.string.should == result
+end
+
+# End of file

data/examples/i18n/nl/features/step_definitions/macro_steps_nl.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+# "Vertaling" in het Nederlands van macrostappen van Macros4Cuke
+# Dit zijn stappen definities dat rechstreeks het API van Macros4Cuke gebruiken
+
+
+Gegeven(/^dat ik de stap "(?:Gegeven dat|Als|Dan) ik \[((?:[^\\\]]|\\.)+)\](:?)" definieër als:$/) do |macro_phrase, colon_capture, template|
+  use_table = (colon_capture == ':')
+  add_macro(macro_phrase, template, use_table)
+end
+
+
+Als(/^ik \[((?:[^\\\]]|\\.)+)\]$/) do |macro_phrase|
+  # This will call the macro with the given phrase
+  invoke_macro(macro_phrase)
+end
+
+
+Als(/^ik \[([^\]]+)\]:$/) do |macro_phrase, table_argument|
+  # Ensure that the second argument is of the correct type
+  unless table_argument.kind_of?(Cucumber::Ast::Table)
+    error_message = 'Deze stap vereist een tabel als parameter.'
+    fail(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]
+  invoke_macro(macro_phrase, table_argument.raw)
+end
+
+# End of file

data/examples/i18n/nl/features/support/use_macros4cuke.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8	You should see a paragraph character: §
+# File: use_macros4cuke.rb
+# Purpose: Add the support for macros in Cucumber.
+# This file is meant to be put next to the 'env.rb' file
+# of your Cucumber project.
+
+
+# Load modules, classes and step definitions from the macros4cuke gem
+require 'macros4cuke/cucumber'
+
+
+# End of file

data/features/support/use_macros4cuke.rb

@@ -0,0 +1,11 @@
+# File: use_macros4cuke.rb
+# Purpose: Add the support for macros in a Cucumber project.
+# This file is meant to be put next to the 'env.rb' file 
+# of your Cucumber project.
+
+
+# Load modules, classes and step definitions from the macros4cuke gem
+require 'macros4cuke/cucumber'
+
+
+# End of file

data/lib/macros4cuke.rb

@@ -3,6 +3,7 @@
 # for a Macros4Cuke user.
 
 require_relative './macros4cuke/constants'
+require_relative './macros4cuke/application'
 require_relative './macros4cuke/macro-step-support'
 
 # End of file

data/lib/macros4cuke/application.rb

@@ -0,0 +1,75 @@
+# File: application.rb
+
+require 'erb'
+
+require_relative 'cli/cmd-line'
+
+module Macros4Cuke # Module used as a namespace
+
+# Runner for the Macros4Cuke application.
+class Application
+  attr_reader(:options)
+
+  public
+
+  def initialize()
+    @options = {}
+  end
+
+  # Entry point for the application object.
+  def run!(theCmdLineArgs)
+    @options = options_from(theCmdLineArgs)
+    if options[:setup]
+      options[:setup].each do |a_path|
+        setup_project(a_path)
+      end
+    end
+  end
+
+  protected
+
+  # Retrieve the user-entered command-line options
+  def options_from(theCmdLineArgs)
+    cli = CLI::CmdLine.new
+    cli.parse!(theCmdLineArgs.dup)
+  end
+
+  # Make the Cucumber project at the designated path
+  # ready for macros.
+  # In practice, this is obtained by adding a file
+  # in the /features/support dir.
+  def setup_project(aPath)
+    file_name = 'use_macros4cuke'
+    prefix = aPath.relative? ? './' : ''
+    destination = prefix +  aPath.to_s + '/' + file_name + '.rb'
+
+    begin
+      fail SupportFileExists.new(destination) if File.exist?(destination)
+
+      template_pathname = Macros4Cuke::RootDir + 'templates/use_macros4cuke.erb'
+      template = File.read(template_pathname)
+
+
+      # Create a context for variables used in our templates
+      prog_version = Macros4Cuke::Version
+
+      # Create one template engine instance
+      engine = ERB.new(template)
+
+      # Generate the text representation with given context
+      file_text = engine.result(binding)
+
+      # Write file contents to file in binary mode in order to avoid eol
+      # consisting of CRLF
+      File.open(destination, 'wb') { |theFile| theFile.write(file_text) }
+    rescue Macros4Cuke::CmdLineError => exc
+      $stderr.puts exc.message
+      exit
+    end
+  end
+
+end # class
+
+end # module
+
+# End of file