justprep 1.0.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4729fa9db5b45ee64efff9c7f0aaddbeddf6d654cfe031d1a7039a13c8deca0
-  data.tar.gz: a2806b5e251bf062763aec4b5c1806919051a3251e42d7c03f61a557f53b9465
+  metadata.gz: 7e0bc299adb71964c6298e1a195b380dd37c4cf716c2c58cb6ffab9320f74a5d
+  data.tar.gz: a22fcb32d3c7c5b516dade83e17670696ef0aa0619efcbb8c1361b580100b814
 SHA512:
-  metadata.gz: b27ccd199ac3f53759e0c07e039c3d5d3d4212166c5f4d6cec0fde22fb4f0281746ca7a61b690cb882280e4bdb0e45f7aee446a3696aadc40db20b9617a1117a
-  data.tar.gz: 436b0657a5d2a66d1db74cdfb953f7a83f2b69889653bb0ad0204365a79117f8adcf086aabc7f256123adefcac8861db339362de7d46c4d4e271974e507a799f
+  metadata.gz: 9c2a9c4b7da6f3ad617f6799084808596c868a710dcb6a639dd742709c3aef18c414d32d654c3f74821d1d10af03c80f27414c0dd7007294b28b731d741eeb9b
+  data.tar.gz: 70b4bc355484300078eac81ec0ce5f450373346dd5809338f03ddaae83f1823f07bb39a8dfa76c67a043960805c14ad54830b036722e855ec62f766c2611bf6a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    justprep (1.0.1)
+    justprep (1.0.2)
 
 GEM
   remote: https://rubygems.org/

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,6 +1,5 @@
 # github.com/MadBomber/justprep/**/ruby/justfile
 #
-# gem install bump
 
 set positional-arguments := true
 
@@ -14,6 +13,10 @@ 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:
@@ -24,26 +27,3 @@ set positional-arguments := true
 @install:
   rake install:local
 
-
-#################################################
-## 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
-
-
-# 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,5 @@
+VERSION = "1.2.2"
+
+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

data/lib/justprep/common/error_messages.crb

@@ -0,0 +1,31 @@
+# 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(" ")
+  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

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/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/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/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,18 @@
+# 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?
+end

data/lib/justprep/version.rb

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

data/lib/justprep.rb

@@ -15,180 +15,102 @@
 # JUSTPREP_KEYWORDS     ... 'import include require with'
 #
 
-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} ") || x.strip == keyword}
-      end
-
-      return modules.flatten!
-    end
+IMPLEMENTATION  = "Ruby"
 
+require           "fileutils"
+require           "pathname"
+require_relative  "justprep/crystal_methods"
 
-    # 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
+# 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"
+
+class Justprep
+  def initialize
+    handle_command_line_parameters  # may terminate the process
     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
+  # single-level inclusion
+  def include_content_from(out_file, module_filename)
+    module_file = File.open(module_filename, "r")
 
+    out_file.puts "\n# >>> #{module_filename}"
 
-    # 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]
+    module_file.readlines.each do |m_line|
+      out_file.write m_line
       end
 
-      a_path_string = `echo "#{a_path_string}"`.chomp
+    out_file.puts "# <<< #{module_filename}\n"
 
-      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
+    return nil
     end
 
 
     # Main function called from executable
     def execute
-      handle_command_line_parameters
+    in_filename  = just_find_it
 
-      mainfile  = just_find_it
-
-      if mainfile.nil?
+    if in_filename.nil?
         STDERR.puts "WARNING: JUSTPREP_FILENAME_IN Not Found: #{JUSTPREP_FILENAME_IN}"
         exit(0)
       end
 
-      basefile  = mainfile.parent + JUSTPREP_FILENAME_OUT
+    out_filename  = File.dirname(in_filename) + "/" + JUSTPREP_FILENAME_OUT
 
-      text = mainfile.readlines.map{|x| x.chomp} # drop the line ending from each line
+    in_file   = File.open(in_filename,  "r")
+    out_file  = File.open(out_filename, "w")
 
-      modules = find_modules text
+    line_number = 0
 
-      if modules.empty?
-        basefile.write text
-        exit(0)
-      end
+    in_file.readlines.map{|x| x.chomp}.each do |a_line|
+      line_number += 1
 
-      modules.each do |a_line|
-        an_index        = text.index a_line
-        begin_filename  = a_line.index(' ')
+      parts = a_line.to_s.split(" ")
 
-        if begin_filename.nil?
-          module_filename = ""
-        else
-          module_filename = a_line[begin_filename, a_line.size - begin_filename].chomp.strip
+      if 0 == parts.size
+        out_file.puts
+        next
         end
 
-        if module_filename.empty?
-          STDERR.puts "ERROR: No path/to/file was provided"
-          line_out = sprintf('% d ', an_index+1)
-          STDERR.puts (" "*line_out.size)+"|"
-          STDERR.puts "#{line_out}| #{a_line}"
-          STDERR.print (" "*line_out.size)+"|"
-          STDERR.puts (" "*(a_line.size+2)) + "^"
-          exit(1)
-        end
+      # 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}"
 
-        if module_filename.include?('~')  || module_filename.include?('$')
-          module_filename = expand_file_path(module_filename)
-        end
+        glob_filename = expand_file_path(parts[1..parts.size].join(" "))
 
-        module_path     = Pathname.new(module_filename)
+        module_filenames = Dir.glob(glob_filename)
 
-        if module_path.relative?
-          module_path = mainfile.parent + module_path
+        if 0 == module_filenames.size
+          error_file_does_not_exist(line_number, a_line)
+          exit(1)
         end
 
-        if module_path.exist?
-          text[an_index]  = include_content_from(module_path)
+        module_filenames.each do |module_filename|
+          if File.exist?(module_filename)
+            include_content_from(out_file, module_filename)
         else
-          STDERR.puts "ERROR: File Does Not Exist - #{module_path}"
-          line_out = sprintf('% d ', an_index+1)
-          STDERR.puts (" "*line_out.size)+"|"
-          STDERR.puts "#{line_out}| #{a_line}"
-          STDERR.print (" "*line_out.size)+"|"
-          STDERR.puts (" "*(a_line.index(module_filename)+1)) + "^"
+            error_file_does_not_exist(line_number, a_line)
           exit(1)
         end
-      end # modules.each do |a_line|
+        end
+      else
+        out_file.puts a_line
+      end
+    end # in_file.readlines ...
 
-      basefile.write text.flatten!.join "\n"
+    out_file.close
     end # def execute
-  end # class << self
-end # module Justprep
+end # class Justprep

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justprep
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-18 00:00:00.000000000 Z
+date: 2022-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -50,6 +50,13 @@ 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/handle_command_line_parameters.crb
+- lib/justprep/common/just_find_it.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 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: A pre-processor for the 'just' command line utility