lib/guard/internals/session.rb

Summary

Maintainability
A
2 hrs
Test Coverage
# frozen_string_literal: true

require "guard/options"
require "guard/internals/debugging"
require "guard/internals/plugins"
require "guard/internals/groups"

module Guard
  # @private api
  module Internals
    # TODO: split into a commandline class and session (plugins, groups)
    # TODO: swap session and metadata
    class Session
      attr_reader :plugins, :groups

      DEFAULT_OPTIONS = {
        clear: false,
        debug: false,
        no_bundler_warning: false,

        # User defined scopes
        group: [],
        plugin: [],

        # Notifier
        notify: true,

        # Interactor
        no_interactions: false,

        # Guardfile options:
        guardfile: nil,
        inline: nil,

        # Listener options
        watchdirs: Dir.pwd,
        latency: nil,
        force_polling: false,
        wait_for_delay: nil,
        listen_on: nil
      }.freeze

      # Internal class to store group and plugin scopes
      ScopesHash = Struct.new(:groups, :plugins)

      def initialize(new_options = {})
        @engine = engine
        @options = Options.new(new_options, DEFAULT_OPTIONS)

        @plugins = Plugins.new
        @groups = Groups.new

        @guardfile_scopes = ScopesHash.new([], [])
        @cmdline_scopes = ScopesHash.new(
          Array(options.delete(:groups)) + Array(options.delete(:group)),
          Array(options.delete(:plugins)) + Array(options.delete(:plugin))
        )
        @interactor_scopes = ScopesHash.new([], [])

        @clear = @options[:clear]
        @debug = @options[:debug]
        @watchdirs = Array(@options[:watchdirs])
        @notify = @options[:notify]
        @interactor_name = @options[:no_interactions] ? :sleep : :pry_wrapper

        @guardfile_ignore = []
        @guardfile_ignore_bang = []

        @guardfile_notifier_options = {}

        # NOTE: must be set before anything calls Guard::UI.debug
        Debugging.start if debug?
      end

      def convert_scopes(entries)
        scopes = { plugins: [], groups: [] }
        unknown = []

        Array(entries).each do |entry|
          if plugin = plugins.find(entry)
            scopes[:plugins] << plugin.name.to_sym
          elsif group = groups.find(entry)
            scopes[:groups] << group.name.to_sym
          else
            unknown << entry
          end
        end

        [scopes, unknown]
      end

      def grouped_plugins(scopes = {})
        if scopes[:plugins]
          _retrieve_plugins(scopes).group_by(&:group)
        elsif scopes[:groups]
          _retrieve_groups(scopes).map do |group|
            [group, plugins.all(group: group.name)]
          end.to_h
        else
          _retrieve_plugins(_scopes_hash).group_by(&:group)
        end
      end

      def scope_titles(entries = [])
        scopes, = convert_scopes(entries)

        if scopes[:plugins].any?
          objects = _retrieve_plugins(scopes)
        elsif scopes[:groups].any?
          objects = _retrieve_groups(scopes)
        else
          if _current_scope_names(:plugins).empty? && _current_scope_names(:groups).empty?
            return ["all"]
          end

          objects = _retrieve_plugins(_scopes_hash)
        end

        objects.map(&:title)
      end

      def guardfile_scopes=(scope)
        opts = scope.dup

        @guardfile_scopes.groups = Array(opts.delete(:groups)) + Array(opts.delete(:group))
        @guardfile_scopes.plugins = Array(opts.delete(:plugins)) + Array(opts.delete(:plugin))

        fail "Unknown options: #{opts.inspect}" unless opts.empty?
      end

      def interactor_scopes=(scopes)
        @interactor_scopes.groups = Array(scopes[:groups])
        @interactor_scopes.plugins = Array(scopes[:plugins])
      end
      attr_reader :cmdline_scopes, :guardfile_scopes, :interactor_scopes

      attr_reader :guardfile_ignore
      def guardfile_ignore=(ignores)
        @guardfile_ignore += Array(ignores).flatten
      end

      attr_reader :guardfile_ignore_bang
      def guardfile_ignore_bang=(ignores)
        @guardfile_ignore_bang = Array(ignores).flatten
      end

      def clearing(flag)
        @clear = flag
      end

      def clearing?
        @clear
      end

      alias :clear? :clearing?

      def debug?
        @debug
      end

      def watchdirs
        @watchdirs_from_guardfile ||= nil
        @watchdirs_from_guardfile || @watchdirs || [Dir.pwd]
      end

      # set by Engine#_instantiate
      def watchdirs=(dirs)
        return if dirs.empty?

        @watchdirs_from_guardfile = dirs.map { |dir| File.expand_path(dir) }
      end

      def listener_args
        if @options[:listen_on]
          [:on, @options[:listen_on]]
        else
          listener_options = {}
          %i(latency force_polling wait_for_delay).each do |option|
            listener_options[option] = @options[option] if @options[option]
          end
          expanded_watchdirs = watchdirs.map { |dir| File.expand_path dir }
          [:to, *expanded_watchdirs, listener_options]
        end
      end

      def notify_options
        names = @guardfile_notifier_options.keys
        return { notify: false } if names.include?(:off)

        {
          notify: @options[:notify],
          notifiers: @guardfile_notifier_options
        }
      end

      def guardfile_notification=(config)
        @guardfile_notifier_options.merge!(config)
      end

      attr_reader :interactor_name, :options

      def to_s
        "#<#{self.class}:#{object_id}>"
      end
      alias_method :inspect, :to_s

      private

      attr_reader :engine

      def _current_scope_names(type)
        [interactor_scopes[type], cmdline_scopes[type], guardfile_scopes[type]].detect do |source|
          !source.empty?
        end || []
      end

      def _scopes_hash
        {
          plugins: _current_scope_names(:plugins),
          groups: _current_scope_names(:groups)
        }.dup.freeze
      end

      def _retrieve_plugins(scope)
        plugin_names = Array(scope[:plugins])
        plugin_names = plugins.all.map(&:name) if plugin_names.empty?
        plugin_names = Set.new(plugin_names)

        plugin_names.map { |plugin_name| plugins.find(plugin_name) }
      end

      def _retrieve_groups(scope)
        group_names = Array(scope[:groups])
        group_names = groups.all.map(&:name) if group_names.empty?
        group_names = Set.new(group_names)

        groups.all(group_names)
      end
    end
  end
end