linear-cli 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c1343c813451d0c0d39f4d883a61856364dba86459c7fe6c1c784771998431
-  data.tar.gz: d40871678beca4fb383c3b569d367dd1434c0df81711b046ac9f970cf1bd8366
+  metadata.gz: ed24311870484d37b861be6bfe48af2edfc58b2c248764dd31f3f82a4ba282a5
+  data.tar.gz: c0404fc83e9157c97b75c1afa3fe0766a1d10838ea33e9284d380de6dde1d547
 SHA512:
-  metadata.gz: 73c3de969e83cfa59685ab2a264bce91c746dc110630a763a3e56f2e2b052fe0a4f0679ad4bba48d4ae23749c75f89db46fc9d45ce704abae793811db3db1000
-  data.tar.gz: 5e770e36384c62ef81f483cddd926b5cd7423ce71366146310eefb134e0675a4f349cdba22decb473e5bb0ff449be7372f2e66c4c3ce6681e9506bea5dfa6c6c
+  metadata.gz: 529c58e8cfa1a550e23de0ea5f3c9bb43d559f34b8c6648aa80bdc0238ee63be00282bf6166da82bf4c5be909dd5a8212e74cd74b92e42a6d1e58bc0de98e0f8
+  data.tar.gz: ee09439dfb8d39fbec79ec0206822a9261b340b4e9c0bc15cfb529dcc68a0e3138810833250972cbbd4a30bee1149f5e280b544193dfc414cb825aefe1c20218

data/Readme.adoc

@@ -3,6 +3,8 @@
 :toclevels: 3
 :sectanchors:
 :icons: font
+:tip-caption: 💡
+:note-caption: 📝
 :experimental:
 
 A command line interface to https://linear.app.
@@ -104,7 +106,7 @@ $ lc issue take CRY-456 CRY-789
 [source,sh]
 ----
 $ 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
+$ lc i c -t "My new issue" -T CRY -l Improvement,Feature
 ----
 
 NOTE: If you don't provide a title, team, labels or description, you will be prompted to enter them.
@@ -120,7 +122,7 @@ This will switch to the branch for the issue, creating the branch if it doesn't
 $ lc i dev CRY-1234
 ----
 
-TIP: You may pass the --dev option to the create subcommand to immediately develop the creted issue.
+TIP: You may pass the --dev option to the create subcommand to immediately develop the created issue.
 
 ==== Update an issue
 

data/exe/linear-cli

@@ -3,4 +3,11 @@
 
 require 'linear'
 Rubyists::Linear::L :cli
-Dry::CLI.new(Rubyists::Linear::CLI).call
+begin
+  Dir.mktmpdir(Process.pid.to_s) do |dir|
+    Rubyists::Linear.tmpdir = dir
+    Dry::CLI.new(Rubyists::Linear::CLI).call
+  end
+ensure
+  FileUtils.rm_rf(Rubyists::Linear.tmpdir) if Rubyists::Linear.tmpdir.exist?
+end

data/lib/linear/cli/sub_commands.rb

@@ -54,6 +54,14 @@ module Rubyists
           prompt.ask(question)
         end
 
+        def cancelled_state_for(thingy)
+          states = thingy.cancelled_states
+          return states.first if states.size == 1
+
+          selection = prompt.select('Choose a cancelled state', states.to_h { |s| [s.name, s.id] })
+          Rubyists::Linear::WorkflowState.find selection
+        end
+
         def completed_state_for(thingy)
           states = thingy.completed_states
           return states.first if states.size == 1

data/lib/linear/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Rubyists
   module Linear
-    VERSION = '0.7.5'
+    VERSION = '0.7.6'
   end
 end

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

@@ -18,18 +18,32 @@ module Rubyists
           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)'
+          argument :issue_ids, type: :array, required: true, desc: 'Issue IDs (i.e. CRY-1)'
           option :comment, type: :string, aliases: ['-m'], desc: 'Comment to add to the issue'
           option :pr, type: :boolean, aliases: ['--pull-request'], default: false, desc: 'Create a pull request'
+          option :cancel, type: :boolean, default: false, desc: 'Cancel the issue'
           option :close, type: :boolean, default: false, desc: 'Close the issue'
           option :reason, type: :string, aliases: ['--butwhy'], desc: 'Reason for closing the issue'
+          option :trash,
+                 type: :boolean,
+                 default: false,
+                 desc: 'Also trash the issue (--close and --cancel support this option)'
+
+          example [
+            '--comment "This is a comment" CRY-1 CRY2    # Add a comment to multiple issues',
+            '--pr CRY-10                                 # Create a pull request for the issue',
+            '--close CRY-2                               # Close an issue. Will be prompted for a reason',
+            '--close --reason "Done" CRY-1 CRY-2         # Close multiple issues with a reason',
+            '--cancel --trash --reason "Garbage" CRY-2   # Cancel an issue, and throw it in the trash'
+          ]
 
           def call(issue_ids:, **options)
