cukesparse 2.0.5 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c90d215f8fb5a25a8ac4d3118c9f5fa051cb82a
-  data.tar.gz: 3859761458f24dac7158f86e8c1dfdfee201227a
+  metadata.gz: c80cf3026666d2482f06451e9e0524afe3deafbe
+  data.tar.gz: 57b144f542d1d48a8b8e0cab9622c5419356300d
 SHA512:
-  metadata.gz: dc10ea17d2ee538d8471837fad7aa77842f9733abcd8de6241328b557236b43fe85d740ac146730618d7699670ff67b6f48bc2ceca7d93ec7e31f167d90dd927
-  data.tar.gz: 34781891aa0413c0b4148c2cb9d6289e6d39413a9399f658443823eed6be423d603c729fc92cde7014cebb01a5f37ba08ed6fe4942d596eca81976e94d6c76ae
+  metadata.gz: c23ce187c948f68a99fd36c3222b7767e289de7f3062ef1900f9a5d00838a0714f1c108497ef5f3502f3bb47ff703b20be96ccab131ee3f56cca2611c4524eff
+  data.tar.gz: adcf9a9adfe34e55e13cdfd54a35c960fc87ffcb300a4279f63732a4a893bec937157172cd6781e35c963c05f465a5a4884504e0852338b9833ab22066808740

data/bin/cukesparse

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 require 'cukesparse'
-require 'colored'
 
 begin
+  Cukesparse.reset!
   Cukesparse.execute
 rescue Interrupt
   exit!

data/cukesparse.gemspec

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + "/lib/cukesparse/version"
 Gem::Specification.new do |s|
   s.name        = 'cukesparse'
   s.version     = Cukesparse::VERSION
-  s.date        = '2013-08-27'
+  s.date        = '2013-08-30'
   s.summary     = 'Cukesparse - cucumber command line parser'
   s.description = 'A simple command line parser to pass arguments into Cucumber'
   s.author      = 'Jonathan Chrisp'

data/lib/cukesparse.rb

@@ -2,16 +2,17 @@ require 'clik'
 require 'colored'
 require 'yaml'
 
+
 module Cukesparse
   class << self
     attr_accessor :config_file, :config, :task, :parameters, :command
 
-    # configure cukeparse
-    def configure
-      yield self
+    # Returns current config file
+    def config_file
+      @config_file ||= 'config/tasks.yml'
     end
 
-    # returns ARGV
+    # Returns current argv
     def argv
       ARGV
     end
@@ -21,42 +22,29 @@ module Cukesparse
     # @param [Symbol] key the key to store in options
     # @param [String] val the arguments passed in for key
     def add_multiple key, val
-      case val
-      when Array
-        val.each do |v|
-          (@parameters[key] ||= []).push '--' + key.to_s + ' ' + v.to_s
-        end
-      else
-        (@parameters[key] ||= []).push '--' + key.to_s + ' ' + val.to_s
+      return (@parameters[key] ||= []).push '--' + key + ' ' + val unless val.is_a? Array
+
+      val.each do |v|
+        (@parameters[key] ||= []).push '--' + key + ' ' + v
       end
     end
 
     # Executes cukesparse by checking arguments passed
     def execute
-      # Check if no arguments
-      if argv.empty?
-        puts 'Cukesparse - a simple command line parser to pass arguments into Cucumber!'.yellow
-        return
-      end
+      load_config
+      return puts 'Cukesparse - a simple command line parser to pass arguments into Cucumber!'.yellow if argv.empty?
+      return puts "You have the following tasks within your config file: #{@config.keys.join(', ')}".yellow if argv.dup.shift == 'tasks'
 
-      # Determine argument passed
-      case argv.dup.shift
-      when 'tasks'
-        load_config
-        puts "You have the following tasks within your config file: #{@config.keys.join(', ')}".yellow
-        return
-      else
-        load_config.parse_argv.build_command
-      end
-    end
-
-    # Builds the command line string
-    def build_command
+      parse_argv
       check_for_task
       check_for_parameters
       set_cucumber_defaults
       set_runtime_defaults
