githuh 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 511863db2788e1b18cb2dfa73b3f4547191cbc0ed3420d02f7da840cd39c3baf
-  data.tar.gz: 81d396dea2a067c736225149f213c99a528cf6e4fa17ce7ecc1662b0649c5034
+  metadata.gz: b85ccd845fbf4f02072b566abd362adc5656eff6746c092ee1591011c69da0ab
+  data.tar.gz: 7becd01e22f79e9a6c79dcb9292f5003d48a4fc57596c9ace415d1bff44f8e6a
 SHA512:
-  metadata.gz: 7dddbd8c7e9c878be15af398d89150d0d1c72ef73fb780f85f7e126b7a42b41fc9b902828518580a6e7fe4ba37898dae104dec49380be70d73529977a228939f
-  data.tar.gz: 5524851da5c59ffe9009502d1d0366a414406e79583cefd0826a0c9f6ba9440e35ed8d6208d7bc20900953f309a8942b14d0c19e60df32ef4ecd13f780b769f5
+  metadata.gz: d425dec858b7587d373b30a8c1dbdeddcdfda625230e32a0cc49ec9d4a28574c164d2330a01ff77c69f5bb57c164aa7c3b6cedfb37e27506dce28910eb176442
+  data.tar.gz: dba51e9fa2685db0978cdb051801ec573f97fd43f740c28fea5250afba8b7e121e265d3f962ca5466a4138eb43344bd81c99558f5a7f7c7859323d2c7f916c84

data/.envrc

@@ -1,4 +1,4 @@
-
-export GITHUB_TOKEN=47b933ddfdc4696f27b67299bf9fe59ce0925a78
-
+# vim: ft=bash
 export PATH=$(pwd)/exe:${PATH}
+[[ -f .envrc.local ]] && source .envrc.local
+

data/.github/workflows/ruby.yml

@@ -21,5 +21,5 @@ jobs:
       run: |
         gem install bundler
         bundle install --jobs 4 --retry 3
-        bundle exec rspec
-        bundle exec rubocop
+        RUBYOPT=-W0 bundle exec rspec
+        RUBYOPT=-W0 bundle exec rubocop

data/.gitignore

@@ -23,3 +23,5 @@ pkg
 .yardoc
 .ruby-version
 *.csv
