guard 1.4.0 → 2.18.0

data/lib/guard/dsl.rb

@@ -1,469 +1,438 @@
-module Guard
+require "guard/guardfile/evaluator"
+require "guard/interactor"
+require "guard/notifier"
+require "guard/ui"
+require "guard/watcher"
+
+require "guard/deprecated/dsl" unless Guard::Config.new.strict?
+require "guard"
 
-  # The DSL class provides the methods that are used in each `Guardfile` to describe
-  # the behaviour of Guard.
+module Guard
+  # The Dsl class provides the methods that are used in each `Guardfile` to
+  # describe the behaviour of Guard.
   #
-  # The main keywords of the DSL are `guard` and `watch`. These are necessary to define
-  # the used Guard plugins and the file changes they are watching.
+  # The main keywords of the DSL are {#guard} and {#watch}. These are necessary
+  # to define the used Guard plugins and the file changes they are watching.
   #
-  # You can optionally group the Guard plugins with the `group` keyword and ignore and filter certain paths
-  # with the `ignore` and `filter` keywords.
+  # You can optionally group the Guard plugins with the {#group} keyword and
+  # ignore and filter certain paths with the {#ignore} and {#filter} keywords.
   #
-  # You can set your preferred system notification library with `notification` and pass
-  # some optional configuration options for the library. If you don't configure a library,
-  # Guard will automatically pick one with default options (if you don't want notifications,
-  # specify `:off` as library). @see ::Guard::Notifier for more information about the supported libraries.
+  # You can set your preferred system notification library with {#notification}
+  # and pass some optional configuration options for the library. If you don't
+  # configure a library, Guard will automatically pick one with default options
+  # (if you don't want notifications, specify `:off` as library). Please see
+  # {Notifier} for more information about the supported libraries.
   #
-  # A more advanced DSL use is the `callback` keyword that allows you to execute arbitrary
-  # code before or after any of the `start`, `stop`, `reload`, `run_all`, `run_on_changes`,
-  # `run_on_additions`, `run_on_modifications` and `run_on_removals` Guard plugins method. 
-  # You can even insert more hooks inside these methods.
-  # Please [checkout the Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for more details.
+  # A more advanced DSL use is the {#callback} keyword that allows you to
+  # execute arbitrary code before or after any of the {Plugin#start},
+  # {Plugin#stop}, {Plugin#reload}, {Plugin#run_all},
+  # {Plugin#run_on_changes}, {Plugin#run_on_additions},
+  # {Plugin#run_on_modifications} and {Plugin#run_on_removals}
+  # Guard plugins method.
+  # You can even insert more hooks inside these methods. Please [checkout the
+  # Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for
+  # more details.
   #
   # The DSL will also evaluate normal Ruby code.
   #
   # There are two possible locations for the `Guardfile`:
-  # - The `Guardfile` in the current directory where Guard has been started
-  # - The `.Guardfile` in your home directory.
-  #
-  # In addition, if a user configuration `.guard.rb` in your home directory is found, it will
-  # be appended to the current project `Guardfile`.
-  #
-  # @example A sample of a complex Guardfile
-  #
-  #   notification :growl
-  #
-  #   group 'frontend' do
-  #     guard 'passenger', :ping => true do
-  #       watch('config/application.rb')
-  #       watch('config/environment.rb')
-  #       watch(%r{^config/environments/.+\.rb})
-  #       watch(%r{^config/initializers/.+\.rb})
-  #     end
-  #
-  #     guard 'livereload', :apply_js_live => false do
-  #       watch(%r{^app/.+\.(erb|haml)})
-  #       watch(%r{^app/helpers/.+\.rb})
-  #       watch(%r{^public/javascripts/.+\.js})
-  #       watch(%r{^public/stylesheets/.+\.css})
-  #       watch(%r{^public/.+\.html})
-  #       watch(%r{^config/locales/.+\.yml})
-  #     end
-  #   end
-  #
-  #   group 'backend' do
-  #     # Reload the bundle when the Gemfile is modified
-  #     guard 'bundler' do
-  #       watch('Gemfile')
-  #     end
   #
