cukedep 0.1.11 → 0.2.00

data/lib/cukedep/hook-dsl.rb

@@ -1,78 +1,78 @@
-# File: hook-dsl.rb
-
-
-module Cukedep # Module used as a namespace
-# Mix-in module that defines the DSL (Domain-Specific Language)
-# for specifying Cukedep hooks.
-# A hook is a custom code block that is executed when 
-# a pre-defined Cukedep event occurs.
-module HookDSL
-  ValidHookScopes = [:all, :each]
-
-  attr_reader(:before_hooks)
-  attr_reader(:after_hooks)
-
-
-  # This method registers the code block to execute
-  # before a Cucumber invocation.
-  def before_cuke(aScope, &aBlock)
-    kind = :before
-    scope = validated_scope(kind, aScope)
-    register_hook(kind, scope, aBlock) if block_given?
-  end
-
-  # This method registers the code block to execute
-  # before a Cucumber invocation.
-  def after_cuke(aScope, &aBlock)
-    kind = :after
-    scope = validated_scope(kind, aScope)
-    register_hook(kind, scope, aBlock) if block_given?
-  end
-
-=begin
-  # Execute the specific hook.
-  def execute_hook(aKind, aScope)
-    scope = validated_scope(aKind, aScope)
-    case [aKind, scope]
-    when [:before, :all],  [:before, :each], [:after, :each], [:after, :all]
-      handler = handler_for(aKind, scope)
-    else
-      raise StandardError, "Unknown Cukedep hook #{aKind}, #{aScope}"
-    end
-    
-    handler.call unless handler.nil?
-  end
-=end
-
-  private
-  
-  def register_hook(aKind, aScope, aBlock)
-    scope = validated_scope(aKind, aScope)
-
-    ivar = "@#{aKind}_hooks".to_sym
-    instance_variable_set(ivar, {}) if instance_variable_get(ivar).nil?
-    instance_variable_get(ivar)[scope] = aBlock
-  end
-  
-  def validated_scope(aKind, aScope)
-    unless ValidHookScopes.include?(aScope)
-      msg = "Unknown scope '#{aScope}' for #{aKind}_cuke hook."
-      fail StandardError, msg
-    end
-    
-    return aScope
-  end
-  
-  def handler_for(aKind, aScope)
-    if aKind == :before
-      hooks = before_hooks
-    else
-      hooks = after_hooks
-    end
-    
-    handler = hooks.nil? ? nil : hooks.fetch(aScope)
-    return handler
-  end
-end # module
-end # module
-# End of file
+# File: hook-dsl.rb
+
+
+module Cukedep # Module used as a namespace
+# Mix-in module that defines the DSL (Domain-Specific Language)
+# for specifying Cukedep hooks.
+# A hook is a custom code block that is executed when
+# a pre-defined Cukedep event occurs.
+module HookDSL
+  ValidHookScopes = %i[all each].freeze
+
+  attr_reader(:before_hooks)
+  attr_reader(:after_hooks)
+
+
+  # This method registers the code block to execute
+  # before a Cucumber invocation.
+  def before_cuke(aScope, &aBlock)
+    kind = :before
+    scope = validated_scope(kind, aScope)
+    register_hook(kind, scope, aBlock) if block_given?
+  end
+
+  # This method registers the code block to execute
+  # before a Cucumber invocation.
+  def after_cuke(aScope, &aBlock)
+    kind = :after
+    scope = validated_scope(kind, aScope)
+    register_hook(kind, scope, aBlock) if block_given?
+  end
+
+=begin
+  # Execute the specific hook.
+  def execute_hook(aKind, aScope)
+    scope = validated_scope(aKind, aScope)
+    case [aKind, scope]
+    when [:before, :all],  [:before, :each], [:after, :each], [:after, :all]
+      handler = handler_for(aKind, scope)
+    else
+      raise StandardError, "Unknown Cukedep hook #{aKind}, #{aScope}"
+    end
+
+    handler.call unless handler.nil?
+  end
+=end
+
+  private
+
+  def register_hook(aKind, aScope, aBlock)
+    scope = validated_scope(aKind, aScope)
+
+    ivar = "@#{aKind}_hooks".to_sym
+    instance_variable_set(ivar, {}) if instance_variable_get(ivar).nil?
+    instance_variable_get(ivar)[scope] = aBlock
+  end
+
+  def validated_scope(aKind, aScope)
+    unless ValidHookScopes.include?(aScope)
+      msg = "Unknown scope '#{aScope}' for #{aKind}_cuke hook."
+      raise StandardError, msg
+    end
+
+    return aScope
+  end
+
+  def handler_for(aKind, aScope)
+    if aKind == :before
+      hooks = before_hooks
+    else
+      hooks = after_hooks
+    end
+
+    handler = hooks.nil? ? nil : hooks.fetch(aScope)
+    return handler
+  end
+end # module
+end # module
+# End of file

