k_decor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b15a205ba61fec4f4099603d274333c9832a4a10726522c0e424cff8d64f767
+  data.tar.gz: ad770756eff0cb95f67c0b58217bebbd65fdc44a31df695b1c8769e900c90710
+SHA512:
+  metadata.gz: 854f3a3ea40f8fc5dbad8e704cacd84af85f32b161fba5d4e4d76f80db7e8a7f839324a4b63d0c41a118fad0f1ceec6364895430652fd1294302cef64dd3c40a
+  data.tar.gz: bfbdd4b5a65ce3a24d8c1f2f00429ed0127a26690593dd6ebc1af79b1640dd46d4cef0fa9746b9e263667733d59929ae295a45c1b50588a0e0d919f21c504971

data/.github/workflows/main.yml

@@ -0,0 +1,31 @@
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Install dependencies
+      run: |
+        gem install bundler -v 2.2.5
+        bundle install
+    - name: Run tests
+      run: bundle exec rspec
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,50 @@
+# Move this into a KLUE SATELITE DOCUMENT
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+#
+# The Octocat has a Gist containing some good rules to add to this file.
+#    https://gist.github.com/octocat/9257657
+
+# Ignore Klue Setup.sh
+/bin/runonce/
+k_decor.yml
+
+/_/
+/.bundle/
+/.history/
+/.yardoc
+/_yardoc/
+/coverage/
+/log/
+!/log/.keep
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+!/tmp/.keep
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Ruby Version
+.ruby-version
+
+# Environment File
+.env
+
+# Gems should not use a Gemfile.lock
+Gemfile.lock
+
+# RubyGem definitions
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+# ByeBug history
+.byebug_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,82 @@
+require: rubocop-rake
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+  ExtraDetails: true
+  NewCops: enable
+  Exclude:
+    - "_/**/*"
+    - "spec/samples/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/spec/**/*"
+    - "*.gemspec"
+  IgnoredMethods:
+    - configure
+    - context
+    - define
+    - describe
+    - draw
+    - factory
+    - feature
+    - guard
+    - included
+    - it
+    - let
+    - let!
+    - scenario
+    - setup
+    - shared_context
+    - shared_examples
+    - shared_examples_for
+    - transaction
+
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
+  Max: 200
+  # Ignores annotate output
+  IgnoredPatterns: ['\A# \*\*']
+  IgnoreCopDirectives: true
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Style/BlockComments:
+  Enabled: false
+  Include:
+    - "**/spec/*"
+
+# My Preferences - Start
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Exclude:
+    - "**/spec/**/*"
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/VariableNumber:
+  Exclude:
+    - "**/spec/**/*"
+Style/EmptyMethod:    
+  Exclude:
+    - "**/spec/**/*"
+Metrics/ParameterLists:
+  Exclude:
+    - "**/spec/**/*"
+Layout/EmptyLineBetweenDefs:
+  Exclude:
+    - "**/spec/**/*"
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "**/spec/**/*"
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Layout/SpaceBeforeComma:
+  Enabled: false
+# My Preferences - End

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at david.cruwys@bugcrowd.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in handlebars_helpers.gemspec
+gemspec
+
+# group :development do
+#   # Currently conflicts with GitHub actions and so I remove it on push
+#   # pry on steroids
+#   gem 'jazz_fingers'
+#   gem 'pry-coolline', github: 'owst/pry-coolline', branch: 'support_new_pry_config_api'
+# end
+
+group :development, :test do
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rake', '~> 12.0'
+  gem 'rake-compiler', require: false
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop'
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 David Cruwys
+
+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,82 @@
+# K Decor
+
+> KDecor provides decorators and management for applying data decoration to data objects
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k_decor'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install k_decor
+```
+
+## Stories
+
+### Main Story
+
+
+
+See all [stories](./STORIES.md)
+
+
+## Usage
+
+See all [usage examples](./USAGE.md)
+
+
+
+## Development
+
+Checkout the repo
+
+```bash
+git clone klueless-io/k_decor
+```
+
+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.
+
+```bash
+bin/console
+
+Aaa::Bbb::Program.execute()
+# => ""
+```
+
+`k_decor` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
+
+To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+```bash
+rake publish
+rake clean
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/k_decor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the K Decor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/klueless-io/k_decor/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) David Cruwys. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# source: https://stephenagrice.medium.com/making-a-command-line-ruby-gem-write-build-and-push-aec24c6c49eb
+
+GEM_NAME = 'k_decor'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'k_decor/version'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+desc 'Compile all the extensions'
+task build: :compile
+
+Rake::ExtensionTask.new('k_decor') do |ext|
+  ext.lib_dir = 'lib/k_decor'
+end
+
+desc 'Publish the gem to RubyGems.org'
+task :publish do
+  system 'gem build'
+  system "gem push #{GEM_NAME}-#{KDecor::VERSION}.gem"
+end
+
+desc 'Remove old *.gem files'
+task :clean do
+  system 'rm *.gem'
+end
+
+task default: %i[clobber compile spec]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'k_decor'
+
+# 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/k

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# NOTE: you may need change file permissions
+#       chmod +x bin/k
+
+help = %(
+----------------------------------------------------------------------
+Klue Scripts - Help
+----------------------------------------------------------------------
+k                       - This Help File
+
+khotfix                 - Create Hot Fix
+                          Hot fixes are created in GIT and versioned correctly.
+                          The patch # will increment by 1.
+                            e.g. v0.1.1 will become v0.1.2
+                          The version.rb file will also store the current version.
+                          usage:
+                            khotfix 'name of my cool hotfix'
+
+kgitsync                - Synchronize the master and development git repositories
+                          Pulls latest code, pushes current changes
+                          usage:
+                            kgitsync
+
+----------------------------------------------------------------------
+Rake Tasks
+----------------------------------------------------------------------
+
+rails db:seed             - load seed data
+
+rails db:seed sample=true - load sample data, useful in developer environments
+
+rails db:seed reset=true  - reset database
+)
+puts help