-            prompt.error('You should provide at least one issue ID') && raise(SmellsBad) if issue_ids.empty?
+            raise SmellsBad, 'No issue IDs provided!' if issue_ids.empty?
+            raise SmellsBad, 'You may only open a PR against a single issue' if options[:pr] && issue_ids.size > 1
 
             logger.debug('Updating issues', issue_ids:, options:)
             Rubyists::Linear::Issue.find_all(issue_ids).each do |issue|
-              update_issue(issue, **options)
+              update_issue(issue, **options) # defined in lib/linear/commands/issue.rb
             end
           end
         end

data/lib/linear/commands/issue.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# This is where the #reason_for, #title_for, #description_for, #team_for, and #labels_for methods are defined
+# as well as other helpers which are used in multiple commands and subcommands
+# This is also where the #prompt method is defined, which is used to display messages to the user and get input
 require_relative '../cli/sub_commands'
 
 module Rubyists
@@ -27,12 +30,23 @@ module Rubyists
           prompt.ok("Comment added to #{issue.identifier}")
         end
 
+        def cancel_issue(issue, **options)
+          reason = reason_for(options[:reason], four: "cancelling #{issue.identifier} - #{issue.title}")
+          issue_comment(issue, reason)
+          cancel_state = cancel_state_for(issue)
+          issue.close!(state: cancel_state, trash: options[:trash])
+          prompt.ok("#{issue.identifier} was cancelled")
+        end
+
         def close_issue(issue, **options)
-          reason = reason_for(options[:reason], four: "closing #{issue.identifier} - #{issue.title}")
+          cancelled = options[:cancel]
+          doing = cancelled ? 'cancelling' : 'closing'
+          done = cancelled ? 'cancelled' : 'closed'
+          workflow_state = cancelled ? cancelled_state_for(issue) : completed_state_for(issue)
+          reason = reason_for(options[:reason], four: "#{doing} #{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")
+          issue.close!(state: workflow_state, trash: options[:trash])
+          prompt.ok("#{issue.identifier} was #{done}")
         end
 
         def issue_pr(issue)

data/lib/linear/models/base_model/class_methods.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Linear
+    class BaseModel
+      # Class methods for Linear models.
+      module ClassMethods
+        def many_to_one(relation, klass)
+          define_method relation do
+            return instance_variable_get("@#{relation}") if instance_variable_defined?("@#{relation}")
+            return unless (val = data[relation])
+
+            instance_variable_set("@#{relation}", Rubyists::Linear.const_get(klass).new(val))
+          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
+
+        alias one_to_one many_to_one
+
+        def find(id_val)
+          camel_name = just_name.camelize :lower
+          bf = base_fragment
+          query_data = Api.query(query { __node(camel_name, id: id_val) { ___ bf } })
+          new query_data[camel_name.to_sym]
+        end
+
+        def const_added(const)
+          return unless const == :Base
+
+          include MethodMagic
+        end
+
+        def allq(filter: nil, limit: 50, after: nil)
+          args = { first: limit }
+          args[:filter] = filter ? basic_filter.merge(filter) : basic_filter
+          args.delete(:filter) if args[:filter].empty?
+          args[:after] = after if after
+          all_query args, plural.to_s, base_fragment
+        end
+
+        def all_query(args, subject, base_fragment)
+          query do
+            __node(subject, args) do
+              edges do
+                node { ___ base_fragment }
+                cursor
+              end
+              ___ Fragments::PageInfo
+            end
+          end
+        end
+
+        def just_name
+          name.split('::').last
+        end
+
+        def base_fragment
+          const_get(:Base)
+        end
+
+        def basic_filter
+          return const_get(:BASIC_FILTER) if const_defined?(:BASIC_FILTER)
+
+          {}
+        end
+
+        def plural
+          return const_get(:PLURAL) if const_defined?(:PLURAL)
+
+          just_name.downcase.pluralize.to_sym
+        end
+
+        def gql_query(filter: nil, after: nil)
+          Api.query(allq(filter:, after:))
+        end
+
+        def all(after: nil, filter: nil, max: 100)
+          edges = []
+          moar = true
+          while moar
+            data = gql_query(filter:, after:)
+            subjects = data[plural]
+            edges += subjects[:edges]
+            moar = false if edges.size >= max || !subjects[:pageInfo][:hasNextPage]
+            after = subjects[:pageInfo][:endCursor]
+          end
+          edges.map { |edge| new edge[:node] }
+        end
+      end
+    end
+  end
+end

data/lib/linear/models/base_model/method_magic.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Rubyists
+  module Linear
+    class BaseModel
+      # Methods for Linear models.
+      module MethodMagic
+        def self.included(base) # rubocop:disable Metrics/MethodLength
+          base.instance_eval do
+            base.base_fragment.__nodes.each do |node|
+              sym = node.__name.to_sym
+              define_method node.__name do
+                updated_data[sym]
+              end
+
+              define_method "#{node.__name}=" do |value|
+                updated_data[sym] = value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/linear/models/base_model.rb

@@ -8,120 +8,17 @@ module Rubyists
   #  Namespace for Linear
   module Linear
     L :api, :fragments
