caretaker-core 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+This changelog was automatically generated using [Caretaker](https://github.com/DevelopersToolbox/caretaker) by [Wolf Software](https://github.com/WolfSoftware)
+
+### [v0.1.0](https://github.com/DevelopersToolbox/positronic-core/releases/v0.1.0)
+
+> Released on March, 3rd 2021
+
+- The initial commit [`[head]`](https://github.com/DevelopersToolbox/positronic-core/commit/)
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in slackit.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2009-2021` `Wolf Software Limited`
+
+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,207 @@
+<h1 align="center">
+	<a href="https://github.com/WolfSoftware">
+		<img src="https://raw.githubusercontent.com/WolfSoftware/branding/master/images/general/banners/64/black-and-white.png" alt="Wolf Software Logo" />
+	</a>
+	<br>
+	caretaker-core
+</h1>
+
+<p align="center">
+	<a href="https://travis-ci.com/DevelopersToolbox/caretaker-core">
+		<img src="https://img.shields.io/travis/com/DevelopersToolbox/caretaker-core/master?style=for-the-badge&logo=travis" alt="Build Status">
+	</a>
+	<a href="https://github.com/DevelopersToolbox/caretaker-core/releases/latest">
+		<img src="https://img.shields.io/github/v/release/DevelopersToolbox/caretaker-core?color=blue&style=for-the-badge&logo=github&logoColor=white&label=Latest%20Release" alt="Release">
+	</a>
+	<a href="https://github.com/DevelopersToolbox/caretaker-core/releases/latest">
+		<img src="https://img.shields.io/github/commits-since/DevelopersToolbox/caretaker-core/latest.svg?color=blue&style=for-the-badge&logo=github&logoColor=white" alt="Commits since release">
+	</a>
+	<a href="LICENSE.md">
+		<img src="https://img.shields.io/badge/license-MIT-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" alt="Software License">
+	</a>
+	<br>
+	<a href=".github/CODE_OF_CONDUCT.md">
+		<img src="https://img.shields.io/badge/Code%20of%20Conduct-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+	<a href=".github/CONTRIBUTING.md">
+		<img src="https://img.shields.io/badge/Contributing-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+	<a href=".github/SECURITY.md">
+		<img src="https://img.shields.io/badge/Report%20Security%20Concern-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+	<a href=".github/SUPPORT.md">
+		<img src="https://img.shields.io/badge/Get%20Support-blue?style=for-the-badge&logo=read-the-docs&logoColor=white" />
+	</a>
+</p>
+
+## Overview
+
+caretaker Core is the brain that makes [Sonny](https://github.com/DevelopersToolbox/sonny) work, it processes the git log for a given repository and returns all of the required information as a single JSON object.
+
+[Sonny](https://github.com/DevelopersToolbox/sonny) makes use of this object in order to dynamically build a CHANGELOG.md file for the given project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'caretaker-core'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install caretaker-core
+
+## Usage
+
+The following is a very [simple snippet](testing/get-raw.rb) showing how to integrate the core into your own code. The key is the single call to [caretakerCore.run](lib/caretaker-core.rb#L20).
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'json'
+require 'caretaker-core'
+
+begin
+    results = caretakerCore.run
+rescue StandardError => e
+    puts e.message
+    exit
+end
+
+puts JSON.pretty_generate(JSON.parse(results))
+```
+
+### Output
+
+The output from [caretakerCore.run](lib/caretaker-core.rb#L20) is a JSON formatted object. In the case of an error it will raise a `StandardError`. 
+
+The basic structure of the JSON is as follows:
+
+```yaml
+{
+    "tags": [ ],
+    "commits": {
+        "chronological": { },
+        "categorised": { },
+    },
+    "repo": {
+        "url": "",
+        "slug": ""
+    }
+}
+```
+* tags - An array of tag names, it will also include 'untagged' for all commits that are not part of a tag.
+* commits - A hash with 2 elements
+    * chronological - All commits in chronological order.
+    * categorised - All commits split by category.
+* repo - A hash with information relating to the repository
+    * url - The full base url to the repo (e.g. https://github.com/DevelopersToolbox/caretaker-core)
+    * slug - The github organisation / repository name (e.g. DevelopersToolbox/caretaker-core)
+
+A more full example (Showing a single commit)
+
+```yaml
+{
+    "tags": [
+        "untagged"
+    ],
+    "commits": {
+        "chronological": {
+            "untagged": [
+                {
+                    "hash": "11781d3",
+                    "hash_full": "11781d3cbdac68a003492fc0d318d402dd241579",
+                    "subject": "The initial commit",
+                    "extra": false,
+                    "commit_type": "commit",
+                    "category": "Uncategorised:",
+                    "date": "2021-03-03"
+                }
+            ]
+        },
+        "categorised": {
+            "untagged": {
+                "New Features:": [ ],
+                "Improvements:": [ ],
+                "Bug Fixes:": [ ],
+                "Security Fixes:": [ ],
+                "Refactor:": [ ],
+                "Style:": [ ],
+                "Deprecated:": [ ],
+                "Removed:": [ ],
+                "Tests:": [ ],
+                "Documentation:": [ ],
+                "Chores:": [ ],
+                "Experiments:": [ ],
+                "Miscellaneous:": [ ],
+                "Uncategorised:": [
+                    {
+                        "hash": "11781d3",
+                        "hash_full": "11781d3cbdac68a003492fc0d318d402dd241579",
+                        "subject": "The initial commit",
+                        "extra": false,
+                        "commit_type": "commit",
+                        "category": "Uncategorised:",
+                        "date": "2021-03-03"
+                    }
+                ],
+                "Initial Commit:": [ ],
+                "Skip:": [ ]
+            }
+        }
+    },
+    "repo": {
+        "url": "https://github.com/DevelopersToolbox/caretaker-core",
+        "slug": "DevelopersToolbox/caretaker-core"
+    }
+}
+```
+
+#### Other Values
+
+| Name | Purpose | Possible Values |
+| ---- | ------- | --------------- |
+| hash | Stores the short hash for the commit. | 7 character hexidecimal string |
+| hash_full | Stores the full hash for the commit. | 40 character hexodecimal string|
+| commit_message | The commit message message. | Anything alphanumberic |
+| child_commit_messages | The commit messages of any commits that form part of a pull/merge request | Anything alphanumberic or false |
+| commit_type | The type of commit | pr or commit |
+| category | The category the commit belongs to | [Category List](lib/caretaker-core/config.rb#L13) |
+| date | The date the commit was made | YYYY-MM-DD format |
+
+> For more information about the use of categories - please refer to the sonny documentation.
+
+### Limitations with regards to Pull Requests
+
+1. Squished commits work as exepected and the contents of the child commmits is available
+2. Rebased commits show as local commits as there is no way to see where they came from
+3. Unsquished commits only show the PR commit_message as the child commits are ignored
+
+> Our advice is to always use Squished commits.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Contributors
+
+<p>
+	<a href="https://github.com/TGWolf">
+		<img src="https://img.shields.io/badge/Wolf-black?style=for-the-badge" />
+	</a>
+</p>
+
+## Show Support
+
+<p>
+	<a href="https://ko-fi.com/wolfsoftware">
+		<img src="https://img.shields.io/badge/Ko%20Fi-blue?style=for-the-badge&logo=ko-fi&logoColor=white" />
+	</a>
+</p>

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION.txt

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'caretaker-core'
+
+# 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/caretaker-core.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'caretaker-core/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = 'caretaker-core'
+    spec.version       = CaretakerCore::VERSION
+    spec.authors       = ['Tim Gurney aka Wolf']
+    spec.email         = ['wolf@tgwolf.com']
+
+    spec.summary       = 'caretaker-core'
+    spec.description   = 'caretaker-core'
+    spec.homepage      = 'https://github.com/DevelopersToolbox/caretaker-core'
+    spec.license       = 'MIT'
+
+    spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/DevelopersToolbox/caretaker-core'
+    spec.metadata['changelog_uri'] = 'https://github.com/DevelopersToolbox/caretaker-core/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.
+    # rubocop:disable Metrics/Layout/ExtraSpacing, Layout/SpaceAroundOperators
+    spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+        `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+    # rubocop:enable Metrics/Layout/ExtraSpacing, Layout/SpaceAroundOperators
+
+    spec.bindir        = 'exe'
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.add_development_dependency 'bundler', '~> 2'
+    spec.add_development_dependency 'json', '~> 2'
+    spec.add_development_dependency 'rake', '~> 12.3.3'
+    spec.add_development_dependency 'rspec', '~> 3.0'
+
+    spec.add_runtime_dependency 'json', '~> 2'
+end

data/lib/caretaker-core.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+#
+# We will need to change this when we restrcuture the code
+#
+require 'caretaker-core/core'
+require 'caretaker-core/version'
+
+#
+# Docs to go here
+#
+class CaretakerCore
+    #
+    # Docs to go here
+    #
+    class << self
+        #
+        # Docs to go here
+        #
+        def run(options = {})
+            # Will throw an exception if not a git repo
+            check_for_git_repo
+
+            # Set the initial config and handle user supplied options
+            config = init_config(options)
+
+            # Get URL and slug for the repo, will throw and exception if no remote origin is set
+            repository, slug = git_repo_details
+
+            # Add to config for easy access
+            config[:repo_url] = repository
+
+            # Really do the processing
+            tags, chronological, categorised = real_process(config)
+
+            # Return the data to the calling function
+            { :tags => tags, :commits => { :chronological => chronological, :categorised => categorised }, :repo => { :url => repository, :slug => slug } }.to_json
+        end
+    end
+end

data/lib/caretaker-core/config.rb

@@ -0,0 +1,36 @@
+#
+# Description should go here
+#
+class CaretakerCore
+    #
+    # We want to create everything as a class/static method
+    #
+    class << self
+        # Class Constants
+        INITIAL_TAG       = 'untagged'.freeze
+
+        DEFAULT_CATEGORY  = 'Uncategorised:'.freeze
+        CATEGORIES        = {
+                                'New Features:'    => [ 'new feature:', 'new:', 'feature:' ],
+                                'Improvements:'    => [ 'improvement:', 'improve:' ],
+                                'Bug Fixes:'       => [ 'bug fix:', 'bug:', 'bugs:' ],
+                                'Security Fixes:'  => [ 'security: '],
+                                'Refactor:'        => [ ],
+                                'Style:'           => [ ],
+                                'Deprecated:'      => [ ],
+                                'Removed:'         => [ 'deleted:' ],
+                                'Tests:'           => [ 'test:', 'testing:' ],
+                                'Documentation:'   => [ 'docs: ' ],
+                                'Chores:'          => [ 'chore:' ],
+                                'Experiments:'     => [ 'experiment:' ],
+                                'Miscellaneous:'   => [ 'misc:' ],
+                                'Uncategorised:'   => [ 'no category:' ],
+                                'Initial Commit:'  => [ 'initial:' ],
+                                'Skip:'            => [ 'ignore:' ]
+                            }.freeze
+        DEFAULT_CONFIG    = {
+                                :enable_categories => false,
+                                :remove_categories => true
+                            }.freeze
+    end
+end

data/lib/caretaker-core/core.rb

@@ -0,0 +1,148 @@
+require 'date'
+require 'open3'
+require 'uri'
+
+require_relative 'config'
+require_relative 'git'
+require_relative 'process'
+require_relative 'tags'
+require_relative 'utils'
+
+# This is the core file
+# @author Wolf
+class CaretakerCore
+    #
+    # We want to create everything as a class/static method
+    #
+    class << self
+        #
+        # Make everything else private so it cannot be accessed directly
+        #
+
+        private
+
+        #
+        # Setup the require global configuration
+        #
+        def init_config(options)
+            # Assign the default config
+            config = DEFAULT_CONFIG
+
+            # Merge in any user supplied options/config and return
+            config.merge(options)
+        end
+
+        def real_process(config)
+            log_entries = retrieve_git_log_entries
+
+            return [ [], [], [] ] unless log_entries
+
+            parsed = parse_git_log_entries(config, log_entries)
+
+            tags = generate_tag_list(parsed)
+
+            chronological, categorised = process_results(parsed)
+
+            [tags, chronological, categorised]
+        end
+
+        #
+        # Limitations with regards to Pull Requests
+        #
+        # 1. Squished commits work as exepected and the contents of the child commmits is available
+        # 2. Rebased commits show as local commits as there is no way to see where they came from
+        # 3. Unsquished commits only show the PR commit_message as the child commits are ignored
+        #
+        # This method reeks of :reek:TooManyStatements { max_statements: 6 }
+        def parse_git_log_entries(config, log_entries)
+            logs = {}
+            tag = INITIAL_TAG
+
+            log_entries.each do |line|
+                tag, data = process_single_line(config, line, tag)
+
+                (logs[tag] ||= []) << data if data
+            end
+            logs
+        end
+
+        def get_parts(line, tag)
+            date, hash, hash_full, commit_message, tag = split_log_entries(line, tag)
+            commit_message, child_commit_messages, commit_type = process_commit_message(commit_message, hash)
+            category = get_category(commit_message)
+
+            [hash, hash_full, commit_message, child_commit_messages, commit_type, category, date, tag]
+        end
+
+        def process_single_line(config, line, tag)
+            hash, hash_full, commit_message, child_commit_messages, commit_type, category, date, tag = get_parts(line, tag)
+
+            return false if category.downcase == 'skip:'
+
+            commit_message = commit_message.sub(/.*?:/, '').strip if config[:remove_categories]
+
+            data = { :hash => hash, :hash_full => hash_full, :commit_message => commit_message, :child_commit_messages => child_commit_messages, :commit_type => commit_type, :category => category, :date => date }
+
+            [tag, data]
+        end
+
+        # This method reeks of :reek:DuplicateMethodCall, :reek:NestedIterators
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        def get_category(commit_message)
+            commit_message_downcase = commit_message.downcase
+
+            # Does it match a primary category ?
+            category = CATEGORIES.select { |key, _values| commit_message_downcase.start_with?(key.downcase) }.map(&:first).join
+
+            # If not a primary category, does it match one of the aliases?
+            category = CATEGORIES.select { |_key, values| values.any? { |value| commit_message_downcase.start_with?(value.downcase) } }.map(&:first).join if category.empty?
+
+            # If in doubt set to the default
+            category = DEFAULT_CATEGORY if category.empty?
+
+            category
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+        def get_pr_number(all_matches)
+            all_matches.to_a.compact.pop
+        end
+
+        def generate_pr_link(matches)
+            pr_number = get_pr_number(matches)
+
+            message = "Merge pull request ##{pr_number}"
+            [message, pr_number]
+        end
+
+        def process_merge_request(merge_message, hash, patterns)
+            matches = merge_message.match(patterns).captures
+
+            new_message = generate_pr_link(matches)
+
+            child_commit_messages = get_child_messages(hash)
+
+            [new_message, child_commit_messages]
+        end
+
+        def process_normal_commit(commit_message)
+            commit_type = :commit
+            [commit_message, commit_type]
+        end
+
+        def process_commit_message(commit_message, hash)
+            patterns_array = [/Merge pull request #(\d+).*/, /\.*\(#(\d+)\)*\)/]
+            patterns = Regexp.union(patterns_array)
+
+            child_commit_messages = false
+            commit_type = :pr
+
+            if commit_message.scan(/Merge pull request #(\d+).*/m).size.positive? || commit_message.scan(/\.*\(#(\d+)\)*\)/m).size.positive?
+                message, child_commit_messages = process_merge_request(commit_message, hash, patterns)
+            else
+                message, commit_type = process_normal_commit(commit_message)
+            end
+            [message, child_commit_messages, commit_type]
+        end
+    end
+end