changelogko 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7b9995971aca753b65bffc71a01aadee292c46aed27ad716ba8ef492c8f0a1b
+  data.tar.gz: a0e464be952384d50313a3e90cf5da8191bd81eb043cb2bfa39270e9158c9000
+SHA512:
+  metadata.gz: 5ee4277bc2f2dc2c0f719ebff07c9b0109b070999773aadbbed905eac715bcf5c7b799fab1a1efbcd6cb7abcc7d0532d037b7608d8e7e02afb0acc649a57317d
+  data.tar.gz: 27273766de8752067b222baa6cbbee6c26a26310ad5f7f5f0b4f0888a4b9772f420fba279f5f344474f924c0cf3cbc122d2a0f79c0c692d2e7de321ad3c8fbf6

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelogs 
+## Added (3 count/s)
+  + No archive option for releasing - tieeeeen1994 (tieeeeen1994@gmail.com)
+  + To automatically append command options through .changelogko file - tieeeeen1994 (tieeeeen1994@gmail.com)
+  + changelogko and releaseko aliases cko and rko - tieeeeen1994 (tieeeeen1994@gmail.com)
+## Fixed (1 count/s)
+  + Help format of changelogko - tieeeeen1994 (tieeeeen1994@gmail.com)
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Tien
+
+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,55 @@
+# Changelogko
+
+This gem provides the ability to easily manage your change logs. Commit changes alongside change log files to easily track them without worry, then just release them whenever to automatically create a new CHANGELOG.md file.
+
+As an additional feature, *Releaseko is integrated into the gem as it feels like Releaseko is very coupled with Changelogko.* It is also just a simple feature that just automatically updates `metadata/app-version`, releases change logs through Changelogko, then push.
+
+## Installation
+
+Use `bundler` to install the gem.
+```ruby
+gem 'changelogko', git: 'https://github.com/tieeeeen1994/changelogko'
+```
+
+Then:
+```
+$ bundle install
+```
+
+## Usage
+
+### Changelogko
+
+Refer to:
+```
+$ bundle exec changelogko -h
+```
+or
+```
+$ bundle exec cko -h
+```
+
+Adding a `.changelogko` file in the root of the working directory will allow to automatically append the contents of the file as options to every `changelogko` (or `cko`) command. For example, assume the `.changelogko` file contains:
+```
+--no-archive
+```
+For every `changelogko` command, it will automatically append `--no-archive`, as such: `bundle exec changelogko -r --no-archive`.
+
+Changelogko will create the needed files if they don't exist yet.
+
+### Releaseko
+
+Refer to:
+```
+$ bundle exec releaseko -h
+```
+or
+```
+$ bundle exec rko -h
+```
+
+Releaseko looks for `metadata/app-version` for the project's versioning. It will automatically increment this file based on mode.
+
+## Credits
+
+The original author of this gem is [@neume](https://github.com/neume), then further enhanced by [@tieeeeen1994](https://github.com/tieeeeen1994).

data/bin/changelogko

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'changelogko'

data/bin/cko

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'changelogko'

data/bin/releaseko

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'releaseko'

data/bin/rko

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'releaseko'

data/changelogko.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = 'changelogko'
+  s.version = File.read('metadata/app-version').strip
+  s.summary = 'Manage changelogs easily!'
+  s.description = 'This is a gem that can manage changelogs very easily.'
+  s.authors = ['Joseph Nelson Valeros', 'Jenek Michael Sarte']
+  s.email = ['valerosjoseph@gmail.com', 'tieeeeen1994@gmail.com']
+  s.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[.git .github Gemfile .vscode]) ||
+        f.end_with?(*%w[.gem .yml .gitignore])
+    end
+  end
+  s.homepage = 'https://github.com/tieeeeen1994/changelogko'
+  s.license = 'MIT'
+  s.executables = %w[changelogko releaseko cko rko]
+  s.required_ruby_version = '>= 3.2.2'
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/changelogs/archive-Feb-16-2024-10-21-04.md