-    # Module which provides a base model for Linear models.
+    M 'base_model/method_magic', 'base_model/class_methods'
+    # The base model for all Linear models
     class BaseModel
       extend GQLi::DSL
       include GQLi::DSL
       include SemanticLogger::Loggable
-
-      # Methods for Linear models.
-      module MethodMagic
-        def self.included(base) # rubocop:disable Metrics/MethodLength
-          base.instance_eval do
-            base.base_fragment.__nodes.each do |node|
-              sym = node.__name.to_sym
-              define_method node.__name do
-                updated_data[sym]
-              end
-
-              define_method "#{node.__name}=" do |value|
-                updated_data[sym] = value
-              end
-            end
-          end
-        end
-      end
-
-      # Class methods for Linear models.
-      class << self
-        def one_to_one(relation, klass)
-          define_method relation do
-            return instance_variable_get("@#{relation}") if instance_variable_defined?("@#{relation}")
-            return unless (val = data[relation])
-
-            instance_variable_set("@#{relation}", Rubyists::Linear.const_get(klass).new(val))
-          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 find(id_val)
-          camel_name = just_name.camelize :lower
-          bf = base_fragment
-          query_data = Api.query(query { __node(camel_name, id: id_val) { ___ bf } })
-          new query_data[camel_name.to_sym]
-        end
-
-        def const_added(const)
-          return unless const == :Base
-
-          include MethodMagic
-        end
-
-        def allq(filter: nil, limit: 50, after: nil)
-          args = { first: limit }
-          args[:filter] = filter ? basic_filter.merge(filter) : basic_filter
-          args.delete(:filter) if args[:filter].empty?
-          args[:after] = after if after
-          all_query args, plural.to_s, base_fragment
-        end
-
-        def all_query(args, subject, base_fragment)
-          query do
-            __node(subject, args) do
-              edges do
-                node { ___ base_fragment }
-                cursor
-              end
-              ___ Fragments::PageInfo
-            end
-          end
-        end
-
-        def just_name
-          name.split('::').last
-        end
-
-        def base_fragment
-          const_get(:Base)
-        end
-
-        def basic_filter
-          return const_get(:BASIC_FILTER) if const_defined?(:BASIC_FILTER)
-
-          {}
-        end
-
-        def plural
-          return const_get(:PLURAL) if const_defined?(:PLURAL)
-
-          just_name.downcase.pluralize.to_sym
-        end
-
-        def gql_query(filter: nil, after: nil)
-          Api.query(allq(filter:, after:))
-        end
-
-        def all(after: nil, filter: nil, max: 100)
-          edges = []
-          moar = true
-          while moar
-            data = gql_query(filter:, after:)
-            subjects = data[plural]
-            edges += subjects[:edges]
-            moar = false if edges.size >= max || !subjects[:pageInfo][:hasNextPage]
-            after = subjects[:pageInfo][:endCursor]
-          end
-          edges.map { |edge| new edge[:node] }
-        end
-      end
-
+      extend ClassMethods
       attr_reader :data, :updated_data
 
+      CANCELLED_STATES = %w[cancelled canceled].freeze
+
       def initialize(data)
         data.each_key { |k| raise SmellsBad, "Unknown key #{k}" unless respond_to? "#{k}=" }
         @data = data
@@ -136,6 +33,10 @@ module Rubyists
         workflow_states.select { |ws| ws.type == 'completed' }
       end
 
+      def cancelled_states
+        workflow_states.select { |ws| CANCELLED_STATES.include? ws.type }
+      end
+
       def to_h
         updated_data
       end

data/lib/linear.rb

@@ -24,6 +24,14 @@ module Rubyists
     FEATURE_ROOT = ROOT/:features
     DEBUG_LEVELS = %i[warn info debug trace].freeze
 
+    def self.tmpdir=(other)
+      @tmpdir = other.is_a?(Pathname) ? other : Pathname(other)
+    end
+
+    def self.tmpdir
+      @tmpdir || raise('tmpdir not set')
+    end
+
     def self.L(*libraries) # rubocop:disable Naming/MethodName
       Array(libraries).each { |library| require LIBROOT/library }
     end

data/linear-cli.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'semantic_logger', '~> 4.0'
   spec.add_dependency 'sequel', '~> 5.0'
   spec.add_dependency 'sqlite3', '~> 1.7'
+  spec.add_dependency 'tty-editor', '~> 0.7'
   spec.add_dependency 'tty-markdown', '~> 0.7'
   spec.add_dependency 'tty-prompt', '~> 0.23'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linear-cli
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Tj (bougyman) Vanderpoel
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: tty-editor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
@@ -250,6 +264,8 @@ files:
 - lib/linear/exceptions.rb
 - lib/linear/fragments.rb
 - lib/linear/models/base_model.rb
+- lib/linear/models/base_model/class_methods.rb
+- lib/linear/models/base_model/method_magic.rb
 - lib/linear/models/issue.rb
 - lib/linear/models/label.rb
 - lib/linear/models/team.rb