linear-cli 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9dbcbc2f5187f96fc259c3255587676d654919430f20a62e734ed9e5b43dccd
-  data.tar.gz: 0ed365c14b74cb25b818037aff0f84abb03316bba52d7eb6b2705a06fc1d9b54
+  metadata.gz: bc273e12a3dd9e864894c2484bd08a203531da62873505b33d5706f13349e2c6
+  data.tar.gz: ffb38d1c66023c229bc98812fa55e4a58e29342adb46e96f63cf0054560a3964
 SHA512:
-  metadata.gz: 677845b48a38aa6b7c03323db68f69de36645516f84f9085f5cd3b5a30ac8e99cfb45d4e14122a5b48a308ca8470ffa33db3033db7cf7e6e5e17d44d50801226
-  data.tar.gz: c4f131d5548f80c8ab49cb0f85136bd38b04e13303dd66446488101c1a355b0b9939fa1c6e11fc23a37d7252a7039fe70e4ffe9150ce09c26ebc70b2a0d2326c
+  metadata.gz: 2323c788c7095f385320006a7be3b167b7dc9fc731c96a13ea5af48dcdec0dc013f8e6f55c71e9631022ae744a5faecbc34c8bda668c172cfb98d935c1af40a0
+  data.tar.gz: c8422224df18d500f92d1d8e0d90cd27f41cc8d0c148943b6f53f6e6269d67aae676f2fd006e9a4210199e5aae572e39e9b3bf46ddce2206f2880d88c3a78fac

data/CHANGELOG.md

@@ -2,8 +2,27 @@
 
 ## [Unreleased]
 
+## [0.6.0] - 2024-02-04
+
+## [0.5.5] - 2024-02-04
+### Added
+- Added lclose alias and 'issue update' subcommand (@bougyman)
+
+## [0.5.4] - 2024-02-04
+
+## [0.5.3] - 2024-02-03
+### Added
+- Added support for multiline descriptions without failing (@bougyman)
+
+### Changed
+- Changed default branch to use upstream default branch name (@bougyman)
+
 ## [0.5.2] - 2024-02-03
 ### Added
 - Added new changelog management system (changelog-rb) (@bougyman)
 
-[Unreleased]: https://github.com/rubyists/linear-cli/compare/v0.5.2...HEAD
+[Unreleased]: https://github.com/rubyists/linear-cli/compare/0.6.0...HEAD
+[0.6.0]: https://github.com/rubyists/linear-cli/compare/v0.5.5...0.6.0
+[0.5.5]: https://github.com/rubyists/linear-cli/compare/v0.5.4...v0.5.5
+[0.5.4]: https://github.com/rubyists/linear-cli/compare/v0.5.3...v0.5.4
+[0.5.3]: https://github.com/rubyists/linear-cli/compare/v0.5.2...v0.5.3

data/Readme.adoc

@@ -82,6 +82,7 @@ $ lc w --teams
 ----
 $ lcls
 $ lcls --full
+$ lcls -f CRY-1
 ----
 
 ==== Assign one or more issues to yourself (take em!)
@@ -100,7 +101,41 @@ $ lc issue take CRY-456 CRY-789
 
 [source,sh]
 ----
-$ lc i c --title "My new issue" --description "This is a new issue"
+$ lc i c --title "My new issue" --description "This is a new issue" --labels Bug,Feature --team CRY
+$ lc i c -t "My new issue" -T CRY -l Improvment,Feature
+----
+
+NOTE: If you don't provide a title, team, labels or description, you will be prompted to enter them.
+
+==== Develop an issue
+
+This will switch to the branch for the issue, creating the branch if it doesn't exist.
+
+'dev' is a shortcut for the 'develop' subcommand of the issue command
+
+[source,sh]
+----
+$ lc i dev CRY-1234
+----
+
+TIP: You may pass the --dev option to the create subcommand to immediately develop the creted issue.
+
+==== Update an issue
+
+All of the update options can work on multiple issues, so long as it's not more than 50
+at a time. You can also use the 'u' alias for 'update', and as always, the 'i' alias for 'issue'.
+
+===== Add a comment to one or more issues
+
+[source,sh]
+----
+$ lc issue update --comment "Here is a comment" CRY-1234
+----
+
+===== Close one or many issues
+
+[source,sh]
+----
+$ lc i u --close --reason "These were closable" CRY-1234 CRY-2
 ----
 
