guard-cucumber 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f72a3ec6a6f5ceb0bbd3b399b91e81f060a8c25
-  data.tar.gz: 69a4be70567b57dab0fb5b521037ea7ec106e4a2
+  metadata.gz: 446cce06cfc0d77430a6b6c7e3ce31b76325ca71
+  data.tar.gz: 9544582765bbb7025dfadb2a88bd3b8114e6ed45
 SHA512:
-  metadata.gz: 0d9ac346adf2447c5679d8456b0cb142c810ea5e193a32adf6e7b3f37a0d361ad223045eba69d771e355b78611508b4fe517aaec20d3ce5edbbbf442f7e06dcc
-  data.tar.gz: 1c9688451ce35651b0f36ea7b9c46d7a29d840f6e02c0d7ba60a313a99fc4d3cbcb7357cda1ff06d201fa0ffd968bfa176144c47f3903e1bf0a7d34543a59b94
+  metadata.gz: 6ab8153c6cdcd1090baca18e1d1ef3a35ee609b6459fcd7c0ada3b6828d0a44963b5af0de79268641b29e11901ea3cb3f68a2130325d6bdbe13f8123e36f3025
+  data.tar.gz: e7cb7a1c69c3b507eb65f068ee642a778cd6ba3c1d92c1c0f7944e0f3974c3334126ede5c758c2182d61822d1d237fbba9c66d9f37e28c0c361ab7620b1978e4

data/README.md

@@ -2,7 +2,7 @@
 
 Guard::Cucumber allows you to automatically run Cucumber features when files are modified.
 
-Tested on MRI Ruby 1.8.7, 1.9.2, 1.9.3, REE and the latest versions of JRuby & Rubinius.
+Tested on MRI Ruby 1.9.3, 2.0.0, 2.1.0 and the latest versions of JRuby.
 
 If you have any questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
 
