cukedep 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWY3NmMwOGE1YjM3MzVmNjA3YzFhYzlhMGE3ZmMwNTNiYzZhYjA1NQ==
+  data.tar.gz: !binary |-
+    MjI3ZDE2ZGY3NGU0ZDQxM2FjNjY2Mzk4OTZiMDg4NGE0M2RhNjdiYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjQxZGZjZDNlMDU1MzRlZDhlZWI2NGYzNjJiYWZmNWRlZDFiMzRhMWQ3YmVh
+    NzllMWI4OGUxMWU1ZGIxNzU5ZjJkNmJiNWMzN2ZjZTlmMTBkN2UxYTIxYzRk
+    YjRjZDlhMzdkNDRmOWY4N2MwZGEyOTVhOTA5NTIyZjJhYWM3ZWM=
+  data.tar.gz: !binary |-
+    ODllMDNmNmNlMzIwZTZmNDFmM2FkYTMyMDhhYmRjNDg4Nzg3NjY4Zjc4NjUw
+    NGFlOTAwMTc5MGY2ZjFlNzllMjMwMzQxN2U0ZWExMjgyYjhkMjBiMzI0YTg5
+    YjMyZThjMmJiNGY1YTBiMDQ0MWQ5NWUxZDE4MGI1YmYxYzdkNTk=

data/.rspec

@@ -0,0 +1 @@
+--backtrace

data/.ruby-gemset

@@ -0,0 +1 @@
+cukedep

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.simplecov

@@ -0,0 +1,7 @@
+# .simplecov
+# Configuration
+
+SimpleCov.start do
+  # Remove all files that match /spec/ in their path
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - jruby-head
+
+gemfile:
+  - Gemfile
+  
+# whitelist
+branches:  
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,6 @@
+--exclude examples --exclude features --exclude spec
+--no-private
+--markup markdown
+-
+Changelog.md
+License.txt

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.01 / 2013-10-23
+
+* [FEATURE] Initial public working version

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+# Prevent Bundler to load the dependencies from our .gemspec file
+
+gem "gherkin", [">=" "1.0.0"]
+gem "cucumber", [">= 0.5.0"]
+gem "rake", [">= 0.8.0" ]
+
+group :development do
+  gem "rake",  ">= 0.8.0" 
+  gem "rspec", ">= 2.11.0"
+  gem "simplecov", ">= 0.5.0"
+end

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Dimitri Geshef
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+Cukedep
+===========
+[![Build Status](https://travis-ci.org/famished-tiger/cukedep.png?branch=master)](https://travis-ci.org/famished-tiger/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.  
+  
+### Highlights ###
+* Simple syntax to specify dependencies
+* Generates dependency reports (in CSV format)
+* Generates dependency diagram (in DOT format),
+* Generates a Rake file.
+
+
+### Installation ###
+The installation of the cukedep gem is fairly standard:  
+```bash  
+$[sudo] gem install cukedep
+```
+
+To check the installation, open a shell/command window
+and type the command-line:
+```bash  
+$[sudo] cukedep --version
+```
+
+You should see the version of cukedep gem.
+
+
+### Synopsis ###
+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
+```
+
+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
+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
+```
+
+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).
+* 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```
+
+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
+```
+
+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/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require_relative './lib/cukedep/constants'
+
+namespace :gem do
+
+desc 'Push the gem to rubygems.org'
+task :push do
+  system("gem push cukedep-#{Cukedep::Version}.gem")
+end
+
+end # namespace
+
+# Testing-specific tasks
+
+
+# RSpec as testing tool
+require 'rspec/core/rake_task'
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+
+# Combine RSpec tests
+desc 'Run tests, with RSpec'
+task :test => [:spec]
+
+
+# Default rake task
+task :default => :test
+
+# End of file

data/bin/cukedep

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# File: cukedep
+# The 'executable' of the Cukedep utility.
+
+mydir = File.dirname(__FILE__)
+lib_dir = mydir + '/../lib'
+$LOAD_PATH.unshift lib_dir unless $:.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/cucumber.yml

@@ -0,0 +1,10 @@
+default: --strict -v -b  --format progress features
+html: --strict -v -b  --format html --out result.html features
+pdf: --strict -v -b  --format pdf --out result.pdf features
+stepdefs: --strict -v -b  --format stepdefs --out stepdefs.txt features
+rerun: --strict -v -b  --format rerun --out rerun.txt features
+tag_cloud: --strict -v -b  --format tag_cloud --out tag_cloud.txt features
+usage: --strict -v -b  --format usage --out usage.txt features
+
+
+

data/lib/cukedep.rb

@@ -0,0 +1,9 @@
+# File: cukedep.rb
+# 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/lib/cukedep/application.rb

@@ -0,0 +1,112 @@
+# File: application.rb
+
+require 'yaml'
+require 'gherkin/parser/parser'
+
+require_relative 'cli/cmd-line'
+require_relative 'config'
+require_relative 'gherkin-listener'
+require_relative 'feature-model'
+
+module Cukedep # Module used as a namespace
+
+# Runner for the Cukedep application
+class Application
+  attr_reader(:proj_dir)
+public
+
+	# Entry point for the application object.
+	def	start!(theCmdLineArgs)
+    options = options_from(theCmdLineArgs)
+    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.")
+      end
+    else
+      @proj_dir = config.proj_dir
+    end
+
+    feature_files = parse_features()
+    
+    model = FeatureModel.new(feature_files)
+    generate_files(model)
+    unless options[:"dry-run"]
+      rake_cmd = "rake -f cukedep.rake"
+      system(rake_cmd)
+    end
+  end
+
+protected
+	# Retrieve the user-entered command-line options
+  def options_from(theCmdLineArgs)
+    cli = CLI::CmdLine.new
+		options = 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()
+      exit if answer =~ /^\s*[Nn]\s*$/
+    end
+    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)
+    else
+      Config.default
+    end
+  end
+
+  # Parse the feature files
+  def parse_features()
+    # Create a Gherkin listener
+    listener = Cukedep::GherkinListener.new
+
+    # Create a Gherkin parser
+    parser = Gherkin::Parser::Parser.new(listener)
+
+    # List all the .feature files
+    filenames = Dir.glob('*.feature')
+    puts "\nParsing:"
+    
+    # Parse them
+    filenames.each do |fname|
+      puts "  #{fname}"
+      File::open(fname, 'r') { |f| parser.parse(f.read, fname, 0) }
+    end
+
+    return listener.feature_files
+  end
+
+
+  def generate_files(aModel)
+    # Sort the feature files by dependency order.
+    aModel.sort_features_by_dep()
+    
+    puts "\nGenerating:"
+    
+    # Generate CSV files detailing the feature to identifier mapping
+    # and vise versa
+    aModel.mapping_reports('feature2id.csv', 'id2feature.csv', true)
+    aModel.draw_dependency_graph('dependencies.dot', true)
+    aModel.generate_rake_tasks('cukedep.rake', proj_dir)
+  end
+end # class
+
+end # module
+
+# End of file

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

