guard 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e49133e02a08d182dd7ee09ca5dcee0a2e0949f5
-  data.tar.gz: 9a2ed142aa0a4c7b1c2bc224fddc951a428a93e4
+  metadata.gz: efd4e83bdc08e364c81e2d39245a9148e72534ba
+  data.tar.gz: 38e624d192902e6ca16f3851c9ef77503be1defa
 SHA512:
-  metadata.gz: 866934042ebebbef9855f9be0a9c620e49e7f62b51eabda81247d15e2ba1f07ca0fd28cfb4ddc946688bec86184021fc91a74be28f19e6179629f2d75b497190
-  data.tar.gz: a45d6770d5f5d2c03f12df7674a71682f8266f3ff55022a94bed99641b28cc012f3ff802cd637d807e98e4162cde64a0ca9de65d1d35f8f26bfec6e39ed3cbde
+  metadata.gz: 09f3d2477a9454d0d02499c77f6c62ff21f79ec113b4b38907c13f384ee884cbca53df241f41db39041d8f532f0afbc7014f5eddb29671c48ce305ae214e7d95
+  data.tar.gz: a31602bbbdea1643e9ebebe118e881aa1a899f895e3896013997914ace5ccae7c783b6598fbfdac8bec28abb2981d775ecb7927d94c35fd9b699033417e1c743

data/README.md

@@ -172,7 +172,7 @@ $ bundle exec guard -c # shortcut
 You can add the following snippet to your `~/.guardrc` to have the clear option always be enabled:
 
 ```
-Guard.options.clear = true
+Guard.options[:clear] = true
 ```
 
 #### `-n`/`--notify` option

data/lib/guard/dsl.rb

@@ -299,7 +299,7 @@ module Guard
         end
       end
 
-      ::Guard::UI.options = ::Guard::UI.options.marshal_dump.merge options
+      ::Guard::UI.options.merge!(options)
     end
 
     # Sets the default scope on startup

data/lib/guard/guardfile/evaluator.rb

@@ -1,3 +1,5 @@
+require 'guard/options'
+
 module Guard
   module Guardfile
 
@@ -16,7 +18,7 @@ module Guard
       # @option opts [String] guardfile_contents a string representing the content of a valid Guardfile
       #
       def initialize(opts = {})
-        @options = ::Guard::Options.new([:guardfile, :guardfile_contents].reduce({}) { |h, key| h[key] = opts[key]; h })
+        @options = ::Guard::Options.new(opts.select { |k, _| [:guardfile, :guardfile_contents].include?(k.to_sym) })
       end
 
       # Evaluates the DSL methods in the `Guardfile`.
@@ -84,7 +86,7 @@ module Guard
       #   the Guardfile has been specified via the `:guardfile_contents` option.
       #
       def guardfile_path
-        options.guardfile_path || ''
+        options[:guardfile_path] || ''
       end
 
       # Gets the content of the `Guardfile` concatenated with the global
@@ -103,21 +105,12 @@ module Guard
 
       private
 
-      # Gets the default path of the `Guardfile`. This returns the `Guardfile`
-      # from the current directory when existing, or the global `~/.Guardfile`.
-      #
-      # @return [String] the path to the Guardfile
-      #
-      def _guardfile_default_path
-        File.exist?(_local_guardfile_path) ? _local_guardfile_path : _home_guardfile_path
-      end
-
       # Gets the content of the `Guardfile`.
       #
       # @return [String] the Guardfile content
       #
       def _guardfile_contents_without_user_config
-        options.guardfile_contents || ''
+        options[:guardfile_contents] || ''
       end
 
       # Evaluates the content of the `Guardfile`.
@@ -125,7 +118,7 @@ module Guard
       # @param [String] contents the content to evaluate.
       #
       def _instance_eval_guardfile(contents)
-        ::Guard::Dsl.new.instance_eval(contents, options.guardfile_path, 1)
+        ::Guard::Dsl.new.instance_eval(contents, options[:guardfile_path], 1)
       rescue => ex
         ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
         raise ex
