caretaker 0.2.0

data/lib/caretaker/version.rb

@@ -0,0 +1,3 @@
+class Caretaker
+    VERSION = '0.2.0'.freeze
+end

data/spec/caretaker_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe Caretaker do
+    it 'has a version number' do
+        expect(Caretaker::VERSION).not_to be nil
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'caretaker'
+
+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

data/testing/caretaker

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift('./lib')
+
+require 'bundler/setup'
+require 'optparse'
+require 'caretaker'
+
+# -------------------------------------------------------------------------------- #
+# Send Mssage to Slack                                                             #
+# -------------------------------------------------------------------------------- #
+# This function will take the input arguments and then send the message.           #
+# -------------------------------------------------------------------------------- #
+
+def send_message_to_caretaker(options)
+    begin
+        caretaker = Caretaker.new(options)
+
+        caretaker.init_repo if options[:init]
+        caretaker.generate_config_file if options[:config]
+        caretaker.generate_changelog if options[:generate]
+    rescue StandardError => e
+        puts "Error: #{e}"
+        puts e.backtrace
+        exit(1)
+    end
+end
+
+# -------------------------------------------------------------------------------- #
+# Process Arguments                                                                #
+# -------------------------------------------------------------------------------- #
+# This function will process the input from the command line and work out what it  #
+# is that the user wants to see.                                                   #
+#                                                                                  #
+# This is the main processing function where all the processing logic is handled.  #
+# -------------------------------------------------------------------------------- #
+
+def process_arguments
+    options = { :generate => true, :init => false, :config => false, :enable_categories => false, :verbose => false }
+    # Enforce the presence of
+    mandatory = %I[]
+
+    optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$PROGRAM_NAME}"
+
+        opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit(1)
+        end
+
+        opts.on('-a', '--author string', 'Specify a default author name to use for commits (author name should be your GIthub username)') do |author|
+            options[:author] = author
+        end
+
+        opts.on('-c', '--config', 'Generate a .caretaker.cfg config file. [default: false]') do
+            options[:config] = true
+            options[:generate] = false
+            options[:init] = false
+        end
+
+        opts.on('-e', '--enable-categories', 'Enable the splitting of commit messages into categories. [default: false]') do
+            options[:enable_categories] = true
+            options[:remove_categories] = true
+        end
+
+        opts.on('-i', '--init', 'Initialise the repo to use Caretaker') do
+            options[:config] = false
+            options[:generate] = false
+            options[:init] = true
+        end
+
+        opts.on('-o', '--output string', 'Set the name of the output file. [default: CHANGELOG.md]') do |output|
+            options[:output] = output
+        end
+
+        opts.on('-r', '--remove-categories', 'Remove categories from commit messages. --enable-categories sets this to true') do
+            options[:remove_categories] = true
+        end
+
+        opts.on('-s', '--silent', 'Turn off all output from Caretaker, aka Silent Mode') do
+            options[:silent] = true
+        end
+
+        opts.on('-u', '--url-verification', 'Verify each url to ensure that the links are valid, skip any links that are not') do
+            options[:verify_urls] = true
+        end
+
+        opts.on('-w', '--words number', 'Minimum number of words needed to include a commit. [default: 1]') do |words|
+            options[:min_words] = words
+        end
+    end
+
+    begin
+        optparse.parse!
+        missing = mandatory.select { |param| options[param].nil? }
+        raise OptionParser::MissingArgument.new(missing.join(', ')) unless missing.empty?
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts e.to_s
+        puts optparse
+        exit
+    end
+
+    exit 0 if send_message_to_caretaker(options)
+
+    exit 1
+end
+
+# -------------------------------------------------------------------------------- #
+# Main()                                                                           #
+# -------------------------------------------------------------------------------- #
+# The main function where all of the heavy lifting and script config is done.      #
+# -------------------------------------------------------------------------------- #
+
+def main
+    process_arguments
+end
+
+main
+
+# -------------------------------------------------------------------------------- #
+# End of Script                                                                    #
+# -------------------------------------------------------------------------------- #
+# This is the end - nothing more to see here.                                      #
+# -------------------------------------------------------------------------------- #

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: caretaker
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tim Gurney aka Wolf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: date
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: date
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A gem for automatically generating a CHANGELOG.md from git log.
+email:
+- wolf@tgwolf.com
+executables:
+- caretaker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caretaker.gemspec
+- exe/caretaker
+- lib/caretaker.rb
+- lib/caretaker/version.rb
+- spec/caretaker_spec.rb
+- spec/spec_helper.rb
+- testing/caretaker
+homepage: https://github.com/WolfSoftware/caretaker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: An automated changelog generator.
+test_files: []