cukedep 0.1.11 → 0.2.00

data/lib/cukedep/feature-model.rb

@@ -18,19 +18,19 @@ class FeatureModel
   # topological sort of the nodes.
   class DepGraph
     include TSort # Mix-in module for topological sorting
-    
+
     attr_reader(:dependencies)
-    
+
     # Inverse lookup: from the feature file => FeatureDependencies
     attr_reader(:lookup)
-    
+
     def initialize(theDependencies)
       @dependencies = theDependencies
       @lookup = dependencies.each_with_object({}) do |f_deps, subresult|
         subresult[f_deps.dependee] = f_deps
       end
     end
-    
+
     # Method required by TSort module.
     # It is used to iterate over all the nodes of the dependency graph
     def tsort_each_node(&aBlock)
@@ -48,7 +48,7 @@ class FeatureModel
 
 
   attr_reader(:feature_files)
-  
+
   # An Array of FeatureDependencies
   attr_reader(:dependencies)
 
@@ -63,35 +63,34 @@ class FeatureModel
     selection = theIds.each_with_object([]) do |an_id, sub_result|
       found_feature = features_by_ids[an_id]
       if found_feature.nil?
-        fail(StandardError, "No feature file with identifier '#{an_id}'.")
+        raise StandardError, "No feature file with identifier '#{an_id}'."
       end
       sub_result << found_feature
     end
-    
+
     return selection
   end
-  
+
   # The list of feature files without identifiers
-  def anonymous_features()
+  def anonymous_features
     feature_files.select { |ff| ff.feature.anonymous? }
   end
 
   # Build an array of FileDependencies objects.
-  def dependency_links()
+  def dependency_links
     if @dependencies.nil?
       # Build the mapping: feature identifier => feature
       features_by_id = id2features
-      
+
       # Resolve the dependency tags
       resolve_dependencies(features_by_id)
     end
-    
+
     return @dependencies
   end
 
-
   # Sort the feature files by dependency order.
-  def sort_features_by_dep()
+  def sort_features_by_dep
     dep_links = dependency_links
     graph = DepGraph.new(dep_links)
     sorted_deps = graph.tsort
@@ -99,7 +98,7 @@ class FeatureModel
     all_sorted = sorted_deps.map(&:dependee)
     @sorted_features = all_sorted.reject { |f| f.feature.anonymous? }
   end
-  
+
   # Generate CSV files detailing the feature to identifier mapping
   # and vise versa
   def mapping_reports(fileFeature2id, fileId2Feature, isVerbose = false)
@@ -113,7 +112,7 @@ class FeatureModel
         f << [filename, identifier.nil? ? 'nil' : identifier]
       end
     end
-    
+
     # Generate the feature file name => feature identifier report
     puts "  #{fileId2Feature}" if isVerbose
     CSV.open(fileId2Feature, 'wb') do |f|
@@ -123,7 +122,7 @@ class FeatureModel
         filename = File.basename(ff.filepath)
         f << [identifier, filename] unless identifier.nil?
       end
-    end    
+    end
   end
 
   # Create a graphical representation of the dependencies.
@@ -136,11 +135,10 @@ class FeatureModel
     emit_body(dot_file)
     emit_trailing(dot_file)
   end
-  
-  
+
   def emit_heading(anIO)
     dir = File.dirname(File.absolute_path(feature_files[0].filepath))
-    heading = <<-EOS
+    heading = <<-DOT
 // Graph of dependencies of feature files in directory:
 // '#{dir}'
 // This file uses the DOT syntax, a free utility from the Graphviz toolset.