@@ -135,40 +128,65 @@ module Guard
       # the options as `:guardfile_contents`.
       #
       def _fetch_guardfile_contents
-        if options.guardfile_contents
-          ::Guard::UI.info 'Using inline Guardfile.'
-          options.guardfile_path = 'Inline Guardfile'
-
-        elsif options.guardfile
-          if File.exist?(options.guardfile)
-            _read_guardfile(options.guardfile)
-            ::Guard::UI.info "Using Guardfile at #{ options.guardfile }."
-          else
-            ::Guard::UI.error "No Guardfile exists at #{ options.guardfile }."
-            exit 1
-          end
+        _use_inline_guardfile || _use_provided_guardfile || _use_default_guardfile
 
+        unless _guardfile_contents_usable?
+          ::Guard::UI.error 'No Guard plugins found in Guardfile, please add at least one.'
+        end
+      end
+
+      # Use the provided inline Guardfile if provided.
+      #
+      def _use_inline_guardfile
+        return false unless options[:guardfile_contents]
+
+        ::Guard::UI.info 'Using inline Guardfile.'
+        options[:guardfile_path] = 'Inline Guardfile'
+      end
+
+      # Try to use the provided Guardfile. Exits Guard if the Guardfile cannot
+      # be found.
+      #
+      def _use_provided_guardfile
+        return false unless options[:guardfile]
+
+        options[:guardfile] = File.expand_path(options[:guardfile])
+        if File.exist?(options[:guardfile])
+          _read_guardfile(options[:guardfile])
+          ::Guard::UI.info "Using Guardfile at #{ options[:guardfile] }."
+          true
         else
-          if File.exist?(_guardfile_default_path)
-            _read_guardfile(_guardfile_default_path)
-          else
-            ::Guard::UI.error 'No Guardfile found, please create one with `guard init`.'
-            exit 1
-          end
+          ::Guard::UI.error "No Guardfile exists at #{ options[:guardfile] }."
+          exit 1
         end
+      end
 
-        unless _guardfile_contents_usable?
-          ::Guard::UI.error 'No Guard plugins found in Guardfile, please add at least one.'
+      # Try to use one of the default Guardfiles (local or home Guardfile).
+      # Exits Guard if no Guardfile is found.
+      #
+      def _use_default_guardfile
+        if guardfile_path = _find_default_guardfile
+          _read_guardfile(guardfile_path)
+        else
+          ::Guard::UI.error 'No Guardfile found, please create one with `guard init`.'
+          exit 1
         end
       end
 
+      # Returns the first default Guardfile (either local or home Guardfile)
+      # or nil otherwise.
+      #
+      def _find_default_guardfile
+        [_local_guardfile_path, _home_guardfile_path].find { |path| File.exist?(path) }
+      end
+
       # Reads the current `Guardfile` content.
       #
       # @param [String] guardfile_path the path to the Guardfile
       #
       def _read_guardfile(guardfile_path)
-        options.guardfile_path     = guardfile_path
-        options.guardfile_contents = File.read(guardfile_path)
+        options[:guardfile_path]     = guardfile_path
+        options[:guardfile_contents] = File.read(guardfile_path)
       rescue => ex
         ::Guard::UI.error ex.inspect
         ::Guard::UI.error("Error reading file #{ guardfile_path }")
@@ -182,9 +200,8 @@ module Guard
         ::Guard.runner.run(:stop)
         ::Guard.reset_groups
         ::Guard.reset_plugins
+        ::Guard.reset_scope
         ::Guard::Notifier.clear_notifiers
-
-        options.guardfile_contents
       end
 
       # Starts Guard and notification and show a message
@@ -218,7 +235,7 @@ module Guard
       # @return [String] the path to the local Guardfile
       #
       def _local_guardfile_path
-        File.join(Dir.pwd, 'Guardfile')
+        File.expand_path(File.join(Dir.pwd, 'Guardfile'))
       end
 
       # The path to the `.Guardfile` that is located at

