justprep 0.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e35c0a964ffac9ceb3a2020aba78022a34f8b4b904a04edf7165e4ea7effc2d2
+  data.tar.gz: 8de618079e948c4288e7dbf93a3d89cc8aff9320e63b930b5558822a9ed209d2
+SHA512:
+  metadata.gz: 49278e4ea5e0d3e245d85f8c2bfc95d9e6d33923a59d90494685ce007fe73c9524133f7704816338ab98a5de85d6ad1ecf63f3cb10f03971a9097de7e60ecef7
+  data.tar.gz: 73a4b132c311e2030704c05269a7f766d7b4521adebc62c68d83de8593dd15e6141cd23f2c2555b3d1b15ce3412da3c8ea697022764dda6e4b11eacda749f167

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-07
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in justprep.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    justprep (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (13.0.4)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  justprep!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dewayne VanHoozer
+
+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,25 @@
+# Justprep
+
+A pre-processor to the "just" command-line utility packaged as a Ruby Gem.
+
+## Installation
+
+    $ gem install justprep
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/justprep.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/justprep

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'justprep'
+
+Justprep.execute

data/bin/setup

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+bundle install
+
+# Assumes 'which' is available
+just=`which just`
+brew=`which brew`
+
+if [[ "x" == "x$just" ]] ; then
+  echo
+  echo "The 'just' command line utility is not installed."
+  if [[ "x" != "x%brew" ]] ; then
+    echo "To install it do this:"
+    echo "  brew install just"
+  else
+    echo "Use your favorite package manager to install 'just'"
+  fi
+  echo
+fi

data/justprep.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/justprep/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "justprep"
+  spec.version       = Justprep::VERSION
+  spec.authors       = ["Dewayne VanHoozer"]
+  spec.email         = ["dvanhoozer@gmail.com"]
+
+  spec.summary       = "A pre-processor for the 'just' command line utility"
+  spec.description   = <<~EOS
+    allows a "justfile" to be auto-generated from a seperate source file
+    that contains inclusionary keywords such as include, import, require
+    and with.  These keywords are followed by a path to a file.  If the
+    file exists, the contents of the file are inserted into the file
+    at the position of the keyword command.  After all keywords have
+    been process a new "justfile" is created which can then be used by
+    the 'just' tool.
+  EOS
+
+  spec.homepage      = "http://github.com/MadBomber/justprep/tree/main/ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = ""
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir        = "bin"
+  spec.executables   = ["justprep"]
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  end
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+end

data/lib/justprep.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+# frozen_string_literal: true
+# warn_indent: true
+
+##########################################################
+###
+##  File: justprep/ruby/lib/justprep.rb
+##
+##  Desc: A preprocessor for the "just" command line utility.
+##        It looks for keywords: import include require with
+##        followed by a file name or path.
+##
+##        It looks for a file "main.just" in the current directory.
+##        If it does not exist, does nothing.  Otherwise it reviews
+##        the file for the KEYWORDS.  When found it inserts the
+##        content of the specified file into that position.  The
+##        final text is written out to the "justfile" for processing
+##        with the "just" tool.
+##
+##  The following system environment variable are supported:
+##
+##    variable name             default value
+##    ---------------------     -------------
+##    JUSTPREP_FILENAME_IN  ... main.just
+##    JUSTPREP_FILENAME_OUT ... justfile
+##    JUSTPREP_KEYWORDS     ... 'import include require with'
+##
+##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+#
+
+require           "pathname"
+require_relative  "justprep/version"
+
+module Justprep
+  class << self
+    JUSTPREP_FILENAME_IN  = ENV.fetch('JUSTPREP_FILENAME_IN',   'main.just')
+    JUSTPREP_FILENAME_OUT = ENV.fetch('JUSTPREP_FILENAME_OUT',  'justfile')
+    JUSTPREP_KEYWORDS     = ENV.fetch('JUSTPREP_KEYWORDS', 'import include require with').split
+
+
+    # review the text looking for module references
+    def find_modules(text)
+      modules = []
+
+      JUSTPREP_KEYWORDS.each do |keyword|
+        modules << text.select{|x| x.start_with? "#{keyword} "}
+      end
+
+      return modules.flatten!
+    end
+
+
+    # somg;e-level inclusion
+    def include_content_from(file_path)
+      content   = []
+      content  << "\n# >>> #{file_path}"
+      content  << file_path.readlines.map{|x| x.chomp} # TODO: support recursion??
+      content  << "# <<< #{file_path}\n"
+
+      return content.flatten
+    end
+
+
+    # look for first occurace of mainfile
+    def just_find_it(here=Pathname.pwd)
+      mainfile = here + JUSTPREP_FILENAME_IN
+      return mainfile if mainfile.exist?
+      return nil if here == here.parent
+      return just_find_it(here.parent)
+    end
+
+
+    # use an external shell to expand system environment variables
+    def expand_file_path(a_path_string)
+      if a_path_string.start_with? '~'
+        a_path_string = "${HOME}" + a_path_string[1, a_path_string.size-1]
+      end
+
+      a_path_string = `echo "#{a_path_string}"`.chomp
+
+      return a_path_string
+    end
+
+    # Print usage text
+    def usage
+      puts <<~EOS
+        justprep v#{VERSION} (ruby)
+        A pre-processor to the just command line utility
+        By Dewayne VanHoozer <dvanhoozer@gmail.com>
+
+        USAGE:
+          justprep [flags] && just
+
+        FLAGS:
+              --version   Shows the current version
+          -h, --help      Displays this usage message
+
+        DESCRIPTION:
+          Looks for a file named #{JUSTPREP_FILENAME_IN} in the current
+          directory hierarchy.  If found it replaces all lines that
+          have the keywords (#{JUSTPREP_KEYWORDS.join(", ")}) followed
+          by file path with the contents of the specified file.
+
+        SYSTEM ENVIRONMENT VARIABLES:
+                                    Default Value
+          JUSTPREP_FILENAME_IN .... main.just
+          JUSTPREP_FILENAME_OUT ... justfile
+          JUSTPREP_KEYWORDS ....... 'import include require with'
+
+        SUGGESTION:
+          Create an alias for your command shell. For example
+            alias jj='justprop && just'
+
+        THANKS TO:
+          Casey Rodarmor <casey@rodarmor.com>
+          Just because just is just a handy utility with just an odd name. :)
+
+      EOS
+    end
+
+
+    # take care of ARGV processing
+    def handle_command_line_parameters
+      if ARGV.size > 0
+        ARGV.each do |param|
+          if "--version" == param
+            puts "jusrprep v#{VERSION} (ruby)"
+          elsif ["-h", "--help"].include?(param)
+            usage
+          else
+            STDERR.puts "justprep does not support: #{param}"
+            exit(1)
+          end
+        end
+      end
+    end
+
+
+    # Main function called from executable
+    def execute
+      handle_command_line_parameters
+
+      mainfile  = just_find_it
+
+      exit(0) if mainfile.nil?
+
+      basefile  = mainfile.parent + JUSTPREP_FILENAME_OUT
+
+      text = mainfile.readlines.map{|x| x.chomp} # drop the line ending from each line
+
+      modules = find_modules text
+
+      if modules.empty?
+        basefile.write text
+        exit(0)
+      end
+
+      modules.each do |a_line|
+        an_index        = text.index a_line
+        begin_filename  = a_line.index(' ')
+        module_filename = a_line[begin_filename, a_line.size - begin_filename].strip
+
+        if module_filename.empty?
+          STDERR.puts "#{an_index}: #{a_line}"
+          STDERR.puts "ERROR: No path/to/file was provided"
+          next
+        end
+
+        if module_filename.include?('~')  || module_filename.include?('$')
+          module_filename = expand_file_path(module_filename)
+        end
+
+        module_path     = Pathname.new(module_filename)
+
+        if module_path.relative?
+          module_path = mainfile.parent + module_path
+        end
+
+        if module_path.exist?
+          text[an_index]  = include_content_from(module_path)
+        else
+          STDERR.puts "#{an_index}: #{a_line}"
+          STDERR.puts "| ERROR: File Does Not Exist - #{module_path}"
+        end
+      end
+
+      basefile.write text.flatten!.join "\n"
+    end # def execute
+  end # class << self
+end # module Justprep
+
+Justprep.execute

data/lib/justprep/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Justprep
+  VERSION = "0.1.0.1"
+end

data/prototype.rb

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
+# warn_indent: true
+##########################################################
+###
+##  File: justprep.rb
+##  Desc: A preprocessor for justfiles using "main.just"
+##        Looks for keywords: import include require with
+##        followed by a file name or path.
+##
+##        It looks for a file "main.just" in the current directory.
+##        If it does not exist, does nothing.  Otherwise it reviews
+##        the file for the KEYWORDS.  When found it inserts the
+##        content of the specified file into that position.  The
+##        final text is written out to the "justfile" for processing
+##        with the "just" tool.
+##
+##        There is NO ERROR checking.  including file names/paths
+##        are assume to have to space characters.
+##
+##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+#
+
+KEYWORDS  = %w[ import include require with ]
+BASEFILE  = 'justfile'
+MAINFILE  = 'main.just'
+
+require 'pathname'
+
+######################################################
+# Local methods
+
+# review the text looking for module references
+def find_modules(text)
+  modules = []
+
+  KEYWORDS.each do |keyword|
+    modules << text.select{|x| x.start_with? "#{keyword} "}
+  end
+
+  return modules.flatten!
+end
+
+
+# somg;e-level inclusion
+def include_content_from(file_path)
+  content   = []
+  content  << "\n# >>> #{file_path}"
+  content  << file_path.readlines.map{|x| x.chomp} # TODO: support recursion??
+  content  << "# <<< #{file_path}\n"
+
+  return content.flatten
+end
+
+
+# look for first occurace of mainfile
+def just_find_it(here=Pathname.pwd)
+  mainfile = here + MAINFILE
+  return mainfile if mainfile.exist?
+  return nil if here == here.parent
+  return just_find_it(here.parent)
+end
+
+
+# use an external shell to expand system environment variables
+def expand_file_path(a_path_string)
+  if a_path_string.start_with? '~'
+    a_path_string = "${HOME}" + a_path_string[1, a_path_string.size-1]
+  end
+
+  a_path_string = `echo "#{a_path_string}"`.chomp
+
+  return a_path_string
+end
+
+
+######################################################
+# Main
+
+mainfile  = just_find_it
+
+exit(0) if mainfile.nil?
+
+basefile  = mainfile.parent + BASEFILE
+
+text = mainfile.readlines.map{|x| x.chomp} # drop the line ending from each line
+
+modules = find_modules text
+
+if modules.empty?
+  basefile.write text
+  exit(0)
+end
+
+modules.each do |a_line|
+  an_index        = text.index a_line
+  begin_filename  = a_line.index(' ')
+  module_filename = a_line[begin_filename, a_line.size - begin_filename].strip
+
+  if module_filename.empty?
+    STDERR.puts "#{an_index}: #{a_line}"
+    STDERR.puts "ERROR: No path/to/file was provided"
+    next
+  end
+
+  if module_filename.include?('~')  || module_filename.include?('$')
+    module_filename = expand_file_path(module_filename)
+  end
+
+  module_path     = Pathname.new(module_filename)
+
+  if module_path.relative?
+    module_path = mainfile.parent + module_path
+  end
+
+  if module_path.exist?
+    text[an_index]  = include_content_from(module_path)
+  else
+    STDERR.puts "#{an_index}: #{a_line}"
+    STDERR.puts "| ERROR: File Does Not Exist - #{module_path}"
+  end
+end
+
+basefile.write text.flatten!.join "\n"

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: justprep
+version: !ruby/object:Gem::Version
+  version: 0.1.0.1
+platform: ruby
+authors:
+- Dewayne VanHoozer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-08 00:00:00.000000000 Z
+dependencies: []
+description: |
+  allows a "justfile" to be auto-generated from a seperate source file
+  that contains inclusionary keywords such as include, import, require
+  and with.  These keywords are followed by a path to a file.  If the
+  file exists, the contents of the file are inserted into the file
+  at the position of the keyword command.  After all keywords have
+  been process a new "justfile" is created which can then be used by
+  the 'just' tool.
+email:
+- dvanhoozer@gmail.com
+executables:
+- justprep
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/justprep
+- bin/setup
+- justprep.gemspec
+- lib/justprep.rb
+- lib/justprep/version.rb
+- prototype.rb
+homepage: http://github.com/MadBomber/justprep/tree/main/ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.21
+signing_key:
+specification_version: 4
+summary: A pre-processor for the 'just' command line utility
+test_files: []