cli-mastermind 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9078a8e331150ebe62b1ecf44270422c93855b869510f34d57e983895a3b7fcf
-  data.tar.gz: c7bb2f6a630aa6b62319e409f238b88a1a81a4baa3a8e76737b1290e15efd2fc
+  metadata.gz: c548ef96d5f0b89113a1110cae2deae76be3c15fd4380727fe74c84bcda29766
+  data.tar.gz: f189bc224bc60e7ee496b5704df921b3cfd0d37ecb831990889c2666305628b8
 SHA512:
-  metadata.gz: 1ec54b9f8e61defa6dd76c40cdd6d46fbba1afb6e173e47f25e0042ed69b7ca4ae32d4dd75ca924af55c22f4a10e2f4f22d2ab907f71abac789e9b08248ed7f9
-  data.tar.gz: ef03260db00aa0062ed9514ae5bd6e201274d89778dccafa1f74b94c1bf2566665513e4ae4fd638b1c717e1586990275d3c4786a3952b721d6bd74849c3a4554
+  metadata.gz: cc898bb8b3ade138634ebd11fbcd6ab830c60e874528759acbbf9c95ba42b2db7a7d66551d34de8f379a74842bdf2850c2e81860cd66310cddcab86a49ce591c
+  data.tar.gz: b2f01d7795e3b1ec527d1d3e74ab53b8f9fe250c4e647c7af004b2569b92a463ba11254d136eceb14fe06ea6c8963dd857ffbfc58075bec00a3d5e7963d0eb58

data/lib/cli/mastermind.rb

@@ -7,6 +7,8 @@ require 'cli/mastermind/errors'
 require 'cli/mastermind/user_interface'
 require 'cli/mastermind/loader'
 require 'cli/mastermind/plan'
+require 'cli/mastermind/parent_plan'
+require 'cli/mastermind/executable_plan'
 require 'cli/mastermind/version'
 
 module CLI

data/lib/cli/mastermind/configuration.rb

@@ -76,16 +76,7 @@ module CLI
       # Loads all plan files added using +add_plans+
       # @see Plan.load
       def load_plans
-        @plans = {}
-
-        top_level_plan = Plan.new('temporary_plan')
-
-        @plan_files.each do |file|
-          plans = Plan.load file
-          top_level_plan.add_children plans
-        end
-
-        @plans = top_level_plan.children
+        @plans = Loader.load_all(@plan_files)
       end
 
       def execute_plan(*plan_stack, arguments: nil)

data/lib/cli/mastermind/executable_plan.rb

@@ -0,0 +1,14 @@
+module CLI
+  module Mastermind
+    class ExecutablePlan
+      include Plan
+
+      def call(options=nil)
+        case @block.arity
+        when 1, -1 then instance_exec(options, &@block)
+        else            instance_exec(&@block)
+        end
+      end
+    end
+  end
+end

data/lib/cli/mastermind/loader.rb

@@ -27,6 +27,19 @@ module CLI::Mastermind
       def load(filename)
         raise NotImplementedError
       end
+
+      # Loads a particular plan from the filesystem.
+      def load_all(files)
+        temp_plan = ParentPlan.new('temporary plan')
+
+        plans = files.map do |file|
+          ext = File.extname(file)
+          loader = Loader.find_loader(ext)
+          temp_plan.add_children loader.load(file)
+        end
+
+        temp_plan.children
+      end
     end
   end
 end

data/lib/cli/mastermind/loader/planfile_loader.rb

@@ -31,7 +31,7 @@ module CLI::Mastermind
         end
 
         def plot(name, &block)
-          plan = Plan.new name, @description, @filename
+          plan = ParentPlan.new name, @description, @filename
           @description = nil
           @plans << plan
           plan.add_children DSL.new(@filename, &block).plans
@@ -43,7 +43,7 @@ module CLI::Mastermind
         end
         alias_method :desc, :description
 
-        def plan(name, plan_class = Plan, &block)
+        def plan(name, plan_class = ExecutablePlan, &block)
           @plans << plan_class.new(name, @description, @filename, &block)
           @description = nil
         end

