cukedep 0.0.8 → 0.1.03

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTdmNmY0Y2RkMTQxYjk5NmY2OGU2ZGIzMWVkNWQ0MmQ3MTFjNTk5OA==
+    NTMzODc5ODIyYzYyNzk4YmIxMzA0ODU3MzNkZWUxYTRkYTcwNDgxZA==
   data.tar.gz: !binary |-
-    NjMxMWRiMmZiOWEwYjAwMmFiZWRlYTVlZDczMTU4OThkMjM1MTE2ZA==
+    YTE0OTg5NTlhNTI1NGFiODJlYTI0NzgyN2U1N2IyZGUzZjJmZDRhYQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTExMGMwMzliMTA0NGU2MGU2NTdhMjNlYWQxYjg1YjJlN2NlMDBmYWZiOWZh
-    Yzc2MGU2M2I0ZjkwOWJjZGFlZGJiMmRhNTgzMWU5N2RiNWQwMmUwN2EzYzUy
-    ODUwOGFlZjlmOWVjYjQ4YzZlMTkzMGUwZTE1OWFlNzY3NDAzMzQ=
+    YWIwY2NlODYwMDE3NzRiNWRmZTE4NjUyZTc0NzkwYmY2MjdhMTU5ZWFiMmQx
+    ZDY5ZjkwMGRiNGFlMTk0MjNmY2IyN2YyMzBiY2UwZTFkNmQ2NmRjYTU0N2Ni
+    NGY1MjZmZjZiYjQzYzBjMWY3YjViMTZkYmViNTBhZWFlOGEwZTc=
   data.tar.gz: !binary |-
-    YzU1MDgyZjk5ZGM3OGE4NTMxNDMwYTk5MWQyNGRmZDY1MGQwMWIyMTI0YmU0
-    YTkxZWYzMTE0N2I0NDVkYjkzMDJjZjhiOTRlMGNmZDJkZmE2NjQxMDRmNWMw
-    MjM4NGJlZDQ4YmYwZWJkMzhkZDkzOWE5OWY1Mjk0NjI2NDgxNmM=
+    YmU1Zjg1MDA2OTdmNzg3ZDZiN2RmMWRiM2YwZTgxNTNmZGViNDJlMWY2MDZh
+    NjE1ZTNjZmJlNjBhOGJhYmMyNGEyODNiMzdmYTY2MTlmODhiZmU2ZGM1ZTlm
+    NWQwMmI4YzJiMjAwMjc1YzFiMjljMDRhZDA0YmM4MzIzNWQ4NWE=

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+### 0.1.03 / 2013-11-28
+* [FIX] Failing execution of generated Rake file in Travis CI. Cause: Rake template always referenced class in gem while it should reference development code while self-testing.
+* [FIX] Added three missing test data files in the committed version.
+
+### 0.1.02 / 2013-11-27
+* [FIX] Failing test again in `file-action_spec.rb` file. Cause: Commit to GitHub doesn't copy empty dir!. Added directory creation code.
+
+### 0.1.01 / 2013-11-27
+* [FIX] Failing test in `file-action_spec.rb` file. Cause: Commit to GitHub doesn't copy empty dir!. Added directory creation code.
+
+### 0.1.00 / 2013-11-27
+* [FEATURE] Customized file actions (save, delete, copy) associated with invocation event
+* [FEATURE] Hooks for further invocation event customization.
+* [NEW] `Cukedep::CukeRunner` class. Responsibilities: -Invokes Cucumber, handles the invocation events.
+* [NEW] `Cukedep::Customization` class. Responsibilities: -Loads custom hook code blocks (in `cukedep_hooks.rb`)
+* [NEW] `Cukedep::FileAction` class hierarchy. Responsibilities: specify the actions to perform before/after Cucumber invocation(s).
+* [NEW] `Cukedep::HookDSL` module. Used to define a DSL (Domain Specific Language)
+* [NEW] `Cukedep::Sandbox`. Responsibilities: Gives the context in which hook code block are executed.
+* [NEW] `Cukedep::Config` class: new methods: `load_cfg`, `write`, `file_action_attrs`
+* [CHANGE] Method `Application#run!`: Using new interface of `Cukedep::Config` class.
+
+
+### 0.0.9 / 2013-11-04 [unreleased]
+* [CHANGE] For uniformity reasons, method `Application#start!` renamed to `Application#run!`
+* [FIX] Method `Application#run!`: incorrect string interpolation in error message.
+
 ### 0.0.8 / 2013-10-31
 * [Fix] After adding a non-ASCII in a sample feature, Gherkin raised an encoding incompatibility error. Fixed
 * [CHANGE] Added a new field 'feature_encoding' in Config object to store the encoding of feature files (default = 'UTF-8')

