cukedep 0.0.1 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWY3NmMwOGE1YjM3MzVmNjA3YzFhYzlhMGE3ZmMwNTNiYzZhYjA1NQ==
+    ZTAzMGZlZWQ2YWQxNzgyYjRiOWFkNWU0MmUxN2E2NjYzNjcwZjRkYQ==
   data.tar.gz: !binary |-
-    MjI3ZDE2ZGY3NGU0ZDQxM2FjNjY2Mzk4OTZiMDg4NGE0M2RhNjdiYQ==
+    MDFmNGNmODNmMjMwZDEyMDFiMDUyYTNmYjIxYTg5NTE1ZmY3YjhlNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjQxZGZjZDNlMDU1MzRlZDhlZWI2NGYzNjJiYWZmNWRlZDFiMzRhMWQ3YmVh
-    NzllMWI4OGUxMWU1ZGIxNzU5ZjJkNmJiNWMzN2ZjZTlmMTBkN2UxYTIxYzRk
-    YjRjZDlhMzdkNDRmOWY4N2MwZGEyOTVhOTA5NTIyZjJhYWM3ZWM=
+    OWI2NmJjYjg5YmUxNjBhMTZmYmIwZDU3OWUyYjIzNjllYjA4NGRlYzk2NGNm
+    NDJmYjI1YWI3ZmQ1MTZkODI3ZWI0ZjI4NjFjNzVkMmNlZjU0MTI5Y2I3ZDMz
+    NTBjYmExYjMyZjY5Yjc3OWI0ZWJhOGM4MTEyNmJkOWJhNzZiZTg=
   data.tar.gz: !binary |-
-    ODllMDNmNmNlMzIwZTZmNDFmM2FkYTMyMDhhYmRjNDg4Nzg3NjY4Zjc4NjUw
-    NGFlOTAwMTc5MGY2ZjFlNzllMjMwMzQxN2U0ZWExMjgyYjhkMjBiMzI0YTg5
-    YjMyZThjMmJiNGY1YTBiMDQ0MWQ5NWUxZDE4MGI1YmYxYzdkNTk=
+    YjcyZGI5YjFhNGMzNDlhMjI3ZGY1ZDUyOGQwZmQ4MzgwNWUxMGFkZTA2YmI4
+    Y2VlYjgwYWFmN2EzNWM0ZWQ5YzBiODBmZGEwYzRhMDM4YTk0MWI0OTA5NTQz
+    ZmJjMWQ0YjA3MmU2YzhmZDk5OTA2YzUyY2U5MDM0ZTczY2JhMmI=

data/CHANGELOG.md

@@ -1,3 +1,11 @@
-### 0.0.01 / 2013-10-23
+### 0.0.3 / 2013-10-24
+* [FIX] File `rake.erb`. Removal of pp method call.
+
+### 0.0.2 / 2013-10-24
+* [CHANGE] Code cleanup done to fix most code style issues reported by Rubocop.
+
+* [FEATURE] Initial public working version
+
+### 0.0.1 / 2013-10-23
 
 * [FEATURE] Initial public working version

data/README.md

