justprep 1.0.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed914c21c366068ea71cd655d4244ab64d09c23d84aa96c3e5ffee1da293c1ff
-  data.tar.gz: d511e8cc0a4f1b39a0a9a6154d3a2ce17f9953d5c7040f5216302cbb9de763b9
+  metadata.gz: c5215db017617c8b34a0e8db31b2d2f0e2db2d59c0600671347fdad324ebad83
+  data.tar.gz: b8d16fec5e8898ed0c8154cc1856c83f2b8419d93c1f56e758f95291bff48fde
 SHA512:
-  metadata.gz: 7b896b41fb0b38201332c7d37440383f6d2bffa4e6e3890c49dd8103a0c183dc537ee32ede80ffb655fa49627eeb6d76aa94e07e67cb5b2e70e05e913419636f
-  data.tar.gz: e1c08ac5bf2b996810cc56eaaf498e7c37de2332891633a274a4959d0cb48854d09c2fcca6f7a3f7972ec0d8e17cceb856c29e62f22f32a1f4acad0b13849218
+  metadata.gz: bae352f6da8c9b2b1f3a174f64f695485373225db830be20694688e02cc7368aab9e5548862c5e2e24d8ee985eef7f09b20bf674cee6ac85217418958af541e1
+  data.tar.gz: 50d4c6fd1f70c4e042e07d948fb0561e43e0788f73d277d54476e2cbbe9c4587fe4686b69262b7a7eb3d53494146f1a1516f0b3d9925651887d67415e568e73a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    justprep (1.0.0)
+    justprep (1.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -20,4 +20,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.21
+   2.2.24

data/bin/justprep

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'justprep'
+require_relative '../lib/justprep.rb'
 
-Justprep.execute
+Justprep.new.execute

data/justfile

@@ -1,11 +1,10 @@
 # github.com/MadBomber/justprep/**/ruby/justfile
 #
-# gem install bump
 
 set positional-arguments := true
 
 # List available recipes
-@list:
+@help:
   echo
   echo "Available Recipes at"
   echo `pwd`
@@ -14,31 +13,17 @@ set positional-arguments := true
   just -l --list-prefix 'just ' --list-heading ''
   echo
 
+# Run the minitest examples on the Ruby code
+test: build
+  rake test
+
 
 # Build the current gem
-build:
+@build:
   rake clean clobber build
 
 
-#################################################
-## Recipes that deal with the source code version
-## Version manager is handled by the "bump" gem
-
-# Set the version: major . minor . patch
-@set version:
-  bump set {{version}} --no-commit --replace-in ../crystal/version.cr
-
-
-# Show current version
-@show:
-  bump current
-
+# Install the gem locally
+@install:
+  rake install:local
 
-# Bump the level:  major . minor . patch
-bump level='patch':
-  #!/bin/bash
-  if [[ "{{level}}" =~ ^(major|minor|patch)$ ]]; then
-    bump {{level}} --no-commit --replace-in ../crystal/version.cr
-  else
-    echo "ERROR: level must be one of: major, minor, patch"
-  fi

data/justprep.gemspec

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "lib/justprep/version"
+load "lib/justprep/common/constants.crb"
 
 Gem::Specification.new do |spec|
   spec.name          = "justprep"
-  spec.version       = Justprep::VERSION
+  spec.version       = VERSION
   spec.authors       = ["Dewayne VanHoozer"]
   spec.email         = ["dvanhoozer@gmail.com"]
 

data/lib/justprep/common/constants.crb

@@ -0,0 +1,7 @@
+VERSION = "1.2.3"
+
+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
+
+JUSTPREP_MODULE_KEYWORD = ENV.fetch("JUSTPREP_MODULE_KEYWORD", "module")

data/lib/justprep/common/error_messages.crb

@@ -0,0 +1,53 @@
+# common/error_messages.crb
+
+# Parameters:
+#   line_number .. Integer (zero-based index)
+#   a_line ....... String
+#
+# Returns:
+#   nil
+#
+def error_file_does_not_exist(line_number, a_line)
+  STDERR.puts
+  STDERR.puts "ERROR: File Does Not Exist"
+
+  # Crystal types thinks line_number can be nil or Int32
+  line_out = sprintf("% d ", line_number.nil? ? 0 : line_number)
+  STDERR.puts (" "*line_out.size)+"|"
+  STDERR.puts "#{line_out}| #{a_line}"
+  STDERR.print (" "*line_out.size)+"|"
+
+  x              = a_line.index(" ")
+
+  if a_line.starts_with?(JUSTPREP_MODULE_KEYWORD)
+    x              = a_line.index(" ", x.nil? ? 0 : x + 1) # because Crystal thinks x could be nil
+  end
+
+  begin_filename = x.nil? ? a_line.size + 2 : x + 2
+  end_filename   = a_line.size
+  len_filename   = end_filename - begin_filename + 1
+
+  len_filename = 13 if len_filename < 0
+
+  STDERR.puts (" "*begin_filename) + ("^"*len_filename)
+  STDERR.puts
+
+  return nil
+end
+
+
+def error_syntax(line_number, a_line)
+  STDERR.puts
+  STDERR.puts "ERROR: Syntax Problem"
+
+  # Crystal types thinks line_number can be nil or Int32
+  line_out = sprintf("% d ", line_number.nil? ? 0 : line_number)
+  STDERR.puts (" "*line_out.size)+"|"
+  STDERR.puts "#{line_out}| #{a_line}"
+  STDERR.print (" "*line_out.size)+"| "
+  STDERR.puts "^"*(a_line.size)
+  STDERR.puts
+
+  return nil
+end
+

data/lib/justprep/common/expand_file_path.crb

@@ -0,0 +1,15 @@
+# common/expand_file_path.crb
+
+# use an external shell to expand system environment variables
+def expand_file_path(a_path_string)
+  a_path_string = a_path_string.strip
+
+  if a_path_string.to_s.starts_with? "~"
+    a_path_string = "${HOME}" + a_path_string.to_s[1, a_path_string.to_s.size-1]
+  end
+
+  a_path_string = `echo "#{a_path_string}"`.chomp
+
+  return a_path_string
+end
+

data/lib/justprep/common/generate_module_recipes.crb

@@ -0,0 +1,27 @@
+# .../ruby/lib/justprep/common/generate_module_recipes.crb
+
+# Given an Array of Strings representing the fake
+# module names it returns a String to be appended
+# to the generated justfile.
+#
+# Input:
+#   module_names .... Array(String) fake module names
+#
+# Output:
+#   recipes ... String
+#
+def generate_module_recipes(module_names)
+  recipes = ""
+
+  module_names.each do |mod_name|
+    recipes += "
+
+# Module #{mod_name}
+@#{mod_name} what='' args='':
+  just -f {{module_#{mod_name}}} {{what}} {{args}}
+
+"
+  end
+
+  return recipes
+end

data/lib/justprep/common/handle_command_line_parameters.crb

@@ -0,0 +1,24 @@
+# common/handle_command_line_parameters.crb
+
+
+# take care of ARGV
+#
+# Returns
+#   nil when there are no command line parameters
+#   otherwise it terminates the process
+#
+def handle_command_line_parameters
+  if ARGV.size > 0
+    ARGV.each do |param|
+      if "--version" == param
+        puts "jusrprep v#{VERSION} (#{IMPLEMENTATION})"
+      elsif ["-h", "--help"].includes?(param)
+        usage
+      else
+        STDERR.puts "justprep does not support: #{param}"
+      end
+    end
+
+    exit(1)
+  end
+end

data/lib/justprep/common/include_content_from.crb

@@ -0,0 +1,24 @@
+# .../ruby/lib/justprep/common/def include_content_from.crb
+
+
+# single-level inclusion
+#
+# Input:
+#   out_file .......... A File pointer for String output
+#   module_filename ... String The name of the file to be included
+#
+# Output:
+#   nil .... This is a function without specific return value
+#
+def include_content_from(out_file, module_filename)
+  out_file.puts "\n# >>> #{module_filename}"
+
+  File.read_lines(module_filename).each do |m_line|
+    out_file.puts m_line
+  end
+
+  out_file.puts "# <<< #{module_filename}\n"
+
+  return nil
+end
+

data/lib/justprep/common/just_find_it.crb

@@ -0,0 +1,14 @@
+# common/just_find_it.crb
+
+# look for first occurace of mainfile
+# returns nil when none are found.
+def just_find_it(here = FileUtils.pwd)
+  mainfile_path = here + "/" + JUSTPREP_FILENAME_IN
+  return mainfile_path if File.exists?(mainfile_path)
+
+  parts = here.to_s.split("/")
+  parts.pop
+
+  return nil if parts.empty?
+  return just_find_it(parts.join('/'))
+end

data/lib/justprep/common/replacement_for_module_line.crb

@@ -0,0 +1,50 @@
+# .../ruby/lig/justprep/common/replacement_for_module_line.crb
+
+# Inserts the module_name into the Array of module_names
+# Returns a string that defines the variable for the path to the module
+#
+# This method replaces a source line that looks like this:
+#
+#   module aaa path/to/modules/justfile
+#
+# with a line that looks like this:
+#
+#   module_aaa := "path/to/modules/justfile"
+#
+# where "aaa" is the module name.
+#
+# Limitations:
+#
+#   module_name can not have a space.  Only :alphanumberic: characters
+#   and the underscore character are valid.
+#
+#   The "path/to/modules/justfile" must exist.  Otherwise an error
+#   message is generated.
+#
+# Input:
+#   line_numer .... Integer the line number in the source file
+#   a_string ...... String the line from the source file
+#
+# Output:
+#   an Array(String) of size 2 where
+#   .first is the fake module_name
+#   .last is the replacement string that defines the module variable
+#
+def replacement_for_module_line(line_number, a_string)
+  parts = a_string.split(" ")
+
+  if parts.size < 3
+    error_syntax(line_number, a_string)
+    exit(1)
+  end
+
+  module_name     = parts[1]
+  path_to_module  = parts[2..].join(" ")
+
+  unless File.exists?(path_to_module)
+    error_file_does_not_exist(line_number, a_string)
+    exit(1)
+  end
+
+  return [module_name, "module_#{module_name} := \"#{path_to_module}\""]
+end

data/lib/justprep/common/usage.crb

@@ -0,0 +1,46 @@
+# common/usage.crb
+
+def usage
+  usage_text = "
+justprep v#{VERSION} (#{IMPLEMENTATION})
+
+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='justprep && just'
+
+THANKS TO:
+  Casey Rodarmor <casey@rodarmor.com>
+    for Just because just is just a handy utility with just an
+    odd name but an extreamly useful product. :)
+
+  Greg Lutostanski <greg.luto@gmail.com>
+    for the homebrew formula and the github actions to compile
+    a new Crystal release.
+
+"
+  puts usage_text
+
+  return usage_text
+end

data/lib/justprep/crystal_methods.rb

@@ -0,0 +1,26 @@
+# common/crystal_methods.rb
+
+# Monkey oatch Ruby classes to match method names
+# used by Crystal
+
+# TODO: find other classes in which Ruby/Crystal differ
+
+class Array
+  alias_method :includes?, :include?
+end
+
+class Pathname
+  alias_method :exists?, :exist?
+end
+
+class String
+  alias_method :starts_with?, :start_with?
+  alias_method :ends_with?,   :end_with?
+  alias_method :includes?,    :include?
+end
+
+class File
+  class << self
+    alias_method :read_lines, :readlines
+  end
+end

data/lib/justprep/version.rb

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

data/lib/justprep.rb

@@ -13,165 +13,114 @@
 # JUSTPREP_FILENAME_IN  ... main.just
 # JUSTPREP_FILENAME_OUT ... justfile
 # JUSTPREP_KEYWORDS     ... 'import include require with'
+# JUSTPREP_MODULE_KEYWORD . 'module'
+#
+# NOTE:
+#   JUSTPREP_KEYWORDS  ** CANNOT ** include the value for
+#   JUSTPREP_MODULE_KEYWORD
 #
 
-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
+IMPLEMENTATION  = "Ruby"
 
+require           "fileutils"
+require           "pathname"
+require_relative  "justprep/crystal_methods"
 
-    # review the text looking for module references
-    def find_modules(text)
-      modules = []
+# The common directory contains files which are usable in
+# both the Ruby gem and compiled Crystal implementations
+# The files have the extension ".crb"
+#
+COMMON_DIR = Pathname.new(__FILE__) + '../justprep/common'
+
+# Loading these common methods as global kernel-level
+load COMMON_DIR + "constants.crb"
+load COMMON_DIR + "error_messages.crb"
+load COMMON_DIR + "expand_file_path.crb"
+load COMMON_DIR + "handle_command_line_parameters.crb"
+load COMMON_DIR + "just_find_it.crb"
+load COMMON_DIR + "usage.crb"
+load COMMON_DIR + "generate_module_recipes.crb"
+load COMMON_DIR + "replacement_for_module_line.crb"
+load COMMON_DIR + "include_content_from.crb"
+
+class Justprep
+  attr_accessor :module_names
+
+  def initialize
+    handle_command_line_parameters  # may terminate the process
+    @module_names = []
+  end
+
+
+  # Main function called from executable
+  def execute
+    if JUSTPREP_KEYWORDS.includes?(JUSTPREP_MODULE_KEYWORD)
+      STDERR.puts
+      STDERR.puts "ERROR: Environment Variable Configuration Problem"
+      STDERR.puts "       JUSTPREP_KEYWORDS cannot include the same value"
+      STDERR.puts "       as the JUSTPREP_MODULE_KEYWORD"
+      STDERR.puts
+      exit(1)
+    end
 
-      JUSTPREP_KEYWORDS.each do |keyword|
-        modules << text.select{|x| x.start_with? "#{keyword} "}
-      end
+    in_filename  = just_find_it
 
-      return modules.flatten!
+    if in_filename.nil?
+      STDERR.puts "WARNING: JUSTPREP_FILENAME_IN Not Found: #{JUSTPREP_FILENAME_IN}"
+      exit(0)
     end
 
+    out_filename  = File.dirname(in_filename) + "/" + JUSTPREP_FILENAME_OUT
 
-    # 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"
+    in_file   = File.open(in_filename,  "r")
+    out_file  = File.open(out_filename, "w")
 
-      return content.flatten
-    end
+    line_number = 0
 
+    in_file.readlines.map{|x| x.chomp}.each do |a_line|
+      line_number += 1
 
-    # 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
+      parts = a_line.to_s.split(" ")
 
-
-    # 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]
+      if 0 == parts.size
+        out_file.puts
+        next
       end
 
-      a_path_string = `echo "#{a_path_string}"`.chomp
+      # NOTE: Leading spaces are not allowed.  The keywords
+      #       MUST be complete left-justified.
+      #
+      if JUSTPREP_KEYWORDS.include?(parts.first.downcase)
+        out_file.puts "# #{a_line}"
 
-      return a_path_string
-    end
+        glob_filename = expand_file_path(parts[1..parts.size].join(" "))
 
-    # 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
+        module_filenames = Dir.glob(glob_filename)
 
+        if 0 == module_filenames.size
+          error_file_does_not_exist(line_number, a_line)
+          exit(1)
+        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
+        module_filenames.each do |module_filename|
+          if File.exist?(module_filename)
+            include_content_from(out_file, module_filename)
           else
-            STDERR.puts "justprep does not support: #{param}"
+            error_file_does_not_exist(line_number, a_line)
             exit(1)
           end
         end
+      elsif JUSTPREP_MODULE_KEYWORD == parts.first.downcase
+        result_array  = replacement_for_module_line(line_number, a_line)
+        @module_names << result_array.first
+        out_file.puts result_array.last
+      else
+        out_file.puts a_line
       end
-    end
-
-
-    # Main function called from executable
-    def execute
-      handle_command_line_parameters
-
-      mainfile  = just_find_it
+    end # in_file.readlines ...
 
-      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
+    out_file.puts generate_module_recipes(@module_names)
 
-      basefile.write text.flatten!.join "\n"
-    end # def execute
-  end # class << self
-end # module Justprep
+    out_file.close
+  end # def
+end # class Justprep

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justprep
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-10 00:00:00.000000000 Z
+date: 2022-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -50,6 +50,16 @@ files:
 - justfile
 - justprep.gemspec
 - lib/justprep.rb
+- lib/justprep/common/constants.crb
+- lib/justprep/common/error_messages.crb
+- lib/justprep/common/expand_file_path.crb
+- lib/justprep/common/generate_module_recipes.crb
+- lib/justprep/common/handle_command_line_parameters.crb
+- lib/justprep/common/include_content_from.crb
+- lib/justprep/common/just_find_it.crb
+- lib/justprep/common/replacement_for_module_line.crb
+- lib/justprep/common/usage.crb
+- lib/justprep/crystal_methods.rb
 - lib/justprep/version.rb
 - prototype.rb
 homepage: http://github.com/MadBomber/justprep/tree/main/ruby
@@ -72,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: A pre-processor for the 'just' command line utility