k_fileset 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/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[KFileset]
+
+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_fileset/version.rb', 'w+') { |f| f.write(output.join("\n")) }

data/k_fileset.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'lib/k_fileset/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version  = '>= 2.5'
+  spec.name                   = 'k_fileset'
+  spec.version                = KFileset::VERSION
+  spec.authors                = ['David Cruwys']
+  spec.email                  = ['david@ideasmen.com.au']
+
+  spec.summary                = 'K-Fileset provides file system snapshot using GLOB inclusions and exclusions'
+  spec.description            = <<-TEXT
+    K-Fileset provides file system snapshot using GLOB inclusions and exclusions
+  TEXT
+  spec.homepage               = 'http://appydave.com/gems/k-fileset'
+  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_fileset'
+  spec.metadata['changelog_uri'] = 'https://github.com/klueless-io/k_fileset/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_fileset/extconf.rb']
+
+  spec.add_dependency 'k_log' , '~> 0.0.0'
+  # spec.add_dependency 'k_type'                , '~> 0.0.0'
+  # spec.add_dependency 'k_util'                , '~> 0.0.0'
+end

data/lib/k_fileset/file_set.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module KFileset
+  # FileSet will build up a list of files and/or folders that match a whitelist.
+  #
+  # Path <PathEntry> will point to a real file or folder
+  #
+  # That list of files can be filtered using exclusions that
+  # follow either Glob or Regex patterns.
+  #
+  # Resources:
+  #   - Rake-FileList: https://github.dev/ruby/rake/blob/5c60da8644a9e4f655e819252e3b6ca77f42b7af/lib/rake/file_list.rb
+  #   - Glob vs Regex: https://www.linuxjournal.com/content/globbing-and-regex-so-similar-so-different
+  #   - Glob patterns: http://web.mit.edu/racket_v612/amd64_ubuntu1404/racket/doc/file/glob.html
+  #   require 'rake/file_list'
+  #   Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)
+  class FileSet
+    DEF_FLAGS = File::FNM_PATHNAME | File::FNM_EXTGLOB
+    DEF_FLAGS_DOTMATCH = File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH
+
+    DEFAULT_IGNORE_PATTERNS = [
+      %r{(^|[/\\])CVS([/\\]|$)},
+      %r{(^|[/\\])\.svn([/\\]|$)},
+      /\.bak$/,
+      /~$/
+    ].freeze
+
+    IGNORE_LAMBDAS = {
+      # Match Examples: 'target/deep/a', 'target/deep/a/.', 'target/deep/a/b', 'target/deep/a/b/.'
+      folder: ->(path) { File.directory?(path) },
+
+      # Match Examples: 'target/deep/a', 'target/deep/a/b'
+      folder_current: ->(path) { File.directory?(path) && !path.end_with?('.') },
+
+      # Match Examples: 'target/deep/a/.', 'target/deep/a/b/.'
+      folder_current_dot: ->(path) { File.directory?(path) && path.end_with?('.') }
+    }.freeze
+
+    # proc { |fn| fn =~ /(^|[\/\\])core$/ && !File.directory?(fn) }
+    DEFAULT_IGNORE_LAMBDAS = [
+      IGNORE_LAMBDAS[:folder]
+    ].freeze
+
+    # Expression to detect standard file GLOB pattern
+    GLOB_PATTERN = /[*?\[{]/.freeze
+
+    attr_writer :file_set # paths / resources / path_entries / valid_resources
+    attr_reader :whitelist # whitelist (rules)
+
+    # FileSet will build up a list of files and/or folders that match a whitelist.
+
+    # attr_writer :items # paths / resources / path_entries / valid_resources
+    # attr_writer :paths # paths / resources / path_entries / valid_resources
+    # attr_writer :entries # paths / resources / path_entries / valid_resources
+    # attr_writer :path_entries # paths / resources / path_entries / valid_resources
+    # attr_writer :resource # paths / resources / path_entries / valid_resources
+
+    # attr_reader :whitelist_rules # whitelist (rules)
+    # attr_reader :whitelist_files # whitelist (rules)
+
+    def initialize
+      @dirty = false
+      @whitelist = KFileset::Whitelist.new
+      @file_set = {}
+    end
+
+    # Add a Glob with option exclusions to the whitelist
+    #
+    # @param [String] glob Any Bourne/Bash shell Glob pattern is acceptable
+    # @param [String|Regex|Array] exclude Glob Pattern or Regexp or Array of patterns to exclude.
+    # @param [String] exclude Glob Pattern
+    # @param [RegExp] exclude Regular expression
+    # @param [Array<String, Regex>] exclude List of Glob patterns or Regular expressions
+    def glob(glob, exclude: nil, flags: DEF_FLAGS, use_defaults: true)
+      exclude = add_default_exclusions(exclude, use_defaults)
+      @whitelist.add(glob, exclude, flags)
+      @dirty = true
+
+      self
+    end
+
+    # Add absolute file
+    def add(path)
+      path = Pathname.new(path).realpath
+      return if file_set.key?(path)
+      return unless whitelist.match?(file)
+
+      file_set.add(file)
+    end
+
+    def clear
+      @dirty = true
+      @file_set.clear
+      @whitelist.clear
+    end
+
+    def length
+      file_set.length
+    end
+
+    # def valid?(file)
+    #   return true if files.include?(file)
+
+    #   if new_file_match?(file)
+    #     @file_set.add(file)
+    #     return true
+    #   end
+
+    #   false
+    # end
+
+    def path_entries
+      @path_entries ||= file_set.values.sort_by(&:key)
+    end
+
+    def relative_paths
+      path_entries.map(&:to_path) # relative_path }
+    end
+
+    def absolute_paths
+      path_entries.map { |entry| entry.realpath.to_s }
+    end
+
+    def pwd
+      Dir.pwd
+    end
+
+    def remove(path)
+      path = abs_path(path)
+      file_set.delete(path)
+    end
+
+    def debug
+      path_entries.each(&:debug)
+    end
+
+    private
+
+    def abs_path(path)
+      Pathname.new(path).realpath.to_s
+    end
+
+    # renamed to path_entries | .paths
+    def file_set
+      return @file_set unless @dirty
+
+      @dirty = false
+      whitelist.path_entries.each do |path_entry|
+        # puts path_entry.class
+        # puts path_entry.key.class
+        # puts path_entry.key
+        @file_set[path_entry.key] = path_entry
+      end
+      @file_set
+      # @file_set = @file_set.merge()
+    end
+
+    def add_default_exclusions(exclude, use_defaults)
+      result = []
+
+      result += DEFAULT_IGNORE_PATTERNS if use_defaults
+      result += DEFAULT_IGNORE_LAMBDAS if use_defaults
+
+      return result unless exclude
+      return result + exclude if exclude.is_a?(Array)
+
+      result << exclude
+
+      result
+    end
+
+    # def new_file_match?(file)
+    #   whitelist.any? { |white_entry| white_entry.match?(file) }
+    # end
+
+    # def exclude_files(glob, exclude = nil)
+    #   get_files = Dir[glob]
+
+    #   return get_files unless exclude
+
+    #   return get_files.reject { |file| exclude.any? { |pattern| pattern_match?(pattern, file) } } if exclude.is_a?(Array)
+
+    #   get_files.reject { |file| pattern_match?(exclude, file) }
+    # end
+
+    # def pattern_match?(pattern, file)
+    #   return pattern.match?(file) if pattern.is_a?(Regexp)
+
+    #   # Guard
+    #   return false unless pattern.is_a?(String)
+
+    #   File.fnmatch?(pattern, file) # As String
+    # end
+  end
+end

data/lib/k_fileset/file_set_examples.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module KFileset
+  # FileSet will build up a list of files using Glob patterns.
+  #
+  # That list of files can be filtered using exclusions that
+  # follow either Glob or Regex patterns.
+  #
+  # Keeping track of excluded patterns is useful in KFileset because an existing file may be
+  # or a new file added and a file watcher my attempt to process that file. The exclusion patterns
+  # provide a way to ignore the file.
+  #
+  # FileSet uses some code from Rake-FileList, but uses the builder pattern to build up a
+  # list of included files and inclusion/exclusion patterns instead of the Array emulation that rake uses.
+  # https://github.com/ruby/rake/blob/master/lib/rake/file_list.rb
+  #
+  # Usage:
+  # Assumes that the current directory is /some_path/k_manager
+  EXAMPLE = <<~RUBY
+        #{'  '}
+          # /Dir.glob('(david|sean|lisa)')
+          # /Users/davidcruwys/dev/kgems/k_manager
+          # .cd('/Users/davidcruwys/dev/kgems/k_manager')
+        #{'  '}
+          Watcher.process_file(file, event) do
+            file = '/Users/davidcruwys/dev/kgems/k_manager/spec/samples/.builder/a/b/c/d/e/bob.png'
+            file = '/Users/davidcruwys/dev/kgems/k_manager/spec/samples/.builder/a/b/c/d/e/bob.rb'
+    #{'    '}
+            case
+            when event :updated
+              if file_set.valid?(file)
+                continue_processing(file)
+              end
+    #{'    '}
+            when event :deleted
+              file_set.remove(file)
+            end
+          end
+    #{'    '}
+          whitelist = [
+            WhiteListEntry.new(
+              '/Users/davidcruwys/dev/kgems/k_manager/spec/samples/.builders/**/*',
+              [/(sean|david).txt/, /\*.xlsx?/, /\*.(jpe?g|png|gif)/]
+            ),
+            WhiteListEntry.new(
+              '/Users/davidcruwys/dev/kgems/k_manager/spec/.templates/**/*',
+              /bob.(jpe?g|png|gif|rb)/
+            )
+          ]
+    #{'    '}
+    #{'    '}
+          file_set = KFileset::FileSet.new
+            .cd('spec/samples')                               # /Users/davidcruwys/dev/kgems/k_manager/spec/samples
+            .add('.builder/**/*')
+            .add('.builder/**/*', exclude: '*.txt')           # /Users/davidcruwys/dev/kgems/k_manager/spec/samples/.builders/**/*
+            .add('.builder/**/*', exclude: /\.txt/)
+            .add('.builder/**/*', exclude: [
+              /(sean|david).txt/,
+              /\*.xlsx?/,
+              /\*.(jpe?g|png|gif)/
+            ])
+            .add('../.templates/**/*', exclude: /bob.(jpe?g|png|gif|rb)/)   # /Users/davidcruwys/dev/kgems/k_manager/spec/.templates/**/*
+  RUBY
+end