data/bin/cukedep

@@ -10,6 +10,6 @@ require 'cukedep' # Load the Cukedep::Application class
 
 # The application's entry point
 app = Cukedep::Application.new
-app.start!(ARGV)
+app.run!(ARGV)
 
 # End of file

data/lib/cukedep/application.rb

@@ -1,6 +1,5 @@
 # File: application.rb
 
-require 'yaml'
 
 require_relative 'cli/cmd-line'
 require_relative 'config'
@@ -16,17 +15,17 @@ class Application
 public
 
   # Entry point for the application object.
-  def start!(theCmdLineArgs)
+  def run!(theCmdLineArgs)
     options = options_from(theCmdLineArgs)
     create_default_cfg if options[:setup]
-    config = load_cfg
+    config = Config.load_cfg(Cukedep::YMLFilename)
 
     # Complain if no project dir is specified
     if config.proj_dir.nil? || config.proj_dir.empty?
       if options[:project]
         @proj_dir = options[:project]
       else
-        msg_p1 = "No project dir specified via 'Cukedep::YMLFilename'"
+        msg_p1 = "No project dir specified in '#{Cukedep::YMLFilename}'"
         msg_p2 = ' nor via --project option.'
         fail(StandardError, msg_p1 + msg_p2)
       end
@@ -62,10 +61,11 @@ protected
       answer = $stdin.gets
       exit if answer =~ /^\s*[Nn]\s*$/
     end
-    File.open(Cukedep::YMLFilename, 'w') { |f| YAML.dump(Config.default, f) }
+    Config.default.write(Cukedep::YMLFilename)
+
     exit
   end
-
+=begin
   # Read the .cukedep.yml file in the current working directory
   def load_cfg()
     if File.exist?(Cukedep::YMLFilename)
@@ -74,7 +74,7 @@ protected
       Config.default
     end
   end
-
+=end
   # Parse the feature files (with the specified external encoding)
   def parse_features(external_encoding)
     # Create a Gherkin listener

data/lib/cukedep/config.rb

@@ -1,34 +1,91 @@
 # File: config.rb
 
+require 'yaml'
+require_relative 'file-action'
+
 module Cukedep # Module used as a namespace
 
 FileMetaData = Struct.new(:name)
 
 Config = Struct.new(
-  :feature_encoding, # The encoding of feature files
+  :feature_encoding, # The character encoding of feature files
   :proj_dir,    # The directory of the cucumber project
   :feature2id,  # Meta-data about the feature => feature id report
   :id2feature,  # Meta-data about the feature id => feature report
   :graph_file,  # Meta-data about the dependency graph file
   :rake_file,   # Name of the output rake file
-  :cucumber_args # Command-line syntax to use for the cucumber application
+  :cucumber_args, # Command-line syntax to use for the cucumber application
+  # File actions triggered at Cucumber invocation events
+  :before_all_f_actions,
+  :before_each_f_actions,
+  :after_each_f_actions,
+  :after_all_f_actions
 )
 
 # Re-open the class for further customisation
-  
+
 # Configuration object for the Cukedep application.
 class Config
   # Factory method. Build a config object with default settings.
   def self.default()