@@ -149,49 +147,49 @@ class FeatureModel
 
 digraph g {
   size = "7, 11"; // Dimensions in inches...
-  center = true;  
+  center = true;
   rankdir = BT; // Draw from bottom to top
-  label = "\\nDependency graph of '#{dir}'";  
-  
+  label = "\\nDependency graph of '#{dir}'";
+
   // Nodes represent feature files
-EOS
+DOT
     anIO.write heading
   end
-  
+
   # Output the nodes as graph vertices + their edges with parent node
   def emit_body(anIO)
-    anIO.puts <<-EOS
+    anIO.puts <<-DOT
   subgraph island {
     node [shape = box, style=filled, color=lightgray];
-EOS
+DOT
     feature_files.each_with_index do |ff, i|
       draw_node(anIO, ff, i) if ff.feature.anonymous?
     end
-    
-    anIO.puts <<-EOS
+
+    anIO.puts <<-DOT
     label = "Isolated features";
     }
 
   subgraph dependencies {
     node [shape = box, fillcolor = none];
-EOS
-    feature_files.each_with_index do |ff, i| 
+DOT
+    feature_files.each_with_index do |ff, i|
       draw_node(anIO, ff, i) unless ff.feature.anonymous?
     end
-    anIO.puts <<-EOS
+    anIO.puts <<-DOT
     label = "Dependencies";
   }
 
   // The edges represent dependencies
-EOS
+DOT
     dependencies.each { |a_dep| draw_edge(anIO, a_dep) }
   end
-  
+
   # Output the closing part of the graph drawing
   def emit_trailing(anIO)
     anIO.puts '} // End of graph'
   end
-  
+
   # Draw a refinement node in DOT format
   def draw_node(anIO, aFeatureFile, anIndex)
     basename = File.basename(aFeatureFile.filepath, '.feature')
@@ -203,7 +201,7 @@ EOS
     end
     anIO.puts %Q(    node_#{anIndex} [label = "#{basename}#{id_suffix}"];)
   end
-  
+
   # Draw an edge between feature files having dependencies.
   def draw_edge(anIO, aDependency)
     source_id = feature_files.find_index(aDependency.dependee)
@@ -216,13 +214,12 @@ EOS
     end
   end
 
-
   def generate_rake_tasks(rakefile, theProjDir)
     puts "  #{rakefile}"
     grandparent_path = Pathname.new(File.dirname(__FILE__)).parent.parent
     template_source = File.read(grandparent_path + './templates/rake.erb')
 
-    # Create one template engine instance     
+    # Create one template engine instance
     engine = ERB.new(template_source)
 
     source_dir = File.absolute_path(Dir.getwd)
@@ -245,7 +242,7 @@ EOS
   end
 
   # Build the mapping: feature identifier => feature
-  def id2features()
+  def id2features
     mapping = feature_files.each_with_object({}) do |file, mp|
       feature_id = file.feature.identifier
       mp[feature_id] = file unless feature_id.nil?
@@ -253,14 +250,14 @@ EOS
 
     return mapping
   end
-  
+
   # Given a feature identifier => feature mapping,
   # resolve the dependency tags; that is,
   # Establish links between a feature file object and its
   # dependent feature file objects.
   def resolve_dependencies(aMapping)
     @dependencies = []
-    
+
     feature_files.each do |feature_file|
       feature = feature_file.feature
       its_id = feature.identifier
@@ -268,22 +265,22 @@ EOS
       # Complain when self dependency detected
       if dep_tags.include?(its_id)
         msg = "Feature with identifier #{its_id} depends on itself!"
-        fail(StandardError, msg)
+        raise StandardError, msg
       end
-      
+
       # Complain when dependency tag refers to an unknown feature
       dependents = dep_tags.map do |a_tag|
         unless aMapping.include?(a_tag)
           msg_p1 = "Feature with identifier '#{its_id}'"
           msg_p2 = " depends on unknown feature '#{a_tag}'"
-          fail(StandardError, msg_p1, msg_p2)
+          raise StandardError, msg_p1 + msg_p2
         end
         aMapping[a_tag]
       end
-      
+
       @dependencies << FeatureDependencies.new(feature_file, dependents)
     end
-    
+
     return @dependencies
   end
 end # class

data/lib/cukedep/feature-rep.rb

@@ -5,39 +5,37 @@ module Cukedep # This module is used as a namespace
 class FeatureRep
   # Constant that specifies how feature identifier tags should begin
   FeatureIdPrefix = /^feature:/
-  
+
   # Constant that specifies how dependency tags should begin
   DependencyPrefix = /^depends_on:/
-  
+
   # The sorted list of all tags of the feature.
   # The @ prefix is stripped from each tag text.
   attr_reader(:tags)
-  
-  # The identifier of the feature. 
+
+  # The identifier of the feature.
   # It comes from a tag with the following syntax '@feature:' + identifier.
   # Note that the @feature: prefix is removed.
   attr_reader(:identifier)
 
 
-  # theTags the tags objects from the Gherkin parser
+  # @param theTags [Array<String>] the tags objects from the Gherkin parser
   def initialize(theTags)
     # Strip first character of tag literal.
     @tags = theTags.map { |t| t[1..-1] }
-    
+
     @identifier = tags.find { |tg| tg =~ FeatureIdPrefix }
     @identifier = @identifier.sub(FeatureIdPrefix, '') unless identifier.nil?
   end
-  
-  public
 
   # The list of all feature identifiers retrieved from the dependency tags
-  def dependency_tags()
+  def dependency_tags
     dep_tags = tags.select { |t| t =~ DependencyPrefix }
     return dep_tags.map { |t| t.sub(DependencyPrefix, '') }
   end
-  
+
   # Return true iff the identifier of the feature is nil.
-  def anonymous?()
+  def anonymous?
     return identifier.nil?
   end
 end # class

data/lib/cukedep/file-action.rb

@@ -5,23 +5,22 @@ require 'fileutils'
 
 module Cukedep # This module is used as a namespace
   class FileAction
-    attr(:patterns, true)
+    attr_accessor(:patterns)
     attr_reader(:delta)
 
     # Constructor.
     # [thePatterns] An array of file patterns.
     def initialize(thePatterns, aDelta = nil)
       @patterns = validate_file_patterns(thePatterns)
-      @delta  = validate_delta(aDelta)
+      @delta = validate_delta(aDelta)
     end
 
-
     # Datavalue semantic: FileActions don't have identity
     def ==(other)
       return true if object_id == other.object_id
       return false if self.class != other.class
 
-      attrs = [:patterns, :delta]
+      attrs = %I[patterns delta]
       equality = true
 
       attrs.each do |accessor|
@@ -32,15 +31,14 @@ module Cukedep # This module is used as a namespace
       return equality
     end
 
-
     protected
 
     def validate_file_patterns(filePatterns)
       err_msg = 'Expecting a list of file patterns'
-      fail StandardError, err_msg unless filePatterns.is_a?(Array)
-      filePatterns.each do |filePatt|
-        err_msg = "Invalid value in list of file patterns: #{filePatt}"
-        fail StandardError, err_msg unless filePatt.is_a?(String)
+      raise StandardError, err_msg unless filePatterns.is_a?(Array)
+      filePatterns.each do |file_patt|
+        err_msg = "Invalid value in list of file patterns: #{file_patt}"
+        raise StandardError, err_msg unless file_patt.is_a?(String)
       end
 
       return filePatterns
@@ -52,7 +50,7 @@ module Cukedep # This module is used as a namespace
         when String
           validated = aDelta.empty? ? nil : aDelta
         else
-          fail StandardError, 'Invalid relative path #{aDelta}'
+          raise StandardError, "Invalid relative path #{aDelta}"
       end
 
       return validated
@@ -74,7 +72,6 @@ module Cukedep # This module is used as a namespace
   end # class
 
 
-
   # A delete action object has for purpose to
   # delete files matching one of its file patterns.
   # These file are deleted from (a subdir of) a given 'target' directory.
@@ -87,7 +84,7 @@ module Cukedep # This module is used as a namespace
 
     def run!(targetDir)
       return if patterns.empty?
-      orig_dir = Dir.getwd  # Store current work directory
+      orig_dir = Dir.getwd # Store current work directory
       # pp orig_dir
 
       begin
@@ -109,7 +106,6 @@ module Cukedep # This module is used as a namespace
   end # class
 
 
-
   # A copy action object has for purpose to
   # copy files matching one of its file patterns.
   # These file are copied from a given 'source' directory
@@ -161,16 +157,14 @@ module Cukedep # This module is used as a namespace
                                     theActionSettings[:copy_subdir])
     end
 
-
     def ==(other)
       return true if object_id == other.object_id
 
       return (save_action == other.save_action) &&
-        (delete_action == other.delete_action) &&
-        (copy_action == other.copy_action)
+             (delete_action == other.delete_action) &&
+             (copy_action == other.copy_action)
     end
 
-
     # Launch the file actions in sequence.
     def run!(currentDir, projectDir)
       save_action.run!(projectDir, currentDir)
@@ -178,7 +172,6 @@ module Cukedep # This module is used as a namespace
       copy_action.run!(currentDir, projectDir)
     end
 
-
     # Retrieve the 'built-in' action triplet associated with the given event.
     # Return nil if no triplet was found for the event.
     def self.builtin(anEvent)

data/lib/cukedep/gherkin-facade.rb

@@ -1,7 +1,6 @@
 # File: gherkin-facade.rb
+require 'gherkin/parser'
 
-require 'gherkin'
-require 'gherkin/lexer/encoding'
 
 module Cukedep # This module is used as a namespace
   # Facade design pattern: A facade is an object that provides
@@ -16,7 +15,6 @@ module Cukedep # This module is used as a namespace
     # as expected by the mode argument of the IO#new method
     attr_reader(:external_encoding)
 
-
     def initialize(isVerbose, anExternalEncoding)
       @verbose = isVerbose
       @external_encoding = anExternalEncoding
@@ -27,25 +25,32 @@ module Cukedep # This module is used as a namespace
     # Parse events are sent to the passed listener object.
     def parse_features(aListener, file_patterns)
       # Create a Gherkin parser
-      parser = Gherkin::Parser::Parser.new(aListener)
+      parser = Gherkin::Parser.new
 
       puts "\nParsing:" if verbose
       # List all .feature files in work directory that match the pattern
       filenames = []
       file_patterns.each { |patt| filenames.concat(Dir.glob(patt)) }
-
       # Parse them
       filenames.each do |fname|
         puts "  #{fname}" if verbose
         # To prevent encoding issue, open the file
         # with an explicit external encoding
         File.open(fname, "r:#{external_encoding}") do |f|
-          parser.parse(f.read, fname, 0)
+          raw = parser.parse(f.read)
+          parse_raw_feature(raw[:feature], fname, aListener) if raw[:feature]
         end
       end
 
       return aListener
     end
+
+    def parse_raw_feature(raw_feature, file_name, listener)
+      listener.uri(file_name)
+      raw_tags = raw_feature[:tags]
+      tag_names = raw_tags.map { |raw_tag| raw_tag[:name] }
+      listener.feature_tags(tag_names)
+    end
   end # class
 end # module
 

data/lib/cukedep/gherkin-listener.rb

@@ -4,15 +4,15 @@ require_relative 'feature-rep'
 
 
 module Cukedep # This module is used as a namespace
-  class FeatureFileRep 
+  class FeatureFileRep
     attr_reader(:filepath)
-    attr(:feature, true)
-    
+    attr_accessor(:feature)
+
     def initialize(aFilepath)
       @filepath = aFilepath
     end
-    
-    def basename()
+
+    def basename
       File.basename(filepath)
     end
   end # class
@@ -27,12 +27,13 @@ module Cukedep # This module is used as a namespace
     attr_reader(:feature_files)
 
     # Internal representation of the feature being parsed
-    attr(:current_feature, true)
-    
-    def initialize()
+    attr_accessor(:current_feature)
+
+    # Constructor
+    def initialize
       @feature_files = []
     end
-    
+
     ######################################
     # Event listening methods
     ######################################
@@ -45,44 +46,13 @@ module Cukedep # This module is used as a namespace
     end
 
     # aFeature is a Gherkin::Formatter::Model::Feature instance
-    def feature(aFeature)
-      tag_names = aFeature.tags.map(&:name)
+    def feature_tags(tag_names)
       @current_feature = feature_files.last.feature = FeatureRep.new(tag_names)
     end
 
-    # aBackground is a Gherkin::Formatter::Model::Background instance
-    def background(_aBackground)
-      ; # Do nothing
-    end
-    
-    # aScenario is a Gherkin::Formatter::Model::Scenario instance
-    def scenario(_aScenario)
-      ; # Do nothing
-    end
-    
-    # aScenarioOutline is a Gherkin::Formatter::Model::ScenarioOutline instance
-    def scenario_outline(_aScenarioOutline)
-      ; # Do nothing  
-    end
-    
-    # theExamples is a Gherkin::Formatter::Model::Examples instance
-    def examples(_theExamples)
-      ; # Do nothing 
-    end
-
-    # aStep is a Gherkin::Formatter::Model::Step instance
-    def step(_aStep)
-      ; # Do nothing
-    end
-    
-    # End of feature file notification.
-    def eof()
-      ; # Do nothing
-    end
-
-
     # Catch all method
     def method_missing(message, *_args)
+      puts caller(1, 5).join("\n")
       puts "Method #{message} is not implemented (yet)."
     end
   end # class