data/lib/cli/mastermind/parent_plan.rb

@@ -0,0 +1,61 @@
+module CLI
+  module Mastermind
+    class ParentPlan
+      include Plan
+
+      # Used in the interactive plan selector to display child plans
+      attr_reader :children
+
+      def initialize(name, description=nil, filename=nil, &block)
+        super
+
+        @children = {}
+      end
+
+      # Get the child plan with the specified +name+
+      def get_child(name)
+        @children[name]
+      end
+      alias_method :[], :get_child
+      alias_method :dig, :get_child
+
+      def add_children(plans)
+        raise InvalidPlanError, 'Cannot add child plans to a plan with an action' unless @block.nil?
+        plans.each(&method(:incorporate_plan))
+      end
+
+      def has_children?
+        true
+      end
+
+      private
+
+      def incorporate_plan(plan)
+        # If this namespace isn't taken just add the plan
+        if @children.has_key? plan.name
+
+          # Otherwise, we need to handle a name collision
+          existing_plan = @children[plan.name]
+
+          # If both plans have children, we merge them together
+          if existing_plan.has_children? and plan.has_children?
+            existing_plan.add_children plan.children.values
+
+            return existing_plan
+          end
+
+          # Otherwise, the plan defined later wins and overwrites the existing plan
+
+          # Warn the user that this is happening, unless we're running tests.
+          warn <<~PLAN_COLLISON.strip unless defined? RSpec
+                 Plan name collision encountered when loading plans from "#{plan.filename}" that cannot be merged.
+                 "#{plan.name}" was previously defined in "#{existing_plan.filename}".
+                 Plans from "#{plan.filename}" will be used instead.
+               PLAN_COLLISON
+        end
+
+        @children[plan.name] = plan
+      end
+    end
+  end
+end

data/lib/cli/mastermind/plan.rb

@@ -1,78 +1,62 @@
-require 'cli/mastermind/plan/interface'
-
 module CLI
   module Mastermind
-    class Plan
-      include Interface
-
-      # Used in the interactive plan selector to display child plans
-      attr_reader :children
-
-      # Loads a particular plan from the filesystem.
-      # @see Loader
-      def self.load(filename)
-        ext = File.extname(filename)
-        loader = Loader.find_loader(ext)
-        loader.load(filename)
+    # The plan interface is everything that is required in order for an object
+    # to be usable as a plan.
+    #
+    # Objects adhering to this interface must implement their own +call+ method.
+    # This method is what is invoked by Mastermind to execute a plan.
+    #
+    # Mastermind assumes that any plan it encounters could have children, hence
+    # the +has_children?+ method here.  Since the default PlanfileLoader doesn't
+    # permit custom plan classes when defining a plan with children, it's assumed
+    # that any custom plans (which include this interface) won't have any children
+    # at all.
+    module Plan
+      extend Forwardable
+
+      def self.included(base)
+        base.class_eval do
+          # The name of the plan.  Used to specify the plan from the command line
+          # or from the interactive menu
+          attr_reader :name
+
+          # Displayed in the non-interactive list of available plans
+          attr_reader :description
+
+          # The file this plan was loaded from, if any
+          attr_reader :filename
+
+          # Provides shorter names for the plan
+          attr_reader :aliases
+
+          include UserInterface
+        end
       end
 
       def initialize(name, description=nil, filename=nil, &block)
-        super
-
-        @children = {}
-      end
-
-      # Get the child plan with the specified +name+
-      def get_child(name)
-        @children[name]
-      end
-      alias_method :[], :get_child
-      alias_method :dig, :get_child
-
-      def add_children(plans)
-        raise InvalidPlanError, 'Cannot add child plans to a plan with an action' unless @block.nil?
-        plans.each(&method(:incorporate_plan))
+        @name = name.to_s.freeze
+        @description = description.freeze
+        @filename = filename
+        @block = block
+        @aliases = Set.new
       end
 
       def has_children?
-        @children.any?
+        false
       end
 
       def call(options=nil)
-        case @block.arity
-        when 1, -1 then instance_exec(options, &@block)
-        else            instance_exec(&@block)
-        end
+        raise NotImplementedError
       end
 