+.envrc.local
+tmp/**

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-09-09 20:59:51 UTC using RuboCop version 0.90.0.
+# on 2020-09-11 02:48:55 UTC using RuboCop version 0.90.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -35,7 +35,7 @@ Layout/EndAlignment:
     - 'lib/githuh/cli/commands/issue/export.rb'
     - 'lib/githuh/cli/commands/repo/list.rb'
 
-# Offense count: 9
+# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
 # SupportedHashRocketStyles: key, separator, table
@@ -52,22 +52,6 @@ Layout/IndentationWidth:
   Exclude:
     - 'lib/githuh/cli/commands/issue/export.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: aligned, indented
-Layout/MultilineOperationIndentation:
-  Exclude:
-    - 'lib/githuh/cli/commands/issue/export.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
-# SupportedStylesForExponentOperator: space, no_space
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'lib/githuh/cli/commands/issue/export.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
@@ -82,6 +66,13 @@ Lint/NonDeterministicRequireOrder:
   Exclude:
     - 'spec/spec_helper.rb'
 
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Lint/SafeNavigationChain:
+  Exclude:
+    - 'lib/githuh/cli/commands/repo/list.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 Lint/ScriptPermission:
@@ -100,16 +91,9 @@ Style/ExpandPathArguments:
 Style/FormatStringToken:
   EnforcedStyle: unannotated
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - 'lib/githuh/cli/commands/issue/export_paginated.rb'
-
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
+    - 'lib/githuh/cli/commands/base.rb'
     - 'lib/githuh/cli/launcher.rb'

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    githuh (0.2.1)
+    githuh (0.3.0)
       activesupport
       colored2 (~> 3)
       dry-cli (~> 0.6)
+      hashie
       octokit (~> 4)
       tty-box
       tty-progressbar
@@ -56,11 +57,11 @@ GEM
     docile (1.3.2)
     dry-cli (0.6.0)
       concurrent-ruby (~> 1.0)
-    equatable (0.6.1)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     ffi (1.13.1)
     gherkin (5.1.0)
+    hashie (4.1.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     minitest (5.14.2)
@@ -73,8 +74,7 @@ GEM
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
-    pastel (0.7.3)
-      equatable (~> 0.6)
+    pastel (0.8.0)
       tty-color (~> 0.5)
     public_suffix (4.0.6)
     rainbow (3.0.0)
@@ -117,25 +117,22 @@ GEM
       simplecov-html (~> 0.11)
     simplecov-formatter-badge (0.1.0)
     simplecov-html (0.12.2)
-    strings (0.1.8)
-      strings-ansi (~> 0.1)
+    strings (0.2.0)
+      strings-ansi (~> 0.2)
       unicode-display_width (~> 1.5)
       unicode_utils (~> 1.4)
-    strings-ansi (0.1.0)
+    strings-ansi (0.2.0)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tty-box (0.5.0)
-      pastel (~> 0.7.2)
-      strings (~> 0.1.6)
+    tty-box (0.6.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
       tty-cursor (~> 0.7)
     tty-color (0.5.2)
     tty-cursor (0.7.1)
-    tty-progressbar (0.17.0)
-      strings-ansi (~> 0.1.0)
-      tty-cursor (~> 0.7)
-      tty-screen (~> 0.7)
-      unicode-display_width (~> 1.6)
-    tty-screen (0.8.1)
+    tty-progressbar (0.11.0)
+      tty-screen (~> 0.5.0)
+    tty-screen (0.5.1)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)

data/README.adoc

@@ -75,9 +75,25 @@ Options:
   --[no-]verbose       # Print additional debugging info, default: false
   --file=VALUE         # Output file, overrides <username>.<repo>.issues.<format>
   --format=VALUE       # Output format: (json/csv), default: "csv"
+  --mapping=VALUE      # YAML file with label to estimates mapping
   --help, -h           # Print this help
 ----
 
+==== Label Mappings
+
+The export suppots a configurable mapping of Github labels to Pivotal Tracker points. To use this feature, create a YAML file similar to the xref:config/label-mapping.yml[config/label-mapping.yml] provided:
+
+[source,yaml]
+----
+---
+label-to-estimates:
+  Large: 5
+  Medium: 3
+  Small: 1
+----
+
+Then add `--mapping=<filename>` argument to the export command.
+
 ==== Example
 
 Eg, to export all issues of this repo into Pivotal Tracker compatibel CSV:

data/config/label-mapping.yml

@@ -0,0 +1,12 @@
+---
+label-to-estimates:
+  "XXL(13 eng day)": 15
+  "XL(8 eng day)": 15
+  "xs(<=1 eng day)": 3
+  "L(5 eng day)": 15
+  "m(3 eng day)": 9
+  "s(2 eng day)": 6
+labels-to-remove:
+  implemented: false
+labels-to-rename:
+  implemented: false

data/docs/img/coverage.svg

@@ -8,10 +8,10 @@
   <rect rx="5" width="130" height="20" fill="url(#a)"/>
   <rect rx="5" x="80" width="50" height="20" fill="#4BAF00"/>
   <rect rx="5" x="80" width="50" height="20" fill="url(#a)"/>
-  <g fill="#fff" text-anchor="middle" font-weight="800" font-family="Consolas,DejaVu Sans,Verdana,Geneva,sans-serif" font-size="12">
+  <g fill="#fff" text-anchor="middle" font-weight="500" font-family="Consolas,DejaVu Sans,Verdana,Geneva,sans-serif" font-size="10">
     <text x="40.5" y="15" fill="#010101" fill-opacity=".3">COVERAGE</text>
     <text x="41.5" y="14">COVERAGE</text>
-    <text x="105.5" y="15" fill="#010101" fill-opacity=".3">61%</text>
-    <text x="106.5" y="14">61%</text>
+    <text x="105.5" y="15" fill="#010101" fill-opacity=".3">68%</text>
+    <text x="106.5" y="14">68%</text>
   </g>
 </svg>

data/githuh.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'colored2', '~> 3'
   spec.add_dependency 'dry-cli', '~> 0.6'
+  spec.add_dependency 'hashie'
   spec.add_dependency 'octokit', '~> 4'
   spec.add_dependency 'tty-box'
   spec.add_dependency 'tty-progressbar'

data/lib/githuh/cli/commands/base.rb

@@ -28,7 +28,7 @@ module Githuh
           end
         end
 
-        attr_accessor :client, :token, :per_page, :verbose, :info, :box, :context
+        attr_accessor :token, :per_page, :verbose, :info, :box, :context
 
         def call(api_token: nil,
                  per_page: DEFAULT_PAGE_SIZE,
@@ -38,11 +38,20 @@ module Githuh
           self.context  = Githuh
           self.verbose  = verbose
           self.info     = info
-          self.token    = api_token || token_from_gitconfig
+          self.token    = api_token || determine_github_token
           self.per_page = per_page.to_i || DEFAULT_PAGE_SIZE
-          self.client   = Octokit::Client.new(access_token: token)
 
-          print_userinfo if info
+          if info
+            begin
+              print_userinfo
+            rescue StandardError
+              nil
+            end
+          end
+        end
+
+        def client
+          @client ||= Octokit::Client.new(access_token: token)
         end
 
         protected
@@ -83,6 +92,17 @@ module Githuh
                                complete: '▉'.magenta)
         end
 
+        def determine_github_token
+          @github_token ||= (ENV['GITHUB_TOKEN'] || `git config --global --get user.token`.chomp)
+
+          return @github_token unless @github_token.empty?
+
+          raise "No token was found in your ~/.gitconfig.\n" \
+                "To add, run the following command: \n" \
+                "git config --global --set user.token YOUR_GITHUB_TOKEN\n" \
+                "or set environment variable GITHUB_TOKEN"
+        end
+
         private
 
         def print_userinfo
@@ -116,16 +136,6 @@ module Githuh
         def h(arg)
           arg.to_s
         end
-
-        def token_from_gitconfig
-          @token_from_gitconfig ||= `git config --global --get user.token`.chomp
-
-          return @token_from_gitconfig unless @token_from_gitconfig.empty?
-
-          raise "No token was found in your ~/.gitconfig.\n" \
-                "To add, run the following command: \n" \
-                "git config --global --set user.token YOUR_GITHUB_TOKEN"
-        end
       end
     end
   end

data/lib/githuh/cli/commands/issue/export.rb

@@ -2,14 +2,15 @@
 # frozen_string_literal: true
 
 # vim: ft=ruby
-require 'bundler/setup'
-require 'dry/cli'
-require 'json'
-require 'tty/progressbar'
-require 'csv'
-require 'active_support/inflector'
+require "bundler/setup"
+require "dry/cli"
+require "json"
+require "tty/progressbar"
+require "csv"
+require "active_support/inflector"
+require "yaml"
 
-require_relative '../base'
+require_relative "../base"
 
 module Githuh
   module CLI
@@ -17,40 +18,50 @@ module Githuh
       module Issue
         class Export < Base
           FORMATS = {
-            json: 'json',
-            csv:  'csv'
+            json: "json",
+            csv: "csv",
           }.freeze
 
-          DEFAULT_FORMAT        = :csv
+          DEFAULT_FORMAT = :csv
           DEFAULT_OUTPUT_FORMAT = "<username>.<repo>.issues.<format>"
 
-          attr_accessor :filename, :file, :output, :repo, :issues, :format, :record_count
+          attr_accessor :filename, :file, :output, :repo, :issues, :format, :record_count, :mapping
 
           desc "Export Repo issues into a CSV or JSON format\n" \
                "  Default output file is " + DEFAULT_OUTPUT_FORMAT.bold.yellow
 
           argument :repo, type: :string, required: true, desc: 'Name of the repo, eg "rails/rails"'
-          option :file, required: false, desc: 'Output file, overrides ' + DEFAULT_OUTPUT_FORMAT
-          option :format, values: FORMATS.keys.map(&:to_s), default: DEFAULT_FORMAT.to_s, required: false, desc: 'Output format'
+          option :file, required: false, desc: "Output file, overrides " + DEFAULT_OUTPUT_FORMAT
+          option :format, values: FORMATS.keys.map(&:to_s), default: DEFAULT_FORMAT.to_s, required: false, desc: "Output format"
+          option :mapping, type: :string, require: false, desc: "YAML file with label to estimates mapping"
 
-          def call(repo: nil, file: nil, format: nil, **opts)
+          def call(repo: nil, file: nil, format: nil, mapping: nil, **opts)
             super(**opts)
 
             self.record_count = 0
-            self.repo         = repo
+            self.repo = repo
 
             raise ArgumentError, "argument <repo> is required" unless repo
             raise ArgumentError, "argument <repo> is not a repository, expected eg 'rails/rails'" unless repo =~ %r{/}
 
+            self.mapping = {}
+            if mapping && ::File.exist?(mapping)
+              self.mapping = ::YAML.safe_load(::File.read(mapping))['label-to-estimates'] || {}
+            end
+
+            Export.const_set(:LabelEstimates, self.mapping)
+
             self.issues = []
             self.output = StringIO.new
             self.format = (format || DEFAULT_FORMAT).to_sym
 
             self.filename = file || file_name(repo)
-            self.file     = File.open(filename, 'w')
+            self.file = File.open(filename, "w")
 
             print_summary
 
+            raise ArgumentError, "Format is not provided" unless FORMATS.key?(format&.to_sym)
+
             # —————————— actually get all issues ———————————————
             self.file.write send("render_as_#{format}", fetch_issues)
             # ————————————————————————————————————————————————————————
@@ -62,9 +73,9 @@ module Githuh
 
           def fetch_issues
             client.auto_paginate = true
-            self.issues          = filter_issues(client.issues(repo, query: default_options)).tap do |issue_list|
+            self.issues = filter_issues(client.issues(repo, query: default_options)).tap do |issue_list|
               self.record_count = issue_list.size
-              bar('Issues')&.advance
+              bar("Issues")&.advance
             end
           end
 
@@ -79,7 +90,7 @@ module Githuh
           end
 
           def default_options
-            { state: 'open' }
+            { state: "open" }
           end
 
           def self.issue_labels(issue)
@@ -87,42 +98,33 @@ module Githuh
           end
 
           def self.find_user(client, username)
-            @user_cache           ||= {}
+            @user_cache ||= {}
             @user_cache[username] ||= client.user(username).name
           end
 
           CSV_MAP = {
-            'Labels'        => ->(_client, issue) { issue_labels(issue).reject { |l| LABEL_ESTIMATES.key?(l) }.join(',').downcase },
-            'Type'          => ->(*) { 'feature' },
-            'Estimate'      => ->(_client, issue) do
-              el = issue_labels(issue).find { |l| LABEL_ESTIMATES.key?(l) }
-              el ? LABEL_ESTIMATES[el] : nil
+            "Labels" => ->(_client, issue) { issue_labels(issue).reject { |l| LabelEstimates.key?(l) }.join(",").downcase },
+            "Type" => ->(*) { "feature" },
+            "Estimate" => ->(_client, issue) do
+              el = issue_labels(issue).find { |l| LabelEstimates.key?(l) }
+              el ? LabelEstimates[el] : nil
             end,
-            'Current State' => ->(*) { 'unstarted' },
-            'Requested By'  => ->(client, issue) do
+            "Current State" => ->(*) { "unstarted" },
+            "Requested By" => ->(client, issue) do
               find_user(client, issue.user.login)
             end,
-            'Owned By'  => ->(client, issue) do
+            "Owned By" => ->(client, issue) do
               find_user(client, issue.user.login)
             end,
-            'Description'   => ->(_client, issue) {
+            "Description" => ->(_client, issue) {
               issue.body
             },
-            'Created at'    => ->(_client, issue) { issue.created_at },
-          }.freeze
-
-          LABEL_ESTIMATES = {
-            'XXL(13 eng day)' => 15,
-            'XL(8 eng day)'   => 15,
-            'xs(<=1 eng day)' => 3,
-            'L(5 eng day)'    => 15,
-            'm(3 eng day)'    => 9,
-            's(2 eng day)'    => 6
+            "Created at" => ->(_client, issue) { issue.created_at },
           }.freeze
 
           CSV_HEADER = %w(Id Title Labels Type Estimate) +
-            ['Current State', 'Created at', 'Accepted at', 'Deadline', 'Requested By',
-             'Owned By', 'Description', 'Comment', 'Comment', 'Comment', 'Comment'].freeze
+                       ["Current State", "Created at", "Accepted at", "Deadline", "Requested By",
+                        "Owned By", "Description", "Comment", "Comment", "Comment", "Comment"].freeze
 
           # Id,Title,Labels,Type,Estimate,Current State,Created at,Accepted at,Deadline,Requested By,Owned By,Description,Comment,Comment
           # 100, existing started story,"label one,label two",feature,1,started,"Nov 22, 2007",,,user1,user2,this will update story 100,,
@@ -136,16 +138,16 @@ module Githuh
                 row = []
                 CSV_HEADER.each do |column|
                   method = column.downcase.underscore.to_sym
-                  value  = if CSV_MAP[column]
-                    CSV_MAP[column][client, issue]
-                  else
-                    begin
-                      issue.to_h[method]
-                    rescue StandardError
-                      nil
+                  value = if CSV_MAP[column]
+                      CSV_MAP[column][client, issue]
+                    else
+                      begin
+                        issue.to_h[method]
+                      rescue StandardError
+                        nil
+                      end
                     end
-                  end
-                  value  = value.strip if value.is_a?(String)
+                  value = value.strip if value.is_a?(String)
                   row << value
                 end
                 csv << row
@@ -164,7 +166,7 @@ module Githuh
           def print_conclusion
             puts
             puts TTY::Box.info("Success: written a total of #{record_count} records to #{filename}",
-                               width: ui_width, padding: 1)
+                               **{ width: ui_width, padding: 1 })
             puts
           end
 
@@ -173,8 +175,7 @@ module Githuh
             puts TTY::Box.info("Format : #{self.format}\n" \
                                "File   : #{filename}\n" \
                                "Repo   : #{repo}\n",
-                               width:   ui_width,
-                               padding: 1)
+                               **{ width: ui_width, padding: 1 })
             puts
           end
 
@@ -184,8 +185,8 @@ module Githuh
         end
       end
 
-      register 'issue', aliases: ['r'] do |prefix|
-        prefix.register 'export', Issue::Export
+      register "issue", aliases: ["r"] do |prefix|
+        prefix.register "export", Issue::Export
       end
     end
   end

data/lib/githuh/cli/commands/repo/list.rb

@@ -98,7 +98,9 @@ module Githuh
           end
 
           def bar_size
-            client.last_response.rels[:last].href.match(/page=(\d+).*$/)[1].to_i
+            return 1 if client&.last_response.nil?
+
+            client&.last_response.rels[:last].href.match(/page=(\d+).*$/)[1].to_i
           end
 
           def render_as_markdown(repositories)

data/lib/githuh/cli/commands/user/info.rb

@@ -17,7 +17,7 @@ module Githuh
 
           def call(**opts)
             super(**opts)
-            puts JSON.pretty_generate(client.user.to_hash)
+            ap client.user.to_hash
           end
         end
       end

data/lib/githuh/cli/launcher.rb

@@ -6,6 +6,8 @@ require 'tty/box'
 require 'tty/screen'
 
 require 'githuh'
+require 'githuh/cli/commands/base'
+
 module Githuh
   module CLI
     class Launcher
@@ -33,11 +35,12 @@ module Githuh
           Githuh.configure_kernel_behavior!
         end
 
+        # noinspection RubyYardParamTypeMatch
         self.command = ::Dry::CLI.new(::Githuh::CLI::Commands)
         command.call(arguments: argv, out: stdout, err: stderr)
       rescue StandardError => e
         lines = [e.message.gsub(/\n/, ', ')]
-        if e.backtrace
+        if e.backtrace && !(ARGV & %w[-v --verbose]).empty?
           lines << ''
           lines.concat(e.backtrace)
         end

data/lib/githuh/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Githuh
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: githuh
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +270,7 @@ files:
 - Rakefile
 - WARRANTY.md
 - codecov.yml
+- config/label-mapping.yml
 - docs/img/coverage.svg
 - docs/img/githuh-issue-export.png
 - exe/githuh