k_director 0.0.6

data/.githooks/pre-commit

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# template_variant: :ruby
+
+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?('.githooks') # ||
+  # 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/.github/workflows/main.yml

@@ -0,0 +1,53 @@
+name: Build Application
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby: ['2.7.1'] #, '3.1.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rspec
+
+    - name: Slack notify on rspec error
+      if: failure()
+      uses: rtCamp/action-slack-notify@v2
+      env:
+        SLACK_CHANNEL: klueless-repos
+        SLACK_COLOR: '#ff0000'
+        SLACK_ICON: https://avatars.githubusercontent.com/u/2956762?s=64&v=4
+        SLACK_TITLE: 'RSpec failure on ${{github.repository}} - try:'
+        SLACK_MESSAGE: 'rspec'
+        SLACK_USERNAME: klueless-io
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}        
+
+    - name: Run rubocop
+      run: bundle exec rubocop
+
+    - name: Slack notification on rubocop error
+      if: failure()
+      uses: rtCamp/action-slack-notify@v2
+      env:
+        SLACK_CHANNEL: klueless-repos
+        SLACK_COLOR: '#ff0000'
+        SLACK_ICON: https://avatars.githubusercontent.com/u/2956762?s=64&v=4
+        SLACK_TITLE: 'Rubocop failure on $ - try:'
+        SLACK_MESSAGE: 'cop -a'
+        SLACK_USERNAME: klueless-io
+        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}        

data/.github/workflows/semver.yml

@@ -0,0 +1,54 @@
+name: SemVer
+on:
+  workflow_run:
+    workflows: ["Build Application"]
+    branches: [main]
+    types:
+      - completed
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      # - uses: hmarr/debug-action@v2 # TURN on ENV DEBUG
+
+      - name: Cache node modules
+        uses: actions/cache@v2
+        id: cache-node-modules
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: Install semantic-release dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: npm ci
+
+        # SEE MORE: https://github.com/semantic-release/semantic-release/issues/753
+      - name: Run SemVer
+        run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+
+      # - name: Slack notify new version created
+      #   if: success()
+      #   uses: rtCamp/action-slack-notify@v2
+      #   env:
+      #     SLACK_CHANNEL: klueless-repos
+      #     SLACK_COLOR: '#00ff00'
+      #     SLACK_ICON: https://avatars.githubusercontent.com/u/2956762?s=64&v=4
+      #     SLACK_TITLE: 'New version released on ${{github.repository}}'
+      #     SLACK_MESSAGE: 'git pull'
+      #     SLACK_USERNAME: klueless-io
+      #     SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}        

data/.gitignore

@@ -0,0 +1,46 @@
+# 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
+
+/_/
+/.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/.releaserc-old

@@ -0,0 +1,46 @@
+{
+  "branches": [
+    "main"
+  ],
+  "verifyRelease": [{
+    "path": "@semantic-release/exec",
+    "cmd": "git config --global user.name 'David Cruwys';echo '${nextRelease.version}' > .ver;git add .;git commit -am '${nextRelease.version} [skip ci]';git push"
+  }],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@klueless-js/semantic-release-rubygem",
+      {
+        "gemPublish": false
+      }
+    ],
+    "semantic-release-rubygem",
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "docs/CHANGELOG.md",
+        "changelogFileTitle": "k_director Changelog"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "lib/k_director/version.rb",
+          "docs/CHANGELOG.md"
+        ],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "repositoryUrl": "git@github.com:klueless-io/k_director.git"
+}
+

data/.releaserc.json

@@ -0,0 +1,40 @@
+{
+  "branches": [
+    "main"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@klueless-js/semantic-release-rubygem",
+      {
+        "gemPublish": true
+      }
+    ],
+    [
+      "@semantic-release/changelog",
+      { 
+        "changelogFile": "docs/CHANGE.md",
+        "changelogFileTitle": "k_director Changelog"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "lib/k_director/version.rb",
+          "docs/CHANGELOG.md"
+        ],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "repositoryUrl": "git@github.com:klueless-io/k_director.git"
+}

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,86 @@
+inherit_mode:
+  merge:
+    - Exclude # see: https://stackoverflow.com/a/70818366/473923
+
+AllCops:
+  TargetRubyVersion: 2.7
+  DisplayCopNames: true
+  ExtraDetails: true
+  NewCops: enable
+  Exclude:
+    - ".builders/**/*"
+    - "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/.ver

@@ -0,0 +1 @@
+0.0.1

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+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/Guardfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+guard :bundler, cmd: 'bundle install' do
+  watch('Gemfile')
+  watch('.gemspec')
+end
+
+group :green_pass_then_cop, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec -f doc' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+    watch(%r{^lib//(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+    watch(%r{^lib//commands/(.+)\.rb$}) { |m| "spec/unit/commands/#{m[1]}_spec.rb" }
+  end
+
+  guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+    watch(/{.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -0,0 +1,83 @@
+# K Director
+
+> KDirector provides domain specific language implementations for code generation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k_director'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install k_director
+```
+
+
+## Stories
+
+### Main Story
+
+As a Developer, I want to generate code using a DSL, so that I can speed up application development
+
+See all [stories](./STORIES.md)
+
+
+## Usage
+
+See all [usage examples](./USAGE.md)
+
+
+
+## Development
+
+Checkout the repo
+
+```bash
+git clone https://github.com/klueless-io/k_director
+```
+
+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_director` 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_director. 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 Director project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/klueless-io/k_director/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) David Cruwys. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# source: https://stephenagrice.medium.com/making-a-command-line-ruby-gem-write-build-and-push-aec24c6c49eb
+
+GEM_NAME = 'k_director'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'k_director/version'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+desc 'Compile all the extensions'
+task build: :compile
+
+Rake::ExtensionTask.new('k_director') do |ext|
+  ext.lib_dir = 'lib/k_director'
+end
+
+desc 'Publish the gem to RubyGems.org'
+task :publish do
+  version = KDirector::VERSION
+  system 'gem build'
+  system "gem push #{GEM_NAME}-#{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_director'
+
+# 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,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/docs/CHANGE.md

@@ -0,0 +1,6 @@
+## [0.0.4](https://github.com/klueless-io/k_director/compare/v0.0.3...v0.0.4) (2022-01-25)
+
+
+### Bug Fixes
+
+* test publish [#1](https://github.com/klueless-io/k_director/issues/1) ([1d001af](https://github.com/klueless-io/k_director/commit/1d001afb6087a50003ff3c18d53b10d35df31a1c))