-NOTE: If you don't provide a title or description, you will be prompted to enter them.

data/changelog/0.5.3/added_support_for_multiline_descriptions_without_failing.yml

@@ -0,0 +1,4 @@
+type: Added
+title: >
+  Added support for multiline descriptions without failing
+author: bougyman

data/changelog/0.5.4/tag.yml

@@ -0,0 +1 @@
+date: 2024-02-04

data/changelog/0.5.5/added_lclose_alias_and_issue_update_subcommand.yml

@@ -0,0 +1,4 @@
+type: Added
+title: >
+  Added lclose alias and 'issue update' subcommand
+author: bougyman

data/changelog/0.5.5/tag.yml

@@ -0,0 +1 @@
+date: 2024-02-04

data/changelog/0.6.0/tag.yml

@@ -0,0 +1 @@
+date: 2024-02-04

data/exe/lclose

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+exec File.join(__dir__, 'lclose.sh'), *ARGV

data/exe/lclose.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+if [[ "$*" =~ "--help" ]]
+then
+    printf "This wrapper adds the --close option to the 'issue update' command.\n" >&2
+    printf "It is used to close one or many issues. The issues are specified by their ID/slugs.\n" >&2
+    printf "For closing multiple issues, you really want to pass --reason so you do not get prompted for each issue.\n\n" >&2
+    exec lc issue update --help
+fi
+exec lc issue update --close "$@"

data/lib/linear/api.rb

@@ -41,7 +41,13 @@ module Rubyists
       end
 
       def query(query)
-        call format('{ "query": "%s" }', query.to_s.gsub("\n", '').gsub('"', '\"'))
+        call format('{ "query": %s }', query.to_s.to_json)
+      rescue StandardError => e
+        logger.error('Error in query', query:, error: e)
+        raise e unless Rubyists::Linear.verbosity > 2
+
+        require 'pry'
+        binding.pry # rubocop:disable Lint/Debugger
       end
 
       def api_key
@@ -51,6 +57,7 @@ module Rubyists
         @api_key = ENV.fetch('LINEAR_API_KEY')
       end
     end
+    # Acts as a singleton for a GraphApi instance
     Api = Rubyists::Linear::GraphApi.new
   end
 end

data/lib/linear/cli/sub_commands.rb

@@ -47,10 +47,24 @@ module Rubyists
           ask_for_team
         end
 
+        def reason_for(reason = nil, four: nil)
+          return reason if reason
+
+          question = four ? "Reason for #{four}:" : 'Reason:'
+          prompt.ask(question)
+        end
+
+        def completed_state_for(thingy)
+          states = thingy.completed_states
+          return states.first if states.size == 1
+
+          prompt.select('Choose a completed state', states.to_h { |s| [s.name, s.id] })
+        end
+
         def description_for(description = nil)
           return description if description
 
-          prompt.multiline('Description:').join(' ')
+          prompt.multiline('Description:').map(&:chomp).join('\\n')
         end
 
         def title_for(title = nil)

data/lib/linear/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Rubyists
   module Linear
-    VERSION = '0.5.3'
+    VERSION = '0.6.0'
   end
 end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'semantic_logger'
