justprep 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0bc299adb71964c6298e1a195b380dd37c4cf716c2c58cb6ffab9320f74a5d
-  data.tar.gz: a22fcb32d3c7c5b516dade83e17670696ef0aa0619efcbb8c1361b580100b814
+  metadata.gz: c5215db017617c8b34a0e8db31b2d2f0e2db2d59c0600671347fdad324ebad83
+  data.tar.gz: b8d16fec5e8898ed0c8154cc1856c83f2b8419d93c1f56e758f95291bff48fde
 SHA512:
-  metadata.gz: 9c2a9c4b7da6f3ad617f6799084808596c868a710dcb6a639dd742709c3aef18c414d32d654c3f74821d1d10af03c80f27414c0dd7007294b28b731d741eeb9b
-  data.tar.gz: 70b4bc355484300078eac81ec0ce5f450373346dd5809338f03ddaae83f1823f07bb39a8dfa76c67a043960805c14ad54830b036722e855ec62f766c2611bf6a
+  metadata.gz: bae352f6da8c9b2b1f3a174f64f695485373225db830be20694688e02cc7368aab9e5548862c5e2e24d8ee985eef7f09b20bf674cee6ac85217418958af541e1
+  data.tar.gz: 50d4c6fd1f70c4e042e07d948fb0561e43e0788f73d277d54476e2cbbe9c4587fe4686b69262b7a7eb3d53494146f1a1516f0b3d9925651887d67415e568e73a

data/lib/justprep/common/constants.crb

@@ -1,5 +1,7 @@
-VERSION = "1.2.2"
+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

@@ -18,6 +18,11 @@ def error_file_does_not_exist(line_number, 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
@@ -29,3 +34,20 @@ def error_file_does_not_exist(line_number, a_line)
 
   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/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/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/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/crystal_methods.rb

@@ -15,4 +15,12 @@ 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.rb

@@ -13,6 +13,11 @@
 # 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
 #
 
 IMPLEMENTATION  = "Ruby"
@@ -34,37 +39,36 @@ 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
 
-
-  # single-level inclusion
-  def include_content_from(out_file, module_filename)
-    module_file = File.open(module_filename, "r")
-
-    out_file.puts "\n# >>> #{module_filename}"
-
-    module_file.readlines.each do |m_line|
-      out_file.write m_line
-      end
-
-    out_file.puts "# <<< #{module_filename}\n"
-
-    return nil
-    end
-
-
-    # Main function called from executable
-    def execute
     in_filename  = just_find_it
 
     if in_filename.nil?
-        STDERR.puts "WARNING: JUSTPREP_FILENAME_IN Not Found: #{JUSTPREP_FILENAME_IN}"
-        exit(0)
-      end
+      STDERR.puts "WARNING: JUSTPREP_FILENAME_IN Not Found: #{JUSTPREP_FILENAME_IN}"
+      exit(0)
+    end
 
     out_filename  = File.dirname(in_filename) + "/" + JUSTPREP_FILENAME_OUT
 
@@ -81,7 +85,7 @@ class Justprep
       if 0 == parts.size
         out_file.puts
         next
-        end
+      end
 
       # NOTE: Leading spaces are not allowed.  The keywords
       #       MUST be complete left-justified.
@@ -101,16 +105,22 @@ class Justprep
         module_filenames.each do |module_filename|
           if File.exist?(module_filename)
             include_content_from(out_file, module_filename)
-        else
+          else
             error_file_does_not_exist(line_number, a_line)
-          exit(1)
-        end
+            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 # in_file.readlines ...
 
+    out_file.puts generate_module_recipes(@module_names)
+
     out_file.close
-    end # def execute
+  end # def
 end # class Justprep

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justprep
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -53,8 +53,11 @@ files:
 - 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
@@ -79,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: A pre-processor for the 'just' command line utility