data/lib/guard/notifier.rb

@@ -91,7 +91,7 @@ module Guard
     # Guard auto detects the first available library.
     #
     def turn_on
-      _auto_detect_notification if notifiers.empty? && (!::Guard.options || ::Guard.options.notify)
+      _auto_detect_notification if notifiers.empty? && (!::Guard.options || ::Guard.options[:notify])
 
       if notifiers.empty?
         turn_off

data/lib/guard/notifiers/base.rb

@@ -43,13 +43,13 @@ module Guard
       # @return [Boolean] the availability status
       #
       def self.available?(opts = {})
-        unless _supported_host?
+        if _supported_host?
+          true
+        else
           hosts = supported_hosts.map { |host| HOSTS[host.to_sym] }.join(', ')
           ::Guard::UI.error "The :#{name} notifier runs only on #{hosts}." unless opts.fetch(:silent) { false }
-          return false
+          false
         end
-
-        true
       end
 
       # This method must be overriden.

data/lib/guard/notifiers/emacs.rb

@@ -19,9 +19,15 @@ module Guard
       }
 
       def self.available?(opts = {})
-        super
-        result = `#{ opts.fetch(:client, DEFAULTS[:client]) } --eval '1' 2> #{DEV_NULL} || echo 'N/A'`
+        super and _emacs_client_available?(opts)
+      end
 
+      # @private
+      #
+      # @return [Boolean] whether or not the emacs client is available
+      #
+      def self._emacs_client_available?(opts)
+        result = `#{opts.fetch(:client, DEFAULTS[:client])} --eval '1' 2> #{DEV_NULL} || echo 'N/A'`
         !%w(N/A 'N/A').include?(result.chomp!)
       end
 

data/lib/guard/notifiers/file_notifier.rb

@@ -19,8 +19,7 @@ module Guard
       #   results will be written
       #
       def self.available?(opts = {})
-        super
-        opts.has_key?(:path)
+        super and opts.has_key?(:path)
       end
 
       # Writes the notification to a file. By default it writes type, title,

data/lib/guard/notifiers/gntp.rb

@@ -49,8 +49,7 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        require_gem_safely(opts)
+        super and require_gem_safely(opts)
       end
 
       # Shows a system notification.

data/lib/guard/notifiers/growl.rb

@@ -43,8 +43,25 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        _register!(opts) if require_gem_safely(opts)
+        super and require_gem_safely(opts) and _register!(opts)
+      end
+
+      # @private
+      #
+      # Detects if the Growl gem is available and if not, displays an
+      # error message unless `opts[:silent]` is true.
+      #
+      # @return [Boolean] whether or not Growl is installed
+      #
+      def self._register!(opts)
+        if ::Growl.installed?
+          true
+        else
+          unless opts[:silent]
+            ::Guard::UI.error "Please install the 'growlnotify' executable (available by installing the 'growl' gem)."
+          end
+          false
+        end
       end
 
       # Shows a system notification.
@@ -80,17 +97,6 @@ module Guard
         ::Growl.notify(message, opts)
       end
 
-      # @private
-      #
-      def self._register!(options)
-        unless ::Growl.installed?
-          ::Guard::UI.error "Please install the 'growlnotify' executable." unless options[:silent]
-          return false
-        end
-
-        true
-      end
-
     end
 
   end

data/lib/guard/notifiers/growl_notify.rb

@@ -32,8 +32,33 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        _register!(opts) if require_gem_safely(opts)
+        super and require_gem_safely(opts) and _register!(opts)
+      end
+
+      # @private
+      #
+      # Detects if the GrowlNotify gem is available and if not, displays an
+      # error message unless `opts[:silent]` is true. If it's available,
+      # GrowlNotify is configured for Guard.
+      #
+      # @return [Boolean] whether or not GrowlNotify is available
+      #
+      def self._register!(options)
+        if ::GrowlNotify.application_name != 'Guard'
+          ::GrowlNotify.config do |c|
+            c.notifications         = %w(success pending failed notify)
+            c.default_notifications = 'notify'
+            c.application_name      = 'Guard'
+          end
+        end
+
+        true
+
+      rescue ::GrowlNotify::GrowlNotFound
+        unless options[:silent]
+          ::Guard::UI.error 'Please install Growl from http://growl.info'
+        end
+        false
       end
 
       # Shows a system notification.
