copyist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07af1b2d7af9174ff84bc3ca3e54b9318e982c4a2d051cc754e50eec8c6de685
-  data.tar.gz: d92d6cd9a2d30257a627bfa5b081856f4a10404f70732b7a4733f9a7e9ca742c
+  metadata.gz: dd206b686340bbe5bd3128aba695172ed20dc8f7668efffbc5069b479c36ad49
+  data.tar.gz: dff18b24a291c853e1d3f79c5f5a7d79607ae21550f3725fc4f3edaa02135c47
 SHA512:
-  metadata.gz: 18de1348997403742d7eccd1b247bb9272435862af895f9f58a58cf782b08a33e766db72ae45b8008e3bbb7f39285fd69323b7e9506a32927b0f0b6314f7c15f
-  data.tar.gz: c4b557e26f5fc40bfa59930ad146fbf898d19df44c54ce5b7c1707234edef997eb0137b87ad52c4ccc1e180110cb1b65a374085b3fede29b4eb9cf0080dc0352
+  metadata.gz: f45f2e8540fa79166e6cad97cb69fccaf1860a5f23cdec4b32d421898ae621981ce6bdad8ce566562420c841944b0c4bef3de40d0bba2d5e1c8b85441df067a4
+  data.tar.gz: 615d0224924e737ae3cd48b07c144744e88d1830f527a74bd49293dfbdbd5937766f1543a457f525df3bd64621d1e267719c49d20c240e6ae9c2dd9521c2e8b7

data/.env.sample

@@ -1,18 +1,33 @@
-GITHUB_PERSONAL_TOKEN=ENV['GITHUB_PERSONAL_TOKEN']
+# ---- for github section ---- #
+
+GITHUB_PERSONAL_TOKEN=
 GITHUB_USER_NAME=
 GITHUB_REPO_NAME=
 
+
+# ---- for JIRA section ---- #
+
+JIRA_API_TOKEN=
+JIRA_SUBDOMAIN_NAME=
+JIRA_USER_NAME=
+JIRA_PROJECT_NAME=
+JIRA_ISSUE_TYPE_ID=
+
+JIRA_PARENT_PROJECT_IDENTIFIRE='parent:'
+
+# ---- common section ---- #
+
+LABEL_IDENTIFIRE='labels:'
+GLOBAL_LABELS='copyist_generated'
+
 # standard style
 TITLE_IDENTIFIRE='#'
 SKIP_IDENTIFIRES='skip_line:,#####'
-LABEL_IDENTIFIRE='labels:'
-
-GLOBAL_LABELS='copyist_generated'
 
 # # alternative style
 # TITLE_IDENTIFIRE='###'
 # SKIP_IDENTIFIRES='#,##'
-# LABEL_IDENTIFIRE='labels:'
 
 # template must have '{ticket_description_block}'. That will be replaced by the tickets description.
 # TEMPLATE_FILE_PATH='../template.md'
+

data/.env.test

@@ -1,13 +1,31 @@
-GITHUB_PERSONAL_TOKEN=ENV['GITHUB_PERSONAL_TOKEN']
-GITHUB_USER_NAME='bar'
-GITHUB_REPO_NAME='foo'
+# ---- for github section ---- #
+GITHUB_PERSONAL_TOKEN=foobar_token
+GITHUB_USER_NAME=foo
+GITHUB_REPO_NAME=bar
 
-TITLE_IDENTIFIRE='#'
 
-SKIP_IDENTIFIRES='skip_line:,#####'
+# ---- for JIRA section ---- #
+JIRA_API_TOKEN=hoobar_token
+JIRA_SUBDOMAIN_NAME=xyz
+JIRA_USER_NAME=hoo
+JIRA_PROJECT_NAME=bar
+JIRA_ISSUE_TYPE_ID=123
+
+JIRA_PARENT_PROJECT_IDENTIFIRE='parent:'
+
+# ---- common section ---- #
 
 LABEL_IDENTIFIRE='labels:'
+GLOBAL_LABELS='copyist_generated'
+
+# standard style
+TITLE_IDENTIFIRE='#'
+SKIP_IDENTIFIRES='skip_line:,#####'
+
+# # alternative style
+# TITLE_IDENTIFIRE='###'
+# SKIP_IDENTIFIRES='#,##'
 
-GLOBAL_LABELS='alpha,beta'
+# template must have '{ticket_description_block}'. That will be replaced by the tickets description.
+# TEMPLATE_FILE_PATH='../template.md'
 
-TEMPLATE_FILE_PATH=

data/.rubocop.yml

@@ -1,5 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'test/**/*.rb'
+    - 'test/*.rb'
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +14,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+# TODO: consider tightening the rule (default: 10)
+Metrics/MethodLength:
+  Max: 25

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-08-16
+
+- impl JIRA job
+
 ## [0.1.0] - 2021-07-13
 
 - Initial release

