kojo 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ebe60ba380017dc65cf0261fd73ece4ab7f9b70138145ea20c2735ec114f39f
-  data.tar.gz: cb704fc398df5df582f5b821295c7681f0879e7e9eaf96280e6a1af2bf43d261
+  metadata.gz: 8eb56880a27b8b6afe976fcd2f4d7b3e46efe647f6892bb616b10cf6a56f592c
+  data.tar.gz: be2b2b5e1a935abf7b049b7960a8d38c4694f0931fd54ae38ed0434e7ffbe58b
 SHA512:
-  metadata.gz: ea47a7425bffbe605b8f96537b04ee0b56ff8ec437c44f6dcdac6044a7705c7c06d449361796ca66b0a2b2fac3baf0512bd8e8dbe909a89f120d6995ff0b10af
-  data.tar.gz: 9f9be3030a47599758014e81ae915f617624873aacd326c20ff44d27e295fb1da04d6938e9a909ec53e17c5c527500c230048004fe4241578ca568812e16df98
+  metadata.gz: d55ba5416cc208750f98f7702fadf4a6e64634fc0a27123b8978b90e9892a7954d8f68efcebd32a5503fad75925ee71632cab9095b4538fe6bd03872efc60655
+  data.tar.gz: 2e9933b0a385a19b39e0c63aa4fc3e76f6d1b80e29eb5c3f1f3973b2a5494311b94ce757140c408d859797172a8233d5f2186ea0bd4a4abec99d3411eaf9b3ba

data/README.md