@@ -0,0 +1,115 @@
+# File: cli.rb
+
+# Access the OptionParser library from the standard Ruby library
+require 'optparse'
+require 'pathname'
+
+require_relative '../constants'
+
+module Cukedep # This module is used as a namespace
+
+# Module dedicated to the command-line interface
+module CLI
+
+
+# Manages the application command-line interface (CLI).
+# It is merely a thin wrapper around the OptionParser library.
+# Responsibilities:
+#- Specify the command-line syntax,
+#- Return the result of the command-line parsing
+class CmdLine
+  # A Hash with the result of the command-line parse.
+  attr_reader(:options)
+
+  # OptionParser object
+  attr_reader(:parser)
+
+  # Constructor.
+  def initialize()
+    @options = { }
+
+    @parser = OptionParser.new do |opts|
+      opts.banner = <<-EOS
+Usage: cukedep [options]
+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
+      end
+
+      # No argument.  Create .cukedep.yml file
+      setup_txt = 'Create a default .cukedep.yml file in current dir.'
+      opts.on(nil, '--setup', setup_txt) do
+        options[:setup] = true
+      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|
+        options[:project] = validated_project(project_path)
+      end
+
+      # No argument, shows at tail.  This will print an options summary.
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        options[:help] = true
+      end
+
+      opts.on_tail('--version', 'Show application version number') do
+        puts Cukedep::Version
+        options[:version] = true
+      end
+
+    end
+  end
+
+public
+  # Perform the command-line parsing
+  def parse!(theCmdLineArgs)
+    begin
+      parser.parse!(theCmdLineArgs)    
+    rescue OptionParser::MissingArgument => exc
+      err_msg = ''
+      exc.args.each do |arg|
+        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)
+    end
+
+    # Some options stop the application
+    exit if options[:version] || options[:help]
+    
+    return options
+  end
+
+private
+  def validated_project(theProjectPath)
+    unless Dir.exist?(theProjectPath)
+      fail StandardError, "Cannot find the directory '#{theProjectPath}'."
+    end
+    
+    # If current dir is /features and project dir is parent of it
+    # then we have an error
+    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
+      end
+    end
+    
+
+    return theProjectPath
+  end
+
+end # class
+
+end # module
+
+end # module
+
+# End of file