data/Gemfile

@@ -10,3 +10,4 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.7"
+gem "rubocop-ast"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    copyist (0.1.0)
+    copyist (0.2.0)
       dotenv
       thor
 
@@ -41,6 +41,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.7)
+  rubocop-ast
 
 BUNDLED WITH
    2.2.16

data/README.md

@@ -3,11 +3,9 @@ This application is a tool that can parse a file written in markdown and generat
 
 The word 'Copyist' means 'Hikko (筆耕)' in Japanese.
 
-## Installation
-
-1. clone this repository
-1. `$ bundle install`
 ## How to use
+### step0. Installation
+- `$ gem install copyist`
 
 ### step1. set ENV
 - set your github personal token to GITHUB_PERSONAL_TOKEN
@@ -30,7 +28,7 @@ example
 ```
 
 ### step3. run copyist
-1. `$ bundle exec exe/copyist job path/to/markdown_file.md`
+1. `$ copyist job path/to/markdown_file.md`
 
 
 ## Required or Optional Settings (to ENV or .env)
@@ -103,6 +101,14 @@ example)
 $ export ENVFILE_PATH=.env
 ```
 
+## Experimental Feature
+Implemented a feature to generate JIRA child issues.
+(Because the team I belong to switched from GIthub to JIRA)
+
+By setting the `JIRA_PARENT_PROJECT_IDENTIFIRE` key to the prepared markdown, you can create a ticket for a child issue that is connected to an already existing parent issue.
+
+Please check the implementation for details.
+
 
 ## Development
 

data/copyist.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = ""
   spec.homepage      = "https://github.com/ymstshinichiro/copyist"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ymstshinichiro/copyist"
@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_dependency 'thor'
-  spec.add_dependency 'dotenv'
+  spec.add_dependency "dotenv"
+  spec.add_dependency "thor"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/exe/copyist

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "copyist"
 
-Copyist::Application.start(ARGV)
+Copyist::Application.start(ARGV)

data/lib/copyist.rb

@@ -1,9 +1,13 @@
-require 'thor'
-require 'net/http'
-require 'json'
-require 'dotenv'
+# frozen_string_literal: true
 
-require 'copyist'
-require_relative 'copyist/version'
-require_relative 'copyist/application'
-require_relative 'copyist/job'
+require "thor"
+require "net/http"
+require "json"
+require "dotenv"
+require "base64"
+
+require "copyist"
+require_relative "copyist/version"
+require_relative "copyist/application"
+require_relative "copyist/job"
+require_relative "copyist/jira"

data/lib/copyist/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Copyist
   class Application < Thor
     def self.exit_on_failure?
@@ -8,5 +10,10 @@ module Copyist
     def job(file)
       Copyist::Job.new(file).run
     end
+
+    desc "jira path/to/markdown_file.md", "Parses the markdown file to creates a jira-subtasks"
+    def jira(file)
+      Copyist::Jira.new(file).run
+    end
   end
 end

