kojo 0.3.8 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31deffc66dbb1ff100bb90f669f8d2995f8eeac92c78919434caffbb9ecfee69
-  data.tar.gz: 6c4b75d7e13b627520d403d8885333a9c30b06cd40c56889e2cd4823ac125b12
+  metadata.gz: fa6bcd67142ce2bbde7f22e49d2884dd258046db5a786c4591ca9657cb697ab9
+  data.tar.gz: a72337674e2a3d8892f63f3705d87cf91723f93ade219ce87f5a8d1331ece91a
 SHA512:
-  metadata.gz: b6731a253afc7c3ccdb8f718e4a78d70d6bfcea9079c269f0b9ca1d8da3596abcbfd5b895fa2e32bbc2b14629c4b5a022cd7996fb3428a6260cb5b5b64b97aa8
-  data.tar.gz: 0c285f0dcaeff09fb183fe2f02e8f25a9905b4431bca7908dfc0824bfd5caba74d215476e661b519733c790b2b79ea599c9d325f03bdab7c847f98761c815ffc
+  metadata.gz: 6e302b53329de878ca3a177f98a8e43d0f12b8b9be88093c2638515c0e514b6e60512a4e217a0896fbc29edaf15fc2f3bd45a05d992efa7e2dbc43f8d46c5475
+  data.tar.gz: ec8504461e7bb58bbd1782dcaa1113fc2fb49729463794995e10b7d67e36e2c475946acc0a34e5663726954c592a340a81a8bbb047f80465b4829d4b9db6baae

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.
@@ -84,11 +89,19 @@ resulting configuration file.
 @import filename (arg: "value", arg2: "value")
 ```
 
-The space after `filename` is optional.
+The space after `filename` is optional, and the arguments list can be split to
+multiple lines:
+
+```ruby
+@import filename (
+  arg: "value",
+  arg2: "value"
+)
+```
 
 ### 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 +110,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 +155,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 +163,7 @@ YAML front matter.
 The YAML front matter should be structured like this:
 
 ```yaml
-filename2:
+filename1:
   arg: value
   another_arg: value
 
@@ -165,9 +178,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 +203,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 +223,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/extensions/yaml.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+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
+  end
+end

data/lib/kojo/refinements/string.rb

@@ -46,6 +46,12 @@ module Kojo
         raise Kojo::TemplateError, "#{e.message}\nin: #{filename}"
       end
 
+      def compress_imports
+        gsub /^ *@import +[^(\s]+\s*\([\S\s]*?\) *$/ do |match|
+          match.gsub /\r?\n\s*/, " "
+        end
+      end
+
     private 
 
       def get_user_input
@@ -57,7 +63,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/template.rb

@@ -38,8 +38,8 @@ module Kojo
 
     def eval_imports(content)
       result = []
-      
-      content.lines.each do |line|
+
+      content.compress_imports.lines.each do |line|
         line.chomp!
         spaces = line[/^\s*/].size
 
@@ -64,7 +64,7 @@ module Kojo
     end
 
     def indent(text, spaces)
-      text.lines.collect { |line| "#{' ' * spaces}#{line}" }.join
+      text.lines.collect { |line| "#{' ' * spaces}#{line}" }.join.gsub(/^\s*$/, '')
     end
 
   end

data/lib/kojo/version.rb

@@ -1,3 +1,3 @@
 module Kojo
-  VERSION = "0.3.8"
+  VERSION = "0.4.1"
 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.4.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2022-03-12 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.3.3
 signing_key: 
 specification_version: 4
 summary: Configuration Ninja