+      build_command
+    end
 
+    # Builds the command line string
+    def build_command
       unless @task.empty? && @parameters.empty?
         @command.push 'bundle exec cucumber'
         @command.push '--require features/'
@@ -65,31 +53,22 @@ module Cukesparse
         @command.push task['defaults'].join(' ')  if task.has_key? 'defaults'
       end
 
-      if @parameters.has_key? :debug
-        debug
-      else
-        system @command.join(' ')
-        exit $?.exitstatus
-      end
+      return debug if @parameters.has_key? 'debug'
+      system @command.join(' ')
+      exit $?.exitstatus
     end
 
     # Checks for task in arguments
     def check_for_task
       task = argv & @config.keys
-      if task.empty?
-        abort 'ERROR: No task was passed to cukesparse!'.red.underline
-      elsif task.length > 1
-        puts 'WARN: Multiple tasks have been passed!'.yellow
-      else
-        @task = @config[task[0]]
-      end
+      return abort 'ERROR: No task was passed to cukesparse!'.red.underline if task.empty?
+      return puts 'WARN: Multiple tasks have been passed!'.yellow if task.length > 1
+      return @task = @config[task[0]]
     end
 
     # Checks parameters and returns boolean
     def check_for_parameters
-      unless @parameters.any?
-        puts 'WARN: No parameters passed to cukesparse'.yellow
-      end
+      return puts 'WARN: No parameters passed to cukesparse'.yellow unless @parameters.any?
     end
 
     # Outputs the debug information
@@ -106,108 +85,97 @@ module Cukesparse
 
     # Loads the config file
     def load_config
-      begin
-       @config = YAML.load_file @config_file
-      rescue Psych::SyntaxError
-        abort 'Your tasks file did not parse as expected!'.red.underline
-      rescue Errno::ENOENT
-        abort 'Your tasks file is missing!'.red.underline
-      end
-      self
+      @config = YAML.load_file config_file
+    rescue Psych::SyntaxError
+      abort 'Your tasks file did not parse as expected!'.red.underline
+    rescue Errno::ENOENT
+      abort 'Your tasks file is missing!'.red.underline
     end
 
     # Parses the options passed via command line
     def parse_argv