@@ -62,26 +87,6 @@ module Guard
         ::GrowlNotify.send_notification(opts)
       end
 
-      # @private
-      #
-      def self._register!(options)
-        if ::GrowlNotify.application_name != 'Guard'
-          ::GrowlNotify.config do |c|
-            c.notifications         = %w(success pending failed notify)
-            c.default_notifications = 'notify'
-            c.application_name      = 'Guard'
-          end
-        end
-
-        true
-
-      rescue ::GrowlNotify::GrowlNotFound
-        unless options[:silent]
-          ::Guard::UI.error 'Please install Growl from http://growl.info'
-        end
-        false
-      end
-
     end
 
   end

data/lib/guard/notifiers/libnotify.rb

@@ -35,8 +35,7 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        require_gem_safely(opts)
+        super and require_gem_safely(opts)
       end
 
       # Shows a system notification.

data/lib/guard/notifiers/notifysend.rb

@@ -25,8 +25,33 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        _register!(opts)
+        super and _register!(opts)
+      end
+
+      # @private
+      #
+      # @return [Boolean] whether or not the notify-send binary is available
+      #
+      def self._notifysend_binary_available?
+        !`which notify-send`.empty?
+      end
+
+      # @private
+      #
+      # Detects if the notify-send binary is available and if not, displays an
+      # error message unless `opts[:silent]` is true.
+      #
+      # @return [Boolean] whether or not the notify-send binary is available
+      #
+      def self._register!(opts)
+        if _notifysend_binary_available?
+          true
+        else
+          unless opts[:silent]
+            ::Guard::UI.error 'The :notifysend notifier runs only on Linux, FreeBSD, OpenBSD and Solaris with the libnotify-bin package installed.'
+          end
+          false
+        end
       end
 
       # Shows a system notification.
@@ -69,36 +94,15 @@ module Guard
       #
       # @param [String] command the command execute
       # @param [Array] supported list of supported option flags
-      # @param [Hash] options additional command options
+      # @param [Hash] opts additional command options
       # @return [Array<String>] the command and its options converted to a shell command.
       #
-      def _to_arguments(command, supported, options = {})
-        options.reduce(command) do |cmd, (flag, value)|
+      def _to_arguments(command, supported, opts = {})
+        opts.reduce(command) do |cmd, (flag, value)|
           supported.include?(flag) ? (cmd << "-#{ flag }" << value.to_s) : cmd
         end
       end
 
-      # @private
-      #
-      # @return [Boolean] whether or not the notify-send binary is available
-      #
-      def self._notifysend_binary_available?
-        !`which notify-send`.empty?
-      end
-
-      # @private
-      #
-      def self._register!(options)
-        unless _notifysend_binary_available?
-          unless options[:silent]
-            ::Guard::UI.error 'The :notifysend notifier runs only on Linux, FreeBSD, OpenBSD and Solaris with the libnotify-bin package installed.'
-          end
-          false
-        end
-
-        true
-      end
-
     end
 
   end

data/lib/guard/notifiers/rb_notifu.rb

@@ -41,8 +41,7 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        require_gem_safely(opts)
+        super and require_gem_safely(opts)
       end
 
       # Shows a system notification.

data/lib/guard/notifiers/terminal_notifier.rb

@@ -32,8 +32,7 @@ module Guard
       end
 
       def self.available?(opts = {})
-        super
-        _register!(opts) if require_gem_safely(opts)
+        super and require_gem_safely(opts) and _register!(opts)
       end
 
       # Shows a system notification.
@@ -62,11 +61,16 @@ module Guard
 
       # @private
       #
