services-changelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56dba570ee5ae94f62f527c77da48d0865d8f46f5705bc56a4f27130cdf36a83
+  data.tar.gz: eadf192e93fefc3f32860398b4103c2b4f87f5e9b311378f883e299ada0dab56
+SHA512:
+  metadata.gz: 90324b6fce93ecb8949346d0797da147f344959cbb75880af491794c34814a3687dfa460dad0587e7e2d03cb0d94c1f2b93a477054b455c2addceafcec1ba437
+  data.tar.gz: 22f2c30e43bf8e04934c25281e96ab37e64e118ce19c585b62c846bc64c5f470539fe5160def91a4f262f9349b5e22d3c42a1090fc430872ac4b80d0a9751c94

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Nexus Mods Test Changelog
+
+
+## [2022-10-22]
+This is the original release for this gem. I setup a basic proof-of-concept
+
+### Added
+- Added initial proof of concept and basic ideas

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rake", "~> 13.0"
+gem 'activesupport'
+gem 'dry-cli'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-cli (0.7.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport
+  dry-cli
+  rake (~> 13.0)
+  rspec
+
+BUNDLED WITH
+   2.3.5

data/README.md

@@ -0,0 +1,88 @@
+# ServicesChangelog
+
+This gem is intended to be used from the CLI. If needed, it can be importing and extended as required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'services-changelog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install services-changelog
+
+## Usage
+
+The available commands are:
+
+```
+Commands:
+  changelog new [NAME]            # Creates a new changelog entry
+  changelog parse                 # Lists all changelog entries
+  changelog version               # Print version
+```
+
+The system expects a folder structure setup in your project, with a list of yaml files documenting your changelog entries:
+
+```
+changelog/
+  2022.01.01/
+    feature1.yaml
+    feature2.yaml
+```
+
+## Configuration
+
+The changelog generation config can be changed at multiple levels:
+
+### changelog/config.yaml
+
+This is the base config for the changelog and has the following options:
+
+```yaml
+title: "Changelog" # Change the default title of the changelog
+intro: "This is my changelog"
+```
+
+### changelog/VERSION/meta.yaml
+
+This is the version meta file - allowing extra metadata for the version declaration.
+
+```yaml
+description: "This version was aimed at improving the application."
+```
+
+### changelog/VERSION/FEATURE.yaml
+
+These files are added for every line of the changelog you wish to add:
+
+```yaml
+title: 'Added initial proof of concept and basic ideas'
+type: 'Added'
+description: ''
+merge_request: null
+issue: null
+author: null
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/example-ruby-gem.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/changelog/2022-10-22/added_new_thing.yaml

@@ -0,0 +1,7 @@
+--- 
+title: 'Added initial proof of concept and basic ideas'
+type: 'Added'
+description: ''
+merge_request: null
+issue: null
+author: null

data/changelog/2022-10-22/meta.yaml

@@ -0,0 +1,2 @@
+---
+description: "This is the original release for this gem. I setup a basic proof-of-concept"

data/changelog/config.yaml

@@ -0,0 +1 @@
+title: "Nexus Mods Test Changelog"

data/exe/changelog

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#
+require 'bundler/setup'
+
+require_relative '../lib/services_changelog'
+
+Dry::CLI.new(ServicesChangelog::CLI::Commands).call

data/lib/services_changelog/changelog.rb

@@ -0,0 +1,33 @@
+module ServicesChangelog
+  class Changelog
+    # @return [Hash{String => Release}] versions All versions parsed.
+    attr_accessor :versions
+
+    attr_accessor :title, :url, :intro
+
+    def initialize
+      self.versions = {}
+    end
+
+    def initialize_version(version)
+      return if versions[version]
+
+      versions[version] = Release.new
+      versions[version].title = version
+      versions[version].description = "Description"
+    end
+
+    def as_json(_options = {})
+      {
+        title: title,
+        intro: intro,
+        url: url,
+        versions: versions
+      }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/services_changelog/cli.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+# typed: true
+require 'dry/cli'
+require 'active_support/core_ext/string/inflections'
+
+module ServicesChangelog
+  TOOL_VERSION = '1.0.0'
+
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        desc 'Print version'
+
+        def call(*)
+          puts TOOL_VERSION
+        end
+      end
+
+      class Parse < Dry::CLI::Command
+        desc 'Lists all changelog entries'
+
+        option :format, default: 'json', values: %w[json yaml md markdown], desc: 'Output format'
+        option :paths, default: 'changelog', desc: 'Input paths to pull changelog entries from. Can be comma seperated'
+
+        def call(**options)
+          # Get Formatters
+          out_formatter = Object.const_get("ServicesChangelog::Formatters::#{options.fetch(:format).to_s.capitalize}Formatter")
+
+          parser = Parser.new(formatter: out_formatter.new)
+          parser.load(options.fetch(:paths))
+
+          puts parser.output
+        end
+      end
+
+      class New < Dry::CLI::Command
+        include Logging
+        require 'erb'
+
+        desc 'Creates a new changelog entry'
+
+        argument :name, desc: 'Name of the changelog entry'
+
+        example [
+          'added new feature # Creates a new changelog entry pre-populated with a basic template'
+        ]
+
+        def call(**options)
+          logger.debug 'Finding changelogs directory'
+          if Dir.exist? 'changelog'
+
+            logger.debug 'Creating new entry'
+
+            contents = <<~EOL
+              ---#{' '}
+              title: 'TODO: Add title'
+              type: 'Updated'
+              description: 'TODO'
+              merge_request: null
+              issue: null
+              author: null
+            EOL
+            dir = "changelog/#{Time.new.strftime('%Y-%m-%d')}"
+
+            filename = options.fetch(:name).to_s.parameterize(separator: '_')
+
+            Dir.mkdir(dir) unless Dir.exist? dir
+
+            File.write("#{dir}/#{filename}.yaml", contents)
+
+          else
+            logger.error 'Cannot find changelogs directory'
+          end
+        end
+      end
+
+      register 'version', Version, aliases: ['v', '-v', '--version']
+      register 'parse',   Parse
+      register 'new',     New
+    end
+  end
+end

data/lib/services_changelog/entry.rb

@@ -0,0 +1,29 @@
+module ServicesChangelog
+  class ChangelogEntry
+    attr_accessor :title, :type, :description, :merge_request, :issue, :author
+
+    def initialize(title:, type:, description:, merge_request:, issue:, author:)
+      self.title = title
+      self.type = type
+      self.description = description
+      self.merge_request = merge_request
+      self.issue = issue
+      self.author = author
+    end
+
+    def as_json(_options = {})
+      {
+        title: title,
+        type: type,
+        description: description,
+        merge_request: merge_request,
+        issue: issue,
+        author: author
+      }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/services_changelog/formatters/json_formatter.rb

@@ -0,0 +1,12 @@
+require 'json'
+
+module ServicesChangelog
+  module Formatters
+  class JsonFormatter
+    # @param [ServicesChangelog::Changelog] data
+    def output(data)
+      JSON.pretty_generate(data)
+    end
+  end
+  end
+end

data/lib/services_changelog/formatters/markdown_formatter.rb

@@ -0,0 +1,21 @@
+require 'erb'
+
+module ServicesChangelog
+  module Formatters
+  class MarkdownFormatter
+    # @param [ServicesChangelog::Changelog] data
+    def output(data)
+      template = ERB.new File.read 'lib/services_changelog/templates/changelog.md.erb'
+
+      versions = data.versions.values
+
+      result = template.result binding
+
+      File.write("CHANGELOG.md", result)
+      File.chmod(0777, "CHANGELOG.md")
+
+      result
+    end
+  end
+  end
+end

data/lib/services_changelog/formatters/yaml_formatter.rb

@@ -0,0 +1,9 @@
+module ServicesChangelog
+  module Formatters
+    class YamlFormatter
+      def output(data)
+        data.to_yaml
+      end
+    end
+  end
+end

data/lib/services_changelog/logging.rb

@@ -0,0 +1,56 @@
+require 'logger'
+
+class Logger
+  module Colors
+    VERSION = '1.0.0'
+
+    NOTHING      = '0;0'
+    BLACK        = '0;30'
+    RED          = '0;31'
+    GREEN        = '0;32'
+    BROWN        = '0;33'
+    BLUE         = '0;34'
+    PURPLE       = '0;35'
+    CYAN         = '0;36'
+    LIGHT_GRAY   = '0;37'
+    DARK_GRAY    = '1;30'
+    LIGHT_RED    = '1;31'
+    LIGHT_GREEN  = '1;32'
+    YELLOW       = '1;33'
+    LIGHT_BLUE   = '1;34'
+    LIGHT_PURPLE = '1;35'
+    LIGHT_CYAN   = '1;36'
+    WHITE        = '1;37'
+
+    SCHEMA = {
+      STDOUT => %w[nothing green brown red purple cyan],
+      STDERR => %w[nothing green yellow light_red light_purple light_cyan]
+    }
+  end
+end
+
+class Logger
+  alias format_message_colorless format_message
+
+  def format_message(level, *args)
+    if Logger::Colors::SCHEMA[@logdev.dev]
+      color = begin
+        Logger::Colors.const_get \
+          Logger::Colors::SCHEMA[@logdev.dev][Logger.const_get(level.sub('ANY', 'UNKNOWN'))].to_s.upcase
+      rescue NameError
+        '0;0'
+      end
+      "\e[#{color}m#{format_message_colorless(level, *args)}\e[0;0m"
+    else
+      format_message_colorless(level, *args)
+    end
+  end
+end
+
+module ServicesChangelog
+  module Logging
+    def logger
+      @logger || Logger.new(STDOUT)
+    end
+  end
+end

data/lib/services_changelog/parser.rb

@@ -0,0 +1,94 @@
+require 'yaml'
+
+module ServicesChangelog
+  class Parser
+    include Logging
+
+    attr_accessor :parsed_content
+
+    # @return [ServicesChangelog::Changelog]
+    attr_accessor :changelog
+
+    # @return [Formatter]
+    attr_accessor :formatter
+
+    def initialize(formatter:)
+      self.formatter = formatter
+      self.changelog = Changelog.new
+    end
+
+    def output
+      formatter.output(changelog)
+    end
+
+    # Parse a folder with YAML files
+    def load(path = nil)
+      path ||= 'changelog'
+      logger.debug "Loading from '#{path}'"
+      load_config("#{path}/config.yaml")
+      Dir.glob("#{path}/*").each { |f| parse_version(f) }
+    end
+
+    private
+
+    def load_config(path)
+      unless File.exist?(path)
+        logger.debug "No config.yaml file found at #{path}"
+        return
+      end
+
+      content = File.open(path, &:read)
+      yaml = YAML.safe_load content
+      unless yaml
+        logger.debug 'config.yaml file is empty or invalid'
+        return
+      end
+      changelog.title = yaml['title']
+      changelog.url = yaml['url']
+      changelog.intro = yaml['intro']
+    end
+
+    def add_change(yaml, version)
+      type = yaml['type'] || 'Updated'
+      changelog.versions[version].entries[type] = [] if changelog.versions[version].entries[type].nil?
+
+      changelog.versions[version].entries[type] << ChangelogEntry.new(
+        title: yaml['title'],
+        type: yaml['type'],
+        description: yaml['description'],
+        merge_request: yaml['merge_request'],
+        issue: yaml['issue'],
+        author: yaml['author']
+      )
+    end
+
+    def parse_version(folder)
+      version = File.basename(folder)
+      return if version == 'config.yaml'
+
+      changelog.initialize_version version
+      metafile = "#{folder}/meta.yaml"
+
+      files = Dir.glob("#{folder}/*.yaml").reject { |i| i == metafile }
+
+      if File.exists? metafile
+        meta = YAML.safe_load File.open(metafile, &:read)
+
+        return if meta.nil?
+
+        changelog.versions[version].description = meta["description"]
+      end
+
+      logger.debug "Found #{files.count} file(s) for version #{version}"
+      files.sort.each { |f| parse_file(f, version) }
+    end
+
+    def parse_file(filename, version)
+      logger.debug "Parsing #{filename} for version #{version}"
+      yaml = YAML.safe_load File.open(filename, &:read)
+      return {} unless yaml
+
+      add_change yaml, version
+    end
+  end
+end

data/lib/services_changelog/release.rb

@@ -0,0 +1,22 @@
+class Release
+  attr_accessor :title, :description
+
+  # @return [Hash{String => Array(ServicesChangelog::Entry)}]
+  attr_accessor :entries
+
+  def initialize
+    self.entries = {}
+  end
+
+  def as_json(_options = {})
+    {
+      title: title,
+      description: description,
+      entries: entries
+    }
+  end
+
+  def to_json(*options)
+    as_json(*options).to_json(*options)
+  end
+end

data/lib/services_changelog/templates/changelog.md.erb

@@ -0,0 +1,9 @@
+# <%= data.title %>
+<%= data.intro %>
+<% versions.each { |version| %>
+## [<%= version.title %>]<% unless version.description.nil? %>
+<%= version.description %><% end %>
+<% version.entries.each_pair { |type, changes| %>
+### <%= type %>
+<% changes.each { |change| %>- <%= change.title %>
+<% } } } %>

data/lib/services_changelog/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ServicesChangelog
+  # Leave this as 0.1.0 in order for CI process to replace with the tagged version.
+  VERSION = '0.1.0'
+end

data/lib/services_changelog.rb

@@ -0,0 +1,10 @@
+require_relative 'services_changelog/version'
+require_relative 'services_changelog/logging'
+require_relative 'services_changelog/cli'
+require_relative 'services_changelog/parser'
+require_relative 'services_changelog/formatters/yaml_formatter'
+require_relative 'services_changelog/formatters/json_formatter'
+require_relative 'services_changelog/formatters/markdown_formatter'
+require_relative 'services_changelog/changelog'
+require_relative 'services_changelog/entry'
+require_relative 'services_changelog/release'

data/services-changelog.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/services_changelog/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "services-changelog"
+  spec.version = ServicesChangelog::VERSION
+  spec.authors = ["Dean Lovett"]
+  spec.email = ["dean.lovett@nexusmods.com"]
+
+  spec.summary = "Converts a group of yaml files, broken down by date, to generate a changelog."
+  spec.description = <<EOF
+  Using this tool, changelogs can be created from a single project's changelog folder, or alternatively, multiple directories
+can be provied to collate all entries together.
+EOF
+  spec.homepage = "https://www.nexusmods.com"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://gitlab.nexdev.uk/Lovett/services-changelog'
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  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"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: services-changelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Lovett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-23 00:00:00.000000000 Z
+dependencies: []
+description: |2
+    Using this tool, changelogs can be created from a single project's changelog folder, or alternatively, multiple directories
+  can be provied to collate all entries together.
+email:
+- dean.lovett@nexusmods.com
+executables:
+- changelog
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- changelog/2022-10-22/added_new_thing.yaml
+- changelog/2022-10-22/meta.yaml
+- changelog/config.yaml
+- exe/changelog
+- lib/services_changelog.rb
+- lib/services_changelog/changelog.rb
+- lib/services_changelog/cli.rb
+- lib/services_changelog/entry.rb
+- lib/services_changelog/formatters/json_formatter.rb
+- lib/services_changelog/formatters/markdown_formatter.rb
+- lib/services_changelog/formatters/yaml_formatter.rb
+- lib/services_changelog/logging.rb
+- lib/services_changelog/parser.rb
+- lib/services_changelog/release.rb
+- lib/services_changelog/templates/changelog.md.erb
+- lib/services_changelog/version.rb
+- services-changelog.gemspec
+homepage: https://www.nexusmods.com
+licenses: []
+metadata:
+  homepage_uri: https://www.nexusmods.com
+  source_code_uri: https://gitlab.nexdev.uk/Lovett/services-changelog
+  changelog_uri: https://www.nexusmods.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Converts a group of yaml files, broken down by date, to generate a changelog.
+test_files: []