-      begin
-        cli argv,
-        # Cucumber options
-        '-t'            => lambda{ |t| add_multiple(:tags, t) },
-        '-n --name'     => lambda{ |n| add_multiple(:name, n) },
-        '-f --format'   => ->(f){ @parameters[:format]    = "--format #{f}" },
-        '-d --dry-run'  => ->{ @parameters[:dry_run]      = "--dry-run" },
-        '-v --verbose'  => ->{ @parameters[:verbose]      = "--verbose" },
-        '-s --strict'   => ->{ @parameters[:strict]       = "--strict" },
-        '-g --guess'    => ->{ @parameters[:guess]        = "--guess" },
-        '-x --expand'   => ->{ @parameters[:expand]       = "--expand" },
-
-        # All options below have been added for custom project but can be used for example
-        # Global options
-        '-e --environment'  => ->(e){ @parameters[:environment] = "ENVIRONMENT=#{e}" },
-        '-l --loglevel'     => ->(l){ @parameters[:log_level]   = "LOG_LEVEL=#{l}" },
-        '-c --controller'   => ->(c){ @parameters[:controller]  = "CONTROLLER=#{c}" },
-        '-h --headless'     => ->{ @parameters[:headless]       = "HEADLESS=TRUE" },
-
-        # Database options
-        '--cleanup'         => ->{ @parameters[:cleanup]    = "CLEANUP=TRUE" },
-        '--no-cleanup'      => ->{ @parameters[:cleanup]    = "CLEANUP=FALSE" },
-        '--database'        => ->{ @parameters[:database]   = "DATABASE=TRUE" },
-        '--jenkins'         => ->{ @parameters[:jenkins]    = "JENKINS=TRUE" },
-
-        # Retry options
-        '--retries'         => ->(r){ @parameters[:retries] = "RETRIES=#{r}" },
-        '--timeout'         => ->(t){ @parameters[:timeout] = "TIMEOUT=#{t}" },
-
-        # Driver Options
-        '--screen'          => ->(s){ split_parameters(s, :screen) },
-        '--position'        => ->(p){ split_parameters(p, :position) },
-        '--screenwidth'     => ->(w){ @parameters[:screen_width]  = "SCREENWIDTH=#{w}" },
-        '--screenheight'    => ->(h){ @parameters[:screen_height] = "SCREENHEIGHT=#{h}" },
-        '--xposition'       => ->(x){ @parameters[:xposition]     = "XPOSITION=#{x}" },
-        '--yposition'       => ->(y){ @parameters[:yposition]     = "YPOSITION=#{y}" },
-        '-H --highlight'    => ->{ @parameters[:highlight]        = "HIGHLIGHT=TRUE" },
-
-        # Debug
-        '--debug' => ->{ @parameters[:debug]  = "DEBUG=TRUE" }
-      rescue
-        abort 'Error processing passed CLI arguments!'.red.underline
-      else
-        self
-      end
+      cli argv,
+      # Cucumber options
+      '-t'            => lambda{ |t| add_multiple('tags', t) },
+      '-n --name'     => lambda{ |n| add_multiple('name', n) },
+      '-f --format'   => ->(f){ @parameters['format']    = "--format #{f}" },
+      '-d --dry-run'  => ->{ @parameters['dry_run']      = "--dry-run" },
+      '-v --verbose'  => ->{ @parameters['verbose']      = "--verbose" },
+      '-s --strict'   => ->{ @parameters['strict']       = "--strict" },
+      '-g --guess'    => ->{ @parameters['guess']        = "--guess" },
+      '-x --expand'   => ->{ @parameters['expand']       = "--expand" },
+
+      # All options below have been added for custom project but can be used for example
+      # Global options
+      '-e --environment'  => ->(e){ @parameters['environment'] = "ENVIRONMENT=#{e}" },
+      '-l --loglevel'     => ->(l){ @parameters['log_level']   = "LOG_LEVEL=#{l}" },
+      '-c --controller'   => ->(c){ @parameters['controller']  = "CONTROLLER=#{c}" },
+      '-h --headless'     => ->{ @parameters['headless']       = "HEADLESS=TRUE" },
+
+      # Database options
+      '--cleanup'         => ->{ @parameters['cleanup']    = "CLEANUP=TRUE" },
+      '--no-cleanup'      => ->{ @parameters['cleanup']    = "CLEANUP=FALSE" },
+      '--database'        => ->{ @parameters['database']   = "DATABASE=TRUE" },
+      '--jenkins'         => ->{ @parameters['jenkins']    = "JENKINS=TRUE" },
+
+      # Retry options
+      '--retries'         => ->(r){ @parameters['retries'] = "RETRIES=#{r}" },
+      '--timeout'         => ->(t){ @parameters['timeout'] = "TIMEOUT=#{t}" },
+
+      # Driver Options
+      '--screen'          => ->(s){ split_parameters(s, 'screen') },
+      '--position'        => ->(p){ split_parameters(p, 'position') },
+      '--screenwidth'     => ->(w){ @parameters['screen_width']  = "SCREENWIDTH=#{w}" },
+      '--screenheight'    => ->(h){ @parameters['screen_height'] = "SCREENHEIGHT=#{h}" },
+      '--xposition'       => ->(x){ @parameters['xposition']     = "XPOSITION=#{x}" },
+      '--yposition'       => ->(y){ @parameters['yposition']     = "YPOSITION=#{y}" },
+      '-H --highlight'    => ->{ @parameters['highlight']        = "HIGHLIGHT=TRUE" },
+
+      # Debug
+      '--debug' => ->{ @parameters['debug']  = "DEBUG=TRUE" }
+    rescue
+      abort 'Error processing passed CLI arguments!'.red.underline
     end
 
     # Updates parameters based on config runtime defaults
     def set_runtime_defaults