data/bin/kgitsync

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+
+#NOTE: you may need change file permissions
+#      chmod +x bin/kgitsync
+
+# Set up colour support, if we have it
+# Are stdout and  stderr both connected to a terminal
+# If not then don't set colours
+if [ -t 1 -a -t 2 ]
+then
+  if tput -V >/dev/null 2>&1
+  then
+    C_RED=`tput setaf 1`
+    C_GREEN=`tput setaf 2`
+    C_BROWN=`tput setaf 3`
+    C_BLUE=`tput setaf 4`
+    C_RESET=`tput sgr0`
+  fi
+fi
+
+
+exit_error ()
+{
+  # dont display if string is zero length
+  [  -z "$1" ] || echo "${C_RED}Error: ${C_BROWN} $1 ${C_RESET}"
+  exit 1
+}
+
+
+# make sure we are in a git tree
+[ "`git rev-parse --is-inside-work-tree`" = "true" ] || exit_error "NOT a git repository"
+echo "Repository check OK"
+
+CURRENT_BRANCH=`git branch | awk '/^\*/{print $2}'`
+
+# check that we are on develop or master
+#[ "${CURRENT_BRANCH}" = "master" -o "${CURRENT_BRANCH}" = "develop" ] || exit_error "You MUST be on either the master or development branch"
+#echo "Branch check OK"
+
+# check that the current branch is clean
+[  -z "`git status --porcelain`" ] || exit_error "Working copy has uncommitted changes"
+echo "Working copy is clean OK"
+
+# fetch from origin
+git fetch origin || exit_error "Failed to fetch from origin"
+
+######################
+# Do develop
+######################
+git checkout develop || exit_error "Failed to checkout develop branch"
+echo "Switched to develop"
+git merge origin/develop || exit_error "Failed to merge develop from origin"
+echo "Develop branch upto date"
+git push || exit_error "Failed to push develop to origin"
+echo "Develop pushed to origin"
+
+######################
+# Do master
+######################
+git checkout master || exit_error "Failed to checkout master branch"
+echo "Switched to master"
+git merge  origin/master || exit_error "Failed to merge master from origin"
+echo "Master branch upto date"
+git push || exit_error "Failed to push master to origin"
+echo "Master pushed to origin"
+
+######################
+# Do tags
+######################
+git push --tags || exit_error "Failed to push tags to origin"
+echo "Tags pushed to origin"
+
+# return to the current branch
+git checkout ${CURRENT_BRANCH} || exit_error "Failed to return to your origional branch ${CURRENT_BRANCH}"
+
+echo "${C_GREEN}Done.  you are on ${CURRENT_BRANCH}${C_RESET}"

data/bin/khotfix

