guard 2.9.0 → 2.9.1

data/lib/guard/guardfile.rb

@@ -5,7 +5,7 @@ if Guard::Config.new.strict?
 else
   require "guard/deprecated/guardfile"
 
-  # TODO: deprecate this whole file
+  # TODO: remove this file in next major version
 
   module Guard
     unless Guard::Config.new.silence_deprecations?

data/lib/guard/guardfile/evaluator.rb

@@ -1,12 +1,11 @@
 require "guard/config"
+
 require "guard/options"
 require "guard/plugin"
 
-# TODO: this class shouldn't use notify directly
-require "guard/notifier"
-
 require "guard/dsl"
-require "guard/metadata"
+
+require "guard/deprecated/evaluator" unless Guard::Config.new.strict?
 
 module Guard
   module Guardfile
@@ -15,9 +14,30 @@ module Guard
     #
     # @see Guard::Dsl
     #
+    # TODO: rename this to a Locator or Loader or something
     class Evaluator
+      Deprecated::Evaluator.add_deprecated(self) unless Config.new.strict?
+
+      ERROR_NO_GUARDFILE = "No Guardfile found,"\
+        " please create one with `guard init`."
+
       attr_reader :options, :guardfile_path
 
+      ERROR_NO_PLUGINS = "No Guard plugins found in Guardfile,"\
+        " please add at least one."
+
+      class Error < RuntimeError
+      end
+
+      class NoGuardfileError < Error
+      end
+
+      class NoCustomGuardfile < Error
+      end
+
+      class NoPluginsError < Error
+      end
+
       def guardfile_source
         @source
       end
@@ -25,53 +45,50 @@ module Guard
       # Initializes a new Guard::Guardfile::Evaluator object.
       #
       # @option opts [String] guardfile the path to a valid Guardfile
-      # @option opts [String] guardfile_contents a string representing the
+      # @option opts [String] contents a string representing the
       # content of a valid Guardfile
       #
       def initialize(opts = {})
-        @evaluated = false
-        @source = nil
-        @guardfile_path = nil
+        @type = nil
+        @path = nil
+        @user_config = nil
 
-        valid_options = opts.select do |k, _|
-          [:guardfile, :guardfile_contents].include?(k.to_sym)
-        end
+        opts = _from_deprecated(opts)
 
-        @options = ::Guard::Options.new(valid_options)
+        if opts[:contents]
+          @type = :inline
+          @contents = opts[:contents]
+        else
+          if opts[:guardfile]
+            @type = :custom
+            @path = Pathname(opts[:guardfile]) # may be updated by _read
+          end
+        end
       end
 
       # Evaluates the DSL methods in the `Guardfile`.
       #
       # @example Programmatically evaluate a Guardfile
-      #   Guard::Guardfile::Evaluator.new.evaluate_guardfile
+      #   Guard::Guardfile::Evaluator.new.evaluate
       #
       # @example Programmatically evaluate a Guardfile with a custom Guardfile
       # path
       #
       #   options = { guardfile: '/Users/guardfile/MyAwesomeGuardfile' }
-      #   Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
+      #   Guard::Guardfile::Evaluator.new(options).evaluate
       #
       # @example Programmatically evaluate a Guardfile with an inline Guardfile
       #
-      #   options = { guardfile_contents: 'guard :rspec' }
-      #   Guard::Guardfile::Evaluator.new(options).evaluate_guardfile
+      #   options = { contents: 'guard :rspec' }
+      #   Guard::Guardfile::Evaluator.new(options).evaluate
       #
-      def evaluate_guardfile
-        _fetch_guardfile_contents
-        _instance_eval_guardfile(guardfile_contents)
-        Guard.add_builtin_plugins(guardfile_path)
-      end
+      def evaluate
+        inline? || _use_provided || _use_default!
 
-      # Re-evaluates the `Guardfile` to update
-      # the current Guard configuration.
-      #
-      def reevaluate_guardfile
-        # Don't re-evaluate inline Guardfile
-        return if @source == :inline
+        contents = _guardfile_contents
+        fail NoPluginsError, ERROR_NO_PLUGINS unless /guard/m =~ contents
 
-        _before_reevaluate_guardfile
-        evaluate_guardfile
-        _after_reevaluate_guardfile
+        Dsl.new.evaluate(contents, @path || "", 1)
       end
 
       # Tests if the current `Guardfile` contains a specific Guard plugin.
@@ -89,8 +106,13 @@ module Guard
       # @return [Boolean] whether the Guard plugin has been declared
       #
       def guardfile_include?(plugin_name)