+require 'git'
+require_relative '../issue'
+
+module Rubyists
+  # Namespace for Linear
+  module Linear
+    M :issue, :user, :label
+    # Namespace for CLI
+    module CLI
+      module Issue
+        Update = Class.new Dry::CLI::Command
+        # The Update class is a Dry::CLI::Command to update an issue
+        class Update
+          include SemanticLogger::Loggable
+          include Rubyists::Linear::CLI::CommonOptions
+          include Rubyists::Linear::CLI::Issue # for #gimme_da_issue! and other Issue methods
+          desc 'Update an issue'
+          argument :issue_ids, type: :array, required: true, desc: 'Issue IDs (i.e. ISS-1)'
+          option :comment, type: :string, aliases: ['--message'], desc: 'Comment to add to the issue'
+          option :pr, type: :boolean, aliases: ['--pull-request'], default: false, desc: 'Create a pull request'
+          option :close, type: :boolean, default: false, desc: 'Close the issue'
+          option :reason, type: :string, aliases: ['--close-reason'], desc: 'Reason for closing the issue'
+
+          def call(issue_ids:, **options)
+            logger.debug('Updating issues', issue_ids:, options:)
+            Rubyists::Linear::Issue.find_all(issue_ids).each do |issue|
+              update_issue(issue, **options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/linear/commands/issue.rb

@@ -12,13 +12,40 @@ module Rubyists
         include CLI::SubCommands
         # Aliases for Issue commands
         ALIASES = {
-          create: %w[c new add],        # aliases for the create command
-          develop: %w[d dev],           # aliases for the create command
-          list: %w[l ls],               # aliases for the list command
-          show: %w[s view v],           # aliases for the show command
-          issue: %w[i issues]           # aliases for the main issue command itself
+          create: %w[c new add], # aliases for the create command
+          develop: %w[d dev],    # aliases for the develop command
+          list: %w[l ls],        # aliases for the list command
+          update: %w[u],         # aliases for the close command
+          issue: %w[i issues]    # aliases for the main issue command itself
         }.freeze
 
+        def issue_comment(issue, comment)
+          issue.add_comment(comment)
+          prompt.ok("Comment added to #{issue.identifier}")
+        end
+
+        def close_issue(issue, **options)
+          reason = reason_for(options[:reason], four: "closing #{issue.identifier} - #{issue.title}")
+          issue_comment(issue, reason)
+          close_state = completed_state_for(issue)
+          issue.close!(state: close_state, trash: options[:trash])
+          prompt.ok("#{issue.identifier} was closed")
+        end
+
+        def issue_pr(issue)
+          issue.create_pr!
+          prompt.ok("Pull request created for #{issue.identifier}")
+        end
+
+        def update_issue(issue, **options)
+          issue_comment(issue, options[:comment]) if options[:comment]
+          return close_issue(issue, **options) if options[:close]
+          return issue_pr(issue) if options[:pr]
+
+          prompt.warn('No action taken, no options specified')
+          prompt.ok('Issue was not updated')
+        end
+
         def make_da_issue!(**options)
           # These *_for methods are defined in Rubyists::Linear::CLI::SubCommands
           title = title_for options[:title]
@@ -28,7 +55,7 @@ module Rubyists
           Rubyists::Linear::Issue.create(title:, description:, team:, labels:)
         end
 
-        def gimme_da_issue!(issue_id, me) # rubocop:disable Naming/MethodParameterName
+        def gimme_da_issue!(issue_id, me: Rubyists::Linear::User.me) # rubocop:disable Naming/MethodParameterName
           logger.trace('Looking up issue', issue_id:, me:)
           issue = Rubyists::Linear::Issue.find(issue_id)
           if issue.assignee && issue.assignee[:id] == me.id

data/lib/linear/models/base_model.rb

@@ -5,7 +5,9 @@ require 'semantic_logger'
 require 'sequel/extensions/inflector'
 
 module Rubyists
+  #  Namespace for Linear
   module Linear
+    L :api, :fragments
     # Module which provides a base model for Linear models.
     class BaseModel
       extend GQLi::DSL
@@ -32,6 +34,20 @@ module Rubyists
 
       # Class methods for Linear models.
       class << self
+        def has_one(relation, klass) # rubocop:disable Naming/PredicateName
+          define_method relation do
+            return instance_variable_get("@#{relation}") if instance_variable_defined?("@#{relation}")
+
+            instance_variable_set("@#{relation}", Rubyists::Linear.const_get(klass).new(data[relation]))
+          end
+
+          define_method "#{relation}=" do |val|
+            hash = val.is_a?(Hash) ? val : val.data
+            updated_data[relation] = hash
+            instance_variable_set("@#{relation}", Rubyists::Linear.const_get(klass).new(hash))
+          end
+        end
+
         def const_added(const)
           return unless const == :Base
 
@@ -108,6 +124,10 @@ module Rubyists
         data != updated_data
       end
 
+      def completed_states
+        workflow_states.select { |ws| ws.type == 'completed' }
+      end
+
       def to_h
         updated_data
       end

data/lib/linear/models/issue.rb

@@ -5,14 +5,13 @@ require 'gqli'
 module Rubyists
   # Namespace for Linear
   module Linear
-    L :api
-    L :fragments
-    M :base_model
-    M :user
+    M :base_model, :user
     Issue = Class.new(BaseModel)
     # The Issue class represents a Linear issue.
-    class Issue
+    class Issue # rubocop:disable Metrics/ClassLength
       include SemanticLogger::Loggable
+      has_one :assignee, :User
+      has_one :team, :Team
 
       BASIC_FILTER = { completedAt: { null: true } }.freeze
 
@@ -20,7 +19,6 @@ module Rubyists
         id
         identifier
         title
-        assignee { ___ User::Base }
         branchName
         description
         createdAt
@@ -28,33 +26,88 @@ module Rubyists
       end
 
       class << self
+        def base_fragment
+          @base_fragment ||= fragment('IssueWithTeams', 'Issue') do
+            ___ Base
+            assignee { ___ User.base_fragment }
+            team { ___ Team.base_fragment }
+          end
+        end
+
         def find(slug)
-          q = query { issue(id: slug) { ___ Base } }
+          q = query { issue(id: slug) { ___ Issue.base_fragment } }
           data = Api.query(q)
           raise NotFoundError, "Issue not found: #{slug}" if data.nil?
 
           new(data[:issue])
         end
 
+        def find_all(*slugs)
+          slugs.flatten.map { |slug| find(slug) }
+        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])
+          input[:labelIds] = label_ids unless label_ids.empty?
+          m = mutation { issueCreate(input:) { issue { ___ Issue.base_fragment } } }
+          query_data = Api.query(m)
+          new query_data.dig(:issueCreate, :issue)
         end
       end
 