data/lib/cukedep/sandbox.rb

@@ -1,16 +1,15 @@
-# File: sandbox.rb
-
-
-module Cukedep # This module is used as a namespace
-  # A context in which hook block codes are run.
-  class Sandbox
-    attr_reader(:base_dir)
-    attr_reader(:proj_dir)
-
-    def initialize(theBaseDir, theProjectDir)
-      @base_dir = theBaseDir.dup.freeze
-      @proj_dir = theProjectDir.dup.freeze
-    end
-  end # class
-end # module
-# End of file
+# File: sandbox.rb
+
+module Cukedep # This module is used as a namespace
+  # A context in which hook block codes are run.
+  class Sandbox
+    attr_reader(:base_dir)
+    attr_reader(:proj_dir)
+
+    def initialize(theBaseDir, theProjectDir)
+      @base_dir = theBaseDir.dup.freeze
+      @proj_dir = theProjectDir.dup.freeze
+    end
+  end # class
+end # module
+# End of file

data/lib/cukedep.rb

@@ -1,9 +1,8 @@
 # File: cukedep.rb
-# This file acts as a jumping-off point for loading dependencies expected 
+# This file acts as a jumping-off point for loading dependencies expected
 # for a Cukedep user.
 
 require_relative './cukedep/constants'
 require_relative './cukedep/application'
 
-
 # End of file

data/sample/features/step_definitions/steps.rb

@@ -1,7 +1,7 @@
 # File: steps.rb
 # Step definitions for a sample Cucumber application
 
-def store()
+def store
   $store
 end
 
@@ -30,7 +30,7 @@ When(/^I remove the video "(.*?)"$/) do |a_title|
 end
 
 Given(/^there is no member yet$/) do
-  store.send(:zap_members!)  # Why is this method seen as private?
+  store.send(:zap_members!) # Why is this method seen as private?
 end
 
 Then(/^I should see member "(.*?)" as unknown$/) do |member_name|

data/sample/model/model.rb

@@ -1,7 +1,7 @@
 # File: model.rb
 
 require 'pp'
-require 'yaml'  # Rely on YAML for object persistence
+require 'yaml' # Rely on YAML for object persistence
 
 
 # Module used as a namespace
@@ -22,7 +22,7 @@ module Sample
   # In our sample model, no rental history is performed
   Rental = Struct.new(
     :video, # Use the title of the rented video as key
-    :member   # Use the name of the Member as key
+    :member # Use the name of the Member as key
   )
 
   # The identification of a store rental employee
@@ -34,10 +34,10 @@ module Sample
   # Simplistic domain model of a video rental store.
   class RentalStore
     MyDir = File.dirname(__FILE__) + '/'
-    CatalogueFile = 'catalogue.yml'
-    MembersFile = 'members.yml'
-    RentalsFile = 'rentals.yml'
-    UsersFile = 'users.yml'
+    CatalogueFile = 'catalogue.yml'.freeze
+    MembersFile = 'members.yml'.freeze
+    RentalsFile = 'rentals.yml'.freeze
+    UsersFile = 'users.yml'.freeze
 
 
     # The list of all videos owned by the store.
