kojo 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31deffc66dbb1ff100bb90f669f8d2995f8eeac92c78919434caffbb9ecfee69
-  data.tar.gz: 6c4b75d7e13b627520d403d8885333a9c30b06cd40c56889e2cd4823ac125b12
+  metadata.gz: 1952c33f6d6360f1a027ee30eefcfea5636a062c2c28c02d83916d99e51ed7c1
+  data.tar.gz: 9554ea0de969c79e11d40b237d4ffb24c3bceead6dc863511124af6b4753841b
 SHA512:
-  metadata.gz: b6731a253afc7c3ccdb8f718e4a78d70d6bfcea9079c269f0b9ca1d8da3596abcbfd5b895fa2e32bbc2b14629c4b5a022cd7996fb3428a6260cb5b5b64b97aa8
-  data.tar.gz: 0c285f0dcaeff09fb183fe2f02e8f25a9905b4431bca7908dfc0824bfd5caba74d215476e661b519733c790b2b79ea599c9d325f03bdab7c847f98761c815ffc
+  metadata.gz: 40bdbcfa32871516c1776923dffd3d78b0757463941da85708b4292e9a84f5c8308dd655e1707493e6da9411771a12c18a57d7098ae0d85cc1c537bf41d3fcb7
+  data.tar.gz: 76d43feccd9c0210bd3239f86b089a27527fdbd293daaf771dcb3d8170dd5d57a864e2a7fc399a00b6989d963659eb1e7ea9a7b8e7f23561a288a27e7187d941

data/README.md

@@ -1,6 +1,6 @@
 <div align='center'>
 
-![kojo](images/kojo.png)
+![kojo](support/kojo.png)
 
 # Kojo Configuration Ninja
 
@@ -26,6 +26,7 @@ format.
   - [Transform an Entire Folder](#transform-an-entire-folder)
   - [Transform One to Many using Config](#transform-one-to-many-using-config)
   - [Transform One to Many using Front Matter](#transform-one-to-many-using-front-matter)
+  - [Convert YAML to JSON](#convert-yaml-to-json)
   - [Interactive Form Templates](#interactive-form-templates)
   - [Conditions and Loops with ERB](#conditions-and-loops-with-erb)
 - [Interactive Fallback](#interactive-fallback)
@@ -54,7 +55,7 @@ relevant files, and the expected output.
 
 ### Variables
 
-![kojo](images/features-vars.svg)
+![kojo](support/features-vars.svg)
 
 Include variables in your configuration templates by using this syntax: 
 `%{varname}`
@@ -65,9 +66,13 @@ Include variables in your configuration templates by using this syntax:
 - Variables from the top level will be forwarded downstream, and aggregated 
   with any additional variables that are defined in subsequent `@imports`.
 
+Note that since the `%` sign is used for variable replacement, if you want
+your generated file to include a literal percent sign, you need to escape it
+as `%%` in your template.
+
 ### Import
 
-![kojo](images/features-import.svg)
+![kojo](support/features-import.svg)
 
 Use the `@import filename` directive anywhere to include another file in the
 resulting configuration file.
@@ -88,7 +93,7 @@ The space after `filename` is optional.
 
 ### Transform an Entire Folder
 
-![kojo](images/features-dir.svg)
+![kojo](support/features-dir.svg)
 
 Process a folder containing templates and `@imports`, and generate a mirror
 output folder, with all the variables and `@imports` evaluated.
@@ -97,7 +102,7 @@ You may use `%{variables}` in filenames.
 
 ### Transform One to Many using Config
 
-![kojo](images/features-config.svg)
+![kojo](support/features-config.svg)
 
 Using the `kojo config` command together with a simple definitions file, you
 can:
@@ -142,7 +147,7 @@ output:
 
 ### Transform One to Many using Front Matter
 
-![kojo](images/features-single.svg)
+![kojo](support/features-single.svg)
 
 Define a template that contains the instructions on how to transform it as a
 YAML front matter.
@@ -150,7 +155,7 @@ YAML front matter.
 The YAML front matter should be structured like this:
 
 ```yaml
-filename2:
+filename1:
   arg: value
   another_arg: value
 
@@ -165,9 +170,22 @@ Your template that uses %{arg} goes here
 Additional arguments provided to the command line, will also be transferred
 to the template.
 
+### Convert YAML to JSON
+
+![kojo](support/features-tojson.svg)
+
+Convert one or more YAML files to JSON.
+
+This can be useful when you require JSON files as output, but wish to edit
+(or generate using Kojo) using the less error-prone and more aesthetically
+pleasing YAML format.
+
+Note that this Kojo command does not provide any additional preprocessing - the
+input files should be valid YAML.
+
 ### Interactive Form Templates
 
-![kojo](images/features-form.svg)
+![kojo](support/features-form.svg)
 
 Using the `kojo form` command lets you define an ERB or [ERBX][erbx] template, and include interactive prompts to enter the input. 
 
@@ -177,11 +195,11 @@ Using the `kojo form` command lets you define an ERB or [ERBX][erbx] template, a
 4. If there is a file with the same name as the template, and with an `.rb` extension (for example `form.md` and `form.md.rb`), then the ruby file will be loaded into the ERB template as if it was written inside it.
 5. If you prefer using a single template file (without the ruby appendix), you can simply use regular ERB/ERBX tags, like demonstrated below.
 
-![kojo](images/features-form-inline.svg)
+![kojo](support/features-form-inline.svg)
 
 ### Conditions and Loops with ERB
 
-![kojo](images/features-erb.svg)
+![kojo](support/features-erb.svg)
 
 Template files are evaluated using ERB, so you can use any Ruby code for more
 advanced templates (for conditions, loops etc.).
@@ -197,7 +215,7 @@ Use this syntax for ruby code:
 When Kojo encounters a variable that was not supplied (either through the command 
 line or through a configuration file), it will prompt for a value.
 
-![kojo](images/interactive-mode.gif)
+![kojo](support/interactive-mode.gif)
 
 You can enable or disable interactive mode by setting the environment
 variable `KOJO_INTERACTIVE` to `yes` or `no`.

data/lib/kojo/commands/config.rb

@@ -33,7 +33,7 @@ module Kojo::Commands
       argfile = args['--args']
 
       if argfile
-        fileopts = YAML.load_file(argfile).symbolize_keys
+        fileopts = YAML.properly_load_file(argfile).symbolize_keys
         @opts = fileopts.merge opts
       end
 

data/lib/kojo/commands/dir.rb

@@ -33,7 +33,7 @@ module Kojo
         argfile = args['--args']
 
         if argfile
-          fileopts = YAML.load_file(argfile).symbolize_keys
+          fileopts = YAML.properly_load_file(argfile).symbolize_keys
           @opts = fileopts.merge @opts
         end
 

data/lib/kojo/commands/file.rb

@@ -33,7 +33,7 @@ module Kojo
         argfile = args['--args']
 
         if argfile
-          fileopts = YAML.load_file(argfile).symbolize_keys
+          fileopts = YAML.properly_load_file(argfile).symbolize_keys
           @opts = fileopts.merge opts
         end
 

data/lib/kojo/commands/to_json.rb

@@ -35,7 +35,7 @@ module Kojo
     private
 
       def tojson(path)
-        JSON.pretty_generate YAML.load_file(path)
+        JSON.pretty_generate YAML.properly_load_file(path)
       end
 
       # Glob patterns are usually handled by the shell, but in case

data/lib/kojo/config.rb

@@ -59,7 +59,7 @@ module Kojo
     end
 
     def config
-      @config ||= YAML.load_file config_file
+      @config ||= YAML.properly_load_file config_file
     end
   end
 

data/lib/kojo/extensions/yaml.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+
+module YAML
+  # ref: https://bugs.ruby-lang.org/issues/17866
+  def self.properly_load_file(path)
+    YAML.load_file path, aliases: true
+  rescue ArgumentError
+    YAML.load_file path
+  end
+end

data/lib/kojo/front_matter_template.rb

@@ -32,7 +32,7 @@ module Kojo
     def read_file(file)
       raise Kojo::NotFoundError, "File not found: #{file}" unless File.exist? file
 
-      config = YAML.load_file file
+      config = YAML.properly_load_file file
       content = File.read(file)[/^---\s*$\n(.*)/m, 1]
 
       [config, content]

data/lib/kojo/refinements/string.rb

@@ -57,7 +57,7 @@ module Kojo
       end
 
       def erb(template, vars)
-        ERB.new(template, nil, '-').result(OpenStruct.new(vars).instance_eval { binding })
+        ERB.new(template, trim_mode: '-').result(OpenStruct.new(vars).instance_eval { binding })
       end
 
     end

data/lib/kojo/version.rb

@@ -1,3 +1,3 @@
 module Kojo
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
 end

data/lib/kojo.rb

@@ -4,8 +4,8 @@ require 'byebug' if ENV['BYEBUG']
 require 'yaml'
 require 'json'
 
-requires 'kojo/refinements'
 requires 'kojo/extensions'
+requires 'kojo/refinements'
 
 require 'kojo/exceptions'
 require 'kojo/template'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kojo
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -103,6 +103,7 @@ files:
 - lib/kojo/config.rb
 - lib/kojo/exceptions.rb
 - lib/kojo/extensions/file.rb
+- lib/kojo/extensions/yaml.rb
 - lib/kojo/form.rb
 - lib/kojo/front_matter_template.rb
 - lib/kojo/refinements/array.rb
@@ -122,14 +123,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Configuration Ninja