Refactors CLI modules for more DRY

Author: bougyman

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    linear-cli (0.3.10)
+    linear-cli (0.3.11)
       base64 (~> 0.2)
       dry-cli (~> 1.0)
       dry-cli-completion (~> 1.0)
@@ -11,6 +11,7 @@ PATH
       sequel (~> 5.0)
       sqlite3 (~> 1.7)
       tty-markdown (~> 0.7)
+      tty-prompt (~> 0.23)
 
 GEM
   remote: https://rubygems.org/
@@ -173,16 +174,25 @@ GEM
       ffi (~> 1.1)
     thor (1.3.0)
     tty-color (0.6.0)
+    tty-cursor (0.7.1)
     tty-markdown (0.7.2)
       kramdown (>= 1.16.2, < 3.0)
       pastel (~> 0.8)
       rouge (>= 3.14, < 5.0)
       strings (~> 0.2.0)
       tty-color (~> 0.5)
       tty-screen (~> 0.8)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
     tty-screen (0.8.2)
     unicode-display_width (2.5.0)
     unicode_utils (1.4.0)
+    wisper (2.0.1)
 
 PLATFORMS
   ruby

lib/linear/cli.rb

@@ -3,72 +3,55 @@
 require 'dry/cli'
 require 'dry/cli/completion/command'
 require_relative '../linear'
+require 'semantic_logger'
 require 'tty-markdown'
+require 'tty-prompt'
 
 # The Rubyists module is the top-level namespace for all Rubyists projects
 module Rubyists
   module Linear
     # The CLI module is a Dry::CLI::Registry that contains all the commands
     module CLI
+      include SemanticLogger::Loggable
       extend Dry::CLI::Registry
 
-      # Watch for the call method to be added to a command
-      module Watcher
-        def self.extended(_mod)
-          define_method :method_added do |method_name|
-            return unless method_name == :call
-
-            prepend Rubyists::Linear::CLI::Caller
-          end
-        end
+      def self.prompt
+        @prompt ||= TTY::Prompt.new
       end
 
-      # The CommonOptions module contains common options for all commands
-      module CommonOptions
-        def self.included(mod)
-          mod.instance_eval do
-            extend Rubyists::Linear::CLI::Watcher
-            option :output, type: :string, default: 'text', values: %w[text json], desc: 'Output format'
-            option :debug, type: :integer, default: 0, desc: 'Debug level'
-          end
+      def self.register_sub!(command, sub_file, klass)
+        # The filename is expected to define a class of the same name, but capitalized
+        name = sub_file.basename('.rb').to_s
+        subklass = klass.const_get(name.capitalize)
+        if (aliases = klass::ALIASES[name.to_sym])
+          command.register name, subklass, aliases: Array(aliases)
+        else
+          command.register name, subklass
         end
+      end
 
-        def display(subject, options)
-          return puts(JSON.pretty_generate(subject)) if options[:output] == 'json'
-          return subject.each { |s| s.display(options) } if subject.respond_to?(:each)
-          unless subject.respond_to?(:display)
-            raise SmellsBad, "Cannot display #{subject}, there is no #display method and it is not a collection"
-          end
-
-          subject.display(options)
+      def self.register_subcommands!(command, name, klass)
+        Pathname.new(__FILE__).dirname.join("commands/#{name}").glob('*.rb').each do |file|
+          require file.expand_path
+          register_sub! command, file, klass
         end
       end
 
-      # This module is prepended to all commands to log their calls
-      module Caller
-        def self.prepended(_mod) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-          Caller.class_eval do
-            define_method :call do |**method_args| # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-              debug = method_args[:debug].to_i
-              Rubyists::Linear.verbosity = debug
-              logger.trace "Calling #{self.class} with #{method_args}"
-              super(**method_args)
-            rescue SmellsBad => e
-              logger.error e.message
-              exit 1
-            rescue NotFoundError => e
-              logger.error e.message
-            rescue StandardError => e
-              logger.error e.message
-              logger.error e.backtrace.join("\n") if Rubyists::Linear.verbosity.positive?
-              exit 5
-            end
-          end
+      def self.load_and_register!(command)
+        logger.debug "Registering #{command}"
+        name = command.name.split('::').last.downcase
+        command_aliases = command::ALIASES[name.to_sym] || []
+        register name, aliases: Array(command_aliases) do |cmd|
+          register_subcommands! cmd, name, command
         end
       end
     end
   end
 