@@ -131,7 +131,7 @@ Since guard-cucumber version 0.3.2, the default `:cli` options are:
 :cli => '--no-profile --color --format progress --strict'
 ```
 
-This default configuration has been chosen to avoid strange behavior when mixing configurations form
+This default configuration has been chosen to avoid strange behavior when mixing configurations from
 the cucumber.yml default profile with the guard-cucumber `:cli` option.
 
 You can safely remove `config/cucumber.yml`, since all configuration is done in the `Guardfile`.
@@ -226,7 +226,7 @@ For questions please join us in our [Google group](http://groups.google.com/grou
 
 ## Author
 
-Developed by Michael Kessler, sponsored by [mksoft.ch](https://mksoft.ch).
+Developed by Michael Kessler, sponsored by [FlinkFinger](http://www.flinkfinger.com).
 
 If you like Guard::Cucumber, you can watch the repository at [GitHub](https://github.com/netzpirat/guard-cucumber)
 and follow [@netzpirat](https://twitter.com/#!/netzpirat) on Twitter for project updates.

data/lib/guard/cucumber.rb

@@ -1,18 +1,16 @@
-require 'guard'
-require 'guard/guard'
-require 'cucumber'
-require 'guard/cucumber/version'
+require "guard"
+require "guard/plugin"
+require "cucumber"
+require "guard/cucumber/version"
 
 module Guard
-
   # The Cucumber guard that gets notifications about the following
   # Guard events: `start`, `stop`, `reload`, `run_all` and `run_on_change`.
   #
-  class Cucumber < Guard
-
-    autoload :Runner, 'guard/cucumber/runner'
-    autoload :Inspector, 'guard/cucumber/inspector'
-    autoload :Focuser, 'guard/cucumber/focuser'
+  class Cucumber < Plugin
+    autoload :Runner, "guard/cucumber/runner"
+    autoload :Inspector, "guard/cucumber/inspector"
+    autoload :Focuser, "guard/cucumber/focuser"
 
     attr_accessor :last_failed, :failed_path
 
@@ -21,25 +19,31 @@ module Guard
     # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
     # @param [Hash] options the options for the Guard
     # @option options [String] :cli any arbitrary Cucumber CLI arguments
-    # @option options [Array<String>] :feature_sets a list of non-standard feature directory/ies
+    # @option options [Array<String>] :feature_sets a list of non-standard
+    # feature directory/ies
     # @option options [Boolean] :bundler use bundler or not
-    # @option options [Array<String>] :rvm a list of rvm version to use for the test
+    # @option options [Array<String>] :rvm a list of rvm version to use for the
+    # test
     # @option options [Boolean] :notification show notifications
-    # @option options [Boolean] :all_after_pass run all features after changed features pass
+    # @option options [Boolean] :all_after_pass run all features after changed
+    # features pass
     # @option options [Boolean] :all_on_start run all the features at startup
-    # @option options [Boolean] :keep_failed Keep failed features until they pass
-    # @option options [Boolean] :run_all run override any option when running all specs
-    # @option options [Boolean] :change_format use a different cucumber format when running individual features
+    # @option options [Boolean] :keep_failed Keep failed features until they
+    # pass
+    # @option options [Boolean] :run_all run override any option when running
+    # all specs
+    # @option options [Boolean] :change_format use a different cucumber format
+    # when running individual features
     #
-    def initialize(watchers = [], options = { })
-      super
+    def initialize(options = {})
+      super(options)
 
       @options = {
-          :all_after_pass => true,
-          :all_on_start   => true,
-          :keep_failed    => true,
-          :cli            => '--no-profile --color --format progress --strict',
-          :feature_sets   => ['features']
+        all_after_pass: true,
+        all_on_start: true,
+        keep_failed: true,
+        cli: "--no-profile --color --format progress --strict",
+        feature_sets: ["features"]
       }.update(options)
 
       @last_failed  = false
@@ -59,7 +63,9 @@ module Guard
     # @raise [:task_has_failed] when stop has failed
     #
     def run_all
-      passed = Runner.run(options[:feature_sets], options.merge(options[:run_all] || { }).merge(:message => 'Running all features'))
+      opts = options.merge(options[:run_all] || {})
+      opts.merge!(message: "Running all features")
+      passed = Runner.run(options[:feature_sets], opts)
 
       if passed
         @failed_paths = []
@@ -87,23 +93,17 @@ module Guard
     #
     def run_on_modifications(paths)
       paths += @failed_paths if @options[:keep_failed]
-      paths   = Inspector.clean(paths, options[:feature_sets])
-      options = @options[:change_format] ? change_format(@options[:change_format]) : @options
-      passed  = Runner.run(paths, paths.include?('features') ? options.merge({ :message => 'Running all features' }) : options)
+      paths = Inspector.clean(paths, options[:feature_sets])
 
-      if passed
-        # clean failed paths memory
-        @failed_paths -= paths if @options[:keep_failed]
-        # run all the specs if the changed specs failed, like autotest
-        run_all if @last_failed && @options[:all_after_pass]
-      else
-        # remember failed paths for the next change
-        @failed_paths += read_failed_features if @options[:keep_failed]
-        # track whether the changed feature failed for the next change
-        @last_failed = true
+      options = @options
+      if @options[:change_format]
+        options = change_format(@options[:change_format])
       end
 
-      throw :task_has_failed unless passed
+      msg = "Running all features"
+      options.merge!(message: msg) if paths.include?("features")
+
+      _run(paths, options)
     end
 
     private
@@ -116,9 +116,9 @@ module Guard
     def read_failed_features
       failed = []
 
-      if File.exist?('rerun.txt')
-        failed = File.open('rerun.txt') { |file| file.read.split(' ') }
-        File.delete('rerun.txt')
+      if File.exist?("rerun.txt")
+        failed = File.open("rerun.txt") { |file| file.read.split(" ") }
+        File.delete("rerun.txt")
       end
 
       failed
@@ -130,14 +130,31 @@ module Guard
     # @return [Hash] the new options
     #
     def change_format(format)
-      cli_parts = @options[:cli].split(' ')
+      cli_parts = @options[:cli].split(" ")
       cli_parts.each_with_index do |part, index|
-        if part == '--format' && cli_parts[index + 2] != '--out'
+        if part == "--format" && cli_parts[index + 2] != "--out"
           cli_parts[index + 1] = format
         end
       end
-      @options.merge(:cli => cli_parts.join(' '))
+      @options.merge(cli: cli_parts.join(" "))
     end
 
+    private
+
+    def _run(paths, options)
+      if Runner.run(paths, options)
+        # clean failed paths memory
+        @failed_paths -= paths if @options[:keep_failed]
+        # run all the specs if the changed specs failed, like autotest
+        run_all if @last_failed && @options[:all_after_pass]
+        return
+      end
+
+      # remember failed paths for the next change
+      @failed_paths += read_failed_features if @options[:keep_failed]
+      # track whether the changed feature failed for the next change
+      @last_failed = true
+      throw :task_has_failed
+    end
   end
 end

data/lib/guard/cucumber.rb.orig

@@ -0,0 +1,143 @@
+require 'guard'
+require 'guard/guard'
+require 'cucumber'
+require 'guard/cucumber/version'
+
+module Guard
+
+  # The Cucumber guard that gets notifications about the following
+  # Guard events: `start`, `stop`, `reload`, `run_all` and `run_on_change`.
+  #
+  class Cucumber < Guard
+
+    autoload :Runner, 'guard/cucumber/runner'
+    autoload :Inspector, 'guard/cucumber/inspector'
+    autoload :Focuser, 'guard/cucumber/focuser'
+
+    attr_accessor :last_failed, :failed_path
+
+    # Initialize Guard::Cucumber.
+    #
+    # @param [Array<Guard::Watcher>] watchers the watchers in the Guard block
+    # @param [Hash] options the options for the Guard
+    # @option options [String] :cli any arbitrary Cucumber CLI arguments
+    # @option options [Array<String>] :feature_sets a list of non-standard feature directory/ies
+    # @option options [Boolean] :bundler use bundler or not
+    # @option options [Array<String>] :rvm a list of rvm version to use for the test
+    # @option options [Boolean] :notification show notifications
+    # @option options [Boolean] :all_after_pass run all features after changed features pass
+    # @option options [Boolean] :all_on_start run all the features at startup
+    # @option options [Boolean] :keep_failed Keep failed features until they pass
+    # @option options [Boolean] :run_all run override any option when running all specs
+    # @option options [Boolean] :change_format use a different cucumber format when running individual features
+    #
+    def initialize(watchers = [], options = { })
+      super
+
+      @options = {
+          :all_after_pass => true,
+          :all_on_start   => true,
+          :keep_failed    => true,
+          :cli            => '--no-profile --color --format progress --strict',
+          :feature_sets   => ['features']
+      }.update(options)
+
+      @last_failed  = false
+      @failed_paths = []
+    end
+
+    # Gets called once when Guard starts.
+    #
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def start
+      run_all if @options[:all_on_start]
+    end
+
+    # Gets called when all specs should be run.
+    #
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def run_all
+      passed = Runner.run(options[:feature_sets], options.merge(options[:run_all] || { }).merge(:message => 'Running all features'))
+
+      if passed
+        @failed_paths = []
+      else
+        @failed_paths = read_failed_features if @options[:keep_failed]
+      end
+
+      @last_failed = !passed
+
+      throw :task_has_failed unless passed
+    end
+
+    # Gets called when the Guard should reload itself.
+    #
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def reload
+      @failed_paths = []
+    end
+
+    # Gets called when watched paths and files have changes.
+    #
+    # @param [Array<String>] paths the changed paths and files
+    # @raise [:task_has_failed] when stop has failed
+    #
+    def run_on_modifications(paths)
+      paths += @failed_paths if @options[:keep_failed]
+      paths   = Inspector.clean(paths, options[:feature_sets])
+      options = @options[:change_format] ? change_format(@options[:change_format]) : @options
+      passed  = Runner.run(paths, paths.include?('features') ? options.merge({ :message => 'Running all features' }) : options)
+
+      if passed
+        # clean failed paths memory
+        @failed_paths -= paths if @options[:keep_failed]
+        # run all the specs if the changed specs failed, like autotest
+        run_all if @last_failed && @options[:all_after_pass]
+      else
+        # remember failed paths for the next change
+        @failed_paths += read_failed_features if @options[:keep_failed]
+        # track whether the changed feature failed for the next change
+        @last_failed = true
+      end
+
+      throw :task_has_failed unless passed
+    end
+
+    private
+
+    # Read the failed features that from `rerun.txt`
+    #
+    # @see Guard::Cucumber::NotificationFormatter#write_rerun_features
+    # @return [Array<String>] the list of features
+    #
+    def read_failed_features
+      failed = []
+
+      if File.exist?('rerun.txt')
+        failed = File.open('rerun.txt') { |file| file.read.split(' ') }
+        File.delete('rerun.txt')
+      end
+
+      failed
+    end
+
+    # Change the `--format` cli option.
+    #
+    # @param [String] format the new format
+    # @return [Hash] the new options
+    #
+    def change_format(format)
+      cli_parts = @options[:cli].split(' ')
+      cli_parts.each_with_index do |part, index|
+        if part == '--format' && cli_parts[index + 2] != '--out'
+          cli_parts[index + 1] = format
+        end
+      end
+      @options.merge(:cli => cli_parts.join(' '))
+    end
+
+  end
+end

data/lib/guard/cucumber/focuser.rb

@@ -1,6 +1,5 @@
 module Guard
   class Cucumber
-
     # The Cucumber focuser updates cucumber feature paths to
     # focus on sections tagged with a provided focus_tag.
     #
@@ -18,7 +17,6 @@ module Guard
     #
     module Focuser
       class << self
-
         # Focus the supplied paths using the provided focus tag.
         #
         # @param [Array<String>] paths the locations of the feature files
@@ -31,12 +29,12 @@ module Guard
           paths.inject([]) do |updated_paths, path|
             focused_line_numbers = scan_path_for_focus_tag(path, focus_tag)
 
-            unless focused_line_numbers.empty?
+            if focused_line_numbers.empty?
+              updated_paths << path
+            else
               updated_paths << append_line_numbers_to_path(
                 focused_line_numbers, path
               )
-            else
-              updated_paths << path
             end
 
             updated_paths
@@ -48,14 +46,15 @@ module Guard
         #
         # @param [String] path the file path to search
         # @param [String] focus_tag the focus tag to look for in each path
-        # @return [Array<Integer>] the line numbers that include the focus tag in path
+        # @return [Array<Integer>] the line numbers that include the focus tag
+        # in path
         #
         def scan_path_for_focus_tag(path, focus_tag)
-          return [] if File.directory?(path) || path.include?(':')
+          return [] if File.directory?(path) || path.include?(":")
 
           line_numbers = []
 
-          File.open(path, 'r') do |file|
+          File.open(path, "r") do |file|
             while (line = file.gets)
               if line.include?(focus_tag)
                 line_numbers << file.lineno
@@ -68,16 +67,18 @@ module Guard
 
         # Appends the line numbers to the path
         #
-        # @param [Array<Integer>] line_numbers the line numbers to append to the path
-        # @param [String] path the path that will receive the appended line numbers
-        # @return [String] the string containing the path appended with the line number
+        # @param [Array<Integer>] line_numbers the line numbers to append to
+        # the path
+        # @param [String] path the path that will receive the appended line
+        # numbers
+        # @return [String] the string containing the path appended with the
+        # line number
         #
         def append_line_numbers_to_path(line_numbers, path)
-          line_numbers.each { |num| path += ':' + num.to_s }
+          line_numbers.each { |num| path += ":" + num.to_s }
 
           path
         end
-
       end
     end
   end

data/lib/guard/cucumber/focuser.rb.orig

@@ -0,0 +1,81 @@
+module Guard
+  class Cucumber
+    # The Cucumber focuser updates cucumber feature paths to
+    # focus on sections tagged with a provided focus_tag.
+    #
+    # For example, if the `foo.feature` file has the provided focus tag
+    # `@bar` on line 8, then the path will be updated using the cucumber
+    # syntax for focusing on a section:
+    #
+    # foo.feature:8
+    #
+    # If '@bar' is found on lines 8 and 16, the path is updated as follows:
+    #
+    # foo.feature:8:16
+    #
+    # The path is not updated if it does not contain the focus tag.
+    #
+    module Focuser
+      class << self
+        # Focus the supplied paths using the provided focus tag.
+        #
+        # @param [Array<String>] paths the locations of the feature files
+        # @param [String] focus_tag the focus tag to look for in each path
+        # @return [Array<String>] the updated paths
+        #
+        def focus(paths, focus_tag)
+          return false if paths.empty?
+
+          paths.inject([]) do |updated_paths, path|
+            focused_line_numbers = scan_path_for_focus_tag(path, focus_tag)
+
+            unless focused_line_numbers.empty?
+              updated_paths << append_line_numbers_to_path(
+                focused_line_numbers, path
+              )
+            else
+              updated_paths << path
+            end
+
+            updated_paths
+          end
+        end
+
+        # Checks to see if the file at path contains the focus tag
+        # It will return an empty array if the path is a directory.
+        #
+        # @param [String] path the file path to search
+        # @param [String] focus_tag the focus tag to look for in each path
+        # @return [Array<Integer>] the line numbers that include the focus tag in path
+        #
+        def scan_path_for_focus_tag(path, focus_tag)
+          return [] if File.directory?(path) || path.include?(":")
+
+          line_numbers = []
+
+          File.open(path, "r") do |file|
+            while (line = file.gets)
+              if line.include?(focus_tag)
+                line_numbers << file.lineno
+              end
+            end
+          end
+
+          line_numbers
+        end
+
+        # Appends the line numbers to the path
+        #
+        # @param [Array<Integer>] line_numbers the line numbers to append to the path
+        # @param [String] path the path that will receive the appended line numbers
+        # @return [String] the string containing the path appended with the line number
+        #
+        def append_line_numbers_to_path(line_numbers, path)
+          line_numbers.each { |num| path += ":" + num.to_s }
+
+          path
+        end
+      end
+    end
+  end
+end