-      def assign!(user)
+      def comment_fragment
+        @comment_fragment ||= fragment('Comment', 'Comment') do
+          id
+          body
+          url
+        end
+      end
+
+      # Reference for this mutation:
+      # https://studio.apollographql.com/public/Linear-API/variant/current/schema/reference/inputs/CommentCreateInput
+      def add_comment(comment)
+        id_for_this = identifier
+        comment_frag = comment_fragment
+        m = mutation { commentCreate(input: { issueId: id_for_this, body: comment }) { comment { ___ comment_frag } } }
+
+        query_data = Api.query(m)
+        query_data.dig(:commentCreate, :comment)
+        self
+      end
+
+      def close_mutation(close_state, trash: false)
         id_for_this = identifier
-        m = mutation { issueUpdate(id: id_for_this, input: { assigneeId: user.id }) { issue { ___ Base } } }
-        data = Api.query(m)
-        updated = data.dig(:issueUpdate, :issue)
+        input = { stateId: close_state.id }
+        input[:trash] = true if trash
+        mutation { issueUpdate(id: id_for_this, input:) { issue { ___ Issue.base_fragment } } }
+      end
+
+      def close!(state: nil, trash: false)
+        logger.warn "Using first completed state found: #{completed_states.first}" if state.nil?
+        state ||= completed_states.first
+        query_data = Api.query close_mutation(state, trash:)
+        updated = query_data.dig(:issueUpdate, :issue)
+        raise SmellsBad, "Unknown response for issue close: #{data} (should have :issueUpdate key)" if updated.nil?
+
+        @data = @updated_data = updated
+        self
+      end
+
+      def assign!(user)
+        this_id = identifier
+        m = mutation { issueUpdate(id: this_id, input: { assigneeId: user.id }) { issue { ___ Issue.base_fragment } } }
+        query_data = Api.query(m)
+        updated = query_data.dig(:issueUpdate, :issue)
         raise SmellsBad, "Unknown response for issue update: #{data} (should have :issueUpdate key)" if updated.nil?
 
-        Issue.new updated
+        @data = @updated_data = updated
+        self
+      end
+
+      def workflow_states
+        @workflow_states ||= team.workflow_states
       end
 
       def inspection
@@ -62,18 +115,26 @@ module Rubyists
       end
 
       def to_s
-        basic = format('%<id>-12s %<title>s', id: data[:identifier], title: data[:title])
+        basic = format('%<id>-12s %<title>s', id: identifier, title:)
         return basic unless (name = data.dig(:assignee, :name))
 
         format('%<basic>s (%<name>s)', basic:, name:)
       end
 
+      def parsed_description
+        return TTY::Markdown.parse(description) if description && !description.empty?
+
+        TTY::Markdown.parse(['# No Description For this issue??',
+                             'Issues really need description',
+                             "## What's up with that?"].join("\n"))
+      rescue StandardError => e
+        logger.error 'Error parsing description', e
+        "Description was unparsable: #{description}\n"
+      end
+
       def full
         sep = '-' * to_s.length