-      def self._register!(options)
+      # Detects if the terminal-notifier-guard gem is available and if not,
+      # displays an error message unless `opts[:silent]` is true.
+      #
+      # @return [Boolean] whether or not the terminal-notifier-guard gem is available
+      #
+      def self._register!(opts)
         if ::TerminalNotifier::Guard.available?
           true
         else
-          unless options[:silent]
+          unless opts[:silent]
             ::Guard::UI.error 'The :terminal_notifier only runs on Mac OS X 10.8 and later.'
           end
           false

data/lib/guard/notifiers/tmux.rb

@@ -35,15 +35,32 @@ module Guard
       }
 
       def self.available?(opts = {})
-        super
+        super and _register!(opts)
+      end
 
-        if ENV[opts.fetch(:tmux_environment, DEFAULTS[:tmux_environment])].nil?
+      # @private
+      #
+      # @return [Boolean] whether or not a TMUX environment is available
+      #
+      def self._tmux_environment_available?(opts)
+        !ENV[opts.fetch(:tmux_environment, DEFAULTS[:tmux_environment])].nil?
+      end
+
+      # @private
+      #
+      # Detects if a TMUX environment is available and if not,
+      # displays an error message unless `opts[:silent]` is true.
+      #
+      # @return [Boolean] whether or not a TMUX environment is available
+      #
+      def self._register!(opts)
+        if _tmux_environment_available?(opts)
+          true
+        else
           unless opts[:silent]
             ::Guard::UI.error 'The :tmux notifier runs only on when Guard is executed inside of a tmux session.'
           end
           false
-        else
-          true
         end
       end
 

data/lib/guard/options.rb

@@ -1,10 +1,10 @@
-require 'ostruct'
+require 'thor/core_ext/hash_with_indifferent_access'
 
 module Guard
 
   # A class that holds options. Can be instantiated with default options.
   #
-  class Options < OpenStruct
+  class Options < Thor::CoreExt::HashWithIndifferentAccess
 
     # Initializes an Guard::Options object. `default_opts` is merged into
     # `opts`.
@@ -13,7 +13,7 @@ module Guard
     # @param [Hash] default_opts the default options
     #
     def initialize(opts = {}, default_opts = {})
-      super(default_opts.dup.merge(opts.dup))
+      super(default_opts.merge(opts || {}))
     end
 
   end

data/lib/guard/plugin/base.rb

@@ -123,8 +123,8 @@ module Guard
       # Returns the plugin's name (without "guard-").
       #
       # @example Name for Guard::RSpec
-      #   > Guard::RSpec.new.name
-      #   => "rspec"
+      #   Guard::RSpec.new.name
+      #   #=> "rspec"
       #
       # @return [String]
       #
@@ -135,8 +135,8 @@ module Guard
       # Returns the plugin's class name without the Guard:: namespace.
       #
       # @example Title for Guard::RSpec
-      #   > Guard::RSpec.new.title
-      #   => "RSpec"
+      #   Guard::RSpec.new.title
+      #   #=> "RSpec"
       #
       # @return [String]
       #

data/lib/guard/setuper.rb

@@ -45,13 +45,13 @@ module Guard
       @watchdirs = [Dir.pwd]
       @runner    = ::Guard::Runner.new
 
-      if options.watchdir
+      if options[:watchdir]
         # Ensure we have an array
-        @watchdirs = Array(options.watchdir).map { |dir| File.expand_path dir }
+        @watchdirs = Array(options[:watchdir]).map { |dir| File.expand_path dir }
       end
 
       ::Guard::UI.clear(force: true)
-      _setup_debug if options.debug
+      _setup_debug if options[:debug]
       _setup_listener
       _setup_signal_traps
 
@@ -61,7 +61,7 @@ module Guard
 
       evaluate_guardfile
 
-      setup_scope(groups: options.group, plugins: options.plugin)
+      setup_scope(groups: options[:group], plugins: options[:plugin])
 
       _setup_notifier
 