-        /^\s*guard\s*\(?\s*['":]#{ plugin_name }['"]?/.
-          match _guardfile_contents_without_user_config
+        /^\s*guard\s*\(?\s*['":]#{plugin_name}['"]?/.match(@contents)
+      end
+
+      attr_reader :path
+
+      def custom?
+        @type == :custom
       end
 
       # Gets the content of the `Guardfile` concatenated with the global
@@ -107,41 +129,32 @@ module Guard
         [_guardfile_contents_without_user_config, config].compact.join("\n")
       end
 
+      def inline?
+        @type == :inline
+      end
+
       private
 
-      # Gets the content of the `Guardfile`.
-      #
-      # @return [String] the Guardfile content
-      #
       def _guardfile_contents_without_user_config
-        fail "BUG: no data - Guardfile wasn't evaluated" unless @evaluated
         @guardfile_contents || ""
       end
 
-      # Evaluates the content of the `Guardfile`.
-      #
-      # @param [String] contents the content to evaluate.
-      #
       def _instance_eval_guardfile(contents)
-        ::Guard::Dsl.new.instance_eval(contents, @guardfile_path || "", 1)
+        Dsl.new.evaluate(contents, @guardfile_path || "", 1)
       rescue => ex
         ::Guard::UI.error "Invalid Guardfile, original error is:\n#{ $! }"
         raise ex
       end
 
-      # Gets the content to evaluate and stores it into @guardfile_contents.
-      #
       def _fetch_guardfile_contents
         _use_inline || _use_provided || _use_default
         @evaluated = true
 
         return if _guardfile_contents_usable?
-        ::Guard::UI.error "No Guard plugins found in Guardfile,"\
+        UI.error "No Guard plugins found in Guardfile,"\
           " please add at least one."
       end
 
-      # Use the provided inline Guardfile if provided.
-      #
       def _use_inline
         source_from_option = @source.nil? && options[:guardfile_contents]
         inline = @source == :inline
@@ -155,130 +168,55 @@ module Guard
         true
       end
 
-      # Try to use the provided Guardfile. Exits Guard if the Guardfile cannot
-      # be found.
-      #
       def _use_provided
-        source_from_file = @source.nil? && options[:guardfile]
-        return false unless source_from_file || (@source == :custom)
-
-        @source = :custom
-
-        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
-          ::Guard::UI.error "No Guardfile exists at #{ options[:guardfile] }."
-          exit 1
-        end
-
+        return unless custom?
+        @path, @contents = _read(@path)
         true
-      end
-
-      # Try to use one of the default Guardfiles (local or home Guardfile).
-      # Exits Guard if no Guardfile is found.
-      #
-      def _use_default
-        if guardfile_path = _find_default_guardfile
-          @source = :default
-          _read_guardfile(guardfile_path)
-        else
-          ::Guard::UI.error \
-            "No Guardfile found, please create one with `guard init`."
-          exit 1
+      rescue Errno::ENOENT
+        fail NoCustomGuardfile, "No Guardfile exists at #{ @path }."
+      end
+
+      def _use_default!
+        @path, @contents = _read("Guardfile")
+        @type = :default
+      rescue Errno::ENOENT
+        begin
+          @path, @contents = _read("~/.Guardfile")
+          @type = :default
+        rescue Errno::ENOENT
+          fail NoGuardfileError, ERROR_NO_GUARDFILE
         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].detect do |path|
-          File.exist?(path)
-        end
-      end
-
-      # Reads the current `Guardfile` content.
-      #
-      # @param [String] guardfile_path the path to the Guardfile
-      #
-      def _read_guardfile(guardfile_path)
-        @guardfile_path     = guardfile_path
-        @guardfile_contents = File.read(guardfile_path)
-      rescue => ex
-        ::Guard::UI.error "Error reading file #{ guardfile_path }:"
-        ::Guard::UI.error ex.inspect
-        ::Guard::UI.error ex.backtrace
-        exit 1
-      end
-
-      # Stops Guard and clear internal state
-      # before the Guardfile will be re-evaluated.
-      #
-      def _before_reevaluate_guardfile
-        Guard::Runner.new.run(:stop)
-        ::Guard.reset_groups
-        ::Guard.reset_plugins
-        ::Guard.reset_scope
-        ::Guard::Notifier.disconnect
+      def _read(path)
+        full_path = Pathname(path).expand_path
+        [full_path, full_path.read]
+      rescue Errno::ENOENT
+        fail
+      rescue SystemCallError => e
+        ::Guard::UI.error "Error reading file #{full_path}:"
+        ::Guard::UI.error e.inspect
+        ::Guard::UI.error e.backtrace
+        abort
       end
 
-      # Starts Guard and notification and show a message
-      # after the Guardfile has been re-evaluated.
-      #
-      def _after_reevaluate_guardfile
-        ::Guard::Notifier.connect(::Guard.options)
-
-        if ::Guard.send(:_pluginless_guardfile?)
-          ::Guard::Notifier.notify(
-            "No plugins 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.setup_scope
-          Guard::Runner.new.run(:start)
-        end
+      def _guardfile_contents
+        @user_config ||= Pathname("~/.guard.rb").expand_path.read
+        [@contents, @user_config].compact.join("\n")
+      rescue Errno::ENOENT
+        @contents || ""
       end
 
-      # Tests if the current `Guardfile` content is usable.
-      #
-      # @return [Boolean] if the Guardfile is usable
-      #
       def _guardfile_contents_usable?
         guardfile_contents && guardfile_contents =~ /guard/m
       end
 
-      # 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.expand_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
-
-      # 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"))
+      def _from_deprecated(opts)
+        res = opts.dup
+        if opts.key?(:guardfile_contents)
+          res[:contents] = opts[:guardfile_contents]
+        end
+        res
       end
     end
   end

data/lib/guard/guardfile/generator.rb

@@ -1,6 +1,15 @@
 require "guard/ui"
 require "guard/plugin_util"
 
+# Add Pathname#binwrite to 1.9.3
+unless Pathname.instance_methods.include?(:binwrite)
+  class Pathname
+    def binwrite(*args)
+      IO.binwrite(to_s, *args)
+    end
+  end
+end
+
 module Guard
   module Guardfile
     # This class is responsible for generating the Guardfile and adding Guard'
@@ -9,7 +18,11 @@ module Guard
     # @see Guard::CLI
     #
     class Generator
-      attr_reader :options
+      require "guard"
+      require "guard/ui"
+
+      INFO_TEMPLATE_ADDED =
+        "%s template added to Guardfile, feel free to edit it"
 
       # The Guardfile template for `guard init`
       GUARDFILE_TEMPLATE = File.expand_path(
@@ -18,21 +31,11 @@ module Guard
 
       # The location of user defined templates
       begin
-        HOME_TEMPLATES = File.expand_path("~/.guard/templates")
+        HOME_TEMPLATES = Pathname("~/.guard/templates").expand_path
       rescue ArgumentError
         # home isn't defined.  Set to the root of the drive.  Trust that there
         # won't be user defined templates there
-        HOME_TEMPLATES = File.expand_path("/")
-      end
-
-      # Initialize a new `Guard::Guardfile::Generator` object.
-      #
-      # @param [Hash] options The options for creating a Guardfile
-      # @option options [Boolean] :abort_on_existence Whether to abort or not
-      #   when a Guardfile already exists
-      #
-      def initialize(options = {})
-        @options = options
+        HOME_TEMPLATES = Pathname("/").expand_path
       end
 
       # Creates the initial Guardfile template when it does not
@@ -41,13 +44,14 @@ module Guard
       # @see Guard::CLI#init
       #
       def create_guardfile
-        if !File.exist?("Guardfile")
-          ::Guard::UI.info "Writing new Guardfile to #{ Dir.pwd }/Guardfile"
-          FileUtils.cp(GUARDFILE_TEMPLATE, "Guardfile")
-        elsif options[:abort_on_existence]
-          ::Guard::UI.error "Guardfile already exists at #{ Dir.pwd }/Guardfile"
+        path = Pathname("Guardfile").expand_path
+        if path.exist?
+          _ui(:error, "Guardfile already exists at #{path}")
           abort
         end
+
+        _ui(:info, "Writing new Guardfile to #{path}")
+        FileUtils.cp(GUARDFILE_TEMPLATE, path.to_s)
       end
 
       # Adds the Guardfile template of a Guard plugin to an existing Guardfile.
@@ -58,33 +62,27 @@ module Guard
       #   initialize
       #
       def initialize_template(plugin_name)
+        guardfile = Pathname("Guardfile")
+
         plugin_util = ::Guard::PluginUtil.new(plugin_name)
-        # TODO: change to "plugin_class?" method
+        # TODO: change to "valid?" method
         if plugin_util.plugin_class(fail_gracefully: true)
           plugin_util.add_to_guardfile
-
-          begin
-            @options[:guardfile] = IO.read("Guardfile")
-          rescue Errno::ENOENT
-          end
-
-        elsif File.exist?(File.join(HOME_TEMPLATES, plugin_name))
-          content = File.read("Guardfile")
-
-          File.open("Guardfile", "wb") do |f|
-            f.puts(content)
-            f.puts("")
-            f.puts(File.read(File.join(HOME_TEMPLATES, plugin_name)))
-          end
-
-          ::Guard::UI.info \
-            "#{ plugin_name } template added to Guardfile, feel free to edit it"
-        else
-          const_name = plugin_name.downcase.gsub("-", "")
-          UI.error "Could not load 'guard/#{ plugin_name.downcase }'"\
-            " or '~/.guard/templates/#{ plugin_name.downcase }'"\
-            " or find class Guard::#{ const_name.capitalize }"
+          return
         end
+
+        template_code = (HOME_TEMPLATES + plugin_name).read
+        guardfile.binwrite(format("\n%s\n", template_code), open_args: ["a"])
+
+        _ui(:info, format(INFO_TEMPLATE_ADDED, plugin_name))
+
+      rescue Errno::ENOENT
+
+        name = plugin_name.downcase
+        class_name = name.gsub("-", "").capitalize
+        _ui(:error, "Could not load 'guard/#{name}'"\
+            " or '~/.guard/templates/#{name}'"\
+            " or find class Guard::#{class_name}")
       end
 
       # Adds the templates of all installed Guard implementations to an
@@ -95,6 +93,12 @@ module Guard
       def initialize_all_templates
         ::Guard::PluginUtil.plugin_names.each { |g| initialize_template(g) }
       end
+
+      private
+
+      def _ui(*args)
+        ::Guard::UI.send(*args)
+      end
     end
   end
 end