justprep 0.1.0.2 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13b593435a5c49d2e2424322e870ff7827b23c09a663aee229fed96244a4ab2
-  data.tar.gz: 34461b2ae7001c6bd742546ce08e772c0615a4e97509c35599f95a478473e4e2
+  metadata.gz: 7e0bc299adb71964c6298e1a195b380dd37c4cf716c2c58cb6ffab9320f74a5d
+  data.tar.gz: a22fcb32d3c7c5b516dade83e17670696ef0aa0619efcbb8c1361b580100b814
 SHA512:
-  metadata.gz: 7acc2115979eb30d55d918032ebcccd635398f874a3088a3349b7a296372a14d890126fa667339fc3f75e7ef95763a0b555a22b5a0e6a2ef6f2b0395b9bd9974
-  data.tar.gz: 942df7a303cab2dcf36c80e5c281e3b47f648f9a89fd6b0ecdc729abff08dd9aefcb032f383ec51ac66963271c3e54ffda428bcab11bed26574f1b965e1de394
+  metadata.gz: 9c2a9c4b7da6f3ad617f6799084808596c868a710dcb6a639dd742709c3aef18c414d32d654c3f74821d1d10af03c80f27414c0dd7007294b28b731d741eeb9b
+  data.tar.gz: 70b4bc355484300078eac81ec0ce5f450373346dd5809338f03ddaae83f1823f07bb39a8dfa76c67a043960805c14ad54830b036722e855ec62f766c2611bf6a

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    justprep (0.1.0)
+    justprep (1.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    bump (0.10.0)
     minitest (5.14.4)
     rake (13.0.4)
 
@@ -13,9 +14,10 @@ PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
+  bump
   justprep!
   minitest (~> 5.0)
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.21
+   2.2.24

data/README.md

@@ -8,13 +8,7 @@ A pre-processor to the "just" command-line utility packaged as a Ruby Gem.
 
 ## 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).
+See the top-level README.md file.
 
 ## Contributing
 

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

@@ -0,0 +1,29 @@
+# github.com/MadBomber/justprep/**/ruby/justfile
+#
+
+set positional-arguments := true
+
+# List available recipes
+@help:
+  echo
+  echo "Available Recipes at"
+  echo `pwd`
+  echo "are:"
+  echo
+  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:
+  rake clean clobber build
+
+
+# Install the gem locally
+@install:
+  rake install:local
+

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"]
 
@@ -39,6 +39,5 @@ Gem::Specification.new do |spec|
     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"
+  spec.add_development_dependency 'bump'
 end

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 = "0.1.0.2"
+  VERSION = "1.0.2"
 end

data/lib/justprep.rb

@@ -1,190 +1,116 @@
 # 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)
+# File: justprep.rb
+# Desc: A preprocessor to "just" cli tool
+# By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
+#
+# 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'
 #
 
-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
-
+IMPLEMENTATION  = "Ruby"
 
-    # 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"
+require           "fileutils"
+require           "pathname"
+require_relative  "justprep/crystal_methods"
 
-      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
-
-      mainfile  = just_find_it
+    in_filename  = just_find_it
 
-      exit(0) 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(' ')
-        module_filename = a_line[begin_filename, a_line.size - begin_filename].strip
+      parts = a_line.to_s.split(" ")
 
-        if module_filename.empty?
-          STDERR.puts "#{an_index}: #{a_line}"
-          STDERR.puts "ERROR: No path/to/file was provided"
-          next
+      if 0 == parts.size
+        out_file.puts
+        next
         end
 
-        if module_filename.include?('~')  || module_filename.include?('$')
-          module_filename = expand_file_path(module_filename)
-        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}"
+
+        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 "#{an_index}: #{a_line}"
-          STDERR.puts "| ERROR: File Does Not Exist - #{module_path}"
+            error_file_does_not_exist(line_number, a_line)
+          exit(1)
+        end
         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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: justprep
 version: !ruby/object:Gem::Version
-  version: 0.1.0.2
+  version: 1.2.2
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
-dependencies: []
+date: 2022-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   allows a "justfile" to be auto-generated from a seperate source file
   that contains inclusionary keywords such as include, import, require
@@ -26,7 +40,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -34,8 +47,16 @@ files:
 - Rakefile
 - bin/justprep
 - bin/setup
+- 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
@@ -58,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: A pre-processor for the 'just' command line utility

data/CHANGELOG.md

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