@@ -71,7 +71,7 @@ module Guard
     # Lazy initializer for Guard's options hash
     #
     def options
-      @options ||= ::Guard::Options.new(@opts || {}, DEFAULT_OPTIONS)
+      @options ||= ::Guard::Options.new(@opts, DEFAULT_OPTIONS)
     end
 
     # Lazy initializer for Guardfile evaluator
@@ -83,7 +83,7 @@ module Guard
     # Lazy initializer the interactor unless the user has specified not to.
     #
     def interactor
-      return if options.no_interactions || !::Guard::Interactor.enabled
+      return if options[:no_interactions] || !::Guard::Interactor.enabled
 
       @interactor ||= ::Guard::Interactor.new
     end
@@ -163,7 +163,7 @@ module Guard
     #
     def _setup_debug
       Thread.abort_on_exception = true
-      ::Guard::UI.options.level = :debug
+      ::Guard::UI.options[:level] = :debug
       _debug_command_execution
     end
 
@@ -191,8 +191,8 @@ module Guard
       end
 
       listener_options = {}
-      %w[latency force_polling].each do |option|
-        listener_options[option.to_sym] = options.send(option) if options.send(option)
+      [:latency, :force_polling].each do |option|
+        listener_options[option] = options[option] if options[option]
       end
 
       listen_args = @watchdirs + [listener_options]
@@ -231,7 +231,7 @@ module Guard
     # Enables or disables the notifier based on user's configurations.
     #
     def _setup_notifier
-      if options.notify && ENV['GUARD_NOTIFY'] != 'false'
+      if options[:notify] && ENV['GUARD_NOTIFY'] != 'false'
         ::Guard::Notifier.turn_on
       else
         ::Guard::Notifier.turn_off

data/lib/guard/ui.rb

@@ -1,5 +1,6 @@
 require 'lumberjack'
 
+require 'guard/options'
 require 'guard/ui/colors'
 
 module Guard
@@ -20,8 +21,7 @@ module Guard
       #
       def logger
         @logger ||= begin
-          opts = options.marshal_dump
-          Lumberjack::Logger.new(opts.delete(:device) { $stderr }, opts)
+          Lumberjack::Logger.new(options.fetch(:device) { $stderr }, options)
         end
       end
 
@@ -82,7 +82,7 @@ module Guard
       # @option options [String] plugin manually define the calling plugin
       #
       def deprecation(message, options = {})
-        warning(message, options) if ::Guard.options.show_deprecations
+        warning(message, options) if ::Guard.options[:show_deprecations]
       end
 
       # Show a debug message that is prefixed with DEBUG and a timestamp.
@@ -104,7 +104,7 @@ module Guard
       # Clear the output if clearable.
       #
       def clear(options = {})
-        if ::Guard.options.clear && (@clearable || options[:force])
+        if ::Guard.options[:clear] && (@clearable || options[:force])
           @clearable = false
           system('clear;')
         end
@@ -150,8 +150,8 @@ module Guard
       # @yieldparam [String] param the calling plugin name
       #
       def _filter(plugin)
-        only   = options.only
-        except = options.except
+        only   = options[:only]
+        except = options[:except]
         plugin = plugin || calling_plugin_name
 
         if (!only && !except) || (only && only.match(plugin)) || (except && !except.match(plugin))

data/lib/guard/version.rb

@@ -1,3 +1,3 @@
 module Guard
-  VERSION = '2.0.3'
+  VERSION = '2.0.4'
 end

data/lib/guard/watcher.rb

@@ -89,7 +89,7 @@ module Guard
     # @return [Boolean] whether one of these files is the Guardfile
     #
     def self.match_guardfile?(files)
-      files.any? { |file| "#{ Dir.pwd }/#{ file }" == ::Guard.evaluator.guardfile_path }
+      files.any? { |file| File.expand_path(file) == ::Guard.evaluator.guardfile_path }
     end
 
     # Test the watchers pattern against a file.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Thibaud Guillaume-Gentil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor