kojo 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6bcd67142ce2bbde7f22e49d2884dd258046db5a786c4591ca9657cb697ab9
-  data.tar.gz: a72337674e2a3d8892f63f3705d87cf91723f93ade219ce87f5a8d1331ece91a
+  metadata.gz: de58d04d2528d3ef48c8a0855aa64b9ea79329becb44c12ca14c016007268d51
+  data.tar.gz: fce2e51b807e1846914e89919d589662e6292322b68a332a7bf8ade7e96924bf
 SHA512:
-  metadata.gz: 6e302b53329de878ca3a177f98a8e43d0f12b8b9be88093c2638515c0e514b6e60512a4e217a0896fbc29edaf15fc2f3bd45a05d992efa7e2dbc43f8d46c5475
-  data.tar.gz: ec8504461e7bb58bbd1782dcaa1113fc2fb49729463794995e10b7d67e36e2c475946acc0a34e5663726954c592a340a81a8bbb047f80465b4829d4b9db6baae
+  metadata.gz: acbcafca4007995e322ef0b0b21f6a1b8993263184c70ad0c30f1b37e7a511d6cc05be69fdde628128172c6959395996ecc926b4eefb436aa1b87ab4ca0d2a67
+  data.tar.gz: 1226331b78b9c630245d9e51e7f34ec356844816544303ee34b76c44e36cac564b2af7b9a55740a8ea8ecadd989e4ac000cebc01b95017b42329083e3e1578b9

data/README.md

@@ -41,10 +41,17 @@ format.
 $ gem install kojo
 ```
 
+Or with Homebrew:
+
+```shell
+$ brew install brew-gem    # once only, to enable the brew gem command
+$ brew gem install kojo
+```
+
 Or with Docker:
 
 ```shell
-$ alias kojo='docker run --rm -it -v "$PWD:/app" dannyben/kojo'
+$ alias kojo='docker run --rm -it --user $(id -u):$(id -g) --volume "$PWD:/app" dannyben/kojo'
 ```
 
 ## Usage

data/bin/kojo

@@ -10,9 +10,9 @@ begin
   exit runner.run ARGV
 rescue Kojo::Interrupt
   say! "\nGoodbye"
-  exit 1  
+  exit 1
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
-end
+end

data/lib/kojo/cli.rb

@@ -3,12 +3,12 @@ require 'kojo/version'
 requires 'commands'
 
 module Kojo
-  # The CLI class is used by the kojo binary and forwards incoming CLI 
+  # The CLI class is used by the kojo binary and forwards incoming CLI
   # commands to the relevant Kojo::Commands class
   class CLI
     def self.runner
       Kojo.interactive = ENV['KOJO_INTERACTIVE'] != 'no'
-      
+
       runner = MisterBin::Runner.new version: Kojo::VERSION
 
       runner.route 'file',   to: Kojo::Commands::FileCmd
@@ -21,5 +21,4 @@ module Kojo
       runner
     end
   end
-
 end

data/lib/kojo/collection.rb

@@ -1,5 +1,5 @@
 module Kojo
-  # The Collection class is a wrapper around the {Template} object. It 
+  # The Collection class is a wrapper around the {Template} object. It
   # provides a mechanism for processing an entire directory of templates.
   class Collection
     using Refinements
@@ -28,7 +28,7 @@ module Kojo
       template = Template.new file
       template.import_base = import_base
 
-      path = file.sub(/#{dir}\//, '').resolve args
+      path = file.sub(%r{#{dir}/}, '').resolve args
 
       yield path, template.render(args)
     end

data/lib/kojo/commands/command_base.rb

@@ -9,4 +9,4 @@ module Kojo
       end
     end
   end
-end
+end

data/lib/kojo/commands/config.rb

@@ -8,22 +8,22 @@ module Kojo::Commands
 
     attr_reader :gen, :outdir, :opts, :import_base, :config_file
 
-    help "Transform based on instructions from a config file"
+    help 'Transform based on instructions from a config file'
 
-    usage "kojo config CONFIG [--save DIR --imports DIR --args FILE] [ARGS...]"
-    usage "kojo config (-h|--help)"
+    usage 'kojo config CONFIG [--save DIR --imports DIR --args FILE] [ARGS...]'
+    usage 'kojo config (-h|--help)'
 
-    option "-s --save DIR", "Save output to directory instead of printing"
-    option "-i --imports DIR", "Specify base directory for @import directives"
-    option "-a --args FILE", "Load arguments from YAML file"
+    option '-s --save DIR', 'Save output to directory instead of printing'
+    option '-i --imports DIR', 'Specify base directory for @import directives'
+    option '-a --args FILE', 'Load arguments from YAML file'
 
-    param "CONFIG", "YAML configuration file"
-    param "ARGS", "Optional key=value pairs"
+    param 'CONFIG', 'YAML configuration file'
+    param 'ARGS', 'Optional key=value pairs'
 
-    example "kojo config config.yml"
-    example "kojo config config.yml --save output"
-    example "kojo config config.yml -s output scale=3"
-    example "kojo config config.yml -s output --args args.yml"
+    example 'kojo config config.yml'
+    example 'kojo config config.yml --save output'
+    example 'kojo config config.yml -s output scale=3'
+    example 'kojo config config.yml -s output --args args.yml'
 
     def run
       @config_file = args['CONFIG']

data/lib/kojo/commands/dir.rb

@@ -8,22 +8,22 @@ module Kojo
 
       attr_reader :opts, :indir, :outdir, :import_base
 
-      help "Transform a folder of templates to a similar output folder"
+      help 'Transform a folder of templates to a similar output folder'
 
-      usage "kojo dir INDIR [--save DIR --imports DIR --args FILE] [ARGS...]"
-      usage "kojo dir (-h|--help)"
+      usage 'kojo dir INDIR [--save DIR --imports DIR --args FILE] [ARGS...]'
+      usage 'kojo dir (-h|--help)'
 
-      option "-s --save DIR", "Save output to directory instead of printing"
-      option "-i --imports DIR", "Specify base directory for @import directives"
-      option "-a --args FILE", "Load arguments from YAML file"
+      option '-s --save DIR', 'Save output to directory instead of printing'
+      option '-i --imports DIR', 'Specify base directory for @import directives'
+      option '-a --args FILE', 'Load arguments from YAML file'
 
-      param "INDIR", "Directory containing templates to transform"
-      param "ARGS", "Optional key=value pairs"
+      param 'INDIR', 'Directory containing templates to transform'
+      param 'ARGS', 'Optional key=value pairs'
 
-      example "kojo dir indir"
-      example "kojo dir in --save out env=production"
-      example "kojo dir in --save out --imports snippets env=production"
-      example "kojo dir in -s out -i snippets -a args.yml"
+      example 'kojo dir indir'
+      example 'kojo dir in --save out env=production'
+      example 'kojo dir in --save out --imports snippets env=production'
+      example 'kojo dir in -s out -i snippets -a args.yml'
 
       def run
         @opts = args['ARGS'].args_to_hash
@@ -67,4 +67,4 @@ module Kojo
       end
     end
   end
-end
+end

data/lib/kojo/commands/file.rb

@@ -8,22 +8,22 @@ module Kojo
 
       attr_reader :opts, :outfile, :infile, :import_base
 
-      help "Transform a file from a template"
+      help 'Transform a file from a template'
 
-      usage "kojo file INFILE [--save FILE --imports DIR --args FILE] [ARGS...]"
-      usage "kojo file (-h|--help)"
+      usage 'kojo file INFILE [--save FILE --imports DIR --args FILE] [ARGS...]'
+      usage 'kojo file (-h|--help)'
 
-      option "-s --save FILE", "Save to file instead of printing"
-      option "-i --imports DIR", "Specify base directory for @import directives"
-      option "-a --args FILE", "Load arguments from YAML file"
+      option '-s --save FILE', 'Save to file instead of printing'
+      option '-i --imports DIR', 'Specify base directory for @import directives'
+      option '-a --args FILE', 'Load arguments from YAML file'
 
-      param "INFILE", "Template to transform"
-      param "ARGS", "Optional key=value pairs"
+      param 'INFILE', 'Template to transform'
+      param 'ARGS', 'Optional key=value pairs'
 
-      example "kojo file main.yml"
-      example "kojo file main.yml --save out.yml"
-      example "kojo file main.yml -s out.yml app=lause"
-      example "kojo file main.yml -s out.yml --args args.yml"
+      example 'kojo file main.yml'
+      example 'kojo file main.yml --save out.yml'
+      example 'kojo file main.yml -s out.yml app=lause'
+      example 'kojo file main.yml -s out.yml --args args.yml'
 
       def run
         @opts = args['ARGS'].args_to_hash
@@ -53,7 +53,6 @@ module Kojo
           puts output
         end
       end
-
     end
   end
-end
+end

data/lib/kojo/commands/form.rb

@@ -6,30 +6,29 @@ module Kojo
     class FormCmd < CommandBase
       attr_reader :infile, :outdir
 
-      help "Fill a template form interactively"
+      help 'Fill a template form interactively'
 
-      usage "kojo form INFILE [--save FILE]"
-      usage "kojo form (-h|--help)"
+      usage 'kojo form INFILE [--save FILE]'
+      usage 'kojo form (-h|--help)'
 
-      option "-s --save FILE", "Save to file instead of printing"
+      option '-s --save FILE', 'Save to file instead of printing'
 
-      param "INFILE", "ERBX template to transform"
+      param 'INFILE', 'ERBX template to transform'
 
-      example "kojo form report.md"
-      example "kojo form report.md --save output.md"
+      example 'kojo form report.md'
+      example 'kojo form report.md --save output.md'
 
       def run
         infile = args['INFILE']
         outfile = args['--save']
         template = Kojo::Form.new infile
-        
+
         if outfile
           save outfile, template.render
         else
-          puts template.render 
+          puts template.render
         end
       end
-
     end
   end
-end
+end

data/lib/kojo/commands/single.rb

@@ -8,20 +8,20 @@ module Kojo
 
       attr_reader :opts, :infile, :outdir
 
-      help "Transform using a single file that contains the instructions"
+      help 'Transform using a single file that contains the instructions'
 
-      usage "kojo single INFILE [--save DIR] [ARGS...]"
-      usage "kojo single (-h|--help)"
+      usage 'kojo single INFILE [--save DIR] [ARGS...]'
+      usage 'kojo single (-h|--help)'
 
-      option "-s --save DIR", "Save output to directory instead of printing"
+      option '-s --save DIR', 'Save output to directory instead of printing'
 
-      param "INFILE", "Template to transform. The template should contain a YAML front matter with transformation instructions"
-      param "ARGS", "Optional key=value pairs"
+      param 'INFILE', 'Template to transform. The template should contain a YAML front matter with transformation instructions'
+      param 'ARGS', 'Optional key=value pairs'
 
-      example "kojo single Dockerfile"
-      example "kojo single template.Dockerfile --save ."
-      example "kojo single template.Dockerfile --save output"
-      example "kojo single template.Dockerfile scale=2"
+      example 'kojo single Dockerfile'
+      example 'kojo single template.Dockerfile --save .'
+      example 'kojo single template.Dockerfile --save output'
+      example 'kojo single template.Dockerfile scale=2'
 
       def run
         @opts = args['ARGS'].args_to_hash
@@ -51,4 +51,4 @@ module Kojo
       end
     end
   end
-end
+end

data/lib/kojo/commands/to_json.rb

@@ -8,24 +8,24 @@ module Kojo
 
       attr_reader :input, :save_files, :replace_files
 
-      help "Convert one or more YAML files to JSON"
+      help 'Convert one or more YAML files to JSON'
 
-      usage "kojo tojson INPUT... [(--save | --replace)]"
-      usage "kojo tojson (-h|--help)"
+      usage 'kojo tojson INPUT... [(--save | --replace)]'
+      usage 'kojo tojson (-h|--help)'
 
-      option "-s --save", "Save each input file in the same directory"
-      option "-r --replace", "Save each input file in the same directory and delete the input file"
+      option '-s --save', 'Save each input file in the same directory'
+      option '-r --replace', 'Save each input file in the same directory and delete the input file'
 
-      param "INPUT", "Path to a YAML file or multiple files using a glob pattern"
+      param 'INPUT', 'Path to a YAML file or multiple files using a glob pattern'
 
-      example "kojo tojson myfile.yaml"
-      example "kojo tojson myfile.yaml --save"
-      example "kojo tojson indir/*.yaml"
-      example "kojo tojson indir/*.yaml --replace"
-      example "kojo tojson indir/**/*.yml"
+      example 'kojo tojson myfile.yaml'
+      example 'kojo tojson myfile.yaml --save'
+      example 'kojo tojson indir/*.yaml'
+      example 'kojo tojson indir/*.yaml --replace'
+      example 'kojo tojson indir/**/*.yml'
 
       def run
-        @input = get_input_files
+        @input = input_files
         @save_files = args['--save'] || args['--replace']
         @replace_files = args['--replace']
 
@@ -41,7 +41,7 @@ module Kojo
       # Glob patterns are usually handled by the shell, but in case
       # we still have '*' in our string (for example, if it was sent
       # quoted), we will do the globbing ourselves
-      def get_input_files
+      def input_files
         args['INPUT'].map do |path|
           path.include?('*') ? Dir[path].sort : path
         end.flatten
@@ -64,4 +64,4 @@ module Kojo
       end
     end
   end
-end
+end

data/lib/kojo/config.rb

@@ -1,5 +1,5 @@
 module Kojo
-  # The Config class handles multiple template generation from a 
+  # The Config class handles multiple template generation from a
   # definitions YAML file.
   class Config
     using Refinements
@@ -25,10 +25,10 @@ module Kojo
     def generate_from_file(opts)
       config['output'].each do |target, config_opts|
         local_opts = opts.merge config_opts.symbolize_keys
-        
+
         template = Template.new source
         template.import_base = import_base if import_base
-        
+
         yield target, template.render(local_opts)
       end
     end
@@ -62,5 +62,4 @@ module Kojo
       @config ||= YAML.load_file config_file
     end
   end
-
 end

data/lib/kojo/exceptions.rb

@@ -3,4 +3,4 @@ module Kojo
   class Error < StandardError; end
   class TemplateError < Error; end
   class NotFoundError < Error; end
-end
+end

data/lib/kojo/extensions/yaml.rb

@@ -4,6 +4,6 @@ module YAML
   # Make YAML.load behave the same in all Ruby versions
   # ref: https://bugs.ruby-lang.org/issues/17866
   class << self
-    alias_method :load, :unsafe_load if YAML.respond_to? :unsafe_load
+    alias load unsafe_load if YAML.respond_to? :unsafe_load
   end
 end

data/lib/kojo/form.rb

@@ -41,20 +41,19 @@ module Kojo
       end
     end
 
-    def respond_to?(method_name, include_private = false)
+    def respond_to_missing?(method_name, include_private = false)
       prompt.respond_to?(method_name) || super
     end
 
-    # Below are TTY::Prompt functions that are not captured by the 
-    # `mthod_missing`, so we specify them explicitly
+    # Below are TTY::Prompt functions that are not captured by the
+    # `method_missing`, so we specify them explicitly
 
-    def select(*args, &block)
-      prompt.select *args, &block
+    def select(...)
+      prompt.select(...)
     end
 
-    def warn(*args, &block)
-      prompt.warn *args, &block
+    def warn(...)
+      prompt.warn(...)
     end
-
   end
 end

data/lib/kojo/front_matter_template.rb

@@ -1,5 +1,5 @@
 module Kojo
-  # The FrontMatterTemplate class handles a single template file, that 
+  # The FrontMatterTemplate class handles a single template file, that
   # contains a YAML front matter.
   class FrontMatterTemplate
     using Refinements
@@ -23,10 +23,7 @@ module Kojo
   private
 
     def handle(args = {})
-      content = template
-      content = content.eval_erb args, file
-      content = content.eval_vars args, file
-      content
+      template.eval_erb(args, file).eval_vars(args, file)
     end
 
     def read_file(file)
@@ -38,5 +35,4 @@ module Kojo
       [config, content]
     end
   end
-
-end
+end

data/lib/kojo/refinements/array.rb

@@ -5,11 +5,8 @@ module Kojo
     refine Array do
       # Convert an array of +["key=value", "key=value"]+ pairs to a hash
       def args_to_hash
-        collect { |a| a.split '=' }
-          .to_h
-          .symbolize_keys
-          .typecast_values
+        to_h { |a| a.split '=' }.symbolize_keys.typecast_values
       end
     end
   end
-end
+end

data/lib/kojo/refinements/hash.rb

@@ -4,12 +4,12 @@ module Kojo
   module Refinements
     refine Hash do
       def symbolize_keys
-        transform_keys &:to_sym
+        transform_keys(&:to_sym)
       end
 
       def typecast_values
-        transform_values &:to_typed
+        transform_values(&:to_typed)
       end
     end
   end
-end
+end

data/lib/kojo/refinements/string.rb

@@ -6,11 +6,11 @@ module Kojo
     refine String do
       # Convert a string to the most appropriate type
       def to_typed
-        if self =~ /\A[+-]?\d+\Z/
-          self.to_i
+        if /\A[+-]?\d+\Z/.match?(self)
+          to_i
 
-        elsif self =~ /\A[+-]?\d+\.\d+\Z/
-          self.to_f
+        elsif /\A[+-]?\d+\.\d+\Z/.match?(self)
+          to_f
 
         elsif %w[yes no true false].include? downcase
           %w[yes true].include? downcase
@@ -23,12 +23,11 @@ module Kojo
 
       def resolve(vars)
         self % vars.symbolize_keys
-      
       rescue KeyError => e
         raise unless Kojo.interactive?
 
         print "> #{e.key}: "
-        vars[e.key] = get_user_input
+        vars[e.key] = user_input
         retry
       end
 
@@ -47,16 +46,17 @@ module Kojo
       end
 
       def compress_imports
-        gsub /^ *@import +[^(\s]+\s*\([\S\s]*?\) *$/ do |match|
-          match.gsub /\r?\n\s*/, " "
+        gsub(/^ *@import +[^(\s]+\s*\([\S\s]*?\) *$/) do |match|
+          match.gsub(/\r?\n\s*/, ' ')
         end
       end
 
-    private 
+    private
 
-      def get_user_input
+      def user_input
         response = $stdin.gets
         raise Kojo::Interrupt unless response # Ctrl+D
+
         response.chomp
       rescue ::Interrupt # Ctrl+C
         raise Kojo::Interrupt
@@ -65,7 +65,6 @@ module Kojo
       def erb(template, vars)
         ERB.new(template, trim_mode: '-').result(OpenStruct.new(vars).instance_eval { binding })
       end
-
     end
   end
-end
+end

data/lib/kojo/template.rb

@@ -24,15 +24,14 @@ module Kojo
   protected
 
     def evaluate(file)
-      content = read_file file
-      content = content.eval_erb args, file
-      content = content.eval_vars args, file
-      content = eval_imports content
-      content
+      eval_imports read_file(file)
+        .eval_erb(args, file)
+        .eval_vars(args, file)
     end
 
     def read_file(file)
       raise Kojo::NotFoundError, "File not found: #{file}" unless File.exist? file
+
       File.read file
     end
 
@@ -46,18 +45,18 @@ module Kojo
         if line =~ /^\s*@import ([^(\s]*)\s*(?:\((.*)\))?\s*/
           file = $1
           args = $2 || ''
-          args = instance_eval("{#{args}}")
+          args = instance_eval("{#{args}}", __FILE__, __LINE__)
           imported = import file, args
           line = indent imported, spaces
         end
-        
+
         result.push line
       end
 
       result.join "\n"
     end
 
-    def import(file, import_args={})
+    def import(file, import_args = {})
       filename = File.expand_path "#{file}#{extension}", import_base
       all_args = args.merge import_args
       self.class.new(filename).render(all_args)
@@ -66,6 +65,5 @@ module Kojo
     def indent(text, spaces)
       text.lines.collect { |line| "#{' ' * spaces}#{line}" }.join.gsub(/^\s*$/, '')
     end
-
   end
 end

data/lib/kojo/version.rb

@@ -1,3 +1,3 @@
 module Kojo
-  VERSION = "0.4.1"
-end
+  VERSION = '0.4.2'
+end

data/lib/kojo.rb

@@ -16,14 +16,12 @@ require 'kojo/form'
 
 module Kojo
   class << self
+    attr_writer :interactive
+
     def interactive?
       return @interactive unless @interactive.nil?
-      @interactive = ENV['KOJO_INTERACTIVE'] == 'yes'
-    end
 
-    def interactive=(value)
-      @interactive = value
+      @interactive = ENV['KOJO_INTERACTIVE'] == 'yes'
     end
   end
-
-end
+end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: kojo
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mister_bin
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: requires
+  name: erbx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: tty-prompt
+  name: requires
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: erbx
+  name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.21'
 description: Generate configuration files from templates, using variables and definition
   files.
 email: db@dannyben.com
@@ -114,7 +114,8 @@ files:
 homepage: https://github.com/dannyben/kojo
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -123,14 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.3
 signing_key: 
 specification_version: 4
 summary: Configuration Ninja