@@ -0,0 +1,6 @@
+# Changelogs 
+## Added (1 count/s)
+  + Display help even when no argument is specified - tieeeeen1994 (tieeeeen1994@gmail.com)
+## Enhanced (1 count/s)
+  + Comply to Rubocop - tieeeeen1994 (tieeeeen1994@gmail.com)
+

data/changelogs/archive-Nov-07-2022-09-15-11.md

@@ -0,0 +1,6 @@
+# Changelogs 
+## Added (1 count/s)
+  + Integrate bin/release in this gem called Releaseko - tieeeeen1994 (tieeeeen1994@gmail.com)
+## Enhanced (1 count/s)
+  + Upgrade bin/changelog into a gem called Changelogko - tieeeeen1994 (tieeeeen1994@gmail.com)
+

data/lib/changelog/creator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Class responsible for creating the file.
+class Changelog::Creator
+  def self.call(options)
+    changelog = Changelog.new(options, :options)
+    changelog.validate!
+    changelog.save
+  end
+end

data/lib/changelog/option_parser.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Class responsible for parsing options and detecting arguments passed for Changelogko.
+class Changelog::OptionParser
+  Options = Struct.new(:release, :title, :type, :no_archive)
+
+  def self.parse(argv)
+    options = Options.new
+
+    parser = option_parser(options)
+
+    argv = ['-h'] if argv.empty?
+    parser.parse!(argv)
+
+    options.title = argv.join(' ').strip.squeeze(' ').tr("\r\n", '') unless options.release
+    options
+  end
+
+  def self.option_parser(options)
+    ::OptionParser.new do |opts|
+      opts.banner = "Usage: (changelogko|cko) [options]\nOptions:\n"
+
+      release_option(opts, options)
+      type_option(opts, options)
+      types_option(opts)
+      no_archive_option(opts, options)
+      help_option(opts)
+    end
+  end
+
+  def self.release_option(opts, options)
+    opts.on('-r', '--release', 'Create release from unreleased directory.') do
+      options.release = true
+    end
+  end
+
+  def self.type_option(opts, options)
+    type_desc = 'Type of changelog. Use -T, --types to display all available types.'
+    opts.on('-t', '--type [title]', String, type_desc) do |value|
+      options.type = value
+    end
+  end
+
+  def self.types_option(opts)
+    opts.on('-T', '--types', 'List available types.') do
+      TYPES.each do |type|
+        $stdout.puts "#{type.name}#{type.description}"
+      end
+      raise ProcessEnded
+    end
+  end
+
+  def self.no_archive_option(opts, options)
+    opts.on('-A', '--no-archive', 'Do not archive the release after creating it.') do
+      options.no_archive = true
+    end
+  end
+
+  def self.help_option(opts)
+    opts.on('-h', '--help', 'Show help.') do
+      $stdout.puts opts
+      $stdout.puts 'Adding a .changelogko file in the root of the working directory will allow to automatically ' \
+                   'append the contents of the file as options to every `changelogko` (or `cko`) command. ' \
+                   'For example, assume the .changelogko file contains "--no-archive". ' \
+                   'For every changelogko command, it will automatically append --no-archive, ' \
+                   'as such: bundle exec changelogko -r --no-archive.'
+      raise ProcessEnded
+    end
+  end
+end