data/lib/copyist/jira.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Copyist
+  class Jira
+    IssueTicket = Struct.new(:title, :description, :labels, :parent)
+
+    attr_accessor(:title_identifire, :skip_identifires, :label_identifire, :global_labels, :template_file_path,
+                  :basic_auth, :parent_identifire)
+
+    def initialize(argv)
+      @source_md_file_path = argv
+
+      env_path = ENV["ENVFILE_PATH"]
+      Dotenv.load(env_path) if env_path && !env_path.empty?
+
+      if ENV["JIRA_USER_NAME"].empty? || ENV["JIRA_PROJECT_NAME"].empty?
+        raise "set JIRA_USER_NAME and JIRA_PROJECT_NAME to env"
+      end
+      raise "set TITLE_IDENTIFIRE to env" if ENV["TITLE_IDENTIFIRE"].empty?
+      raise "set JIRA_PARENT_PROJECT_IDENTIFIRE to env" if ENV["JIRA_PARENT_PROJECT_IDENTIFIRE"].empty?
+
+      @parent_identifire = "#{ENV["JIRA_PARENT_PROJECT_IDENTIFIRE"]} "
+
+      @title_identifire = "#{ENV["TITLE_IDENTIFIRE"]} "
+      @skip_identifires = ENV["SKIP_IDENTIFIRES"]&.size&.nonzero? ? Regexp.new("^#{ENV["SKIP_IDENTIFIRES"].split(",").join(" |")}") : nil
+      @label_identifire = ENV["LABEL_IDENTIFIRE"]&.size&.nonzero? ? "#{ENV["LABEL_IDENTIFIRE"]} " : nil
+
+      @global_labels      = ENV["GLOBAL_LABELS"]&.size&.nonzero? ? ENV["GLOBAL_LABELS"] : nil
+      @template_file_path = ENV["TEMPLATE_FILE_PATH"]&.size&.nonzero? ? ENV["TEMPLATE_FILE_PATH"] : nil
+
+      @basic_auth = Base64.urlsafe_encode64("#{ENV["JIRA_USER_NAME"]}:#{ENV["JIRA_API_TOKEN"]}")
+    end
+
+    def run
+      puts "make subtasks to JIRA from markdown"
+
+      tickets_from_markdown.each do |ticket|
+        response = request_to_jira(ticket)
+        puts response.message
+      end
+
+      puts "process finished"
+    rescue StandardError => e
+      puts ["fatal error.", "-------", e.backtrace, "------"].flatten.join("\n")
+    end
+
+    def tickets_from_markdown
+      tickets = []
+      get_markdown.each do |line|
+        next if skip_identifires && line.match?(skip_identifires)
+
+        if line.match?(/^#{title_identifire}/)
+          tickets << IssueTicket.new(line.gsub(/#{title_identifire}|\*|\*\*|`/, ""), [], [], nil)
+
+        elsif line.match?(/^#{parent_identifire}/)
+          tickets&.last&.parent = line.gsub(/#{parent_identifire}|\*|\*\*|`/, "")
+
+        elsif label_identifire && line.match?(/^#{label_identifire}/)
+          (tickets&.last&.labels || []) << line.gsub(label_identifire, "").chomp.split(",").map(&:strip)
+
+        else
+          (tickets&.last&.description || []) << line
+        end
+      end
+
+      tickets.each { |i| i.description = make_description(i.description) }
+      tickets
+    end
+
+    private
+
+    def make_description(description_text_array)
+      description = description_text_array.join("\n")
+
+      if template_file_path
+        template = File.open(template_file_path, "r", &:read)
+        description = template.gsub("{ticket_description_block}", description)
+      end
+
+      description
+    end
+
+    def request_to_jira(ticket)
+      uri = get_uri
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme === "https"
+
+      headers = { "Authorization" => "Basic #{basic_auth}" }
+      headers["Content-Type"] = "application/json"
+      body = make_request_body(ticket)
+
+      http.post(uri.path, body.to_json, headers)
+    end
+
+    def make_request_body(ticket)
+      {
+        fields: {
+          project: { key: ENV["JIRA_PROJECT_NAME"] },
+          parent: { key: ticket.parent },
+          summary: ticket.title,
+          description: ticket.description,
+          issuetype: { "id": ENV["JIRA_ISSUE_TYPE_ID"] },
+          labels: (global_labels&.split(",")&.map(&:strip) + ticket.labels).flatten.uniq
+        }
+      }
+    end
+
+    def get_uri
+      URI.parse("https://#{ENV["JIRA_SUBDOMAIN_NAME"]}.atlassian.net/rest/api/2/issue/")
+    end
+
+    def get_markdown
+      File.new(@source_md_file_path).readlines.map(&:chomp)
+    end
+  end
+end

data/lib/copyist/job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Copyist
   class Job
     IssueTicket = Struct.new(:title, :description, :labels)
@@ -7,30 +9,32 @@ module Copyist
     def initialize(argv)
       @source_md_file_path = argv
 
-      env_path = ENV['ENVFILE_PATH']
+      env_path = ENV["ENVFILE_PATH"]
       Dotenv.load(env_path) if env_path && !env_path.empty?
 
-      raise 'set GITHUB_USER_NAME and GITHUB_REPO_NAME to .env file' if (ENV['GITHUB_USER_NAME'].empty? || ENV['GITHUB_REPO_NAME'].empty?)
-      raise 'set TITLE_IDENTIFIRE to .env file' if ENV['TITLE_IDENTIFIRE'].empty?
+      if ENV["GITHUB_USER_NAME"].empty? || ENV["GITHUB_REPO_NAME"].empty?
+        raise "set GITHUB_USER_NAME and GITHUB_REPO_NAME to .env file"
+      end
+      raise "set TITLE_IDENTIFIRE to .env file" if ENV["TITLE_IDENTIFIRE"].empty?
 
-      @title_identifire = "#{ENV['TITLE_IDENTIFIRE']} "
-      @skip_identifires = ENV['SKIP_IDENTIFIRES']&.size&.nonzero? ? Regexp.new("^#{ENV['SKIP_IDENTIFIRES'].split(',').join(' |')}") : nil
-      @label_identifire = ENV['LABEL_IDENTIFIRE']&.size&.nonzero? ? "#{ENV['LABEL_IDENTIFIRE']} " : nil
+      @title_identifire = "#{ENV["TITLE_IDENTIFIRE"]} "
+      @skip_identifires = ENV["SKIP_IDENTIFIRES"]&.size&.nonzero? ? Regexp.new("^#{ENV["SKIP_IDENTIFIRES"].split(",").join(" |")}") : nil
+      @label_identifire = ENV["LABEL_IDENTIFIRE"]&.size&.nonzero? ? "#{ENV["LABEL_IDENTIFIRE"]} " : nil
 
-      @global_labels      = ENV['GLOBAL_LABELS']&.size&.nonzero? ? ENV['GLOBAL_LABELS'] : nil
-      @template_file_path = ENV['TEMPLATE_FILE_PATH']&.size&.nonzero? ? ENV['TEMPLATE_FILE_PATH'] : nil
+      @global_labels      = ENV["GLOBAL_LABELS"]&.size&.nonzero? ? ENV["GLOBAL_LABELS"] : nil
+      @template_file_path = ENV["TEMPLATE_FILE_PATH"]&.size&.nonzero? ? ENV["TEMPLATE_FILE_PATH"] : nil
     end
 
     def run
-      puts 'make tickets to Github from markdown'
+      puts "make tickets to Github from markdown"
 
       tickets_from_markdown.each do |ticket|
         response = request_to_github(ticket)
         puts response.message
       end
-      puts 'process finished'
-    rescue => e
-      puts ['fatal error.', '-------', e.backtrace, '------'].flatten.join("\n")
+      puts "process finished"
+    rescue StandardError => e
+      puts ["fatal error.", "-------", e.backtrace, "------"].flatten.join("\n")
     end
 
     def tickets_from_markdown
@@ -39,17 +43,17 @@ module Copyist
         next if skip_identifires && line.match?(skip_identifires)
 
         if line.match?(/^#{title_identifire}/)
-          tickets << IssueTicket.new(line.gsub(/#{title_identifire}|\*|\*\*|`/, ''), [], [])
+          tickets << IssueTicket.new(line.gsub(/#{title_identifire}|\*|\*\*|`/, ""), [], [])
 
         elsif label_identifire && line.match?(/^#{label_identifire}/)
-          (tickets&.last&.labels || []) << line.gsub(label_identifire, '').chomp.split(',').map(&:strip)
+          (tickets&.last&.labels || []) << line.gsub(label_identifire, "").chomp.split(",").map(&:strip)
 
         else
           (tickets&.last&.description || []) << line
         end
       end
 
-      tickets.each{ |i| i.description = make_description(i.description) }
+      tickets.each { |i| i.description = make_description(i.description) }
       tickets
     end
 
@@ -59,8 +63,8 @@ module Copyist
       description = description_text_array.join
 
       if template_file_path
-        template = File.open(template_file_path, "r") { |f| f.read }
-        description = template.gsub('{ticket_description_block}', description)
+        template = File.open(template_file_path, "r", &:read)
+        description = template.gsub("{ticket_description_block}", description)
       end
 
       description
@@ -71,7 +75,7 @@ module Copyist
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme === "https"
 
-      headers = { Authorization: "token #{ENV['GITHUB_PERSONAL_TOKEN']}" }
+      headers = { Authorization: "token #{ENV["GITHUB_PERSONAL_TOKEN"]}" }
       body = make_request_body(ticket)
 
       http.post(uri.path, body.to_json, headers)
@@ -79,18 +83,18 @@ module Copyist
 
     def make_request_body(ticket)
       {
-        title:  ticket.title,
-        body:   ticket.description,
-        labels: (global_labels&.split(',')&.map(&:strip) + ticket.labels).flatten.uniq
+        title: ticket.title,
+        body: ticket.description,
+        labels: (global_labels&.split(",")&.map(&:strip) + ticket.labels).flatten.uniq
       }
     end
 
     def get_uri
-      URI.parse("https://api.github.com/repos/#{ENV['GITHUB_USER_NAME']}/#{ENV['GITHUB_REPO_NAME']}/issues")
+      URI.parse("https://api.github.com/repos/#{ENV["GITHUB_USER_NAME"]}/#{ENV["GITHUB_REPO_NAME"]}/issues")
     end
 
     def get_markdown
       File.new(@source_md_file_path).readlines
     end
   end
-end
+end

data/lib/copyist/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Copyist
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: copyist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ymstshinichiro
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -63,6 +63,7 @@ files:
 - exe/copyist
 - lib/copyist.rb
 - lib/copyist/application.rb
+- lib/copyist/jira.rb
 - lib/copyist/job.rb
 - lib/copyist/version.rb
 homepage: https://github.com/ymstshinichiro/copyist
@@ -72,7 +73,7 @@ metadata:
   homepage_uri: https://github.com/ymstshinichiro/copyist
   source_code_uri: https://github.com/ymstshinichiro/copyist
   changelog_uri: https://github.com/ymstshinichiro/copyist/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,15 +81,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: parse markdown to create github issues
 test_files: []