@@ -1,11 +1,12 @@
 Cukedep
 ===========
 [![Build Status](https://travis-ci.org/famished-tiger/cukedep.png?branch=master)](https://travis-ci.org/famished-tiger/cukedep)
+[![Gem Version](https://badge.fury.io/rb/cukedep.png)](http://badge.fury.io/rb/cukedep)
 
 _Handle dependencies between feature file._  
 [Homepage](https://github.com/famished-tiger/cukedep)
 
-__Cukedep__ is a command-line utility that helps to run feature files in the proper sequence.  
+__Cukedep__ is a command-line utility that helps to run a set feature files in the proper sequence.  
   
 ### Highlights ###
 * Simple syntax to specify dependencies
@@ -23,7 +24,7 @@ $[sudo] gem install cukedep
 To check the installation, open a shell/command window
 and type the command-line:
 ```bash  
-$[sudo] cukedep --version
+cukedep --version
 ```
 
 You should see the version of cukedep gem.
@@ -34,21 +35,21 @@ To get a first taste of how cukedep works, install it first.
 Then go to the root dir of the cukedep gem, then open a shell/command window
 and type the command-line:
 ```bash  
-$[sudo] rake
+rake
 ```
 
 You will see tests running and Cucumber executing a number of feature files.
 
-To learn more what's happening, go to the ```pec/sample_features``` dir
+To learn more what's happening, go to the ```rspec/sample_features``` dir
 You will notice a number of feature files for a sample application.
 Stay in that folder and type the following command-line:
 ```bash  
-$[sudo] cukedep --project ../../../sample --dry-run
+cukedep --project ../../../sample --dry-run
 ```
 
 You instructed cukedep to do the following:
 * Read (parse) all the feature files in the current dir.
-* Resolve the dependencies between the feature files (based on specific Gherkin @tags).
+* Resolve the dependencies between the feature files (based on Gherkin @tags with a special format).
 * Generate a number of dependency reports and drawing.
 * Generate a rake file that will execute the feature files in the proper sequence for
 the project located at the relative path ```../../../sample```
@@ -56,9 +57,12 @@ the project located at the relative path ```../../../sample```
 To generate all the above files and run the feature files with Cucumber,
 then retry the command line without the --dry-run option:
 ```bash  
-$[sudo] cukedep --project ../../../sample --dry-run
+cukedep --project ../../../sample --dry-run
 ```
 
+### How can I define ###
+
+
 Copyright
 ---------
 Copyright (c) 2013, Dimitri Geshef. Cukedep is released under the MIT License see [LICENSE.txt](https://github.com/famished-tiger/Cukedep/blob/master/LICENSE.txt) for details.

data/bin/cukedep

@@ -4,11 +4,12 @@
 
 mydir = File.dirname(__FILE__)
 lib_dir = mydir + '/../lib'
-$LOAD_PATH.unshift lib_dir unless $:.include?(lib_dir)
+$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
 
 require 'cukedep' # Load the Cukedep::Application class	
 
 # The application's entry point
 app = Cukedep::Application.new
 app.start!(ARGV)
+
 # End of file

data/lib/cukedep.rb

@@ -5,5 +5,5 @@
 require_relative './cukedep/constants'
 require_relative './cukedep/application'
 
-# End of file
 
+# End of file

data/lib/cukedep/application.rb

@@ -10,62 +10,65 @@ require_relative 'feature-model'
 
 module Cukedep # Module used as a namespace
 
-# Runner for the Cukedep application
+# Runner for the Cukedep application.
 class Application
   attr_reader(:proj_dir)
 public
 
-	# Entry point for the application object.
-	def	start!(theCmdLineArgs)
+  # Entry point for the application object.
+  def start!(theCmdLineArgs)
     options = options_from(theCmdLineArgs)
-    create_default_cfg() if options[:setup]
-    config = load_cfg()
+    create_default_cfg if options[:setup]
+    config = load_cfg
 
     # Complain if no project dir is specified
     if config.proj_dir.nil? || config.proj_dir.empty?
       if options[:project]
         @proj_dir = options[:project]
       else
-        fail(StandardError,  "No project dir specified via 'Cukedep::YMLFilename' nor via --project option.")
+        msg_p1 = "No project dir specified via 'Cukedep::YMLFilename'"
+        msg_p2 = ' nor via --project option.'
+        fail(StandardError, msg_p1 + msg_p2)
       end
     else
       @proj_dir = config.proj_dir
     end
 
-    feature_files = parse_features()
+    feature_files = parse_features
     
     model = FeatureModel.new(feature_files)
     generate_files(model)
-    unless options[:"dry-run"]
-      rake_cmd = "rake -f cukedep.rake"
+    unless options[:dryrun]
+      rake_cmd = 'rake -f cukedep.rake'
       system(rake_cmd)
     end
   end
 
 protected
-	# Retrieve the user-entered command-line options
+  # Retrieve the user-entered command-line options
   def options_from(theCmdLineArgs)
     cli = CLI::CmdLine.new
-		options = cli.parse!(theCmdLineArgs.dup)
+    cli.parse!(theCmdLineArgs.dup)
   end
 
+
   # Create a local copy of the .cukedep.yml file, then
   # stop the application.
   def create_default_cfg()
     if File.exist?(Cukedep::YMLFilename)
       puts "OK to overwrite file #{Cukedep::YMLFilename}."
       puts '(Y/N)?'
-      answer = $stdin.gets()
+      answer = $stdin.gets
       exit if answer =~ /^\s*[Nn]\s*$/
     end
-    File::open(Cukedep::YMLFilename, 'w') { |f| YAML.dump(Config.default, f) }
+    File.open(Cukedep::YMLFilename, 'w') { |f| YAML.dump(Config.default, f) }
     exit
   end
 
   # Read the .cukedep.yml file in the current working directory
   def load_cfg()
     if File.exist?(Cukedep::YMLFilename)
-      YAML::load_file(Cukedep::YMLFilename)
+      YAML.load_file(Cukedep::YMLFilename)
     else
       Config.default
     end
@@ -86,7 +89,7 @@ protected
     # Parse them
     filenames.each do |fname|
       puts "  #{fname}"
-      File::open(fname, 'r') { |f| parser.parse(f.read, fname, 0) }
+      File.open(fname, 'r') { |f| parser.parse(f.read, fname, 0) }
     end
 
     return listener.feature_files
@@ -95,12 +98,13 @@ protected
 
   def generate_files(aModel)
     # Sort the feature files by dependency order.
-    aModel.sort_features_by_dep()
+    aModel.sort_features_by_dep
     
     puts "\nGenerating:"
     
     # Generate CSV files detailing the feature to identifier mapping
     # and vise versa
+    # TODO: replace hardcoded names by value from config
     aModel.mapping_reports('feature2id.csv', 'id2feature.csv', true)
     aModel.draw_dependency_graph('dependencies.dot', true)
     aModel.generate_rake_tasks('cukedep.rake', proj_dir)
@@ -109,4 +113,4 @@ end # class
 
 end # module
 
-# End of file
+# End of file

data/lib/cukedep/cli/cmd-line.rb

@@ -35,9 +35,10 @@ The command-line options are:
 EOS
 
       # No argument.  Check
-      dry_txt = 'Check the feature file dependencies without running the feature files.'
-      opts.on(nil, '--dry-run', dry_txt) do
-        options[:"dry-run"] = true
+      dry_txt1 = 'Check the feature file dependencies'
+      dry_txt2 = ' without running the feature files.'
+      opts.on(nil, '--dry-run', dry_txt1 + dry_txt2) do
+        options[:dryrun] = true
       end
 
       # No argument.  Create .cukedep.yml file
@@ -47,8 +48,9 @@ EOS
       end
 
       # Mandatory argument
-      msg = 'Run the Cucumber project at given path with features from current dir.'
-      opts.on('--project PROJ_PATH', msg) do |project_path|
+      msg_p1 = 'Run the Cucumber project at given path '
+      msg_p2 = 'with features from current dir.'
+      opts.on('--project PROJ_PATH', msg_p1 + msg_p2) do |project_path|
         options[:project] = validated_project(project_path)
       end
 
@@ -77,7 +79,7 @@ public
         err_msg << "No argument provided with command line option: #{arg}\n"
       end
       err_msg << 'To see the command-line syntax, do:\ncukedep --help'
-      fail(StandardError, err_msg)
+      raise(StandardError, err_msg)
     end
 
     # Some options stop the application
@@ -94,11 +96,12 @@ private
     
     # If current dir is /features and project dir is parent of it
     # then we have an error
-    current_path = Pathname.getwd()
+    current_path = Pathname.getwd
     if current_path.to_s =~ /features$/
       if current_path.parent == Pathname.new(theProjectPath)
-        msg = "Original feature file may not be in 'features' subdir of project dir."
-        fail StandardError, msg
+        msg_prefix = "Don't place original feature file in 'features'"
+        msg_suffix = ' subdir of project dir.'
+        fail StandardError, msg_prefix + msg_suffix
       end
     end
     
@@ -112,4 +115,4 @@ end # module
 
 end # module
 
-# End of file
+# End of file

data/lib/cukedep/config.rb

@@ -19,13 +19,18 @@ Config = Struct.new(
 class Config
   # Factory method. Build a config object with default settings.
   def self.default()
-    Config.new(nil, FileMetaData.new('feature2id.csv'), 
-      FileMetaData.new('feature2id.csv'), FileMetaData.new('dependencies.dot'),
-      'cukedep.rake', [])
+    Config.new(
+      nil, 
+      FileMetaData.new('feature2id.csv'), 
+      FileMetaData.new('feature2id.csv'), 
+      FileMetaData.new('dependencies.dot'),
+      'cukedep.rake',
+      []
+    )
   end
 
 end # class
 
 end # module
 
-# End of file
+# End of file

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.1'
+  Version = '0.0.3'
 
   # Brief description of the gem.
   Description = 'Manage dependencies between Cucumber feature files'

data/lib/cukedep/feature-model.rb

@@ -16,7 +16,9 @@ class FeatureModel
 
 FeatureDependencies = Struct.new(:dependee, :dependents)
 
-
+# Helper class used internally by FeatureModel class.
+# Purpose: to try to create a valid dependency graph and perform a
+# topological sort of the nodes.
 class DepGraph
   include TSort # Mix-in module for topological sorting
   
@@ -61,7 +63,7 @@ end # class
   # Retrieve the feature file matching the given feature identifiers
   # theIds one or more Strings, each being one feature identifier
   def select_by_ids(*theIds)
-    features_by_ids = id2features()
+    features_by_ids = id2features
     selection = theIds.each_with_object([]) do |an_id, sub_result|
       found_feature = features_by_ids[an_id]
       if found_feature.nil?
@@ -82,7 +84,7 @@ end # class
   def dependency_links()
     if @dependencies.nil?
       # Build the mapping: feature identifier => feature
-      features_by_id = id2features()
+      features_by_id = id2features
       
       # Resolve the dependency tags
       resolve_dependencies(features_by_id)
@@ -94,9 +96,9 @@ end # class
 
   # Sort the feature files by dependency order.
   def sort_features_by_dep()
-    dep_links = dependency_links()
+    dep_links = dependency_links
     graph = DepGraph.new(dep_links)
-    sorted_deps = graph.tsort()
+    sorted_deps = graph.tsort
 
     all_sorted = sorted_deps.map(&:dependee)
     @sorted_features = all_sorted.reject { |f| f.feature.anonymous? }
@@ -142,7 +144,7 @@ end # class
   
   def emit_heading(anIO)
     dir = File.dirname(File.absolute_path(feature_files[0].filepath))
-    heading =<<-EOS
+    heading = <<-EOS
 // Graph of dependencies of feature files in directory:
 // '#{dir}'
 // This file uses the DOT syntax, a free utility from the Graphviz toolset.
@@ -166,7 +168,9 @@ EOS
   subgraph island {
     node [shape = box, style=filled, color=lightgray];
 EOS
-    feature_files.each_with_index { |ff, i| draw_node(anIO, ff, i) if ff.feature.anonymous? }
+    feature_files.each_with_index do |ff, i|
+      draw_node(anIO, ff, i) if ff.feature.anonymous?
+    end
     
     anIO.puts <<-EOS
     label = "Isolated features";
@@ -175,26 +179,33 @@ EOS
   subgraph dependencies {
     node [shape = box, fillcolor = none];
 EOS
-    feature_files.each_with_index { |ff, i| draw_node(anIO, ff, i) unless ff.feature.anonymous? }
+    feature_files.each_with_index do |ff, i| 
+      draw_node(anIO, ff, i) unless ff.feature.anonymous?
+    end
     anIO.puts <<-EOS
     label = "Dependencies";
   }
 
   // The edges represent dependencies
 EOS
-    dependencies.each {|a_dep| draw_edge(anIO, a_dep) }
+    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" 
+    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')
-    identifier_suffix = aFeatureFile.feature.anonymous? ? '' : " -- #{aFeatureFile.feature.identifier}"
-    anIO.puts %Q|    node_#{anIndex} [label = "#{basename}#{identifier_suffix}"];|
+    its_feature = aFeatureFile.feature
+    if its_feature.anonymous?
+      id_suffix = ''
+    else
+      id_suffix = " -- #{its_feature.identifier}"
+    end
+    anIO.puts %Q|    node_#{anIndex} [label = "#{basename}#{id_suffix}"];|
   end
   
   # Draw an edge between feature files having dependencies.
@@ -212,18 +223,18 @@ EOS
 
   def generate_rake_tasks(rakefile, theProjDir)
     puts "  #{rakefile}"
-    template_filepath = Pathname.new(File.dirname(__FILE__)).parent.parent + './templates/rake.erb'
-    template_source = File.read(template_filepath)
+    grandparent_path = Pathname.new(File.dirname(__FILE__)).parent.parent
+    template_source = File.read(grandparent_path + './templates/rake.erb')
 
     # Create one template engine instance     
     engine = ERB.new(template_source)
 
-    source_dir = File.absolute_path(Dir.getwd())
+    source_dir = File.absolute_path(Dir.getwd)
     proj_dir = File.absolute_path(theProjDir)
-    anonymous = anonymous_features.map {|ff| ff.basename}
+    anonymous = anonymous_features.map { |ff| ff.basename }
     feature_ids = feature_files.map { |ff| ff.feature.identifier }
     feature_ids.compact!
-    deps = dependencies.reject {|dep| dep.dependee.feature.anonymous?}
+    deps = dependencies.reject { |dep| dep.dependee.feature.anonymous? }
 
     # Generate the text representation with given context
     file_source = engine.result(binding)
@@ -266,8 +277,9 @@ EOS
       # Complain when dependency tag refers to an unknown feature
       dependents = dep_tags.map do |a_tag|
         unless aMapping.include?(a_tag)
-          msg = "Feature with identifier '#{its_id}' depends on unknown feature '#{a_tag}'"
-          fail(StandardError, msg)
+          msg_p1 = "Feature with identifier '#{its_id}'"
+          msg_p2 = " depends on unknown feature '#{a_tag}'"
+          fail(StandardError, msg_p1 = msg_p2)
         end
         aMapping[a_tag]
       end

data/spec/cukedep/cli/cmd-line_spec.rb

@@ -37,7 +37,7 @@ describe CLI::CmdLine do
 
     it 'should accept the dry-run option' do
       expect { subject.parse!(['--dry-run']) }.not_to raise_error
-      expect(subject.options).to eq({ :"dry-run" => true })
+      expect(subject.options).to eq({ :dryrun => true })
     end
 
     it 'should accept the setup option' do

data/templates/rake.erb

@@ -1,8 +1,7 @@
 # File: <%=rakefile%>
-# Generated by Cukedep <%=Cukedep::Version%>
+# Generated by Cukedep <%=Cukedep::Version%> on <%=Time.now.strftime('%d/%m/%Y %H:%M:%S')%>
 
 require 'rake'
-require 'pp'
 
 # Run Cucumber via specialized Rake task
 require 'cucumber/rake/task'
@@ -80,7 +79,6 @@ def clean_project_dir(fname_patterns)
     Dir.chdir(CUKE_PROJECT + '/features')
     fname_patterns.each do |patt|
       filenames = Dir.glob(patt)
-      pp filenames
       filenames.each { |fn| FileUtils.remove_file(fn) }
     end
   ensure  #Always restore previous working dir.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cukedep
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -102,9 +102,7 @@ files:
 - README.md
 - bin/cukedep
 - lib/cukedep.rb
-- lib/macros4cuke.rb
 - lib/cukedep/application.rb
-- lib/cukedep/cli/application.rb
 - lib/cukedep/cli/cmd-line.rb
 - lib/cukedep/config.rb
 - lib/cukedep/constants.rb

data/lib/macros4cuke.rb

@@ -1,8 +0,0 @@
-# File: macros4cuke.rb
-# This file acts as a jumping-off point for loading dependencies expected 
-# for a Macros4Cuke user.
-
-require_relative './macros4cuke/constants'
-require_relative './macros4cuke/macro-step-support'
-
-# End of file