data/lib/changelog/writer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Class responsible for writing the change logs and collating them.
+class Changelog::Writer
+  def self.call(collection, no_archive = false)
+    generate_change_log(collection)
+    archive_old_change_log unless no_archive
+    publish_change_log
+    clear_unreleased_logs
+  end
+
+  def self.generate_change_log(collection)
+    File.open(TEMP_CHANGE_LOG_NAME, 'w') do |file|
+      write_title(file)
+      TYPES.each do |type|
+        write_collection(type, collection, file)
+      end
+      file.puts ''
+    end
+    puts "Creating temporary file  #{::TEMP_CHANGE_LOG_NAME}"
+  end
+
+  def self.archive_old_change_log
+    system('mkdir -p changelogs')
+    date_str = Time.now.strftime('%b-%d-%Y-%H-%M-%S')
+    old_change_log_location = "changelogs/archive-#{date_str}.md"
+    system("mv #{::CHANGE_LOG_NAME} #{old_change_log_location}")
+    puts 'Archive old Changelog'
+  end
+
+  def self.publish_change_log
+    system("mv #{::TEMP_CHANGE_LOG_NAME} #{::CHANGE_LOG_NAME}")
+    puts "Renamed #{::TEMP_CHANGE_LOG_NAME} to #{::CHANGE_LOG_NAME}"
+  end
+
+  def self.clear_unreleased_logs
+    puts 'Clearing changelogs/unreleased'
+    system('rm changelogs/unreleased/*')
+    system('rmdir changelogs/unreleased')
+  end
+
+  def self.write_title(file)
+    file.puts("# Changelogs \n")
+  end
+
+  def self.write_collection(type, collection, file)
+    lines = collection[type.name]
+    size = lines.size
+
+    return if size.zero?
+
+    file.puts("## #{type.name.capitalize} (#{size} count/s)\n")
+
+    write_lines(lines, file)
+  end
+
+  def self.write_lines(lines, file)
+    lines.each do |line|
+      file.puts("  + #{line.title} - #{line.author}")
+    end
+  end
+end

data/lib/changelog.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Main class that manages the set of actions for managing change logs.
+class Changelog
+  attr_reader :file_path, :errors, :type, :title, :options, :source, :author
+
+  def initialize(params, source = :file)
+    @source = source
+    @errors = []
+    if source == :file
+      @file_path = params
+    else
+      @options = params
+    end
+
+    load_data
+  end
+
+  def valid?
+    clear_errors
+    load_data
+    check_data
+
+    errors.empty?
+  end
+
+  def validate!
+    return true if valid?
+
+    raise InvalidLogFile, error_full_messages.join(".\n")
+  end
+
+  def file
+    @file ||= File.read(file_path)
+  end
+
+  def load_data
+    @title = data[:title]
+    @type = data[:type]
+    @author = data[:author]
+  end
+
+  def check_data
+    add_error 'Missing Title' if @title.nil?
+    add_error 'Missing Type' if @type.nil?
+    validate_type
+  end
+
+  def validate_type
+    type = TYPES.find { |t| t.name == @type }
+
+    add_error "Invalid Type '#{@type}'" unless type
+  end
+
+  def clear_errors
+    @errors = []
+  end
+
+  def data
+    @data ||= load_from_source
+  end
+
+  def load_from_source
+    if source == :file
+      yaml = YAML.safe_load(file)
+      initialize_props_from_yaml(yaml)
+    else
+      initialize_props_from_options
+    end
+  end
+
+  def initialize_props_from_yaml(yaml)
+    {
+      title: yaml.fetch('title', nil),
+      type: yaml.fetch('type', nil),
+      author: yaml.fetch('author', nil)
+    }
+  end
+
+  def initialize_props_from_options
+    {
+      title: options.title,
+      type: options.type,
+      author: author_name
+    }
+  end
+
+  def to_s
+    "Title: #{@title} | Type: #{@type}"
+  end
+
+  def author_name
+    name = "#{`git config user.name`[0..-2]} (#{`git config user.email`[0..-2]})"
+    name = "#{`git config --global user.name`[0..-2]} (#{`git config --global user.email`[0..-2]})" if name =~ /\A\s*\Z/
+    name
+  end
+
+  def show_errors
+    errors_full_messages.each { |message| puts message }
+  end
+
+  def error_full_messages
+    if source == :file
+      errors.collect { |error| "#{error} at #{file_path}" }
+    else
+      errors
+    end
+  end
+
+  def add_error(message)
+    errors << message
+  end
+
+  def save
+    File.open(generate_file_name, 'w') do |file|
+      file.puts("title: #{title}")
+      file.puts("author: #{author}")
+      file.puts("type: #{type}")
+    end
+  end
+
+  def generate_file_name
+    base_path = 'changelogs/unreleased'
+    FileUtils.mkdir_p(base_path)
+    safe_name = title.gsub(/[^\w-]/, '-')
+    "#{base_path}/#{safe_name}.yml"
+  end
+end