@@ -52,28 +52,27 @@ module Sample
     # The list of application user (credentials)
     attr_reader(:users)
 
-    def initialize()
+    def initialize
       init_catalogue
       init_members
       init_rentals
       init_users
     end
 
-
     # Clear the catalogue (= make it empty).
-    def zap_catalogue!()
+    def zap_catalogue!
       catalogue.clear
       save_catalogue
       zap_rentals!
     end
 
-    def zap_members!()
+    def zap_members!
       members.clear
       save_members
       zap_rentals!
     end
 
-    def zap_users!()
+    def zap_users!
       users.clear
       save_users
     end
@@ -143,7 +142,7 @@ module Sample
 
     private
 
-    def init_catalogue()
+    def init_catalogue
       filepath = MyDir + CatalogueFile
       if File.exist?(filepath)
         @catalogue = YAML.load_file(filepath)
@@ -152,7 +151,7 @@ module Sample
       end
     end
 
-    def init_members()
+    def init_members
       filepath = MyDir + MembersFile
       if File.exist?(filepath)
         @members = YAML.load_file(filepath)
@@ -161,7 +160,7 @@ module Sample
       end
     end
 
-    def init_users()
+    def init_users
       filepath = MyDir + UsersFile
       if File.exist?(filepath)
         @users = YAML.load_file(filepath)
@@ -170,7 +169,7 @@ module Sample
       end
     end
 
-    def init_rentals()
+    def init_rentals
       filepath = MyDir + RentalsFile
       if File.exist?(filepath)
         @rentals = YAML.load_file(filepath)
@@ -179,27 +178,27 @@ module Sample
       end
     end
 
-    def zap_rentals!()
+    def zap_rentals!
       rentals.clear
       save_rentals
     end
 
-    def save_catalogue()
+    def save_catalogue
       filepath = MyDir + CatalogueFile
       File.open(filepath, 'w') { |f| YAML.dump(catalogue, f) }
     end
 
-    def save_members()
+    def save_members
       filepath = MyDir + MembersFile
       File.open(filepath, 'w') { |f| YAML.dump(members, f) }
     end
 
-    def save_users()
+    def save_users
       filepath = MyDir + UsersFile
       File.open(filepath, 'w') { |f| YAML.dump(users, f) }
     end
 
-    def save_rentals()
+    def save_rentals
       filepath = MyDir + RentalsFile
       File.open(filepath, 'w') { |f| YAML.dump(rentals, f) }
     end

data/spec/cukedep/application_spec.rb