-  #     # for big project you can fine tune the "timeout" before Spork's launch is considered failed
-  #     guard 'spork', :wait => 40 do
-  #       watch('Gemfile')
-  #       watch('config/application.rb')
-  #       watch('config/environment.rb')
-  #       watch(%r{^config/environments/.+\.rb})
-  #       watch(%r{^config/initializers/.+\.rb})
-  #       watch('spec/spec_helper.rb')
-  #     end
+  # * The `Guardfile` or `guardfile.rb` in the current directory where Guard
+  #   has been started
+  # * The `.Guardfile` in your home directory.
   #
-  #     # use RSpec 2, from the system's gem and with some direct RSpec CLI options
-  #     guard 'rspec', :version => 2, :cli => "--color --drb -f doc", :bundler => false do
-  #       watch('spec/spec_helper.rb')                                  { "spec" }
-  #       watch('app/controllers/application_controller.rb')            { "spec/controllers" }
-  #       watch('config/routes.rb')                                     { "spec/routing" }
-  #       watch(%r{^spec/support/(controllers|acceptance)_helpers\.rb}) { |m| "spec/#{m[1]}" }
-  #       watch(%r{^spec/.+_spec\.rb})
+  # In addition, if a user configuration `.guard.rb` in your home directory is
+  # found, it will be appended to the current project `Guardfile`.
   #
-  #       watch(%r{^app/controllers/(.+)_(controller)\.rb}) { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  #
-  #       watch(%r{^app/(.+)\.rb}) { |m| "spec/#{m[1]}_spec.rb" }
-  #       watch(%r{^lib/(.+)\.rb}) { |m| "spec/lib/#{m[1]}_spec.rb" }
-  #     end
-  #   end
+  # @see https://github.com/guard/guard/wiki/Guardfile-examples
   #
   class Dsl
+    Deprecated::Dsl.add_deprecated(self) unless Config.new.strict?
 