data/lib/changelogko.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require 'optparse'
+
+CHANGE_LOGS_PATH = './changelogs'
+CHANGE_LOG_NAME = './CHANGELOG.md'
+TEMP_CHANGE_LOG_NAME = './CHANGELOG.md.temp'
+InvalidLogFile = Class.new(StandardError)
+NoLogsFound = Class.new(StandardError)
+ProcessEnded = Class.new(StandardError)
+
+Type = Struct.new(:name, :description)
+
+TYPES = [
+  Type.new('added', "\t\tAdd something new like a new feature."),
+  Type.new('changed', "\t\tAlter something that already exists."),
+  Type.new('deprecated', "\tDepreciate an existing feature."),
+  Type.new('enhanced', "\tImprove an existing feature."),
+  Type.new('fixed', "\t\tFix a bug."),
+  Type.new('optimized', "\tRender a feature efficient and effective."),
+  Type.new('other', "\t\tEtc."),
+  Type.new('removed', "\t\tDelete a feature."),
+  Type.new('secured', "\t\tEstablish a security layer.")
+].freeze
+
+require 'changelog'
+require 'changelog/option_parser'
+require 'changelog/writer'
+require 'changelog/creator'
+
+begin
+  changelogko_command_file_path = "#{FileUtils.pwd}/.changelogko"
+  ARGV << File.read(changelogko_command_file_path).strip if File.exist?(changelogko_command_file_path)
+  options = Changelog::OptionParser.parse(ARGV)
+  if options.release
+    log_collection = {}
+    TYPES.each do |type|
+      log_collection[type.name] = []
+    end
+    files = 0
+    Dir.glob('./changelogs/unreleased/*.yml') do |file|
+      changelog = Changelog.new(file, :file)
+      changelog.validate!
+      log_collection[changelog.type] << changelog
+      files += 1
+    rescue InvalidLogFile => e
+      puts e.message
+      exit(1)
+    end
+    if files.positive?
+      Changelog::Writer.call(log_collection, options.no_archive)
+    else
+      puts 'No logs found at changelogs/unreleased/'
+    end
+  elsif options.title && options.type
+    Changelog::Creator.call(options)
+    # Changelog creation
+  end
+rescue InvalidLogFile => e
+  puts e.message
+  exit(1)
+rescue ProcessEnded
+  exit
+end

data/lib/releaseko/app_version.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Releaseko
+  # Class responsible for managing the file ./metadata/app-version.
+  class AppVersion
+    METHODS = %w[major minor build].freeze
+    FILE_PATH = File.join(Dir.pwd, 'metadata', 'app-version').freeze
+
+    attr_reader :method, :breakdown
+
+    def initialize(method)
+      @method = method
+      validate!
+    end
+
+    def perform
+      breakdown_version
+      increment_on_method
+      build_version!
+    end
+
+    private
+
+    def validate!
+      CustomError.new("Unknown method: #{method}").complain unless METHODS.include?(method)
+      CustomError.new("#{FILE_PATH} not found", 2).complain unless File.exist?(FILE_PATH)
+    end
+
+    def app_version
+      @app_version ||= File.read(FILE_PATH).strip
+    end
+
+    def build_version!
+      puts "Overwriting #{FILE_PATH} with new version"
+      new_version = "#{breakdown['major']}.#{breakdown['minor']}.#{breakdown['build']}"
+      File.write(FILE_PATH, new_version)
+    end
+
+    def breakdown_version
+      puts 'Breaking down version numbers'
+      version_numbers = app_version.split('.')
+      @breakdown = {
+        'major' => version_numbers[0],
+        'minor' => version_numbers[1],
+        'build' => version_numbers[2],
+        'other' => version_numbers[3..].join('.')
+      }
+    end
+
+    def increment_on_method
+      puts "Incrementing #{method} number"
+      breakdown[method] = breakdown[method].next
+      reset_trailing_version_numbers
+    end
+
+    def reset_trailing_version_numbers
+      ((METHODS.find_index(method) + 1)..(METHODS.length - 1)).each do |i|
+        breakdown[METHODS[i]] = 0
+      end
+    end
+  end
+end