+  Pathname.new(__FILE__).dirname.join('cli').glob('*.rb').each do |file|
+    require file.expand_path
+  end
+
   # Load all our commands
   Pathname.new(__FILE__).dirname.join('commands').glob('*.rb').each do |file|
     require file.expand_path

lib/linear/cli/caller.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Linear
+    module CLI
+      # This module is prepended to all commands to log their calls
+      module Caller
+        def self.prepended(mod) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+          # Global options for all commands
+          mod.instance_eval do
+            option :output, type: :string, default: 'text', values: %w[text json], desc: 'Output format'
+            option :debug, type: :integer, default: 0, desc: 'Debug level'
+          end
+          Caller.class_eval do
+            # Wraps the :call method so the debug option is honored, and we can trace the call
+            # as well as handle any exceptions that are raised
+            define_method :call do |**method_args| # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+              debug = method_args[:debug].to_i
+              Rubyists::Linear.verbosity = debug
+              logger.trace "Calling #{self.class} with #{method_args}"
+              super(**method_args)
+            rescue SmellsBad => e
+              logger.error e.message
+              exit 1
+            rescue NotFoundError => e
+              logger.error e.message
+            rescue StandardError => e
+              logger.error e.message
+              logger.error e.backtrace.join("\n") if Rubyists::Linear.verbosity.positive?
+              exit 5
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/linear/cli/common_options.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Linear
+    module CLI
+      # The CommonOptions module contains common options for all commands
+      module CommonOptions
+        def self.included(mod)
+          mod.instance_eval do
+            extend Rubyists::Linear::CLI::Watcher
+          end
+        end
+
+        def display(subject, options)
+          return puts(JSON.pretty_generate(subject)) if options[:output] == 'json'
+          return subject.each { |s| s.display(options) } if subject.respond_to?(:each)
+          unless subject.respond_to?(:display)
+            raise SmellsBad, "Cannot display #{subject}, there is no #display method and it is not a collection"
+          end
+
+          subject.display(options)
+        end
+      end
+    end
+  end
+end

lib/linear/cli/sub_commands.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Linear
+    module CLI
+      # The SubCommands module should be included in all commands with subcommands
+      module SubCommands
+        def self.included(mod)
+          mod.instance_eval do
+            def const_added(const)
+              return unless const == :ALIASES
+
+              Rubyists::Linear::CLI.load_and_register! self
+            end
+          end
+        end
+
+        def ask_for_team # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          teams = Rubyists::Linear::Team.mine
+          if teams.size == 1
+            logger.info('Only one team found, using it', team: teams.first.name)
+            teams.first
+          elsif teams.empty?
+            logger.error('No teams found for you. Please join a team or pass an existing team name.')
+            raise SmellsBad, 'No team given and none found for you'
+          else
+            prompt.on(:keypress) do |event|
+              prompt.trigger(:keydown) if event.value == 'j'
+              prompt.trigger(:keyup) if event.value == 'k'
+            end
+            key = prompt.select('Choose a team', teams.to_h { |t| [t.name, t.key] })
+            Rubyists::Linear::Team.find key
+          end
+        end
+
+        def prompt
+          @prompt ||= CLI.prompt
+        end
+
+        def team_for(key = nil)
+          return Team.find(key) if key
+
+          ask_for_team
+        end
+
+        def description_for(description = nil)
+          return description if description
+
+          prompt.multiline('Description:')
+        end
+
+        def title_for(title = nil)
+          return title if title
+
+          prompt.ask('Title:')
+        end
+
+        def labels_for(team, labels = nil)
+          return Rubyists::Linear::Label.find_all_by_name(labels.map(&:strip)) if labels
+
+          prompt.multi_select('Labels:', team.labels.to_h { |t| [t.name, t] })
+        end
+      end
+    end
+  end
+end

lib/linear/cli/watcher.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Linear
+    module CLI
+      # Watch for the call method to be added to a command
+      module Watcher
+        def self.extended(_mod)
+          define_method :method_added do |method_name|
+            return unless method_name == :call
+
+            prepend Rubyists::Linear::CLI::Caller
+          end
+        end
+      end
+    end
+  end
+end