-    Config.new(
+    instance = Config.new(
       'UTF-8',
-      nil, 
-      FileMetaData.new('feature2id.csv'), 
-      FileMetaData.new('feature2id.csv'), 
+      nil,
+      FileMetaData.new('feature2id.csv'),
+      FileMetaData.new('feature2id.csv'),
       FileMetaData.new('dependencies.dot'),
       'cukedep.rake',
       []
     )
+
+    file_action_attrs.each do |attr|
+      instance[attr] = empty_action_triplet
+    end
+
+    return instance
+  end
+  
+  
+  # Read the YAML file with specified name from the current working directory.
+  # If that file does not exist, then return an instance with default values.
+  def self.load_cfg(filename)
+    # TODO: validation
+    instance = File.exist?(filename) ? YAML.load_file(filename) : self.default
+    
+    return instance
+  end
+
+  
+  # Save the Config object to a YAML file.
+  def write(filename)
+    File.open(filename, 'w') { |f| YAML.dump(self, f) }
+  end
+
+
+  private
+
+  # Purpose: get the list of attributes referencing
+  # a file action triplet.
+  def self.file_action_attrs()
+    return [
+      :before_all_f_actions,
+      :before_each_f_actions,
+      :after_each_f_actions,
+      :after_all_f_actions
+    ]
+  end
+
+
+  # Return Hash config for a no-op action triplet.
+  def self.empty_action_triplet()
+    {
+      save_patterns: [],
+      save_subdir: '',
+      delete_patterns: [],
+      delete_subdir: '',
+      copy_patterns: [],
+      copy_subdir: ''
+    }
   end
 
 end # class

data/lib/cukedep/constants.rb

@@ -3,7 +3,7 @@
 
 module Cukedep # Module used as a namespace
   # The version number of the gem.
-  Version = '0.0.8'
+  Version = '0.1.03'
 
   # Brief description of the gem.
   Description = 'Manage dependencies between Cucumber feature files'
@@ -23,6 +23,10 @@ module Cukedep # Module used as a namespace
 
     # The file name for the user's settings
     YMLFilename = '.cukedep.yml'
+    
+    # The file name for the custom block codes associated
+    # with before/after events.
+    HookFilename = 'cukedep_hooks.rb'
   end
 end # module
 

data/lib/cukedep/cuke-runner.rb

@@ -0,0 +1,202 @@
+# File: cuke-runner.rb
+
+require 'pathname'
+require 'rake'
+
+# Run Cucumber via specialized Rake task
+require 'cucumber/rake/task'
+
+require_relative 'file-action'
+require_relative 'customization'
+
+# UGLY workaround for bug in Cucumber's rake task
+if Gem::VERSION[0].to_i >= 2 && Cucumber::VERSION <= '1.3.2'
+  # Monkey-patch a buggy method
+  class Cucumber::Rake::Task::ForkedCucumberRunner
+    def gem_available?(gemname)
+      if Gem::VERSION[0].to_i >= 2
+        gem_available_new_rubygems?(gemname)
+      else
+        gem_available_old_rubygems?(gemname)
+      end
+    end
+  end # class
+end
+
+
+
+module Cukedep # This module is used as a namespace
+
+# Purpose: to launch Cucumber in the appropriate directory
+# and pass it command-line arguments.
+# Responsibilities:
+# Know how to invoke Cucumber
+# Know the base directory
+# Know the project's root dir
+class CukeRunner
+  # The current state of the runner.
+  attr_reader(:state)
+  
+  # The absolute path of the root's project directory
+  attr_reader(:proj_dir)
+  attr_reader(:base_dir)
+  attr_reader(:config)
+  attr_reader(:handlers)
+
+  attr(:cucumber_opts, true)
+
+  # Constructor
+  def initialize(baseDir, projectDir, aConfig)
+    @base_dir = baseDir
+    @proj_dir = validated_proj_dir(projectDir)
+    @config = aConfig
+    @handlers = Customization.new.build_handlers(baseDir)
+    
+    @state = :Initialized
+  end
+
+  # Launch Cucumber in the project directory.
+  def invoke()
+    options = [] # TODO: retrieve Cucumber options
+    orig_dir = Dir.getwd()
+    Dir.chdir(proj_dir)
+
+    begin
+      cuke_task = Cucumber::Rake::Task.new do |t|
+        t.cucumber_opts = options
+      end
+
+      cuke_task.runner.run()
+    rescue SystemExit => exc  # Cucumber reports a failure.
+      raise StandardError, "Cucumber exited with status #{exc.status}"
+    ensure
+      Dir.chdir(orig_dir)
+    end
+  end
+
+  # Event handler that is triggered
+  # before any other event.
+  # It executes the before all hook first.
+  # Then it executes in the following order:
+  # Built-in save action, Custom save action
+  # Built-in delete action, Custom delete action
+  # Built-in copy action, Custom copy action
+  def before_all()
+    expected_state(:Initialized)
+
+    # Execute before all hook code
+    run_code_block
+    
+    # Execute file actions
+    builtin_actions = ActionTriplet.builtin(:before_all)
+    custom_actions = ActionTriplet.new(config.before_all_f_actions)
+    run_triplets([builtin_actions, custom_actions])
+    @state = :ReadyToRun
+  end
+
+
+  # Event handler that is triggered
+  # after any other event.
+  # It executes first actions in the following order:
+  # Built-in save action, Custom save action
+  # Built-in delete action, Custom delete action
+  # Built-in copy action, Custom copy action
+  # Then it executes the after all hook last.
+  def after_all()
+    expected_state(:ReadyToRun)
+
+    builtin_actions = ActionTriplet.builtin(:after_all)
+    custom_actions = ActionTriplet.new(config.after_all_f_actions)
+    run_triplets([builtin_actions, custom_actions])
+    
+    # Execute before all hook code
+    run_code_block
+    @state = :Complete
+  end
+
+
+  def run!(fileNames)
+    expected_state(:ReadyToRun)
+    before_each(fileNames)
+    invoke
+    after_each
+  end
+
+
+  private
+  def validated_proj_dir(projectDir)
+    path = Pathname.new(projectDir)
+    path = path.expand_path if path.relative?
+    unless path.exist?
+      raise StandardError, "No such project path: '#{path}'"
+    end
+    
+    return path.to_s
+  end
+  
+  def expected_state(aState)
+    unless state == aState
+      msg = "expected state was '#{aState}' instead of '#{state}'."
+      raise StandardError, msg
+    end
+  end
+
+
+  def before_each(fileNames)
+    # Execute before each hook code
+    run_code_block(fileNames)
+
+    builtin_actions = ActionTriplet.builtin(:before_each).dup
+    unless builtin_actions.nil?
+      builtin_actions.copy_action.patterns = fileNames
+    end
+
+    custom_actions = ActionTriplet.new(config.before_each_f_actions)
+    run_triplets([builtin_actions, custom_actions])
+  end
+
+
+  def after_each()
+    builtin_actions = ActionTriplet.builtin(:after_each)
+
+    custom_actions = ActionTriplet.new(config.after_each_f_actions)
+    run_triplets([builtin_actions, custom_actions])
+
+    # Execute after each hook code
+    run_code_block
+  end
+
+
+  def run_triplets(theTriplets)
+    all_triplets = theTriplets.compact # Remove nil elements
+
+    # Do all save actions...
+    all_triplets.each { |t| t.save_action.run!(proj_dir, base_dir) }
+
+    # Do all delete actions...
+    all_triplets.each { |t| t.delete_action.run!(proj_dir) }
+
+    # Do all copy actions...
+    all_triplets.each { |t| t.copy_action.run!(base_dir, proj_dir) }
+  end
+  
+
+  def run_code_block(*args)
+    # Retrieve the name of the parent method.
+    parent_mth = (caller[0].sub(/^(.+):in (.+)$/, "\\2"))[1..-2]
+    kind, scope = parent_mth.split('_')
+    hook_kind = (kind + '_hooks')
+    
+    kode = handlers[hook_kind.to_sym][scope.to_sym]
+    unless kode.nil?
+      safe_args = args.map { |one_arg| one_arg.dup.freeze }
+      kode.call(*safe_args) 
+    end
+  end
+
+
+end # class
+
+end # module
+
+# End of file

data/lib/cukedep/customization.rb

@@ -0,0 +1,35 @@
+# File: customization.rb
+
+require_relative 'constants'
+require_relative 'hook-dsl'
+
+module Cukedep # This module is used as a namespace
+
+
+  class Customization
+
+    # Retrieve before/after handlers from file
+    # Handlers are put in a Hash with keys :before_hooks, :after_hooks.
+    def build_handlers(directory)
+      handlers = nil
+
+      filepath = directory + '/' + Cukedep::HookFilename
+      if File.exist? filepath
+        obj = Object.new
+        obj.extend(HookDSL)
+        hook_source = File.read(filepath)
+        obj.instance_eval(hook_source)
+        handlers =  { 
+          before_hooks: obj.before_hooks,
+          after_hooks: obj.after_hooks
+        }
+      end
+
+      return handlers
+    end
+
+  end # class
+
+end # module
+
+# End of file