@@ -25,8 +25,9 @@ Table of Contents
 - [Usage](#usage)
   - [Variables](#variables)
   - [Import](#import)
-  - [Compile an Entire Folder](#compile-an-entire-folder)
-  - [One to Many Generation](#one-to-many-generation)
+  - [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)
   - [Conditions and Loops with ERB](#conditions-and-loops-with-erb)
 - [Interactive Mode](#interactive-mode)
 
@@ -85,7 +86,7 @@ The space after `filename` is optional.
 
 
 
-### Compile an Entire Folder
+### Transform an Entire Folder
 
 ![kojo](images/features-dir.svg)
 
@@ -96,7 +97,7 @@ You may use `%{variables}` in filenames.
 
 
 
-### One to Many Generation
+### Transform One to Many using Config
 
 ![kojo](images/features-config.svg)
 
@@ -141,6 +142,27 @@ output:
     argument2: value
 ```
 
+### Transform One to Many using Front Matter
+
+![kojo](images/features-single.svg)
+
+Define a template that contains the instructions on how to transform it as a
+YAML front matter.
+
+The YAML front matter should be structured like this:
+
+```yaml
+filename2:
+  arg: value
+  another_arg: value
+
+filename2:
+  arg: value
+  another_arg: value
+---
+Your template that uses %{arg} goes here
+...
+```
 
 ### Conditions and Loops with ERB
 

data/lib/kojo.rb

@@ -1,6 +1,10 @@
 require 'requires'
 require 'byebug' if ENV['BYEBUG']
-requires 'kojo/exceptions', 'kojo'
+
+requires 'kojo/exceptions'
+requires 'kojo/template'
+requires 'kojo/commands/command_base'
+requires 'kojo'
 
 module Kojo
   module Commands

data/lib/kojo/cli.rb

@@ -10,6 +10,7 @@ module Kojo
       runner.route 'file',   to: Kojo::Commands::FileCmd
       runner.route 'dir',    to: Kojo::Commands::DirCmd
       runner.route 'config', to: Kojo::Commands::ConfigCmd
+      runner.route 'single', to: Kojo::Commands::SingleCmd
 
       runner
     end

data/lib/kojo/collection.rb

@@ -16,7 +16,7 @@ module Kojo
       end
     end
 
-    private
+  private
 
     def handle(file, args={})
       template = Template.new file

data/lib/kojo/commands/command_base.rb

@@ -0,0 +1,13 @@
+require 'mister_bin'
+
+module Kojo::Commands
+  class CommandBase < MisterBin::Command
+    def save(file, output)
+      outpath = "#{outdir}/#{file}"
+      dir = File.dirname outpath
+      FileUtils.mkdir_p dir unless Dir.exist? dir
+      File.write outpath, output
+      say "Saved #{outpath}"  
+    end
+  end
+end

data/lib/kojo/commands/config.rb

@@ -6,7 +6,7 @@ module Kojo::Commands
   class ConfigCmd < MisterBin::Command
     attr_reader :gen, :outdir, :opts, :import_base, :config_file
 
-    help "Generate 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)"
@@ -15,6 +15,7 @@ module Kojo::Commands
     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"
 
     example "kojo config config.yml"
@@ -37,6 +38,8 @@ module Kojo::Commands
       run!
     end
 
+  private
+
     def run!
       config = Kojo::Config.new config_file
       config.import_base = import_base if import_base
@@ -46,8 +49,6 @@ module Kojo::Commands
       end
     end
 
-    private
-
     def handle(file, output)
       if outdir
         save "#{outdir}/#{file}", output

data/lib/kojo/commands/dir.rb

@@ -2,10 +2,10 @@ require 'mister_bin'
 
 module Kojo::Commands
   # Handle calls to the +kojo dir+ command
-  class DirCmd < MisterBin::Command
+  class DirCmd < CommandBase
     attr_reader :opts, :indir, :outdir, :import_base
 
-    help "Compile 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)"
@@ -14,6 +14,7 @@ module Kojo::Commands
     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"
 
     example "kojo dir indir"
@@ -36,7 +37,7 @@ module Kojo::Commands
       run!
     end
 
-    private
+  private
 
     def run!
       collection = Kojo::Collection.new @indir
@@ -61,13 +62,5 @@ module Kojo::Commands
         save file, output
       end
     end
-
-    def save(file, output)
-      outpath = "#{outdir}/#{file}"
-      dir = File.dirname outpath
-      FileUtils.mkdir_p dir unless Dir.exist? dir
-      File.write outpath, output
-      say "Saved #{outpath}"  
-    end
   end
 end

data/lib/kojo/commands/file.rb

@@ -5,7 +5,7 @@ module Kojo::Commands
   class FileCmd < MisterBin::Command
     attr_reader :opts, :outfile, :infile, :import_base
 
-    help "Compile 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)"
@@ -14,6 +14,7 @@ module Kojo::Commands
     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"
 
     example "kojo file main.yml"
@@ -36,6 +37,8 @@ module Kojo::Commands
       run!
     end
 
+  private
+
     def run!
       template = Kojo::Template.new infile
       template.import_base = import_base if import_base

data/lib/kojo/commands/single.rb

@@ -0,0 +1,50 @@
+require 'mister_bin'
+
+module Kojo::Commands
+  # Handle calls to the +kojo single+ command
+  class SingleCmd < CommandBase
+    attr_reader :opts, :infile, :outdir
+
+    help "Transform using a single file that contains the instructions"
+
+    usage "kojo single INFILE [--save DIR] [ARGS...]"
+    usage "kojo single (-h|--help)"
+
+    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"
+
+    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
+      @outdir = args['--save']
+      @infile = args['INFILE']
+      run!
+    end
+
+  private
+
+    def run!
+      template = Kojo::FrontMatterTemplate.new infile
+      outdir ? write(template) : show(template)
+    end
+
+    def show(template)
+      template.render opts do |file, output|
+        say "\n!txtgrn!# #{file}"
+        say output
+      end
+    end
+
+    def write(template)
+      template.render opts do |file, output|
+        save file, output
+      end
+    end
+  end
+end

data/lib/kojo/config.rb

@@ -20,7 +20,7 @@ module Kojo
       end
     end
 
-    private
+  private
 
     def generate_from_file(opts)
       config['output'].each do |target, config_opts|

data/lib/kojo/extensions/string.rb

@@ -1,3 +1,6 @@
+require 'erb'
+require 'ostruct'
+
 class String
   # Convert a string to the most appropriate type
   def to_typed
@@ -17,7 +20,7 @@ class String
   end
 
   def resolve(vars)
-    self % vars
+    self % vars.symbolize_keys
   
   rescue KeyError => e
     print "> #{e.key}: "
@@ -25,7 +28,21 @@ class String
     retry
   end
 
-  private 
+  def eval_vars(args, filename)
+    resolve args.symbolize_keys
+  rescue ArgumentError => e
+    raise Kojo::TemplateError, "#{e.message}\nin: #{filename}"
+  end
+
+  def eval_erb(args, filename)
+    erb self, args
+  rescue RuntimeError => e
+    raise Kojo::TemplateError, "Invalid Ruby code #{e.message}\nin: #{filename}"
+  rescue SyntaxError => e
+    raise Kojo::TemplateError, "#{e.message}\nin: #{filename}"
+  end
+
+private 
 
   def get_user_input
     response = $stdin.gets
@@ -34,4 +51,9 @@ class String
   rescue Interrupt # Ctrl+C
     raise Kojo::Interrupt
   end
-end
+
+  def erb(template, vars)
+    ERB.new(template, nil, '-').result(OpenStruct.new(vars).instance_eval { binding })
+  end
+
+end

data/lib/kojo/front_matter_template.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module Kojo
+  # The FrontMatterTemplate class handles a single template file, that 
+  # contains a YAML front matter.
+  class FrontMatterTemplate
+    attr_reader :file, :args, :template
+
+    def initialize(file)
+      @file = file
+    end
+
+    def render(additional_args=nil)
+      additional_args ||= {}
+      config, @template = read_file file
+
+      config.each do |outfile, args|
+        content = handle args.merge(additional_args)
+        yield outfile, content
+      end
+    end
+
+  private
+
+    def handle(args={})
+      content = template
+      content = content.eval_erb args, file
+      content = content.eval_vars args, file
+      content
+    end
+
+    def read_file(file)
+      raise Kojo::NotFoundError, "File not found: #{file}" unless File.exist? file
+
+      config = YAML.load_file file
+      content = File.read(file)[/^---\s*$\n(.*)/m, 1]
+
+      [config, content]
+    end
+  end
+
+end

data/lib/kojo/template.rb

@@ -1,6 +1,3 @@
-require 'erb'
-require 'ostruct'
-
 module Kojo
   # The Template class handles a single template file, and processes it for:
   # - Variables (using +%{var}+ syntax)
@@ -22,12 +19,12 @@ module Kojo
       evaluate file
     end
 
-    private
+  protected
 
     def evaluate(file)
       content = read_file file
-      content = eval_erb content
-      content = eval_vars content
+      content = content.eval_erb args, file
+      content = content.eval_vars args, file
       content = eval_imports content
       content
     end
@@ -37,20 +34,6 @@ module Kojo
       File.read file
     end
 
-    def eval_vars(content)
-      content.resolve args
-    rescue ArgumentError => e
-      raise Kojo::TemplateError, "#{e.message}\nin: #{file}"
-    end
-
-    def eval_erb(content)
-      erb content, args
-    rescue RuntimeError => e
-      raise Kojo::TemplateError, "Invalid Ruby code #{e.message}\nin: #{file}"
-    rescue SyntaxError => e
-      raise Kojo::TemplateError, "#{e.message}\nin: #{file}"
-    end
-
     def eval_imports(content)
       result = []
       
@@ -78,13 +61,9 @@ module Kojo
       self.class.new(filename).render(all_args)
     end
 
-    def erb(template, vars)
-      ERB.new(template, nil, '-').result(OpenStruct.new(vars).instance_eval { binding })
-    end
-
     def indent(text, spaces)
       text.lines.collect { |line| "#{' ' * spaces}#{line}" }.join
     end
-  end
 
-end
+  end
+end

data/lib/kojo/version.rb

@@ -1,3 +1,3 @@
 module Kojo
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kojo
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-13 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -65,14 +65,17 @@ files:
 - lib/kojo.rb
 - lib/kojo/cli.rb
 - lib/kojo/collection.rb
+- lib/kojo/commands/command_base.rb
 - lib/kojo/commands/config.rb
 - lib/kojo/commands/dir.rb
 - lib/kojo/commands/file.rb
+- lib/kojo/commands/single.rb
 - lib/kojo/config.rb
 - lib/kojo/exceptions.rb
 - lib/kojo/extensions/array.rb
 - lib/kojo/extensions/hash.rb
 - lib/kojo/extensions/string.rb
+- lib/kojo/front_matter_template.rb
 - lib/kojo/template.rb
 - lib/kojo/version.rb
 homepage: https://github.com/dannyben/kojo
@@ -95,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Configuration Ninja