kojo 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb56880a27b8b6afe976fcd2f4d7b3e46efe647f6892bb616b10cf6a56f592c
-  data.tar.gz: be2b2b5e1a935abf7b049b7960a8d38c4694f0931fd54ae38ed0434e7ffbe58b
+  metadata.gz: b8608c2acf1ded769eac7140256f0cd9d7b172cc38c6ccf4c8b0cb5a3ef15fd7
+  data.tar.gz: 0b94e504f27c2504ce3801b94c81f6b8f94d583189d529ffe6c6f73a00b19216
 SHA512:
-  metadata.gz: d55ba5416cc208750f98f7702fadf4a6e64634fc0a27123b8978b90e9892a7954d8f68efcebd32a5503fad75925ee71632cab9095b4538fe6bd03872efc60655
-  data.tar.gz: 2e9933b0a385a19b39e0c63aa4fc3e76f6d1b80e29eb5c3f1f3973b2a5494311b94ce757140c408d859797172a8233d5f2186ea0bd4a4abec99d3411eaf9b3ba
+  metadata.gz: 9086487049e3ddd2a0f4e2ce912ca451a1b67c1812301a967893e9bd701b762598343d7aef04a2d0a90dbfddb46e2da7eabfec48400a5a96ab152033d1860d73
+  data.tar.gz: e9c040bd31fd36cca5ec7be5285a1098d42a26d216a4edb26bfb41dc9ea0b227f49e3ca435bd19c8427b89a313cf6fd1df631e332e519fb62924d968d95856c2

data/README.md