@@ -1,80 +1,80 @@
-# File: cmd-line_spec.rb
-
-require 'stringio'
-require 'English'
-require_relative '../spec_helper'
-
-# Load the class under testing
-require_relative '../../lib/cukedep/application'
-
-module Cukedep # Open module to get rid of long qualified names
-describe Application do
-  context 'Creation & initialization:' do
-    it 'should be created without argument' do
-      expect { Application.new }.not_to raise_error
-    end
-  end # context
-  
-  context 'Provided services:' do
-    subject { Application.new }
-    
-    it 'should read its command-line' do
-      options = subject.send(:options_from, [])
-      expect(options).to be_empty
-    end
-    
-    it 'should generate a user settings file' do
-      # Start state: no config
-      File.delete(Cukedep::YMLFilename) if File.exist?(Cukedep::YMLFilename)
-      
-      # --setup option creates the config file then stops the application
-      expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
-      
-      # Check that the config file was effectively created.
-      expect(File.exist?(Cukedep::YMLFilename)).to be true
-      created_config = Config.load_cfg(Cukedep::YMLFilename)
-      expect(created_config).to eq(Config.default)
-      
-      # Re-run again with --setup option.
-      # It should ask permission for overwriting
-      # Capture console IO
-      old_stdout = $DEFAULT_OUTPUT
-      ostream = StringIO.new('rw')
-      $DEFAULT_OUTPUT = ostream
-      old_stdin = $stdin
-      $stdin = StringIO.new("n\n", 'r')
-      expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
-      $DEFAULT_OUTPUT = old_stdout
-      $stdin = old_stdin
-    end
-    
-    it 'should complain in absence of project dir' do
-      # Start state: no config
-      File.delete(Cukedep::YMLFilename) if File.exist?(Cukedep::YMLFilename)
-      expect(File.exist?(Cukedep::YMLFilename)).to be_falsey
-      
-      # Create default config
-      expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
-        
-      err = StandardError
-      err_msg1 = "No project dir specified in '.cukedep.yml'"
-      err_msg2 = ' nor via --project option.'
-      expect { subject.run!([]) }.to raise_error(err, err_msg1 + err_msg2)
-    end
-    
-    it 'should parse the feature files' do
-      curr_dir = Dir.getwd
-      begin
-        file_dir = File.dirname(__FILE__)
-        Dir.chdir(file_dir + '/sample_features')
-        unless File.exist?(Cukedep::YMLFilename)
-          expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
-        end
-        subject.run!(['--project', '../../../sample'])
-      ensure
-        Dir.chdir(curr_dir)
-      end
-    end
-  end # context
-end # describe
-end # module
+# File: cmd-line_spec.rb
+
+require 'stringio'
+require 'English'
+require_relative '../spec_helper'
+
+# Load the class under testing
+require_relative '../../lib/cukedep/application'
+
+module Cukedep # Open module to get rid of long qualified names
+describe Application do
+  context 'Creation & initialization:' do
+    it 'should be created without argument' do
+      expect { Application.new }.not_to raise_error
+    end
+  end # context
+
+  context 'Provided services:' do
+    subject { Application.new }
+
+    it 'should read its command-line' do
+      options = subject.send(:options_from, [])
+      expect(options).to be_empty
+    end
+
+    it 'should generate a user settings file' do
+      # Start state: no config
+      File.delete(Cukedep::YMLFilename) if File.exist?(Cukedep::YMLFilename)
+
+      # --setup option creates the config file then stops the application
+      expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
+
+      # Check that the config file was effectively created.
+      expect(File.exist?(Cukedep::YMLFilename)).to be true
+      created_config = Config.load_cfg(Cukedep::YMLFilename)
+      expect(created_config).to eq(Config.default)
+
+      # Re-run again with --setup option.
+      # It should ask permission for overwriting
+      # Capture console IO
+      old_stdout = $DEFAULT_OUTPUT
+      ostream = StringIO.new('rw')
+      $DEFAULT_OUTPUT = ostream
+      old_stdin = $stdin
+      $stdin = StringIO.new("n\n", 'r')
+      expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
+      $DEFAULT_OUTPUT = old_stdout
+      $stdin = old_stdin
+    end
+
+    it 'should complain in absence of project dir' do
+      # Start state: no config
+      File.delete(Cukedep::YMLFilename) if File.exist?(Cukedep::YMLFilename)
+      expect(File.exist?(Cukedep::YMLFilename)).to be_falsey
+
+      # Create default config
+      expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
+
+      err = StandardError
+      err_msg1 = "No project dir specified in '.cukedep.yml'"
+      err_msg2 = ' nor via --project option.'
+      expect { subject.run!([]) }.to raise_error(err, err_msg1 + err_msg2)
+    end
+
+    it 'should parse the feature files' do
+      curr_dir = Dir.getwd
+      begin
+        file_dir = File.dirname(__FILE__)
+        Dir.chdir(file_dir + '/sample_features')
+        unless File.exist?(Cukedep::YMLFilename)
+          expect { subject.run!(['--setup']) }.to raise_error(SystemExit)
+        end
+        subject.run!(['--project', '../../../sample'])
+      ensure
+        Dir.chdir(curr_dir)
+      end
+    end
+  end # context
+end # describe
+end # module