-      if @task.has_key? 'runtime_defaults'
-        @task['runtime_defaults'].each do |key, val|
-          case key.to_sym
-          when :screen, :position
-            split_parameters(val, key.to_sym)
-          else
-            unless @parameters.has_key? key.to_sym
-              @parameters[key.to_sym] = key.upcase + '=' + val.to_s
-            end
+      return puts 'WARN: The task has no runtime defaults!'.yellow unless @task.has_key? 'runtime_defaults'
+
+      @task['runtime_defaults'].each do |key, val|
+        case key
+        when 'screen', 'position'
+          split_parameters(val, key)
+        else
+          unless @parameters.has_key? key
+            @parameters[key] = key.upcase + '=' + val.to_s
           end
         end
-      else
-        puts 'WARN: The task has no runtime defaults!'.yellow
       end
     end
 
     # Updates parameters based on config cucumber defaults
     def set_cucumber_defaults
-      if @task.has_key? 'cucumber_defaults'
-        @task['cucumber_defaults'].each do |key, val|
-          case key.to_sym
-          when :tags, :name
-            add_multiple key.to_sym, val
-          when :format
-            unless @parameters.has_key? key.to_sym
-              @parameters[key.to_sym] = '--' + key.downcase + ' ' + val.to_s
-            end
-          when :strict, :verbose, :guess, :expand
-            unless @parameters.has_key? key.to_sym && @parameters[key.to_sym] == true
-              @parameters[key.to_sym] = '--' + key.downcase
-            end
-          when :dry_run
-            unless @parameters.has_key? key.to_sym && @parameters[key.to_sym] == true
-              @parameters[key.to_sym] = '--dry-run'
-            end
-          else
-           puts 'WARN: The cucumber default ' + key.to_s + ' isn\'t a known option!'.yellow
+      return puts 'WARN: The task has no cucumber defaults!'.yellow unless @task.has_key? 'cucumber_defaults'
+
+      @task['cucumber_defaults'].each do |key, val|
+        case key
+        when 'tags', 'name'
+          add_multiple key, val
+        when 'format'
+          unless @parameters.has_key? key
+            @parameters[key] = '--' + key.downcase + ' ' + val.to_s
+          end
+        when 'strict', 'verbose', 'guess', 'expand'
+          unless @parameters.has_key? key && @parameters[key] == true
+            @parameters[key] = '--' + key.downcase
+          end
+        when 'dry_run'
+          unless @parameters.has_key? key && @parameters[key] == true
+            @parameters[key] = '--dry-run'
           end
+        else
+         puts "WARN: The cucumber default #{key} isn't a known option!".yellow
         end
-      else
-        puts 'WARN: The task has no cucumber defaults!'.yellow
       end
     end
 
@@ -224,29 +192,21 @@ module Cukesparse
       end
 
       case sym
-      when :screen
-        @parameters[:screenwidth]  = "SCREENWIDTH=#{params[0]}"
-        @parameters[:screenheight] = "SCREENHEIGHT=#{params[1]}"
-      when :position
-        @parameters[:xposition] = "XPOSITION=#{params[0]}"
-        @parameters[:yposition] = "YPOSITION=#{params[1]}"
+      when 'screen'
+        @parameters['screenwidth']  = "SCREENWIDTH=#{params[0]}"
+        @parameters['screenheight'] = "SCREENHEIGHT=#{params[1]}"
+      when 'position'
+        @parameters['xposition'] = "XPOSITION=#{params[0]}"
+        @parameters['yposition'] = "YPOSITION=#{params[1]}"
       end
     end
 