data/lib/releaseko/changelog_wrapper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Releaseko
+  # Wrapper for Changelogko.
+  class ChangelogWrapper
+    def self.perform
+      puts 'Running changelogko -r'
+      return_value = system("#{'bundle exec ' if defined? Bundler}changelogko -r")
+      CustomError.new('changelogko crashed', $CHILD_STATUS.exitstatus).complain unless return_value
+    end
+  end
+end

data/lib/releaseko/custom_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Releaseko
+  # Custom Error object for Releaseko
+  class CustomError
+    attr_reader :message, :code
+
+    def initialize(message, code = 1)
+      @message = message
+      @code = code
+    end
+
+    def complain
+      puts "Error occurred!\n#{message}\nExit code #{code}"
+      exit(code)
+    end
+  end
+end

data/lib/releaseko/repository_updater.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Releaseko
+  # Class that is responsible for updating the repository.
+  class RepositoryUpdater
+    def self.perform
+      puts 'Updating remote repository'
+      system('git add CHANGELOG.md metadata/app-version changelogs/*')
+      system('git commit -m "Bump app version and release changelogs"')
+      system('git push')
+    end
+
+    def self.set_to_push
+      ['-p', '--push'].include?(ARGV[2])
+    end
+  end
+end

data/lib/releaseko.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'fileutils'
+require 'releaseko/custom_error'
+require 'releaseko/app_version'
+require 'releaseko/changelog_wrapper'
+require 'releaseko/repository_updater'
+
+begin
+  case ARGV[0]
+  when '-m', '--method'
+    Releaseko::AppVersion.new(ARGV[1]).perform
+    Releaseko::ChangelogWrapper.perform
+    Releaseko::RepositoryUpdater.perform if Releaseko::RepositoryUpdater.set_to_push
+    puts 'Release operation is a success!!!'
+  when '-h', '--help'
+    puts 'Usage: (releaseko|rko) [options]'
+    puts 'Options:'
+    puts '  -m, --method [major, minor, build] [-p, --push]'
+    puts '    Method of release so app version is updated accordingly.'
+    puts '    Extra option -p, --push will automatically commit and push the release to working branch.'
+    puts '    It will only push if the branch has a set upstream remote.'
+    puts '  -h, --help'
+    puts '    Display help. Duh.'
+    puts 'Methods:'
+    puts '  major  Increments major version number'
+    puts '  minor  Increments minor version number'
+    puts '  build  Increments build version number'
+  else
+    puts 'Use --help (-h) option for usage details'
+  end
+
+  exit(0)
+end

data/metadata/app-version

@@ -0,0 +1 @@
+1.4.0

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: changelogko
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Joseph Nelson Valeros
+- Jenek Michael Sarte
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-03 00:00:00.000000000 Z
+dependencies: []
+description: This is a gem that can manage changelogs very easily.
+email:
+- valerosjoseph@gmail.com
+- tieeeeen1994@gmail.com
+executables:
+- changelogko
+- releaseko
+- cko
+- rko
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/changelogko
+- bin/cko
+- bin/releaseko
+- bin/rko
+- changelogko.gemspec
+- changelogs/archive-Feb-16-2024-10-21-04.md
+- changelogs/archive-Nov-07-2022-09-15-11.md
+- lib/changelog.rb
+- lib/changelog/creator.rb
+- lib/changelog/option_parser.rb
+- lib/changelog/writer.rb
+- lib/changelogko.rb
+- lib/releaseko.rb
+- lib/releaseko/app_version.rb
+- lib/releaseko/changelog_wrapper.rb
+- lib/releaseko/custom_error.rb
+- lib/releaseko/repository_updater.rb
+- metadata/app-version
+homepage: https://github.com/tieeeeen1994/changelogko
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Manage changelogs easily!
+test_files: []