-        format("%<to_s>s\n%<sep>s\n%<description>s\n",
-               sep:,
-               to_s:,
-               description: (TTY::Markdown.parse(data[:description]) rescue 'No Description?')) # rubocop:disable Style/RescueModifier
+        format("%<to_s>s\n%<sep>s\n%<description>s\n", sep:, to_s:, description: parsed_description)
       end
 
       def display(options)

data/lib/linear/models/label.rb

@@ -31,14 +31,14 @@ module Rubyists
         fragment('LabelWithTeams', 'IssueLabel') do
           ___ Base
           parent { ___ Base }
-          team { ___ Team::Base }
+          team { ___ Team.base_fragment }
         end
       end
 
       def self.find_all_by_name(names)
         q = query do
           issueLabels(filter: { name: { in: names } }) do
-            edges { node { ___ Base } }
+            edges { node { ___ base_fragment } }
           end
         end
         data = Api.query(q)

data/lib/linear/models/team.rb

@@ -5,8 +5,7 @@ require 'gqli'
 module Rubyists
   # Namespace for Linear
   module Linear
-    L :api, :fragments
-    M :base_model, :issue, :user
+    M :base_model, :issue, :user, :workflow_state
     Team = Class.new(BaseModel)
     # The Issue class represents a Linear issue.
     class Team
@@ -96,6 +95,26 @@ module Rubyists
       def display(_options)
         printf "%s\n", full
       end
+
+      def workflow_states_query
+        team_id = id
+        query do
+          team(id: team_id) do
+            states do
+              nodes { ___ WorkflowState.base_fragment }
+            end
+          end
+        end
+      end
+
+      def workflow_states
+        return @workflow_states if @workflow_states
+
+        data = Api.query(workflow_states_query)
+        @workflow_states = data.dig(:team, :states, :nodes)&.map do |state|
+          WorkflowState.new state
+        end
+      end
     end
   end
 end

data/lib/linear/models/workflow_state.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'gqli'
+
+module Rubyists
+  # Namespace for Linear
+  module Linear
+    M :base_model
+    WorkflowState = Class.new(BaseModel)
+    # The WorkflowState class represents a Linear workflow state.
+    class WorkflowState
+      include SemanticLogger::Loggable
+
+      Base = fragment('BaseWorkflowState', 'WorkflowState') do
+        id
+        name
+        position
+        type
+        description
+        createdAt
+        updatedAt
+      end
+
+      def to_s
+        format('%<name>-12s %<type>s', name:, type:)
+      end
+
+      def inspection
+        format('name: "%<name>s" type: "%<type>s"', name:, type:)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linear-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -183,6 +183,8 @@ email:
 - tj@rubyists.com
 executables:
 - lc
+- lclose
+- lclose.sh
 - lcls
 - lcls.sh
 extensions: []
@@ -194,10 +196,17 @@ files:
 - Readme.adoc
 - changelog/0.5.2/added_new_changelog_management_system_changelog_rb.yml
 - changelog/0.5.2/tag.yml
+- changelog/0.5.3/added_support_for_multiline_descriptions_without_failing.yml
 - changelog/0.5.3/changed_default_branch_to_use_upstream_default_branch_name.yml
 - changelog/0.5.3/tag.yml
+- changelog/0.5.4/tag.yml
+- changelog/0.5.5/added_lclose_alias_and_issue_update_subcommand.yml
+- changelog/0.5.5/tag.yml
+- changelog/0.6.0/tag.yml
 - changelog/unreleased/.gitkeep
 - exe/lc
+- exe/lclose
+- exe/lclose.sh
 - exe/lcls
 - exe/lcls.sh
 - lib/linear.rb
@@ -213,6 +222,7 @@ files:
 - lib/linear/commands/issue/develop.rb
 - lib/linear/commands/issue/list.rb
 - lib/linear/commands/issue/take.rb
+- lib/linear/commands/issue/update.rb
 - lib/linear/commands/team.rb
 - lib/linear/commands/team/list.rb
 - lib/linear/commands/whoami.rb
@@ -223,6 +233,7 @@ files:
 - lib/linear/models/label.rb
 - lib/linear/models/team.rb
 - lib/linear/models/user.rb
+- lib/linear/models/workflow_state.rb
 - lib/linear/version.rb
 - linear-cli.gemspec
 - sig/linear/cli.rbs