-    require 'guard'
-    require 'guard/dsl'
-    require 'guard/interactor'
-    require 'guard/notifier'
-    require 'guard/ui'
-    require 'guard/watcher'
-
-    # Deprecation message for the `ignore_paths` method
-    IGNORE_PATHS_DEPRECATION = <<-EOS.gsub(/^\s*/, '')
-      Starting with Guard v1.1 the use of the 'ignore_paths' Guardfile dsl method is deprecated.
-
-      Please replace that method with the better 'ignore' or/and 'filter' methods.
-      Documentation on the README: https://github.com/guard/guard#guardfile-dsl-ignore
-    EOS
-
-    class << self
-
-      @@options = nil
-
-      # Evaluate the DSL methods in the `Guardfile`.
-      #
-      # @option options [Array<Symbol,String>] groups the groups to evaluate
-      # @option options [String] guardfile the path to a valid Guardfile
-      # @option options [String] guardfile_contents a string representing the content of a valid Guardfile
-      # @raise [ArgumentError] when options are not a Hash
-      #
-      def evaluate_guardfile(options = {})
-        raise ArgumentError.new('No option hash passed to evaluate_guardfile!') unless options.is_a?(Hash)
-
-        @@options = options.dup
-
-        fetch_guardfile_contents
-        instance_eval_guardfile(guardfile_contents_with_user_config)
-      end
-
-      # Re-evaluate the `Guardfile` to update the current Guard configuration.
-      #
-      def reevaluate_guardfile
-        before_reevaluate_guardfile
-        ::Guard::Dsl.evaluate_guardfile(@@options)
-        after_reevaluate_guardfile
-      end
-
-      # Stop Guard and clear internal state
-      # before the Guardfile will be re-evaluated.
-      #
-      def before_reevaluate_guardfile
-        ::Guard.runner.run(:stop)
-        ::Guard.guards.clear
-        ::Guard.setup_groups
-        ::Guard::Notifier.clear_notifications
-
-        @@options.delete(:guardfile_contents)
-      end
-
-      # Start Guard and notification and show a message
-      # after the Guardfile has been re-evaluated.
-      #
-      def after_reevaluate_guardfile
-        ::Guard::Notifier.turn_on if ::Guard::Notifier.enabled?
-
-        if ::Guard.guards.empty?
-          ::Guard::Notifier.notify('No guards found in Guardfile, please add at least one.', :title => 'Guard re-evaluate', :image => :failed)
-        else
-          msg = 'Guardfile has been re-evaluated.'
-          ::Guard::UI.info(msg)
-          ::Guard::Notifier.notify(msg, :title => 'Guard re-evaluate')
-
-          ::Guard.runner.run(:start)
-        end
-      end
-
-      # Evaluate the content of the `Guardfile`.
-      #
-      # @param [String] contents the content to evaluate.
-      #
-      def instance_eval_guardfile(contents)
-        new.instance_eval(contents, @@options[:guardfile_path], 1)
-      rescue
-        ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
-      end
-
-      # Test if the current `Guardfile` contains a specific Guard plugin.
-      #
-      # @param [String] guard_name the name of the Guard
-      # @return [Boolean] whether the Guard has been declared
-      #
-      def guardfile_include?(guard_name)
-        guardfile_contents.match(/^guard\s*\(?\s*['":]#{ guard_name }['"]?/)
-      end
-
-      # Read 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)
-      rescue
-        ::Guard::UI.error("Error reading file #{ guardfile_path }")
-        exit 1
-      end
-
-      # Get the content to evaluate and stores it into
-      # 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
-
-        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
-        end
-
-        unless guardfile_contents_usable?
-          ::Guard::UI.error 'No Guard plugins found in Guardfile, please add at least one.'
-        end
-      end
-
-      # Get the content of the `Guardfile`.
-      #
-      # @return [String] the Guardfile content
-      #
-      def guardfile_contents
-        @@options ? @@options[:guardfile_contents] : ''
-      end
-
-      # Get the content of the `Guardfile` and the global
-      # user configuration file.
-      #
-      # @see #user_config_path
-      #
-      # @return [String] the Guardfile content
-      #
-      def guardfile_contents_with_user_config
-        config = File.read(user_config_path) if File.exist?(user_config_path)
-        [guardfile_contents, config].join("\n")
-      end
-
-      # Get the file path to the project `Guardfile`.
-      #
-      # @return [String] the path to the Guardfile
-      #
-      def guardfile_path
-        @@options ? @@options[:guardfile_path] : ''
-      end
-
-      # Tests if the current `Guardfile` content is usable.
-      #
-      # @return [Boolean] if the Guardfile is usable
-      #
-      def guardfile_contents_usable?
-        guardfile_contents && guardfile_contents.size >= 'guard :a'.size # Smallest Guard definition
-      end
-
-      # Gets the default path of the `Guardfile`. This returns the `Guardfile`
-      # from the current directory when existing, or the global `.Guardfile`
-      # at the home directory.
-      #
-      # @return [String] the path to the Guardfile
-      #
-      def guardfile_default_path
-        File.exist?(local_guardfile_path) ? local_guardfile_path : home_guardfile_path
-      end
-
-      private
-
-      # The path to the `Guardfile` that is located at
-      # the directory, where Guard has been started from.
-      #
-      # @return [String] the path to the local Guardfile
-      #
-      def local_guardfile_path
-        File.join(Dir.pwd, 'Guardfile')
-      end
-
-      # The path to the `.Guardfile` that is located at
-      # the users home directory.
-      #
-      # @return [String] the path to ~/.Guardfile
-      #
-      def home_guardfile_path
-        File.expand_path(File.join('~', '.Guardfile'))
-      end
+    # Wrap exceptions during parsing Guardfile
+    class Error < RuntimeError
+    end
 
-      # The path to the user configuration `.guard.rb`
-      # that is located at the users home directory.
-      #
-      # @return [String] the path to ~/.guard.rb
-      #
-      def user_config_path
-        File.expand_path(File.join('~', '.guard.rb'))
-      end
+    WARN_INVALID_LOG_LEVEL = "Invalid log level `%s` ignored. "\
+      "Please use either :debug, :info, :warn or :error."
 
-    end
+    WARN_INVALID_LOG_OPTIONS = "You cannot specify the logger options"\
+      " :only and :except at the same time."
 
     # Set notification options for the system notifications.
-    # You can set multiple notification, which allows you to show local
+    # You can set multiple notifications, which allows you to show local
     # system notifications and remote notifications with separate libraries.
     # You can also pass `:off` as library to turn off notifications.
     #
     # @example Define multiple notifications
-    #   notification :growl_notify
-    #   notification :ruby_gntp, :host => '192.168.1.5'
-    #
-    # @see Guard::Notifier for available notifier and its options.
+    #   notification :ruby_gntp
+    #   notification :ruby_gntp, host: '192.168.1.5'
     #
     # @param [Symbol, String] notifier the name of the notifier to use
-    # @param [Hash] options the notification library options
+    # @param [Hash] opts the notification library options
     #
-    def notification(notifier, options = {})
-      ::Guard::Notifier.add_notification(notifier.to_sym, options, false)
+    # @see Guard::Notifier for available notifier and its options.
+    #
+    def notification(notifier, opts = {})
+      Guard.state.session.guardfile_notification = { notifier.to_sym => opts }
     end
 
-    # Sets the interactor to use.
+    # Sets the interactor options or disable the interactor.
     #
-    # @example Use the readline interactor
-    #   interactor :readline
-    #
-    # @example Use the gets interactor
-    #   interactor :gets
+    # @example Pass options to the interactor
+    #   interactor option1: 'value1', option2: 'value2'
     #
     # @example Turn off interactions
     #   interactor :off
     #
-    def interactor(interactor)
-      ::Guard::Interactor.interactor = interactor.to_sym
+    # @param [Symbol, Hash] options either `:off` or a Hash with interactor
+    #   options
+    #
+    def interactor(options)
+      # TODO: remove dependency on Interactor (let session handle this)
+      case options
+      when :off
+        Interactor.enabled = false
+      when Hash
+        Interactor.options = options
+      end
     end
 
-    # Declares a group of Guard plugins to be run with `guard start --group group_name`.
+    # Declares a group of Guard plugins to be run with `guard start --group
+    #   group_name`.
     #
     # @example Declare two groups of Guard plugins
-    #
-    #   group 'backend' do
-    #     guard 'spork'
-    #     guard 'rspec'
+    #   group :backend do
+    #     guard :spork
+    #     guard :rspec
     #   end
     #
-    #   group 'frontend' do
-    #     guard 'passenger'
-    #     guard 'livereload'
+    #   group :frontend do
+    #     guard :passenger
+    #     guard :livereload
     #   end
     #
-    # @param [Symbol, String] name the group name called from the CLI
+    # @param [Symbol, String, Array<Symbol, String>] name the group name called
+    #   from the CLI
     # @param [Hash] options the options accepted by the group
-    # @yield a block where you can declare several guards
+    # @yield a block where you can declare several Guard plugins
     #
+    # @see Group
     # @see Guard.add_group
-    # @see Dsl#guard
-    # @see Guard::DslDescriber
+    # @see #guard
     #
-    def group(name, options = {})
-      @groups = @@options[:group] || []
-      name    = name.to_sym
+    def group(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      groups = args
 
-      if block_given? && (@groups.empty? || @groups.map(&:to_sym).include?(name))
-        ::Guard.add_group(name.to_s.downcase, options)
-        @current_group = name
+      groups.each do |group|
+        next unless group.to_sym == :all
+        fail ArgumentError, "'all' is not an allowed group name!"
+      end
 
-        yield if block_given?
+      if block_given?
+        groups.each do |group|
+          # TODO: let groups be added *after* evaluation
+          Guard.state.session.groups.add(group, options)
+        end
 
-        @current_group = nil
+        @current_groups ||= []
+        @current_groups.push(groups)
+
+        yield
+
+        @current_groups.pop
+      else
+        UI.error \
+          "No Guard plugins found in the group '#{ groups.join(', ') }',"\
+          " please add at least one."
       end
     end
 
-    # Declare a Guard plugin to be used when running `guard start`.
+    # Declares a Guard plugin to be used when running `guard start`.
     #
     # The name parameter is usually the name of the gem without
     # the 'guard-' prefix.
     #
     # The available options are different for each Guard implementation.
     #
-    # @example Declare a Guard
+    # @example Declare a Guard without `watch` patterns
+    #   guard :rspec
     #
-    #   guard 'rspec' do
+    # @example Declare a Guard with a `watch` pattern
+    #   guard :rspec do
+    #     watch %r{.*_spec.rb}
     #   end
     #
-    # @param [String] name the Guard name
-    # @param [Hash] options the options accepted by the Guard
+    # @param [String] name the Guard plugin name
+    # @param [Hash] options the options accepted by the Guard plugin
     # @yield a block where you can declare several watch patterns and actions
     #
-    # @see Guard.add_guard
-    # @see Dsl#group
-    # @see Dsl#watch
-    # @see Guard::DslDescriber
+    # @see Plugin
+    # @see Guard.add_plugin
+    # @see #watch
+    # @see #group
     #
     def guard(name, options = {})
-      @watchers  = []
-      @callbacks = []
-      @current_group ||= :default
+      @plugin_options = options.merge(watchers: [], callbacks: [])
 
       yield if block_given?
 
-      options.update(:group => @current_group)
-      ::Guard.add_guard(name.to_s.downcase, @watchers, @callbacks, options)
+      @current_groups ||= []
+      groups = @current_groups && @current_groups.last || [:default]
+      groups.each do |group|
+        opts = @plugin_options.merge(group: group)
+        # TODO: let plugins be added *after* evaluation
+        Guard.state.session.plugins.add(name, opts)
+      end
+
+      @plugin_options = nil
     end
 
-    # Define a pattern to be watched in order to run actions on file modification.
+    # Defines a pattern to be watched in order to run actions on file
+    # modification.
     #
     # @example Declare watchers for a Guard
-    #
-    #   guard 'rspec' do
+    #   guard :rspec do
     #     watch('spec/spec_helper.rb')
     #     watch(%r{^.+_spec.rb})
-    #     watch(%r{^app/controllers/(.+).rb}) { |m| 'spec/acceptance/#{m[1]}s_spec.rb' }
+    #     watch(%r{^app/controllers/(.+).rb}) do |m|
+    #       'spec/acceptance/#{m[1]}s_spec.rb'
+    #     end
     #   end
     #
-    # @param [String, Regexp] pattern the pattern to be watched by the guard
+    # @example Declare global watchers outside of a Guard
+    #   watch(%r{^(.+)$}) { |m| puts "#{m[1]} changed." }
+    #
+    # @param [String, Regexp] pattern the pattern that Guard must watch for
+    # modification
+    #
     # @yield a block to be run when the pattern is matched
     # @yieldparam [MatchData] m matches of the pattern
-    # @yieldreturn a directory, a filename, an array of directories / filenames, or nothing (can be an arbitrary command)
+    # @yieldreturn a directory, a filename, an array of
+    #   directories / filenames, or nothing (can be an arbitrary command)
     #
     # @see Guard::Watcher
-    # @see Dsl#guard
+    # @see #guard
     #
     def watch(pattern, &action)
-      @watchers << ::Guard::Watcher.new(pattern, action)
+      # Allow watches in the global scope (to execute arbitrary commands) by
+      # building a generic Guard::Plugin.
+      @plugin_options ||= nil
+      return guard(:plugin) { watch(pattern, &action) } unless @plugin_options
+
+      @plugin_options[:watchers] << Watcher.new(pattern, action)
     end
 
-    # Define a callback to execute arbitrary code before or after any of
-    # the `start`, `stop`, `reload`, `run_all`, `run_on_changes` `run_on_additions`, `run_on_modifications`
-    # and `run_on_removals` plugin method.
+    # Defines a callback to execute arbitrary code before or after any of
+    # the `start`, `stop`, `reload`, `run_all`, `run_on_changes`,
+    # `run_on_additions`, `run_on_modifications` and `run_on_removals` plugin
+    # method.
     #
-    # @param [Array] args the callback arguments
-    # @yield a block with listeners
+    # @example Add callback before the `reload` action.
+    #   callback(:reload_begin) { puts "Let's reload!" }
     #
-    # @see Guard::Hook
+    # @example Add callback before the `start` and `stop` actions.
     #
-    def callback(*args, &listener)
-      listener, events = args.size > 1 ? args : [listener, args[0]]
-      @callbacks << { :events => events, :listener => listener }
+    #   my_lambda = lambda do |plugin, event, *args|
+    #     puts "Let's #{event} #{plugin} with #{args}!"
+    #   end
+    #
+    #   callback(my_lambda, [:start_begin, :start_end])
+    #
+    # @param [Array] args the callback arguments
+    # @yield a callback block
+    #
+    def callback(*args, &block)
+      @plugin_options ||= nil
+      fail "callback must be called within a guard block" unless @plugin_options
+
+      block, events = if args.size > 1
+                        # block must be the first argument in that case, the
+                        # yielded block is ignored
+                        args
+                      else
+                        [block, args[0]]
+                      end
+      @plugin_options[:callbacks] << { events: events, listener: block }
     end
 
-    # @deprecated Ignore certain paths globally.
+    # Ignores certain paths globally.
     #
     # @example Ignore some paths
-    #   ignore_paths ".git", ".svn"
+    #   ignore %r{^ignored/path/}, /man/
     #
-    # @param [Array] paths the list of paths to ignore
+    # @param [Regexp] regexps a pattern (or list of patterns) for ignoring paths
     #
-    def ignore_paths(*paths)
-      ::Guard::UI.deprecation(IGNORE_PATHS_DEPRECATION)
+    def ignore(*regexps)
+      # TODO: use guardfile results class
+      Guard.state.session.guardfile_ignore = regexps
     end
 
-    # Ignore certain patterns paths globally.
+    # TODO: deprecate
+    alias filter ignore
+
+    # Replaces ignored paths globally
     #
-    # @example Ignore some paths
-    #   ignore %r{^ignored/path/}, /man/
+    # @example Ignore only these paths
+    #   ignore! %r{^ignored/path/}, /man/
     #
-    # @param [Regexp] regexps a pattern for ignoring paths
+    # @param [Regexp] regexps a pattern (or list of patterns) for ignoring paths
     #
-    def ignore(*regexps)
-      ::Guard.listener = ::Guard.listener.ignore(*regexps)
+    def ignore!(*regexps)
+      @ignore_regexps ||= []
+      @ignore_regexps << regexps
+      # TODO: use guardfile results class
+      Guard.state.session.guardfile_ignore_bang = @ignore_regexps
+    end
+
+    # TODO: deprecate
+    alias filter! ignore!
+
+    # Configures the Guard logger.
+    #
+    # * Log level must be either `:debug`, `:info`, `:warn` or `:error`.
+    # * Template supports the following placeholders: `:time`, `:severity`,
+    #   `:progname`, `:pid`, `:unit_of_work_id` and `:message`.
+    # * Time format directives are the same as `Time#strftime` or
+    #   `:milliseconds`.
+    # * The `:only` and `:except` options must be a `RegExp`.
+    #
+    # @example Set the log level
+    #   logger level: :warn
+    #
+    # @example Set a custom log template
+    #   logger template: '[Guard - :severity - :progname - :time] :message'
+    #
+    # @example Set a custom time format
+    #   logger time_format: '%h'
+    #
+    # @example Limit logging to a Guard plugin
+    #   logger only: :jasmine
+    #
+    # @example Log all but not the messages from a specific Guard plugin
+    #   logger except: :jasmine
+    #
+    # @param [Hash] options the log options
+    # @option options [String, Symbol] level the log level
+    # @option options [String] template the logger template
+    # @option options [String, Symbol] time_format the time format
+    # @option options [Regexp] only show only messages from the matching Guard
+    #   plugin
+    # @option options [Regexp] except does not show messages from the matching
+    #   Guard plugin
+    #
+    def logger(options)
+      if options[:level]
+        options[:level] = options[:level].to_sym
+
+        unless [:debug, :info, :warn, :error].include? options[:level]
+          UI.warning(format(WARN_INVALID_LOG_LEVEL, options[:level]))
+          options.delete :level
+        end
+      end
+
+      if options[:only] && options[:except]
+        UI.warning WARN_INVALID_LOG_OPTIONS
+
+        options.delete :only
+        options.delete :except
+      end
+
+      # Convert the :only and :except options to a regular expression
+      [:only, :except].each do |name|
+        next unless options[name]
+
+        list = [].push(options[name]).flatten.map do |plugin|
+          Regexp.escape(plugin.to_s)
+        end
+
+        options[name] = Regexp.new(list.join("|"), Regexp::IGNORECASE)
+      end
+
+      UI.options = UI.options.merge(options)
     end
 
-    # Filter certain patterns paths globally.
+    # Sets the default scope on startup
     #
-    # @example Filter some files
-    #   ignore /\.txt$/, /.*\.zip/
+    # @example Scope Guard to a single group
+    #   scope group: :frontend
     #
-    # @param [Regexp] regexps a pattern for filtering paths
+    # @example Scope Guard to multiple groups
+    #   scope groups: [:specs, :docs]
     #
-    def filter(*regexps)
-      ::Guard.listener = ::Guard.listener.filter(*regexps)
+    # @example Scope Guard to a single plugin
+    #   scope plugin: :test
+    #
+    # @example Scope Guard to multiple plugins
+    #   scope plugins: [:jasmine, :rspec]
+    #
+    # @param [Hash] scope the scope for the groups and plugins
+    #
+    def scope(scope = {})
+      # TODO: use a Guardfile::Results class
+      Guard.state.session.guardfile_scope(scope)
+    end
+
+    def evaluate(contents, filename, lineno) # :nodoc
+      instance_eval(contents, filename.to_s, lineno)
+    rescue StandardError, ScriptError => e
+      prefix = "\n\t(dsl)> "
+      cleaned_backtrace = _cleanup_backtrace(e.backtrace)
+      backtrace = "#{prefix}#{cleaned_backtrace.join(prefix)}"
+      msg = "Invalid Guardfile, original error is: \n\n%s, \nbacktrace: %s"
+      raise Error, format(msg, e, backtrace)
     end
 
+    # Sets the directories to pass to Listen
+    #
+    # @example watch only given directories
+    #   directories %w(lib specs)
+    #
+    # @param [Array] directories directories for Listen to watch
+    #
+    def directories(directories)
+      directories.each do |dir|
+        fail "Directory #{dir.inspect} does not exist!" unless Dir.exist?(dir)
+      end
+      Guard.state.session.watchdirs = directories
+    end
+
+    # Sets Guard to clear the screen before every task is run
+    #
+    # @example switching clearing the screen on
+    #   clearing(:on)
+    #
+    # @param [Symbol] on ':on' to turn on, ':off' (default) to turn off
+    #
+    def clearing(on)
+      Guard.state.session.clearing(on == :on)
+    end
+
+    private
+
+    def _cleanup_backtrace(backtrace)
+      dirs = { File.realpath(Dir.pwd) => ".", }
+
+      gem_env = ENV["GEM_HOME"] || ""
+      dirs[gem_env] = "$GEM_HOME" unless gem_env.empty?
+
+      gem_paths = (ENV["GEM_PATH"] || "").split(File::PATH_SEPARATOR)
+      gem_paths.each_with_index do |path, index|
+        dirs[path] = "$GEM_PATH[#{index}]"
+      end
+
+      backtrace.dup.map do |raw_line|
+        path = nil
+        symlinked_path = raw_line.split(":").first
+        begin
+          path = raw_line.sub(symlinked_path, File.realpath(symlinked_path))
+          dirs.detect { |dir, name| path.sub!(File.realpath(dir), name) }
+          path
+        rescue Errno::ENOENT
+          path || symlinked_path
+        end
+      end
+    end
   end
 end