-      private
-
-      def incorporate_plan(plan)
-        # If this namespace isn't taken just add the plan
-        if @children.has_key? plan.name
-
-          # Otherwise, we need to handle a name collision
-          existing_plan = @children[plan.name]
-
-          # If both plans have children, we merge them together
-          if existing_plan.has_children? and plan.has_children?
-            existing_plan.add_children plan.children.values
-
-            return existing_plan
-          end
-
-          # Otherwise, the plan defined later wins and overwrites the existing plan
-
-          # Warn the user that this is happening, unless we're running tests.
-          warn <<~PLAN_COLLISON.strip unless defined? RSpec
-                 Plan name collision encountered when loading plans from "#{plan.filename}" that cannot be merged.
-                 "#{plan.name}" was previously defined in "#{existing_plan.filename}".
-                 Plans from "#{plan.filename}" will be used instead.
-               PLAN_COLLISON
-        end
-
-        @children[plan.name] = plan
+      def add_alias(alias_to)
+        config.define_alias(alias_to.to_s, name)
+        @aliases.add alias_to
       end
+
+      # Delegate configuration to the top-level configuration object
+      def_delegator :'CLI::Mastermind', :configuration
+      alias_method :config, :configuration
     end
   end
 end

data/lib/cli/mastermind/version.rb

@@ -7,7 +7,7 @@ module CLI
 
     module VERSION
       RELEASE = 0
-      MAJOR = 6
+      MAJOR = 7
       MINOR = 0
       PATCH = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-mastermind
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chris Hall
@@ -77,10 +77,11 @@ files:
 - lib/cli/mastermind/arg_parse.rb
 - lib/cli/mastermind/configuration.rb
 - lib/cli/mastermind/errors.rb
+- lib/cli/mastermind/executable_plan.rb
 - lib/cli/mastermind/loader.rb
 - lib/cli/mastermind/loader/planfile_loader.rb
+- lib/cli/mastermind/parent_plan.rb
 - lib/cli/mastermind/plan.rb
-- lib/cli/mastermind/plan/interface.rb
 - lib/cli/mastermind/user_interface.rb
 - lib/cli/mastermind/version.rb
 homepage: https://github.com/chall8908/cli-mastermind

data/lib/cli/mastermind/plan/interface.rb

@@ -1,62 +0,0 @@
-module CLI::Mastermind
-  class Plan
-    # The plan interface is everything that is required in order for an object
-    # to be usable as a plan.
-    #
-    # Objects adhering to this interface must implement their own +call+ method.
-    # This method is what is invoked by Mastermind to execute a plan.
-    #
-    # Mastermind assumes that any plan it encounters could have children, hence
-    # the +has_children?+ method here.  Since the default PlanfileLoader doesn't
-    # permit custom plan classes when defining a plan with children, it's assumed
-    # that any custom plans (which include this interface) won't have any children
-    # at all.
-    module Interface
-      extend Forwardable
-
-      def self.included(base)
-        base.class_eval do
-          # The name of the plan.  Used to specify the plan from the command line
-          # or from the interactive menu
-          attr_reader :name
-
-          # Displayed in the non-interactive list of available plans
-          attr_reader :description
-
-          # The file this plan was loaded from, if any
-          attr_reader :filename
-
-          # Provides shorter names for the plan
-          attr_reader :aliases
-
-          include UserInterface
-        end
-      end
-
-      def initialize(name, description=nil, filename=nil, &block)
-        @name = name.to_s.freeze
-        @description = description.freeze
-        @filename = filename
-        @block = block
-        @aliases = Set.new
-      end
-
-      def has_children?
-        false
-      end
-
-      def call(options=nil)
-        raise NotImplementedError
-      end
-
-      def add_alias(alias_to)
-        config.define_alias(alias_to.to_s, name)
-        @aliases.add alias_to
-      end
-
-      # Delegate configuration to the top-level configuration object
-      def_delegator :'CLI::Mastermind', :configuration
-      alias_method :config, :configuration
-    end
-  end
-end