macdiff 0.0.3

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/exe/macdiff

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'macdiff/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Macdiff::CLI.start
+rescue Macdiff::CLI::Error => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/ext/macdiff/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+create_makefile('macdiff/macdiff')

data/ext/macdiff/macdiff.c

@@ -0,0 +1,9 @@
+#include "macdiff.h"
+
+VALUE rb_mMacdiff;
+
+void
+Init_macdiff(void)
+{
+  rb_mMacdiff = rb_define_module("Macdiff");
+}

data/ext/macdiff/macdiff.h

@@ -0,0 +1,6 @@
+#ifndef MACDIFF_H
+#define MACDIFF_H 1
+
+#include "ruby.h"
+
+#endif /* MACDIFF_H */

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,21 @@
+#!/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] # revove 'v' character, e.g. v0.1.1 becomes 0.1.1
+
+output = <<~RUBY
+  # frozen_string_literal: true
+
+  module Macdiff
+    VERSION = '#{version}'
+  end
+RUBY
+
+printf "%-25<label>s : %<version>s\n", label: 'GEM VERSION', version: version
+File.open('lib/macdiff/version.rb', 'w+') { |f| f.write(output) }

data/lib/macdiff/app.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Macdiff
+  # Handle the global access such as configuration
+  class App
+    attr_reader :config
+
+    def initialize
+      @config = TTY::Config.new
+      @config.filename = 'macdiff'
+      @config.extname = '.yml'
+      # @config.append_path Dir.pwd # Dir.home
+      @config.append_path File.join(Dir.home, '.config')
+      @config.write unless @config.exist?
+      @config.read
+    end
+
+    def self.config
+      @config ||= new.config
+    end
+  end
+end

data/lib/macdiff/cli.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Macdiff
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'macdiff version'
+    def version
+      require_relative 'version'
+      puts 'v' + Macdiff::VERSION
+    end
+    map %w[--version -v] => :version
+  end
+end

data/lib/macdiff/command.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+require_relative 'app'
+require 'forwardable'
+require 'pastel'
+
+module Macdiff
+  # Base command class
+  class Command
+    extend Forwardable
+
+    attr_reader :pastel
+    # attr_reader :my_config_setting
+
+    def_delegators :command, :run
+
+    def initialize(options)
+      @options = options
+      @pastel = Pastel.new
+      config
+    end
+
+    # ----------------------------------------------------------------------
+    # Commandlet configuration helpers
+    # ----------------------------------------------------------------------
+
+    # Commandlet Configuration
+    def config
+      config = Macdiff::App.config
+
+      # @my_config_setting = config.fetch(:my_config_setting)
+
+      config
+    end
+
+    # Configuration set key/value
+    #
+    # example:
+    #   set(:name, 'David')
+    def config_set(key, value)
+      config.read
+      config.set(key, value: value)
+      config.write force: true
+      value
+    end
+    alias set config_set
+
+    # Configuration fetch key/value
+    #
+    # example:
+    #   get(:name) ==> 'David'
+    def config_fetch(key)
+      config.read
+      config.fetch(key)
+    end
+    alias get config_fetch
+
+    # ----------------------------------------------------------------------
+    # Screen rendering helpers
+    # ----------------------------------------------------------------------
+
+    # kv - Print Key/Value
+    def kv(key, value, key_width = 30)
+      puts "#{pastel.green(key.ljust(key_width))}: #{value}"
+    end
+
+    def line(size = 70, character = '=')
+      result = character * size
+      puts pastel.green(result)
+    end
+    alias l line
+
+    def heading(heading, size = 70)
+      line(size)
+      puts heading
+      line(size)
+    end
+
+    def subheading(heading, size = 70)
+      line(size, '-')
+      puts heading
+      line(size, '-')
+    end
+
+    # A section heading
+    #
+    # example:
+    # [ I am a heading ]----------------------------------------------------
+    def section_heading(heading, size = 70)
+      section_heading = "[ #{heading} ]#{'-' * (size - heading.length)}"
+
+      puts pastel.green(section_heading)
+    end
+
+    def pretty_print(obj)
+      puts JSON.pretty_generate obj
+    end
+
+    def print_all(data)
+      keys = data.first.keys
+      data.each do |row|
+        keys.each do |key|
+          puts "#{key.to_s.rjust(20)}: #{row[key].to_s.delete("\n")[1..100]}"
+        end
+        puts '-' * 120
+      end
+    end
+
+    # Print a pretty table
+    #
+    # Example:
+    #   values = [
+    #     ['less', which('less')],
+    #     ['ruby', which('ruby')]
+    #   ]
+    # pretty_table('Which paths', %w[key path], values)
+    def pretty_table(heading, column_headings, column_values)
+      heading heading
+
+      require 'tty-table'
+      table = TTY::Table.new column_headings, column_values
+      puts table.render(:unicode, multiline: true, resize: true)
+    end
+
+    # ----------------------------------------------------------------------
+    # Access to TTY helpers
+    # ----------------------------------------------------------------------
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    def clear_screen
+      puts cursor.clear_screen
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end

data/lib/macdiff/commands/.keep

@@ -0,0 +1 @@
+