+    # Resets cukesparse
     def reset!
-      @config     = nil
+      @config     = {}
       @parameters = {}
       @task       = {}
       @command    = []
     end
   end
-
-  # defaults
-  self.parameters = {}
-  self.task       = {}
-  self.command    = []
-end
-
-Cukesparse.configure do |config|
-  config.config_file = 'config/tasks.yml'
 end

data/lib/cukesparse/version.rb

@@ -1,3 +1,3 @@
 module Cukesparse
-  VERSION = "2.0.5"
+  VERSION = "2.1.1"
 end

data/spec/cukesparse/add_multiple_spec.rb

@@ -8,17 +8,17 @@ describe '.add_multiple' do
 
   context "when run with a single value" do
     it "will add a key to parameters with the correct array value" do
-      Cukesparse.add_multiple(:tags, 'abc')
-      Cukesparse.parameters.should have_key(:tags)
-      Cukesparse.parameters[:tags].should eql ['--tags abc']
+      Cukesparse.add_multiple('tags', 'abc')
+      Cukesparse.parameters.should have_key('tags')
+      Cukesparse.parameters['tags'].should eql ['--tags abc']
     end
   end
 
   context "when run with multiple values" do
     it "will add a key to parameters with the correct array values" do
-      Cukesparse.add_multiple(:tags, ['abc', 'def', 'hij'])
-      Cukesparse.parameters.should have_key(:tags)
-      Cukesparse.parameters[:tags].should eql ['--tags abc', '--tags def', '--tags hij']
+      Cukesparse.add_multiple('tags', ['abc', 'def', 'hij'])
+      Cukesparse.parameters.should have_key('tags')
+      Cukesparse.parameters['tags'].should eql ['--tags abc', '--tags def', '--tags hij']
     end
   end
 end

data/spec/cukesparse/argv_spec.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+describe ".argv" do
+  before :each do
+    ARGV.clear
+    Cukesparse.reset!
+  end
+
+  context "when run" do
+    it "returns true for empty opts parameter" do
+      Cukesparse.argv.should be_empty
+    end
+  end
+end

data/spec/cukesparse/check_for_parameters_spec.rb

@@ -8,7 +8,6 @@ describe '.check_for_parameters' do
 
   context "when run with no paramaters defined" do
     it "will return an warning if no parameters are provided" do
-      Cukesparse.instance_variable_set(:@parameters, {})
       Cukesparse.should_receive("puts").with("\e[0;33;49mWARN: No parameters passed to cukesparse\e[0m")
       Cukesparse.check_for_parameters
     end

data/spec/cukesparse/check_for_task_spec.rb

@@ -9,7 +9,6 @@ describe '.check_for_task' do
   context "when run with no task defined" do
     it "will return an error if no task is provided" do
       ARGV.push('incorrect_task')
-      Cukesparse.config = {}
       Cukesparse.should_receive("abort").with("\e[4;31;49mERROR: No task was passed to cukesparse!\e[0m")
       Cukesparse.check_for_task
     end
@@ -18,7 +17,7 @@ describe '.check_for_task' do
   context "when run with multiple tasks defined" do
     it "will return an error if multiple tasks are provided" do
       ARGV.push('test_task', 'test_task1')
-      Cukesparse.configure {|c| c.config_file = File.join(fixture_path, 'valid_tasks.yml')}
+      Cukesparse.config_file = File.join(fixture_path, 'valid_tasks.yml')
       Cukesparse.load_config
       Cukesparse.should_receive("puts").with("\e[0;33;49mWARN: Multiple tasks have been passed!\e[0m")
       Cukesparse.check_for_task
@@ -28,7 +27,7 @@ describe '.check_for_task' do
   context "when task is defined the @task instance variable will return a hash" do
     it "will set the task in @task" do
       ARGV.push('test_task')
