kojo 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f80fdd7c65e0cd8e431e54f2fa32119a1ca2f0557329207481290dd2ed09e241
-  data.tar.gz: ebcd8acc4d7352efedb02baea82d2a22605141f88c719c9112cfb07c55261889
+  metadata.gz: 6fe6f0b9571a1cdd9a808cccaac4dcf5049647d1bc3190702ca45b811421ed61
+  data.tar.gz: 7fde526ad1d6efd84a8571c87ef419da1b7f672f06d55982efe68dc487399a29
 SHA512:
-  metadata.gz: 68535d8c56fb7a354b1035fbc145093d03e4846ba195c2bf2d1ff03ddf539cf7b9b545a0302d96d34b99d651a7432b8a6ae0697425cd5aba3ea8fd1732e859ab
-  data.tar.gz: 793ef15e654c1c3b2d1e900bcc5d86a6f8df966bc1d007951b749c61bdb5120b6cc413f18b52728608050429ebe711ed32e75a6c498c21d0dce61b0c0c5c736f
+  metadata.gz: e8fc1e607b10197997602db589b6e3ca4f692b7a17118b276fe2e2e5bfe7ee471b6217b3dcaf12f3a5cac85df2d9b50bbc8d2e77a2ccef542e5009a3952546d2
+  data.tar.gz: 2ea4b1943f5a6169881bcf4a68071718016041e0aa0a2e0d5a9673ead2eb5653dfa94f77533b320791d2c7fb8338b2cccfa3905b523b2d2a129c829d8ef4732e

data/README.md

@@ -1,6 +1,6 @@
 <div align='center'>
 
-![kojo](images/kojo.png)
+![kojo](support/kojo.png)
 
 # Kojo Configuration Ninja
 
@@ -10,8 +10,8 @@
 
 
 Kojo helps you generate configuration files from templates, using variables 
-and definition files.  
-It is a command line utility, and it works on any text file format.
+and definition files. It is a command line utility, and works on any text file
+format.
 
 </div>
 
@@ -26,6 +26,7 @@ It is a command line utility, and it works on any text file 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/cli.rb

@@ -16,6 +16,7 @@ module Kojo
       runner.route 'config', to: Kojo::Commands::ConfigCmd
       runner.route 'single', to: Kojo::Commands::SingleCmd
       runner.route 'form',   to: Kojo::Commands::FormCmd
+      runner.route 'tojson', to: Kojo::Commands::ToJsonCmd
 
       runner
     end

data/lib/kojo/commands/command_base.rb

@@ -4,9 +4,8 @@ module Kojo
   module Commands
     class CommandBase < MisterBin::Command
       def save(file, output)
-        outpath = "#{outdir}/#{file}"
-        File.deep_write outpath, output
-        say "Saved #{outpath}"  
+        File.deep_write file, output
+        say "Saved #{file}"
       end
     end
   end

data/lib/kojo/commands/config.rb

@@ -3,7 +3,7 @@ require 'mister_bin'
 
 module Kojo::Commands
   # Handle calls to the +kojo config+ command
-  class ConfigCmd < MisterBin::Command
+  class ConfigCmd < CommandBase
     using Kojo::Refinements
 
     attr_reader :gen, :outdir, :opts, :import_base, :config_file
@@ -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
 
@@ -59,13 +59,5 @@ module Kojo::Commands
         say output
       end
     end
-
-    def save(path, output)
-      dir = File.dirname path
-      FileUtils.mkdir_p dir unless Dir.exist? dir
-      File.write path, output
-      say "Saved #{path}"
-    end
-
   end
 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
 
@@ -62,7 +62,7 @@ module Kojo
 
       def write(collection)
         collection.render @opts do |file, output|
-          save file, output
+          save "#{outdir}/#{file}", output
         end
       end
     end

data/lib/kojo/commands/file.rb

@@ -3,7 +3,7 @@ require 'mister_bin'
 module Kojo
   module Commands
     # Handle calls to the +kojo file+ command
-    class FileCmd < MisterBin::Command
+    class FileCmd < CommandBase
       using Kojo::Refinements
 
       attr_reader :opts, :outfile, :infile, :import_base
@@ -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
 
@@ -48,8 +48,7 @@ module Kojo
         output = template.render(opts)
 
         if outfile
-          File.write outfile, output
-          say "Saved #{outfile}"
+          save outfile, output
         else
           puts output
         end

data/lib/kojo/commands/form.rb

@@ -24,8 +24,7 @@ module Kojo
         template = Kojo::Form.new infile
         
         if outfile
-          File.deep_write outfile, template.render
-          say "Saved #{outfile}"  
+          save outfile, template.render
         else
           puts template.render 
         end

data/lib/kojo/commands/single.rb

@@ -46,7 +46,7 @@ module Kojo
 
       def write(template)
         template.render opts do |file, output|
-          save file, output
+          save "#{outdir}/#{file}", output
         end
       end
     end

data/lib/kojo/commands/to_json.rb

@@ -0,0 +1,67 @@
+require 'mister_bin'
+
+module Kojo
+  module Commands
+    # Handle calls to the +kojo dir+ command
+    class ToJsonCmd < CommandBase
+      using Kojo::Refinements
+
+      attr_reader :input, :save_files, :replace_files
+
+      help "Convert one or more YAML files to JSON"
+
+      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"
+
+      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"
+
+      def run
+        @input = get_input_files
+        @save_files = args['--save'] || args['--replace']
+        @replace_files = args['--replace']
+
+        save_files ? write : show
+      end
+
+    private
+
+      def tojson(path)
+        JSON.pretty_generate YAML.properly_load_file(path)
+      end
+
+      # 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
+        args['INPUT'].map do |path|
+          path.include?('*') ? Dir[path].sort : path
+        end.flatten
+      end
+
+      def show
+        input.each do |infile|
+          outfile = infile.gsub(/\.ya?ml/, '.json')
+          say "\n!txtgrn!# #{outfile}"
+          say tojson(infile)
+        end
+      end
+
+      def write
+        input.each do |infile|
+          outfile = infile.gsub(/\.ya?ml/, '.json')
+          save outfile, tojson(infile)
+          File.delete infile if replace_files
+        end
+      end
+    end
+  end
+end

data/lib/kojo/config.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Kojo
   # The Config class handles multiple template generation from a 
   # definitions YAML file.
@@ -61,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

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Kojo
   # The FrontMatterTemplate class handles a single template file, that 
   # contains a YAML front matter.
@@ -34,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

@@ -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
 

data/lib/kojo/version.rb

@@ -1,3 +1,3 @@
 module Kojo
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

data/lib/kojo.rb

@@ -1,8 +1,11 @@
 require 'requires'
 require 'byebug' if ENV['BYEBUG']
 
-requires 'kojo/refinements'
+require 'yaml'
+require 'json'
+
 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.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -99,9 +99,11 @@ files:
 - lib/kojo/commands/file.rb
 - lib/kojo/commands/form.rb
 - lib/kojo/commands/single.rb
+- lib/kojo/commands/to_json.rb
 - 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
@@ -121,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.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Configuration Ninja