copyist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07af1b2d7af9174ff84bc3ca3e54b9318e982c4a2d051cc754e50eec8c6de685
+  data.tar.gz: d92d6cd9a2d30257a627bfa5b081856f4a10404f70732b7a4733f9a7e9ca742c
+SHA512:
+  metadata.gz: 18de1348997403742d7eccd1b247bb9272435862af895f9f58a58cf782b08a33e766db72ae45b8008e3bbb7f39285fd69323b7e9506a32927b0f0b6314f7c15f
+  data.tar.gz: c4b557e26f5fc40bfa59930ad146fbf898d19df44c54ce5b7c1707234edef997eb0137b87ad52c4ccc1e180110cb1b65a374085b3fede29b4eb9cf0080dc0352

data/.env.sample

@@ -0,0 +1,18 @@
+GITHUB_PERSONAL_TOKEN=ENV['GITHUB_PERSONAL_TOKEN']
+GITHUB_USER_NAME=
+GITHUB_REPO_NAME=
+
+# 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

@@ -0,0 +1,13 @@
+GITHUB_PERSONAL_TOKEN=ENV['GITHUB_PERSONAL_TOKEN']
+GITHUB_USER_NAME='bar'
+GITHUB_REPO_NAME='foo'
+
+TITLE_IDENTIFIRE='#'
+
+SKIP_IDENTIFIRES='skip_line:,#####'
+
+LABEL_IDENTIFIRE='labels:'
+
+GLOBAL_LABELS='alpha,beta'
+
+TEMPLATE_FILE_PATH=

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.env

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in copyist.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    copyist (0.1.0)
+      dotenv
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    dotenv (2.7.6)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  universal-darwin-19
+
+DEPENDENCIES
+  copyist!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# Copyist
+This application is a tool that can parse a file written in markdown and generate multiple Github isuue tickets at once.
+
+The word 'Copyist' means 'Hikko (筆耕)' in Japanese.
+
+## Installation
+
+1. clone this repository
+1. `$ bundle install`
+## How to use
+
+### step1. set ENV
+- set your github personal token to GITHUB_PERSONAL_TOKEN
+  - `$ export GITHUB_PERSONAL_TOKEN={YOUR_TOKEN}`
+
+- set target github user name, target github repository name to .env file
+
+### step2. ready markdown file
+
+example
+
+```
+### foo
+- fizz
+    - bazz
+- fizzbazz
+### bar
+- aaa
+    - **bbb**
+```
+
+### step3. run copyist
+1. `$ bundle exec exe/copyist job path/to/markdown_file.md`
+
+
+## Required or Optional Settings (to ENV or .env)
+#### TITLE_IDENTIFIRE (requires)
+An identifier to determine which line to use as the title of the ticket.
+Determine if it matches the beginning of a line.
+Add a space after the set string to judge.
+
+example)
+
+```
+# when you set '#' as the TITLE_IDENTIFIRE
+
+match -> '# This is title.'
+
+not match -> '#This is title.'
+not match -> '## This is title.'
+```
+
+#### SKIP_IDENTIFIRES (optional)
+Identifier to determine which lines you do not want to include in the ticket.
+If it doesn't exist, ignore it.
+You can specify multiple values separated by commas.
+Determine if it matches the beginning of a line.
+Add a space after the set string to judge.
+
+example)
+
+```
+# when you set 'aaa,bbb:' as the SKIP_IDENTIFIRES
+
+match -> 'aaa This line skipped.'
+match -> 'bbb: This line skipped.'
+
+not match -> ' aaa This line skipped.'
+not match -> 'aaaline skipped.'
+not match -> 'bbb line skipped.'
+```
+
+#### LABEL_IDENTIFIRE (optional)
+Identifier to determine the line representing the label to be given to the ticket.
+Enter a comma-separated list of labels to be set on the line to be judged.
+Determine if it matches the beginning of a line.
+Add a space after the set string to judge.
+
+
+example)
+
+```
+# when you set 'labels:' as the LABEL_IDENTIFIRE
+
+match -> 'labels: labelA,labelB'  -> tickets add label 'labelA' and 'labelB'
+match -> 'labels: labelA, labelB'  -> tickets add label 'labelA' and 'labelB'  (Spaces will be removed)
+
+not match -> 'labels:labelA,labelB'  -> No label will be set on the ticket.
+```
+
+#### GLOBAL_LABELS (optional)
+Specify the label to be set for all tickets.
+Enter a comma-separated list of labels to be set on the line to be judged.
+You can specify multiple values separated by commas.
+
+#### ENVFILE_PATH
+ENV-related settings can be specified in a file.
+Enter the path in the environment variable ENVFILE_PATH.
+
+
+example)
+```
+$ export ENVFILE_PATH=.env
+```
+
+
+## Development
+
+## Contributing
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Copyist project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/copyist/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "copyist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/copyist.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/copyist/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "copyist"
+  spec.version       = Copyist::VERSION
+  spec.authors       = ["ymstshinichiro"]
+  spec.email         = ["yamashitashinichirou@gmail.com"]
+
+  spec.summary       = "parse markdown to create github issues"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/ymstshinichiro/copyist"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ymstshinichiro/copyist"
+  spec.metadata["changelog_uri"] = "https://github.com/ymstshinichiro/copyist/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'thor'
+  spec.add_dependency 'dotenv'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/copyist

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

data/lib/copyist.rb

@@ -0,0 +1,9 @@
+require 'thor'
+require 'net/http'
+require 'json'
+require 'dotenv'
+
+require 'copyist'
+require_relative 'copyist/version'
+require_relative 'copyist/application'
+require_relative 'copyist/job'

data/lib/copyist/application.rb

@@ -0,0 +1,12 @@
+module Copyist
+  class Application < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "job path/to/markdown_file.md", "Parses the markdown file to creates a issue"
+    def job(file)
+      Copyist::Job.new(file).run
+    end
+  end
+end

data/lib/copyist/job.rb

@@ -0,0 +1,96 @@
+module Copyist
+  class Job
+    IssueTicket = Struct.new(:title, :description, :labels)
+
+    attr_accessor :title_identifire, :skip_identifires, :label_identifire, :global_labels, :template_file_path
+
+    def initialize(argv)
+      @source_md_file_path = argv
+
+      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?
+
+      @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
+    end
+
+    def run
+      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")
+    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}|\*|\*\*|`/, ''), [], [])
+
+        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
+
+      if template_file_path
+        template = File.open(template_file_path, "r") { |f| f.read }
+        description = template.gsub('{ticket_description_block}', description)
+      end
+
+      description
+    end
+
+    def request_to_github(ticket)
+      uri = get_uri
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme === "https"
+
+      headers = { Authorization: "token #{ENV['GITHUB_PERSONAL_TOKEN']}" }
+      body = make_request_body(ticket)
+
+      http.post(uri.path, body.to_json, headers)
+    end
+
+    def make_request_body(ticket)
+      {
+        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")
+    end
+
+    def get_markdown
+      File.new(@source_md_file_path).readlines
+    end
+  end
+end

data/lib/copyist/version.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: copyist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ymstshinichiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: dotenv
+  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'
+description: ''
+email:
+- yamashitashinichirou@gmail.com
+executables:
+- copyist
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".env.test"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- copyist.gemspec
+- exe/copyist
+- lib/copyist.rb
+- lib/copyist/application.rb
+- lib/copyist/job.rb
+- lib/copyist/version.rb
+homepage: https://github.com/ymstshinichiro/copyist
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: parse markdown to create github issues
+test_files: []