-      Cukesparse.configure {|c| c.config_file = File.join(fixture_path, 'valid_tasks.yml')}
+      Cukesparse.config_file = File.join(fixture_path, 'valid_tasks.yml')
       Cukesparse.load_config
       Cukesparse.check_for_task
       Cukesparse.task.should be_an_instance_of Hash

data/spec/cukesparse/debug_spec.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+describe '.debug' do
+  before :each do
+    ARGV.clear
+    Cukesparse.reset!
+  end
+
+  context "when run with task and --debug parameter" do
+    it "will return the correct output" do
+      ARGV.push('test_task1', '--debug')
+      Cukesparse.config_file = File.join(fixture_path, 'valid_tasks.yml')
+      Cukesparse.should_receive("puts").with("\e[0;33;49mDEBUG: Outputting ARGV passed\e[0m")
+      Cukesparse.should_receive("puts").with("[\"test_task1\", \"--debug\"]")
+      Cukesparse.should_receive("puts").with("\e[0;33;49mDEBUG: Outputting parsed config file\e[0m")
+      Cukesparse.should_receive("puts").with("{\"test_task\"=>{\"feature_order\"=>[\"features/featureOne\", \"features/featureTwo\", \"features/featureThree\"], \"cucumber_defaults\"=>{\"format\"=>\"pretty\", \"name\"=>[\"feature1\", \"feature2\"], \"tags\"=>[\"tags1\", \"tags2\"], \"strict\"=>true, \"verbose\"=>true, \"dry_run\"=>true, \"guess\"=>true, \"expand\"=>true}, \"runtime_defaults\"=>{\"environment\"=>\"release\", \"log_level\"=>\"debug\", \"cleanup\"=>true, \"database\"=>true, \"jenkins\"=>true, \"retries\"=>5, \"timeout\"=>60, \"screen\"=>\"1280/1024\", \"screenwidth\"=>1280, \"screenheight\"=>1024, \"position\"=>\"0/0\", \"xposition\"=>0, \"yposition\"=>0, \"highlight\"=>true}, \"defaults\"=>[\"--format html\", \"--out coverage/report.html\", \"-P -s\"]}, \"test_task1\"=>{\"feature_order\"=>[\"features/featureOne\", \"features/featureTwo\", \"features/featureThree\"], \"cucumber_defaults\"=>{\"format\"=>\"pretty\"}, \"runtime_defaults\"=>{\"environment\"=>\"release\", \"log_level\"=>\"debug\"}, \"defaults\"=>[\"--format html\", \"--out coverage/report.html\", \"-P -s\"]}, \"cucumber_default_unknown\"=>{\"feature_order\"=>[\"features/featureOne\", \"features/featureTwo\", \"features/featureThree\"], \"cucumber_defaults\"=>{\"testing\"=>\"pretty\"}, \"runtime_defaults\"=>{\"environment\"=>\"release\", \"log_level\"=>\"debug\"}, \"defaults\"=>[\"--format html\", \"--out coverage/report.html\", \"-P -s\"]}, \"no_defaults\"=>{\"feature_order\"=>[\"features/featureOne\", \"features/featureTwo\", \"features/featureThree\"]}}")
+      Cukesparse.should_receive("puts").with("\e[0;33;49mDEBUG: Outputting parameters created\e[0m")
+      Cukesparse.should_receive("puts").with("{\"debug\"=>\"DEBUG=TRUE\", \"format\"=>\"--format pretty\", \"environment\"=>\"ENVIRONMENT=release\", \"log_level\"=>\"LOG_LEVEL=debug\"}")
+      Cukesparse.should_receive("puts").with("\e[0;33;49mDEBUG: Outputting command created\e[0m")
+      Cukesparse.should_receive("puts").with("bundle exec cucumber --require features/ features/featureOne features/featureTwo features/featureThree DEBUG=TRUE --format pretty ENVIRONMENT=release LOG_LEVEL=debug --format html --out coverage/report.html -P -s")
+      Cukesparse.execute
+    end
+
+  end
+end