@@ -0,0 +1,244 @@
+#!/usr/bin/env bash
+
+#NOTE: you may need change file permissions
+#      chmod +x bin/khotfix
+
+# Create a Versioned HotFix in Git and update the VERSION #
+# USAGE
+#
+#   ./bin/khotfix.sh 'my brand new hot fix'
+
+# HELPERS
+clear
+
+l_heading ()
+{
+  heading=$1
+
+  echo "======================================================================"
+  echo "${heading}"
+  echo "======================================================================"
+}
+
+l_line ()
+{
+  echo "----------------------------------------------------------------------"
+}
+
+l_title ()
+{
+  title=$1
+
+  l_line
+  echo "${title}"
+  l_line
+}
+
+l ()
+{
+  title=$1
+
+  echo "${title}"
+}
+
+lkv ()
+{
+  title=$1
+  value=$2
+
+  printf "%-25s : %s\n" "$title" "$value"
+}
+
+
+# expect 1 argument
+MESSAGE=$1
+
+l_heading "Make Hotfix - '${MESSAGE}'"
+
+
+# This environment var will prevent git from asking for merge messages
+export GIT_MERGE_AUTOEDIT=no
+
+# Set up colour support, if we have it
+# Are stdout and  stderr both connected to a terminal, If not then don't set colours
+if [ -t 1 -a -t 2 ]
+then
+  if tput -V >/dev/null 2>&1
+  then
+    C_RED=`tput setaf 1`
+    C_GREEN=`tput setaf 2`
+    C_BROWN=`tput setaf 3`
+    C_BLUE=`tput setaf 4`
+    C_RESET=`tput sgr0`
+  fi
+fi
+
+
+exit_error ()
+{
+  # dont display if string is zero length
+  [  -z "$1" ] || echo "${C_RED}Error: ${C_BROWN} $1 ${C_RESET}"
+  exit 1
+}
+
+
+# check arguments
+[ ! -z "${MESSAGE}" ] || exit_error "You must pass a message when making a hotfix"
+
+# make sure we are in a git tree
+[ "`git rev-parse --is-inside-work-tree`" = "true" ] || exit_error "NOT a git repository"
+l "Repository check OK"
+
+CURRENT_BRANCH=`git branch | awk '/^\*/{print $2}'`
+
+lkv "CURRENT_BRANCH" "${CURRENT_BRANCH}"
+
+# check that we are on develop or master
+[ "${CURRENT_BRANCH}" = "master" -o "${CURRENT_BRANCH}" = "develop" ] || exit_error "You MUST be on either the master or development branch"
+l "OK: Branch"
+
+# check that the current branch is NOT clean (we need changes to make a hotfix)
+[  ! -z "`git status --porcelain`" ] || exit_error "Working copy is clean - no hotfix"
+l "OK: Working copy has hotfix ready"
+
+# fetch from origin
+git fetch origin || exit_error "Failed to fetch from origin"
+l "OK: Fsetch from origin"
+
+# get the current directory that this script is in.
+# we assume that the other scripts are in the same directory
+SYNC_SCRIPT=kgitsync
+SCRIPT_DIR=`dirname $0`
+
+# ----------------------------------------------------------------------
+# GET VERSION NUMBER
+# ----------------------------------------------------------------------
+
+l_title 'GET VERSION NUMBER'
+
+# Get the last tag version
+VERSION=`git tag | sort -V | tail -1`
+lkv "CURENT VERSION" "${VERSION}"
+
+# NOTE, if you don't have a TAG then you might need to manually do
+# git flow hotfix start v0.01.001
+# git flow hotfix finish v0.01.001
+
+# Verify its format
+[[ "`git tag | sort -V | tail -1`"  =~ ^v[0-9]{1,2}.[0-9]{1,2}.[0-9]{1,3}$ ]] || exit_error "Bad version format, version=${VERSION}"
+# extract the version components
+IFS=. read MAJOR_VERSION MINOR_VERSION PATCH_VERSION <<< "${VERSION}"
+
+# inc the patch version.  note: force base 10 as leading 0 makes bash think this is octal
+PATCH_VERSION=$((10#${PATCH_VERSION} + 1))
+lkv 'Patch #' "${PATCH_VERSION}"
+
+# assemble the new version
+NEW_VERSION="${MAJOR_VERSION}.${MINOR_VERSION}.${PATCH_VERSION}"
+lkv "NEW VERSION" "${NEW_VERSION}"
+
+./hooks/update-version "${NEW_VERSION}" || exit_error "could not update version.rb you may need to run [chmod +x hooks/update-version]"
+
+l_line
+l 'git add .'
+git add .
+
+l 'git status'
+l_line
+git status
+
+# ----------------------------------------------------------------------
+# Before doing anything, add the files and then run the commit hook
+# Then stash any changes - working directory will be clean after this
+# The commit hook is where we can check for any debugging code that has
+# gone into the code and abort the commit
+# ----------------------------------------------------------------------
+
+l 'check for debugging code'
+./hooks/pre-commit || exit_error "remove debugging code from the commit - then run again"
+
+l "Stash changes to [git_make_hotfix: ${MESSAGE}]"
+
+git stash save "git_make_hotfix: ${MESSAGE}"
+
+l "OK: Stashed"
+
+l_title 'Master/Develop Branches'
+# ----------------------------------------------------------------------
+# update develop
+# ----------------------------------------------------------------------
+
+lkv "Develop" "Synchronized"
+git checkout develop || exit_error "Failed to checkout develop branch"
+lkv "Develop" "Switched"
+git merge origin/develop || exit_error "Failed to merge develop from origin"
+lkv "Develop" "Merged and upto date"
+
+# ----------------------------------------------------------------------
+# update master
+# ----------------------------------------------------------------------
+
+lkv "Master" "Synchronized"
+git checkout master || exit_error "Failed to checkout master branch"
+lkv "Master" "Switched"
+git merge  origin/master || exit_error "Failed to merge master from origin"
+lkv "Master" "Merged and upto date"
+
+# ----------------------------------------------------------------------
+# start the hotfix
+# ----------------------------------------------------------------------
+
+l_title 'Hotfix'
+
+lkv "Version" "${NEW_VERSION}"
+
+
+
+lkv "git flow hotfix start" "${NEW_VERSION}"
+
+git flow hotfix start "${NEW_VERSION}" || exit_error "Failed to start hotfix ${NEW_VERSION}"
+
+HOTFIX_BRANCH="hotfix/${NEW_VERSION}"
+
+lkv "started" "${HOTFIX_BRANCH}"
+
+# ----------------------------------------------------------------------
+# commit the stashed changes
+# ----------------------------------------------------------------------
+
+lkv "git stash" "pop"
+
+git stash pop || exit_error "Failed to pop the stash into the hotfix"
+
+lkv "git commit" "${MESSAGE}"
+
+git commit -a -m"${MESSAGE}" || exit_error "Failed to commit the stash to ${HOTFIX_BRANCH}"
+
+lkv "git commit succesful" "${HOTFIX_BRANCH}"
+
+# ----------------------------------------------------------------------
+# close the hotfix
+# ----------------------------------------------------------------------
+
+lkv "git flow hotfix finish" "${NEW_VERSION}"
+
+git flow hotfix finish "${NEW_VERSION}" -m"${MESSAGE}" || exit_error "Failed to close ${HOTFIX_BRANCH}"
+
+lkv "finished" "${HOTFIX_BRANCH}"
+
+# closing the hotfix leaves you on the development branch
+# return to the master ???? or should we stay on development
+
+lkv "git checkout" "master"
+
+git checkout master || exit_error "Failed to return to master branch"
+
+# ----------------------------------------------------------------------
+# now push the changes
+# ----------------------------------------------------------------------
+
+l_title 'Push Changes and Synchronize Master/Develop'
+
+${SCRIPT_DIR}/${SYNC_SCRIPT}
+
+l_heading 'Success'

data/bin/setup

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+# frozen_string_literal: true
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hooks/pre-commit

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'English'
+
+# NOTE: you may need change file permissions
+#       chmod +x hooks/pre-commit
+
+exit 0 if ARGV.include?('--no-verify')
+
+warning_keywords = %w[console.log]
+keywords = %w[binding.pry console.dir byebug debugger]
+files_changed = `git diff-index --name-only HEAD --`.split
+
+# puts '----------------------------------------------------------------------'
+# puts remove files changed from the pre-commit checking if they are one of the following files
+# puts '----------------------------------------------------------------------'
+# files_changed = files_changed - ['hooks/pre-commit']
+# files_changed = files_changed - ['hooks/update-version']
+
+# byebug may need to be in these files
+files_changed -= ['Gemfile']
+files_changed -= ['Gemfile.lock']
+files_changed -= ['.gitignore']
+files_changed -= ['README.md']
+
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.json') }
+files_changed = files_changed.reject { |f| f.downcase.end_with?('.yml') }
+
+# ignore files from specific folders
+
+file_groups = files_changed.select do |item|
+  item.start_with?('hooks') # ||
+  # item.start_with?('lib/generators')
+end
+
+files_changed -= file_groups
+
+# remove files that are changed because they are deleted
+files_changed = files_changed.select { |filename| File.file?(filename) }
+
+# puts '----------------------------------------------------------------------'
+# puts 'Files Changed'
+# puts '----------------------------------------------------------------------'
+# puts files_changed
+# puts '----------------------------------------------------------------------'
+
+unless files_changed.length.zero?
+  # puts "#{keywords.join('|')}"
+  # puts "#{files_changed.join(' ')}"
+
+  `git grep -q -E "#{warning_keywords.join('|')}" #{files_changed.join(' ')}`
+
+  if $CHILD_STATUS.exitstatus.zero?
+    puts '' # Check following lines:''
+    puts $CHILD_STATUS.exitstatus
+    files_changed.each do |file|
+      warning_keywords.each do |keyword|
+        # puts "#{keyword} ::: #{file}"
+        `git grep -q -E #{keyword} #{file}`
+        if $CHILD_STATUS.exitstatus.zero?
+          line = `git grep -n #{keyword} #{file} | awk -F ":" '{print $2}'`.split.join(', ')
+          puts "WARNING:\t\033[31m#{file}\033[0m contains #{keyword} at line \033[33m#{line}\033[0m."
+        end
+      end
+    end
+  end
+
+  `git grep -q -E "#{keywords.join('|')}" #{files_changed.join(' ')}`
+
+  if $CHILD_STATUS.exitstatus.zero?
+    puts '' # Check following lines:''
+    puts $CHILD_STATUS.exitstatus
+    files_changed.each do |file|
+      keywords.each do |keyword|
+        # puts "#{keyword} ::: #{file}"
+        `git grep -q -E #{keyword} #{file}`
+        if $CHILD_STATUS.exitstatus.zero?
+          line = `git grep -n #{keyword} #{file} | awk -F ":" '{print $2}'`.split.join(', ')
+          puts "ERROR  :\t\033[31m#{file}\033[0m contains #{keyword} at line \033[33m#{line}\033[0m."
+        end
+      end
+    end
+    puts '# Force commit with --no-verify'
+    exit 1
+  end
+end

data/hooks/update-version

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# NOTE: you may need change file permissions
+#       chmod +x hooks/update-version
+
+exit 1 if ARGV.empty?
+
+version = ARGV[0]
+version = version[1..-1] # revoke 'v' character, e.g. v0.1.1 becomes 0.1.1
+
+namespaces = %w[KDecor]
+
+indent = 0
+output = ['# frozen_string_literal: true', '']
+
+namespaces.each do |namespace|
+  output.push "#{'  ' * indent}module #{namespace}"
+  indent += 1
+end
+
+output.push "#{'  ' * indent}VERSION = \'#{version}'"
+indent -= 1
+
+namespaces.each do
+  output.push "#{'  ' * indent}end"
+  indent -= 1
+end
+
+output.push('')
+
+printf "%-25<label>s : %<version>s\n", label: 'GEM VERSION', version: version
+File.open('lib/k_decor/version.rb', 'w+') { |f| f.write(output.join("\n")) }

data/k_decor.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/k_decor/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version  = '>= 2.5'
+  spec.name                   = 'k_decor'
+  spec.version                = KDecor::VERSION
+  spec.authors                = ['David Cruwys']
+  spec.email                  = ['david@ideasmen.com.au']
+
+  spec.summary                = 'KDecor provides decorators and management for applying data decoration to data objects'
+  spec.description            = <<-TEXT
+    KDecor provides decorators and management for applying data decoration to data objects
+  TEXT
+  spec.homepage               = 'http://appydave.com/gems/k-decor'
+  spec.license                = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  # spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/klueless-io/k_decor'
+  spec.metadata['changelog_uri'] = 'https://github.com/klueless-io/k_decor/commits/master'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the RubyGem files 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.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  # spec.extensions    = ['ext/k_decor/extconf.rb']
+
+  # spec.add_dependency 'tty-box',         '~> 0.5.0'
+end

data/lib/k_decor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'k_decor/version'
+
+module KDecor
+  # raise KDecor::Error, 'Sample message'
+  class Error < StandardError; end
+
+  # Your code goes here...
+end

data/lib/k_decor/version.rb

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

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: k_decor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Cruwys
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-07 00:00:00.000000000 Z
+dependencies: []
+description: "    KDecor provides decorators and management for applying data decoration
+  to data objects\n"
+email:
+- david@ideasmen.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/k
+- bin/kgitsync
+- bin/khotfix
+- bin/setup
+- hooks/pre-commit
+- hooks/update-version
+- k_decor.gemspec
+- lib/k_decor.rb
+- lib/k_decor/version.rb
+homepage: http://appydave.com/gems/k-decor
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://appydave.com/gems/k-decor
+  source_code_uri: https://github.com/klueless-io/k_decor
+  changelog_uri: https://github.com/klueless-io/k_decor/commits/master
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.7
+signing_key:
+specification_version: 4
+summary: KDecor provides decorators and management for applying data decoration to
+  data objects
+test_files: []