chmd 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6825fc3e2a7dcc568b5404a092a5a8e832c27cbf408fa13e493ef0af5aebd9eb
+  data.tar.gz: 9d1cd4a0bb320b61d7ecdb92b189e35c3934611c86c0cf986e63ac207192999d
+SHA512:
+  metadata.gz: ae30762304183340673eba0b8aab893647d13f52cbf699caf1de33e592cda1986f311319f09ce253eda85caffaeb5268d2c1f3b4e51299cb396fcdd5192250c1
+  data.tar.gz: '079cec0602b258cb64ff24250aca44b43dfe50f385d62acfdf2b96be28ffb270e79222a5a62f336d8dd74e1dca5761f565fb575fe3dc75577be8b8138bfed913'

data/.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: Release Gem
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.7.x
+
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        echo -e "---\n:rubygems_api_key: ${RUBYGEMS_TOKEN}" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_TOKEN: ${{secrets.RUBYGEMS_TOKEN}}
+
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        draft: false
+        prerelease: false

data/.gitignore

@@ -0,0 +1,60 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# rspec failure tracking
+.rspec_status
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## [v1.0](https://github.com/eggplants/chmd/releases/tag/v1.0) - 2021-08-10 02:39:47 ([compare](https://github.com/eggplants/chmd/compare/v0.2...v1.0))
+
+- [47908579895ebbed0202f57083de72703ed9b82a](https://github.com/eggplants/chmd/commit/47908579895ebbed0202f57083de72703ed9b82a)
+  - fix: ci syntax
+- [552ec473d2ba8b51d4c284a3b15ede680f05461f](https://github.com/eggplants/chmd/commit/552ec473d2ba8b51d4c284a3b15ede680f05461f)
+  - add: swp to ignore
+- [9b45e5c8285a0e73ad9fc7a70f219f26853895cb](https://github.com/eggplants/chmd/commit/9b45e5c8285a0e73ad9fc7a70f219f26853895cb)
+  - fix: version
+- [5784cabe38858a9d71a79849703f4e35264268b2](https://github.com/eggplants/chmd/commit/5784cabe38858a9d71a79849703f4e35264268b2)
+  - add: ci
+- [3d2b8c7b4005d8589e6e6060e66afc09d781421e](https://github.com/eggplants/chmd/commit/3d2b8c7b4005d8589e6e6060e66afc09d781421e)
+  - add: gem requirements
+- [88e089e071abe5f62c2b8b43d9002e0f3854556b](https://github.com/eggplants/chmd/commit/88e089e071abe5f62c2b8b43d9002e0f3854556b)
+  - fix: error handler for git command
+
+## [v0.2](https://github.com/eggplants/chmd/releases/tag/v0.2) - 2021-08-09 20:16:40 ([compare](https://github.com/eggplants/chmd/compare/v0.1...v0.2))
+
+- [4dc07614cad192582fa7c9b8efaf9f65cdd4243a](https://github.com/eggplants/chmd/commit/4dc07614cad192582fa7c9b8efaf9f65cdd4243a)
+  - update: readme
+- [ede6c14fff8f6b72e05f7d7df2ab4a2fd384cc1c](https://github.com/eggplants/chmd/commit/ede6c14fff8f6b72e05f7d7df2ab4a2fd384cc1c)
+  - fix: relpath to abspath and make syntax more common
+
+## [v0.1](https://github.com/eggplants/chmd/releases/tag/v0.1) - 2021-08-09 18:54:09 ([compare](https://github.com/eggplants/chmd/compare/v0.0...v0.1))
+
+- [02cd225b84d1fc85049876a2e17acc6950d8162f](https://github.com/eggplants/chmd/commit/02cd225b84d1fc85049876a2e17acc6950d8162f)
+  - fix: mistakes of tag regex
+- [e5fe2a676a1c6b531d965b786ce6527e5199bf7c](https://github.com/eggplants/chmd/commit/e5fe2a676a1c6b531d965b786ce6527e5199bf7c)
+  - update: readme
+- [9355492f4b10b6f79c7182a67e85f25f1d46ce67](https://github.com/eggplants/chmd/commit/9355492f4b10b6f79c7182a67e85f25f1d46ce67)
+  - lint
+
+## [v0.0](https://github.com/eggplants/chmd/releases/tag/v0.0) - 2021-08-09 18:34:01 ([compare](https://github.com/eggplants/chmd/compare/36270608f2c0473e284ef41d2f65fdf9a30a15ea...v0.0))
+
+- [b9724e0ce294ccc4ac250838a91e8e864816d35c](https://github.com/eggplants/chmd/commit/b9724e0ce294ccc4ac250838a91e8e864816d35c)
+  - add: installation
+- [36270608f2c0473e284ef41d2f65fdf9a30a15ea](https://github.com/eggplants/chmd/commit/36270608f2c0473e284ef41d2f65fdf9a30a15ea)
+  - init

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chmd.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    chmd (1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  chmd!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Haruna (eggplants)
+
+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,53 @@
+# `chmd`
+
+- Make CHANGELOG.md from git-log and git-tag
+
+## Syntax
+
+```txt
+# Changelog
+<blank line>
+## [<tagname>](<gh_url>/releases/tag/<tagname>) - <timestamp> ([compare](<gh_url>/compare/<prev_tagname | init_commit_hash>...<tagname>))
+<blank line>
+- [<commit_hash>](<gh_url>/commit/<commit_hash>)
+  - <message>
+- [<commit_hash>](<gh_url>/commit/<commit_hash>)
+  - <message>
+...
+- [<commit_hash>](<gh_url>/commit/<commit_hash>)
+  - <message>
+<blank line>
+```
+
+## Usage
+
+```bash
+$ curl -L https://git.io/JRuUu -o chmd && chmod +x $_
+# inside git repo
+$ ./chmd | less # check output
+$ ./chmd > CHANGELOG.md
+# outside git repo
+$ ./chmd
+Error: outside git repo, or git is not installed.
+```
+
+- If you want to globally run this command,
+
+```bash
+$ sudo install -m 755 chmd /usr/local/bin/chmd
+$ which chmd
+/usr/local/bin/mkch
+```
+
+## Sample
+
+- [face-symmetrizer/CHANGELOG.md](https://github.com/eggplants/face-symmetrizer/blob/master/CHANGELOG.md)
+  - Made by `chmd`
+
+## Requirements
+
+- Ruby
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/chmd

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'chmd'
+require 'chmd/version'
+require 'optparse'
+
+OptionParser.new do |opt|
+  opt.banner = "Usage: #{$PROGRAM_NAME} [options]"
+  opt.separator 'options are:'
+  opt.on('-h', '--help', 'Show this message') do
+    puts opt
+    exit
+  end
+  opt.on('-v', '--version', 'Show version') do
+    puts Chmd::VERSION
+    exit
+  end
+  opt.parse!(ARGV)
+end
+
+puts Chmd.make

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'chmd'
+
+# 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/chmd.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chmd'
+  spec.version       = Chmd::VERSION
+  spec.authors       = ['eggplants']
+  spec.email         = ['w10776e8w@yahoo.co.jp']
+  spec.summary       = 'Make CHANGELOG.md from git log and tags.'
+  spec.description   = 'Make CHANGELOG.md from git log and tags of repositorywhich origin exists on github.'
+  spec.homepage      = 'https://github.com/eggplants/chmd'
+  spec.license       = 'MIT'
+
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => spec.homepage,
+    'changelog_uri' => 'https://github.com/eggplants/chmd/blob/main/CHANGELOG.md'
+  }
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = 'chmd'
+  spec.bindir        = 'bin'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/lib/chmd.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'mkmf'
+
+MakeMakefile::Logging.quiet = true
+
+module MakeMakefile
+  # MakeMakefile::Logging
+  module Logging
+    @logfile = File::NULL
+  end
+end
+
+# atext
+module Chmd
+  class << self
+    def make
+      Make.new.make
+    end
+  end
+
+  # class for making changelog.md
+  class Make
+    attr_reader :remote_url, :tags
+
+    def initialize
+      @remote_url = self.class.set_remote
+      @tags = self.class.set_tags
+    end
+
+    def make
+      ['# Changelog'] | @tags.map do |tag, commits|
+        next unless tag =~ /tag: /
+
+        _, timestamp, = commits.first.map(&:strip)
+        tag_name = tag.scan(/(?<=tag: )[^,]+/).first
+        prev_tag_name = self.class.get_prev_tag_name(@tags, tag)
+        tag_info = self.class.parse_tag_info(tag_name, prev_tag_name, @remote_url, timestamp)
+        tag_commits_info = self.class.parse_tag_commits(commits, @remote_url).compact
+        ['', tag_info, '', tag_commits_info]
+      end.compact
+    end
+    class << self
+      def parse_tag_info(tag_name, prev_tag_name, remote_url, timestamp)
+        "## [#{tag_name}](#{remote_url}/releases/tag/#{tag_name}) " \
+            + "- #{timestamp} ([compare](#{remote_url}/compare/#{prev_tag_name}...#{tag_name}))"
+      end
+
+      def get_prev_tag_name(tags, current_tag)
+        (
+          tags.keys[tags.keys.index(current_tag) + 1] \
+          ||= tags.values.last.last.first
+        ).sub('tag: ', '')
+      end
+
+      def parse_tag_commits(commits, remote_url)
+        commits.map do |hash, _, msg|
+          if msg =~ /changelog/i
+            nil
+          else
+            <<~A
+              - [#{hash}](#{remote_url}/commit/#{hash})
+                - #{msg}
+            A
+          end
+        end
+      end
+
+      def set_tags
+        ref = nil
+        tags = {}
+        logs = `git log --pretty=format:"%H	%ad	%s	%D" \
+                --date=format:'%Y-%m-%d %H:%M:%S'`.split "\n"
+        logs.map { _1.split "\t" }.each do |c|
+          ref = c[-1] unless c[3].nil?
+          tags[ref] = tags[ref].nil? ? [c[0, 3]] : tags[ref] + [c[0, 3]]
+        end
+        tags
+      end
+
+      def set_remote
+        check_git_command_exist
+        check_git_remote_is_github
+        remote_urls = `git remote get-url origin`.split("\n").grep(/github\.com/)
+        unless remote_urls.size == 1
+          warn 'Error: remote origin is not on github.com.'
+          exit 1
+        end
+        remote_urls[0].sub(/.git$/, '')
+      end
+
+      def check_git_command_exist
+        return if find_executable 'git'
+
+        warn 'Error: Git is not installed.'
+        exit 1
+      end
+
+      def check_git_remote_is_github
+        system 'git rev-parse --show-toplevel', %i[out err] => File::NULL
+        return if $CHILD_STATUS.success?
+
+        warn 'Error: You are outside git repo.'
+        exit 1
+      end
+    end
+  end
+end

data/lib/chmd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Chmd
+  VERSION = '1.0'
+end

data/spec/chmd_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Chmd do
+  it 'has a version number' do
+    expect(Chmd::VERSION).not_to be nil
+  end
+end

data/spec/make_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe Chmd::Make do
+  it 'has initializer' do
+    expect(Chmd::Make.new).not_to be nil
+  end
+
+  it 'has an instance value: remote_url' do
+    expect(Chmd::Make.new.remote_url).to eq 'https://github.com/eggplants/chmd'
+  end
+
+  it 'has an instance value: tags' do
+    expect(Chmd::Make.new.tags).not_to be nil
+  end
+
+  it 'can make' do
+    expect(Chmd::Make.new.make[0]).to eq '# Changelog'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'chmd'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: chmd
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- eggplants
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make CHANGELOG.md from git log and tags of repositorywhich origin exists
+  on github.
+email:
+- w10776e8w@yahoo.co.jp
+executables:
+- chmd
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/chmd
+- bin/console
+- bin/setup
+- chmd.gemspec
+- lib/chmd.rb
+- lib/chmd/version.rb
+- spec/chmd_spec.rb
+- spec/make_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/eggplants/chmd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/eggplants/chmd
+  source_code_uri: https://github.com/eggplants/chmd
+  changelog_uri: https://github.com/eggplants/chmd/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Make CHANGELOG.md from git log and tags.
+test_files:
+- spec/chmd_spec.rb
+- spec/make_spec.rb
+- spec/spec_helper.rb