@@ -8,7 +8,7 @@ Kojo Configuration Ninja
 [![Gem Version](https://badge.fury.io/rb/kojo.svg)](https://badge.fury.io/rb/kojo)
 [![Build Status](https://travis-ci.com/DannyBen/kojo.svg?branch=master)](https://travis-ci.com/DannyBen/kojo)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f24566ad04b5054a2251/maintainability)](https://codeclimate.com/github/DannyBen/kojo/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/f24566ad04b5054a2251/test_coverage)](https://codeclimate.com/github/DannyBen/kojo/test_coverage)
+
 
 Kojo helps you generate configuration files from templates, using variables 
 and definition files.  
@@ -30,6 +30,7 @@ Table of Contents
   - [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)
+- [Using from Ruby Code](#using-from-ruby-code)
 
 ---
 
@@ -164,6 +165,9 @@ Your template that uses %{arg} goes here
 ...
 ```
 
+Additional arguments provided to the command line, will also be transferred
+to the template.
+
 ### Conditions and Loops with ERB
 
 ![kojo](images/features-erb.svg)
@@ -187,3 +191,63 @@ line or through a configuration file), it will prompt for a value.
 
 ![kojo](images/interactive-mode.gif)
 
+You can enable or disable interactive mode by setting the environment
+variable `KOJO_INTERACTIVE` to `yes` or `no`.
+
+By default, interactivity is enabled when running the CLI, and disabled when
+running from within Ruby code.
+
+When running from within Ruby code, you can also use `Kojo.interactive = true`
+and `Kojo.interactive?` to get the current state.
+
+
+Using from Ruby Code
+--------------------------------------------------
+
+Although Kojo was primarily designed as a command line utility, you can also
+use it as a library from your Ruby code.
+
+These are the primary classes:
+
+| Class                       | Description                                  | CLI equivalent
+|-----------------------------|----------------------------------------------|---------------
+| `Kojo::Template`            | generate from a single template              | `kojo file`
+| `Kojo::FrontMatterTemplate` | generate from a template with a front matter | `kojo single`
+| `Kojo::Config`              | generate from a config file                  | `kojo config`
+| `Kojo::Collection`          | generate from a directory                    | `kojo dir`
+
+### Examples
+
+```ruby
+# Template
+template = Kojo::Template.new 'examples/variables/main.yml'
+result = template.render domain: 'example.com', scale: 2
+puts result
+
+# Collection
+collection = Kojo::Collection.new 'examples/dir'
+collection.import_base = 'examples/dir/imports'
+
+params = { env: 'env', app: 'app' }
+result = collection.render params do |path, content|
+  # code to handle results here
+end
+
+# Config
+config = Kojo::Config.new 'examples/config-from-file/config.yml'
+config.import_base = "examples/config-from-file/imports"
+
+config.generate do |path, content|
+  # code to handle results here
+end
+
+# FrontMatterTemplate
+template = Kojo::FrontMatterTemplate.new 'examples/single/Dockerfile'
+params = { version: '0.1.1' }
+
+result = template.render params do |path, content|
+  # code to handle results here
+end
+
+```
+

data/bin/kojo

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 require 'kojo'
+require 'kojo/cli'
 require 'colsole'
 include Colsole
 

data/lib/kojo.rb

@@ -1,12 +1,24 @@
 require 'requires'
 require 'byebug' if ENV['BYEBUG']
 
-requires 'kojo/exceptions'
-requires 'kojo/template'
-requires 'kojo/commands/command_base'
-requires 'kojo'
+requires 'kojo/refinements'
+
+require 'kojo/exceptions'
+require 'kojo/template'
+require 'kojo/collection'
+require 'kojo/config'
+require 'kojo/front_matter_template'
 
 module Kojo
-  module Commands
+  class << self
+    def interactive?
+      return @interactive unless @interactive.nil?
+      @interactive = ENV['KOJO_INTERACTIVE'] == 'yes'
+    end
+
+    def interactive=(value)
+      @interactive = value
+    end
   end
+
 end

data/lib/kojo/cli.rb

@@ -1,10 +1,14 @@
 require 'mister_bin'
+require 'kojo/version'
+requires 'commands'
 
 module Kojo
   # 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

data/lib/kojo/collection.rb

@@ -2,6 +2,8 @@ module Kojo
   # 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
+
     attr_reader :dir
     attr_accessor :import_base
 

data/lib/kojo/commands/command_base.rb

@@ -1,13 +1,15 @@
 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}"  
+module Kojo
+  module 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
-end
+end

data/lib/kojo/commands/config.rb

@@ -4,6 +4,8 @@ require 'mister_bin'
 module Kojo::Commands
   # Handle calls to the +kojo config+ command
   class ConfigCmd < MisterBin::Command
+    using Kojo::Refinements
+
     attr_reader :gen, :outdir, :opts, :import_base, :config_file
 
     help "Transform based on instructions from a config file"
@@ -41,7 +43,7 @@ module Kojo::Commands
   private
 
     def run!
-      config = Kojo::Config.new config_file
+      config = Config.new config_file
       config.import_base = import_base if import_base
 
       config.generate opts do |file, output|

data/lib/kojo/commands/dir.rb

@@ -1,66 +1,70 @@
 require 'mister_bin'
 
-module Kojo::Commands
-  # Handle calls to the +kojo dir+ command
-  class DirCmd < CommandBase
-    attr_reader :opts, :indir, :outdir, :import_base
+module Kojo
+  module Commands
+    # Handle calls to the +kojo dir+ command
+    class DirCmd < CommandBase
+      using Kojo::Refinements
 
-    help "Transform a folder of templates to a similar output folder"
+      attr_reader :opts, :indir, :outdir, :import_base
 
-    usage "kojo dir INDIR [--save DIR --imports DIR --args FILE] [ARGS...]"
-    usage "kojo dir (-h|--help)"
+      help "Transform a folder of templates to a similar output folder"
 
-    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"
+      usage "kojo dir INDIR [--save DIR --imports DIR --args FILE] [ARGS...]"
+      usage "kojo dir (-h|--help)"
 
-    param "INDIR", "Directory containing templates to transform"
-    param "ARGS", "Optional key=value pairs"
+      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"
 
-    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"
+      param "INDIR", "Directory containing templates to transform"
+      param "ARGS", "Optional key=value pairs"
 
-    def run
-      @opts = args['ARGS'].args_to_hash
-      @indir = args['INDIR']
-      @outdir = args['--save']
-      @import_base = args['--imports']
-      argfile = args['--args']
+      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"
 
-      if argfile
-        fileopts = YAML.load_file(argfile).symbolize_keys
-        @opts = fileopts.merge @opts
-      end
+      def run
+        @opts = args['ARGS'].args_to_hash
+        @indir = args['INDIR']
+        @outdir = args['--save']
+        @import_base = args['--imports']
+        argfile = args['--args']
 
-      run!
-    end
+        if argfile
+          fileopts = YAML.load_file(argfile).symbolize_keys
+          @opts = fileopts.merge @opts
+        end
+
+        run!
+      end
 
-  private
+    private
 
-    def run!
-      collection = Kojo::Collection.new @indir
-      collection.import_base = import_base if import_base
+      def run!
+        collection = Collection.new @indir
+        collection.import_base = import_base if import_base
 
-      if outdir
-        write collection
-      else
-        show collection
+        if outdir
+          write collection
+        else
+          show collection
+        end
       end
-    end
 
-    def show(collection)
-      collection.render @opts do |file, output|
-        say "\n!txtgrn!# #{file}"
-        say output
+      def show(collection)
+        collection.render @opts do |file, output|
+          say "\n!txtgrn!# #{file}"
+          say output
+        end
       end
-    end
 
-    def write(collection)
-      collection.render @opts do |file, output|
-        save file, output
+      def write(collection)
+        collection.render @opts do |file, output|
+          save file, output
+        end
       end
     end
   end
-end
+end

data/lib/kojo/commands/file.rb

@@ -1,56 +1,60 @@
 require 'mister_bin'
 
-module Kojo::Commands
-  # Handle calls to the +kojo file+ command
-  class FileCmd < MisterBin::Command
-    attr_reader :opts, :outfile, :infile, :import_base
-
-    help "Transform a file from a template"
-
-    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"
-
-    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"
-
-    def run
-      @opts = args['ARGS'].args_to_hash
-      @outfile = args['--save']
-      @infile = args['INFILE']
-      @import_base = args['--imports']
-      argfile = args['--args']
-
-      if argfile
-        fileopts = YAML.load_file(argfile).symbolize_keys
-        @opts = fileopts.merge opts
-      end
+module Kojo
+  module Commands
+    # Handle calls to the +kojo file+ command
+    class FileCmd < MisterBin::Command
+      using Kojo::Refinements
 
-      run!
-    end
+      attr_reader :opts, :outfile, :infile, :import_base
+
+      help "Transform a file from a template"
+
+      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"
+
+      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"
 
-  private
+      def run
+        @opts = args['ARGS'].args_to_hash
+        @outfile = args['--save']
+        @infile = args['INFILE']
+        @import_base = args['--imports']
+        argfile = args['--args']
 
-    def run!
-      template = Kojo::Template.new infile
-      template.import_base = import_base if import_base
-      output = template.render(opts)
+        if argfile
+          fileopts = YAML.load_file(argfile).symbolize_keys
+          @opts = fileopts.merge opts
+        end
 
-      if outfile
-        File.write outfile, output
-        say "Saved #{outfile}"
-      else
-        puts output
+        run!
       end
-    end
 
+    private
+
+      def run!
+        template = Template.new infile
+        template.import_base = import_base if import_base
+        output = template.render(opts)
+
+        if outfile
+          File.write outfile, output
+          say "Saved #{outfile}"
+        else
+          puts output
+        end
+      end
+
+    end
   end
-end
+end

data/lib/kojo/commands/single.rb

@@ -1,50 +1,54 @@
 require 'mister_bin'
 
-module Kojo::Commands
-  # Handle calls to the +kojo single+ command
-  class SingleCmd < CommandBase
-    attr_reader :opts, :infile, :outdir
+module Kojo
+  module Commands
+    # Handle calls to the +kojo single+ command
+    class SingleCmd < CommandBase
+      using Kojo::Refinements
 
-    help "Transform using a single file that contains the instructions"
+      attr_reader :opts, :infile, :outdir
 
-    usage "kojo single INFILE [--save DIR] [ARGS...]"
-    usage "kojo single (-h|--help)"
+      help "Transform using a single file that contains the instructions"
 
-    option "-s --save DIR", "Save output to directory instead of printing"
+      usage "kojo single INFILE [--save DIR] [ARGS...]"
+      usage "kojo single (-h|--help)"
 
-    param "INFILE", "Template to transform. The template should contain a YAML front matter with transformation instructions"
-    param "ARGS", "Optional key=value pairs"
+      option "-s --save DIR", "Save output to directory instead of printing"
 
-    example "kojo single Dockerfile"
-    example "kojo single template.Dockerfile --save ."
-    example "kojo single template.Dockerfile --save output"
-    example "kojo single template.Dockerfile scale=2"
+      param "INFILE", "Template to transform. The template should contain a YAML front matter with transformation instructions"
+      param "ARGS", "Optional key=value pairs"
 
-    def run
-      @opts = args['ARGS'].args_to_hash
-      @outdir = args['--save']
-      @infile = args['INFILE']
-      run!
-    end
+      example "kojo single Dockerfile"
+      example "kojo single template.Dockerfile --save ."
+      example "kojo single template.Dockerfile --save output"
+      example "kojo single template.Dockerfile scale=2"
 
-  private
+      def run
+        @opts = args['ARGS'].args_to_hash
+        @outdir = args['--save']
+        @infile = args['INFILE']
+        run!
+      end
 
-    def run!
-      template = Kojo::FrontMatterTemplate.new infile
-      outdir ? write(template) : show(template)
-    end
+    private
 
-    def show(template)
-      template.render opts do |file, output|
-        say "\n!txtgrn!# #{file}"
-        say output
+      def run!
+        template = 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
-    end
 
-    def write(template)
-      template.render opts do |file, output|
-        save file, output
+      def write(template)
+        template.render opts do |file, output|
+          save file, output
+        end
       end
     end
   end
-end
+end

data/lib/kojo/config.rb

@@ -4,6 +4,8 @@ module Kojo
   # The Config class handles multiple template generation from a 
   # definitions YAML file.
   class Config
+    using Refinements
+
     attr_reader :config_file, :outdir
     attr_accessor :import_base
 

data/lib/kojo/front_matter_template.rb

@@ -4,6 +4,8 @@ module Kojo
   # The FrontMatterTemplate class handles a single template file, that 
   # contains a YAML front matter.
   class FrontMatterTemplate
+    using Refinements
+
     attr_reader :file, :args, :template
 
     def initialize(file)

data/lib/kojo/refinements/array.rb

@@ -0,0 +1,15 @@
+require 'kojo/refinements/hash'
+
+module Kojo
+  module Refinements
+    refine Array do
+      # Convert an array of +["key=value", "key=value"]+ pairs to a hash
+      def args_to_hash
+        collect { |a| k, v = a.split '=' }
+          .to_h
+          .symbolize_keys
+          .typecast_values
+      end
+    end
+  end
+end

data/lib/kojo/refinements/hash.rb

@@ -0,0 +1,15 @@
+require 'kojo/refinements/string'
+
+module Kojo
+  module Refinements
+    refine Hash do
+      def symbolize_keys
+        transform_keys &:to_sym
+      end
+
+      def typecast_values
+        transform_values &:to_typed
+      end
+    end
+  end
+end

data/lib/kojo/refinements/string.rb

@@ -0,0 +1,66 @@
+require 'erb'
+require 'ostruct'
+require 'kojo/refinements/hash'
+
+module Kojo
+  module Refinements
+    refine String do
+      # Convert a string to the most appropriate type
+      def to_typed
+        if self =~ /\A[+-]?\d+\Z/
+          self.to_i
+
+        elsif self =~ /\A[+-]?\d+\.\d+\Z/
+          self.to_f
+
+        elsif %w[yes no true false].include? downcase
+          %w[yes true].include? downcase
+
+        else
+          self
+
+        end
+      end
+
+      def resolve(vars)
+        self % vars.symbolize_keys
+      
+      rescue KeyError => e
+        raise unless Kojo.interactive?
+
+        print "> #{e.key}: "
+        vars[e.key] = get_user_input
+        retry
+      end
+
+      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
+        raise Kojo::Interrupt unless response # Ctrl+D
+        response.chomp
+      rescue ::Interrupt # Ctrl+C
+        raise Kojo::Interrupt
+      end
+
+      def erb(template, vars)
+        ERB.new(template, nil, '-').result(OpenStruct.new(vars).instance_eval { binding })
+      end
+
+    end
+  end
+end

data/lib/kojo/template.rb

@@ -4,6 +4,8 @@ module Kojo
   # - ERB
   # - +@import+ statements
   class Template
+    using Refinements
+
     attr_reader :file, :extension, :dir, :args
     attr_accessor :import_base
 

data/lib/kojo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kojo
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2020-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -72,10 +72,10 @@ files:
 - 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/refinements/array.rb
+- lib/kojo/refinements/hash.rb
+- lib/kojo/refinements/string.rb
 - lib/kojo/template.rb
 - lib/kojo/version.rb
 homepage: https://github.com/dannyben/kojo
@@ -97,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Configuration Ninja

data/lib/kojo/extensions/array.rb

@@ -1,11 +0,0 @@
-require 'kojo/extensions/hash'
-
-class Array
-  # Convert an array of +["key=value", "key=value"]+ pairs to a hash
-  def args_to_hash
-    collect { |a| k, v = a.split '=' }
-      .to_h
-      .symbolize_keys
-      .typecast_values
-  end
-end

data/lib/kojo/extensions/hash.rb

@@ -1,11 +0,0 @@
-require 'kojo/extensions/string'
-
-class Hash
-  def symbolize_keys
-    transform_keys &:to_sym
-  end
-
-  def typecast_values
-    transform_values &:to_typed
-  end
-end

data/lib/kojo/extensions/string.rb

@@ -1,59 +0,0 @@
-require 'erb'
-require 'ostruct'
-
-class String
-  # Convert a string to the most appropriate type
-  def to_typed
-    if self =~ /\A[+-]?\d+\Z/
-      self.to_i
-
-    elsif self =~ /\A[+-]?\d+\.\d+\Z/
-      self.to_f
-
-    elsif %w[yes no true false].include? downcase
-      %w[yes true].include? downcase
-
-    else
-      self
-
-    end
-  end
-
-  def resolve(vars)
-    self % vars.symbolize_keys
-  
-  rescue KeyError => e
-    print "> #{e.key}: "
-    vars[e.key] = get_user_input
-    retry
-  end
-
-  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
-    raise Kojo::Interrupt unless response # Ctrl+D
-    response.chomp
-  rescue Interrupt # Ctrl+C
-    raise Kojo::Interrupt
-  end
-
-  def erb(template, vars)
-    ERB.new(template, nil, '-').result(OpenStruct.new(vars).instance_eval { binding })
-  end
-
-end