lib/linear/commands/issue.rb

@@ -1,23 +1,38 @@
 # frozen_string_literal: true
 
+require_relative '../cli/sub_commands'
+
 module Rubyists
   module Linear
     # The Cli module is defined in cli.rb and is the top-level namespace for all CLI commands
     module CLI
+      # The Issue module is the namespace for all issue-related commands, and
+      # should be included in any command that deals with issues
       module Issue
-        # This ALIASES hash will return the key as the value if the key is not found,
-        # otherwise it will return the value of the existing key
-        ALIASES = Hash.new { |h, k| h[k] = k }.merge(
-          'list' => 'ls'
-        )
-      end
+        include CLI::SubCommands
+        # Aliases for Issue commands
+        ALIASES = {
+          create: %w[new add c],        # aliases for the create command
+          list: %w[l ls],               # aliases for the list command
+          show: %w[s view v display d], # aliases for the show command
+          issue: %w[i issues]           # aliases for the main issue command itself
+        }.freeze
+
+        def make_da_issue!(**options)
+          # These *_for methods are defined in Rubyists::Linear::CLI::SubCommands
+          title = title_for options[:title]
+          description = description_for options[:description]
+          team = team_for options[:team]
+          labels = labels_for team, options[:labels]
+          Rubyists::Linear::Issue.create(title:, description:, team:, labels:)
+        end
 
-      Pathname.new(__FILE__).dirname.join('issue').glob('*.rb').each do |file|
-        require file.expand_path
-        register 'issue', aliases: %w[i] do |issue|
-          basename = File.basename(file, '.rb')
-          # The filename is expected to define a class of the same name, but capitalized
-          issue.register Issue::ALIASES[basename], Issue.const_get(basename.capitalize)
+        def gimme_da_issue!(issue_id, me) # rubocop:disable Naming/MethodParameterName
+          issue = Rubyists::Linear::Issue.find(issue_id)
+          logger.debug 'Taking issue', issue:, assignee: me
+          updated = issue.assign! me
+          logger.debug 'Issue taken', issue: updated
+          updated
         end
       end
     end

lib/linear/commands/issue/create.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'semantic_logger'
+
+module Rubyists
+  # Namespace for Linear
+  module Linear
+    M :issue, :user, :label
+    # Namespace for CLI
+    module CLI
+      module Issue
+        Create = Class.new Dry::CLI::Command
+        # The Create class is a Dry::CLI::Command to create a new issue
+        class Create
+          include SemanticLogger::Loggable
+          include Rubyists::Linear::CLI::CommonOptions
+          include Rubyists::Linear::CLI::Issue # for #gimme_da_issue and other methods
+          desc 'Create a  new issue'
+          option :title, type: :string, aliases: ['-t'], desc: 'Issue Title'
+          option :team, type: :string, aliases: ['-T'], desc: 'Team Identifier'
+          option :description, type: :string, aliases: ['-d'], desc: 'Issue Description'
+          option :labels, type: :array, aliases: ['-l'], desc: 'Labels for the issue (Comma separated list)'
+
+          def call(**options)
+            logger.debug('Creating issue', options:)
+            issue = make_da_issue!(**options)
+            logger.debug('Issue created', issue:)
+          end
+        end
+      end
+    end
+  end
+end

lib/linear/commands/issue/take.rb

@@ -17,18 +17,10 @@ class Take
           desc 'Assign one or more issues to yourself'
           argument :issue_ids, type: :array, required: true, desc: 'Issue Identifiers'
 
-          def gimme_da_issue(issue_id, me) # rubocop:disable Naming/MethodParameterName
-            issue = Rubyists::Linear::Issue.find(issue_id)
-            logger.debug 'Taking issue', issue:, assignee: me
-            updated = issue.assign! me
-            logger.debug 'Issue taken', issue: updated
-            updated
-          end
-
           def call(issue_ids:, **options)
             me = Rubyists::Linear::User.me
             updates = issue_ids.map do |issue_id|
-              gimme_da_issue issue_id, me
+              gimme_da_issue! issue_id, me # gimme_da_issue! is defined in Rubyists::Linear::CLI::Issue
             rescue NotFoundError => e
               logger.warn e.message
               next