linear-cli 0.3.10 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42beb6ec055c0604219c54ecd861a08e2e5fc367531cdacc76d7fdb4bd86f0f
-  data.tar.gz: 66b66a585dc37fc0f82dd31a9044d17dbc53b6b8d8f66288c62d9d7a05a8ddf3
+  metadata.gz: 78d3b6f808a137827fc21be0dd57daab6ef08fe4b54d6c2b428dec93e5801baa
+  data.tar.gz: 96e390ec3116a9cfd0ec844351ec0b9c86148f808ef9471a9bce37e95674c2b6
 SHA512:
-  metadata.gz: 54c653e2f07ce9ebf5483ee3e13ec98db266b9a6e6a1775e768bfbff7f3036da4d73bc15c7fbc49e73939e560ae7ec970e6283d62875390578f658490faa1835
-  data.tar.gz: f3caaa0bb9d299a2a753f899d416f20bd6a7de3a0b03a4496cc6a43810cb77cf31dd5d38a6676cb110e823e4f109daf90235f3c479f0106795adceb9d54ae320
+  metadata.gz: f9cfd202b19123a1c32b81995335f6947e40e204e50b588e9a059d508c495756de852f4cc3293f93590f14f1c9ad2a6c4978169d4a6e5a9dbd82c3d24f5e3478
+  data.tar.gz: b690c54cd0657929a45fea1bd68fe2621ea8afe4eefcf1af86f09575b04e8c864e9bc2a0a98523820406e6c6319b567aea98bfeba459a397a9de29efee6065ab

data/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

data/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

data/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 Rubyists::Linear::Team.find(key) if key
+
+          ask_for_team
+        end
+
+        def description_for(description = nil)
+          return description if description
+
+          prompt.multiline('Description:').join(' ')
+        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

data/lib/linear/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Rubyists
   module Linear
-    VERSION = '0.3.10'
+    VERSION = '0.4.1'
   end
 end

data/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

data/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

data/lib/linear/commands/issue/create.rb

@@ -0,0 +1,35 @@
+# 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:)
+            prompt.yes?('Do you want to take this issue?') && gimme_da_issue!(issue.id, User.me)
+            display issue, options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/linear/commands/issue/list.rb

@@ -38,7 +38,7 @@ module Rubyists
 
           def issues_for(options)
             logger.debug('Fetching issues', options:)
-            return options[:ids].map { |id| Rubyists::Linear::Issue.find(id) } if options[:ids]
+            return options[:ids].map { |id| Rubyists::Linear::Issue.find(id.upcase) } if options[:ids]
             return Rubyists::Linear::Issue.all(filter: { assignee: { null: true } }) if options[:unassigned]
             return Rubyists::Linear::User.me.issues if options[:mine]
 

data/lib/linear/commands/issue/take.rb

@@ -17,18 +17,10 @@ module Rubyists
           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

data/lib/linear/commands/issue.rb

@@ -1,21 +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
-      # 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'
-      )
+      # The Issue module is the namespace for all issue-related commands, and
+      # should be included in any command that deals with issues
+      module Issue
+        include CLI::SubCommands
+        # Aliases for Issue commands
+        ALIASES = {
+          create: %w[c new add],        # 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 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

data/lib/linear/commands/team/list.rb

@@ -31,10 +31,6 @@ module Rubyists
           prepend Rubyists::Linear::CLI::Caller
         end
       end
-
-      register 'team', aliases: %w[t] do |team|
-        team.register 'ls', Team::List
-      end
     end
   end
 end

data/lib/linear/commands/team.rb

@@ -1,5 +1,18 @@
 # frozen_string_literal: true
 
-Pathname.new(__FILE__).dirname.join('team').glob('*.rb').each do |file|
-  require file.expand_path
+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 Team module is the namespace for all team-related commands
+      module Team
+        include CLI::SubCommands
+        # Aliases for Team commands.
+        ALIASES = {
+          list: %w[ls l],   # aliases for the list command
+          team: %w[t teams] # aliases for the main team command itself
+        }.freeze
+      end
+    end
+  end
 end

data/lib/linear/commands/whoami.rb

@@ -14,7 +14,9 @@ module Rubyists
         include SemanticLogger::Loggable
         include Rubyists::Linear::CLI::CommonOptions
 
-        option :teams, type: :boolean, default: false, desc: 'Show teams'
+        desc 'Get your own user info'
+
+        option :teams, aliases: ['-t'], type: :boolean, default: false, desc: 'Show teams'
 
         def call(**options)
           logger.debug 'Getting user info'
@@ -23,7 +25,7 @@ module Rubyists
 
         prepend Rubyists::Linear::CLI::Caller
       end
-      register 'whoami', WhoAmI
+      register 'whoami', WhoAmI, aliases: %w[me w who whodat]
     end
   end
 end

data/lib/linear/models/issue.rb

@@ -34,6 +34,16 @@ module Rubyists
 
           new(data[:issue])
         end
+
+        def create(title:, description:, team:, labels: [])
+          team_id = team.id
+          label_ids = labels.map(&:id)
+          input = { title:, description:, teamId: team_id }
+          input.merge!(labelIds: label_ids) unless label_ids.empty?
+          m = mutation { issueCreate(input:) { issue { ___ Base } } }
+          data = Api.query(m)
+          new(data[:issueCreate][:issue])
+        end
       end
 
       def assign!(user)

data/lib/linear/models/label.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'gqli'
+
+module Rubyists
+  # Namespace for Linear
+  module Linear
+    L :api, :fragments
+    M :base_model, :issue, :user, :team
+    Label = Class.new(BaseModel)
+    # The Label class represents a Linear issue label.
+    class Label
+      include SemanticLogger::Loggable
+
+      Base = fragment('BaseLabel', 'IssueLabel') do
+        id
+        description
+        name
+        createdAt
+        updatedAt
+      end
+
+      def self.find_all_by_name(names)
+        q = query do
+          issueLabels(filter: { name: { in: names } }) do
+            edges { node { ___ Base } }
+          end
+        end
+        data = Api.query(q)
+        edges = data.dig(:issueLabels, :edges)
+        raise NotFoundError, "No labels found: #{names}" unless edges
+
+        edges.map { |edge| new edge[:node] }
+      end
+
+      def self.find_by_name(name)
+        them = find_all_by_name([name])
+        if them.size > 1
+          logger.warn('Found multiple matches for label name, using the first one returned', labels: them)
+        end
+        them.first
+      end
+
+      def to_s
+        format('%<name>s', name:)
+      end
+
+      def full
+        format('%<to_s>-10s %<description>s', description: , to_s:)
+      end
+
+      def display(_options)
+        printf "%s\n", full
+      end
+    end
+  end
+end

data/lib/linear/models/team.rb

@@ -12,6 +12,9 @@ module Rubyists
     class Team
       include SemanticLogger::Loggable
 
+      # TODO: Make this configurable
+      IgnoredLabels = [/-ios$/, /-android$/].freeze # rubocop:disable Naming/ConstantName
+
       Base = fragment('BaseTeam', 'Team') do
         description
         id
@@ -21,6 +24,17 @@ module Rubyists
         updatedAt
       end
 
+      def self.find(key)
+        q = query do
+          team(id: key) { ___ Base }
+        end
+        data = Api.query(q)
+        hash = data[:team]
+        raise NotFoundError, "Team not found: #{key}" unless hash
+
+        new hash
+      end
+
       def self.mine
         User.me.teams
       end
@@ -33,8 +47,34 @@ module Rubyists
         format('%<key>-6s %<to_s>s', key:, to_s:)
       end
 
+      def label_query
+        team_id = id
+        query do
+          team(id: team_id) do
+            labels do
+              nodes { ___ Label::Base }
+            end
+          end
+        end
+      end
+
+      def label_filter(labels = nil)
+        return [] unless labels
+
+        labels.reject { |label| IgnoredLabels.detect { |i| label.name.match? i } }
+      end
+
+      def labels
+        return @labels if @labels && !@labels.empty?
+
+        all = Api.query(label_query).dig(:team, :labels, :nodes)&.map do |label|
+          Label.new label
+        end
+        @labels = label_filter(all)
+      end
+
       def members
-        return @members unless @members.empty?
+        return @members if @members && !@members.empty?
 
         q = query do
           team(id:) do

data/lib/linear/models/user.rb

@@ -18,15 +18,17 @@ module Rubyists
         email
       end
 
-      WithTeams = fragment('UserWithTeams', 'User') do
-        ___ Base
-        teams do
-          nodes { ___ Team::Base }
+      def self.with_teams
+        @with_teams = fragment('UserWithTeams', 'User') do
+          ___ Base
+          teams do
+            nodes { ___ Team::Base }
+          end
         end
       end
 
       def self.me(teams: false)
-        fragment = teams ? WithTeams : Base
+        fragment = teams ? with_teams : Base
         q = query do
           viewer do
             ___ fragment

data/linear-cli.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sequel', '~> 5.0'
   spec.add_dependency 'sqlite3', '~> 1.7'
   spec.add_dependency 'tty-markdown', '~> 0.7'
+  spec.add_dependency 'tty-prompt', '~> 0.23'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linear-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.4.1
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
 description: A CLI for interacting with Linear.app. Loosely based on the GitHub CLI
 email:
 - tj@rubyists.com
@@ -156,8 +170,13 @@ files:
 - lib/linear.rb
 - lib/linear/api.rb
 - lib/linear/cli.rb
+- lib/linear/cli/caller.rb
+- lib/linear/cli/common_options.rb
+- lib/linear/cli/sub_commands.rb
 - lib/linear/cli/version.rb
+- lib/linear/cli/watcher.rb
 - lib/linear/commands/issue.rb
+- lib/linear/commands/issue/create.rb
 - lib/linear/commands/issue/list.rb
 - lib/linear/commands/issue/take.rb
 - lib/linear/commands/team.rb
@@ -167,6 +186,7 @@ files:
 - lib/linear/fragments.rb
 - lib/linear/models/base_model.rb
 - lib/linear/models/issue.rb
+- lib/linear/models/label.rb
 - lib/linear/models/team.rb
 - lib/linear/models/user.rb
 - lib/linear/version.rb