kojo 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66b59e59e2a7d874db8c30218544c194798aa8b0e0680dbc1a906f3f75f67e59
-  data.tar.gz: 56ff38e17c7cedd6df3373275fdacc65e9bc7fe8f2df5bdf7bdd650edea5eb37
+  metadata.gz: 60d550cda8b281a7ecbac40c236b6446fbe6a4d0b2ed7cb261ec47abeb654cbc
+  data.tar.gz: a991496e62aa272ad939b5c663cec543ed5e49aa9dedff5f3505c579d50de8d5
 SHA512:
-  metadata.gz: 1202ad70051723bcbeceaf4ef641704f133685177dc42f9479bb7d4391d69e0b1d6b80245b684c68788627933be382843865654a6b7766e4ad6379d5963d4c89
-  data.tar.gz: 312a0a592b342cef71bbe08f5c38c3db2007047fa052ae3f34faa65910d4cb41af60deb9b241804290a2ab3d2e42c269e8581ece1c543fae3ddf9c2349d94387
+  metadata.gz: aa51aa1c425c7af70bd8fd12bed004c0472d290e96cfdb172e3222f76d994a671eba764b45baae57f1287ebb4f7ba27fa94f0fbf725edc714095740653c9507a
+  data.tar.gz: 58802308a1134db6abd3265b0f7ccacd854fe4cdef6468f6c15217799f75eaf03aae0e9761a2b990201ae6c50cb680f2bb026f1f8869be86930bbff4dce36779

data/README.md

@@ -2,13 +2,13 @@
 
 ![kojo](images/kojo.png)
 
-Kojo - Configuration Ninja
+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.  
@@ -25,8 +25,8 @@ Table of Contents
 - [Usage](#usage)
   - [Variables](#variables)
   - [Import](#import)
-  - [One to Many Generation](#one-to-many-generation)
   - [Compile an Entire Folder](#compile-an-entire-folder)
+  - [One to Many Generation](#one-to-many-generation)
   - [Conditions and Loops with ERB](#conditions-and-loops-with-erb)
 
 ---
@@ -41,7 +41,7 @@ Installation
 Usage
 --------------------------------------------------
 
-If you prefer to learn by example, see the [examples](examples) folder for 
+If you prefer to learn by example, see the [examples](examples#examples) folder for 
 several use cases. Each example subfolder contains the command to run, the 
 relevant files, and the expected output.
 
@@ -85,15 +85,28 @@ The space after `filename` is optional.
 
 
 
+### Compile an Entire Folder
+
+![kojo](images/features-dir.svg)
+
+Process a folder containing templates and `@imports`, and generate a mirror
+output folder, with all the variables and `@imports` evaluated.
+
+
+
 ### One to Many Generation
 
 ![kojo](images/features-config.svg)
 
-In order to generate several configuration files that are based on the same 
-template, you should:
+Using the `kojo config` command together with a simple definitions file, you
+can:
+
+1. Generate multiple output files based on a single template file
+2. Generate multiple output directories, based on a single source directory.
+
+To achieve this, you need to:
 
-1. Create the configuration template, using `%{variables}` and `@imports` 
-   where appropriate.
+1. Create the configuration template or directory of templates.
 2. Create a configuration YAML file using this syntax:
 
 ```yaml
@@ -109,15 +122,22 @@ output:
     argument2: value
 ```
 
+When using a folder as input, simply provide the folder name in the `input` 
+property, and instead of providing desired output filenames in the `output`
+property, provide desired output directories:
 
+```yaml
+input: base
 
-### Compile an Entire Folder
-
-![kojo](images/features-dir.svg)
-
-Process a folder containing templates and `@imports`, and generate a mirror
-output folder, with all the variables and `@imports` evaluated.
+output:
+  app1:
+    argument1: value
+    argument2: value
 
+  app2:
+    argument1: value
+    argument2: value
+```
 
 
 ### Conditions and Loops with ERB

data/bin/kojo

@@ -7,6 +7,6 @@ begin
   exit runner.run ARGV
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
-  say! "!txtred!#{e.class}: #{e.message}"
+  say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
 end

data/lib/kojo.rb

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

data/lib/kojo/cli.rb

@@ -1,6 +1,8 @@
 require 'mister_bin'
 
 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
       runner = MisterBin::Runner.new version: Kojo::VERSION

data/lib/kojo/collection.rb

@@ -0,0 +1,38 @@
+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
+    attr_reader :dir
+    attr_accessor :import_base
+
+    def initialize(dir)
+      @dir = dir
+      @import_base = dir
+    end
+
+    def render(args={}, &block)
+      files.each do |file|
+        handle file, args, &block
+      end
+    end
+
+    private
+
+    def handle(file, args={})
+      template = Template.new file
+      template.import_base = import_base
+
+      path = file.sub(/#{dir}\//, '')
+      
+      yield path, template.render(args)
+    end
+
+    def files
+      return @files if @files
+      raise Kojo::NotFoundError, "Directory not found: #{dir}" unless Dir.exist? dir
+      raise Kojo::NotFoundError, "Directory is empty: #{dir}" if Dir.empty? dir
+
+      @files = Dir["#{dir}/**/*"].reject { |f| File.directory? f }
+    end
+  end
+end

data/lib/kojo/commands/config.rb

@@ -2,15 +2,17 @@ require 'fileutils'
 require 'mister_bin'
 
 module Kojo::Commands
+  # Handle calls to the +kojo config+ command
   class ConfigCmd < MisterBin::Command
-    attr_reader :gen, :outdir, :opts
+    attr_reader :gen, :outdir, :opts, :import_base, :config_file
 
     help "Generate based on instructions from a config file"
 
-    usage "kojo config CONFIG [--save DIR --args FILE] [ARGS...]"
+    usage "kojo config CONFIG [--save DIR --imports DIR --args FILE] [ARGS...]"
     usage "kojo config (-h|--help)"
 
     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"
 
     param "ARGS", "Optional key=value pairs"
@@ -21,9 +23,10 @@ module Kojo::Commands
     example "kojo config config.yml -s output --args args.yml"
 
     def run(args)
-      @gen = Kojo::Generator.new args['CONFIG']
+      @config_file = args['CONFIG']
       @outdir = args['--save']
       @opts = args['ARGS'].args_to_hash
+      @import_base = args['--imports']
       argfile = args['--args']
 
       if argfile
@@ -35,7 +38,10 @@ module Kojo::Commands
     end
 
     def run!
-      gen.generate opts do |file, output|
+      config = Kojo::Config.new config_file
+      config.import_base = import_base if import_base
+
+      config.generate opts do |file, output|
         handle file, output
       end
     end

data/lib/kojo/commands/dir.rb

@@ -1,30 +1,31 @@
 require 'mister_bin'
 
 module Kojo::Commands
+  # Handle calls to the +kojo dir+ command
   class DirCmd < MisterBin::Command
     attr_reader :opts, :indir, :outdir, :import_base
 
     help "Compile a folder of templates to a similar output folder"
 
-    usage "kojo dir INDIR [--save DIR --import DIR --args FILE] [ARGS...]"
+    usage "kojo dir INDIR [--save DIR --imports DIR --args FILE] [ARGS...]"
     usage "kojo dir (-h|--help)"
 
     option "-s --save DIR", "Save output to directory instead of printing"
-    option "-i --import DIR", "Specify base directory for @import directives"
+    option "-i --imports DIR", "Specify base directory for @import directives"
     option "-a --args FILE", "Load arguments from YAML file"
 
     param "ARGS", "Optional key=value pairs"
 
     example "kojo dir indir"
     example "kojo dir in --save out env=production"
-    example "kojo dir in --save out --import snippets env=production"
+    example "kojo dir in --save out --imports snippets env=production"
     example "kojo dir in -s out -i snippets -a args.yml"
 
     def run(args)
       @opts = args['ARGS'].args_to_hash
       @indir = args['INDIR']
       @outdir = args['--save']
-      @import_base = args['--import']
+      @import_base = args['--imports']
       argfile = args['--args']
 
       if argfile
@@ -37,32 +38,32 @@ module Kojo::Commands
 
     private
 
-    def files
-      @files ||= Dir["#{indir}/**/*"].reject { |file| File.directory? file }
-    end
-
     def run!
-      files.each do |file|
-        handle file
+      collection = Kojo::Collection.new @indir
+      collection.import_base = import_base if import_base
+
+      if outdir
+        write collection
+      else
+        show collection
       end
     end
 
-    def handle(file)
-      template = Kojo::Template.new(file, opts)
-      template.import_base = import_base if import_base
-      output = template.render
+    def show(collection)
+      collection.render @opts do |file, output|
+        say "\n!txtgrn!# #{file}"
+        say output
+      end
+    end
 
-      if outdir
+    def write(collection)
+      collection.render @opts do |file, output|
         save file, output
-      else
-        outpath = file.sub(/#{indir}/, '')
-        say "\n!txtgrn!# #{outpath}"
-        say output
       end
     end
 
     def save(file, output)
-      outpath = file.sub(/#{indir}/, outdir)
+      outpath = "#{outdir}/#{file}"
       dir = File.dirname outpath
       FileUtils.mkdir_p dir unless Dir.exist? dir
       File.write outpath, output

data/lib/kojo/commands/file.rb

@@ -1,15 +1,17 @@
 require 'mister_bin'
 
 module Kojo::Commands
+  # Handle calls to the +kojo file+ command
   class FileCmd < MisterBin::Command
-    attr_reader :opts, :outfile, :infile
+    attr_reader :opts, :outfile, :infile, :import_base
 
     help "Compile a file from a template"
 
-    usage "kojo file INFILE [--save FILE --args FILE] [ARGS...]"
+    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 "ARGS", "Optional key=value pairs"
@@ -23,6 +25,7 @@ module Kojo::Commands
       @opts = args['ARGS'].args_to_hash
       @outfile = args['--save']
       @infile = args['INFILE']
+      @import_base = args['--imports']
       argfile = args['--args']
 
       if argfile
@@ -34,7 +37,9 @@ module Kojo::Commands
     end
 
     def run!
-      output = Kojo::Template.new(infile, opts).render
+      template = Kojo::Template.new infile
+      template.import_base = import_base if import_base
+      output = template.render(opts)
 
       if outfile
         File.write outfile, output

data/lib/kojo/config.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+
+module Kojo
+  # The Config class handles multiple template generation from a 
+  # definitions YAML file.
+  class Config
+    attr_reader :config_file, :outdir
+    attr_accessor :import_base
+
+    def initialize(config_file)
+      @config_file = config_file
+      @import_base = nil
+    end
+
+    def generate(opts={}, &block)
+      if directory_mode?
+        generate_from_dir opts, &block
+      else
+        generate_from_file opts, &block
+      end
+    end
+
+    private
+
+    def generate_from_file(opts)
+      config['output'].each do |target, config_opts|
+        local_opts = opts.merge config_opts.symbolize_keys
+        
+        template = Template.new source
+        template.import_base = import_base if import_base
+        
+        yield target, template.render(local_opts)
+      end
+    end
+
+    def generate_from_dir(opts)
+      config['output'].each do |dir, config_opts|
+        local_opts = opts.merge config_opts.symbolize_keys
+
+        collection = Collection.new source
+        collection.import_base = import_base if import_base
+
+        collection.render(local_opts) do |file, output|
+          yield "#{dir}/#{file}", output
+        end
+      end
+    end
+
+    def base_dir
+      @base_dir ||= File.dirname config_file
+    end
+
+    def directory_mode?
+      File.directory? source
+    end
+
+    def source
+      "#{base_dir}/#{config['input']}"
+    end
+
+    def config
+      @config ||= YAML.load_file config_file
+    end
+  end
+
+end

data/lib/kojo/exceptions.rb

@@ -0,0 +1,5 @@
+module Kojo
+  class Error < StandardError; end
+  class TemplateError < Error; end
+  class NotFoundError < Error; end
+end

data/lib/kojo/extensions/array.rb

@@ -1,6 +1,7 @@
 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

data/lib/kojo/extensions/string.rb

@@ -1,4 +1,5 @@
 class String
+  # Convert a string to the most appropriate type
   def to_typed
     if self =~ /\A[+-]?\d+\Z/
       self.to_i
@@ -6,8 +7,8 @@ class String
     elsif self =~ /\A[+-]?\d+\.\d+\Z/
       self.to_f
 
-    elsif %w[yes no true false].include? self.downcase
-      %w[yes true].include? self.downcase
+    elsif %w[yes no true false].include? downcase
+      %w[yes true].include? downcase
 
     else
       self

data/lib/kojo/template.rb

@@ -2,30 +2,53 @@ require 'erb'
 require 'ostruct'
 
 module Kojo
+  # The Template class handles a single template file, and processes it for:
+  # - Variables (using +%{var}+ syntax)
+  # - ERB
+  # - +@import+ statements
   class Template
-    attr_reader :file, :extension, :args, :dir
+    attr_reader :file, :extension, :dir, :args
     attr_accessor :import_base
 
-    def initialize(file, args={})
+    def initialize(file)
       @file = file
-      @args = args
-      @extension = file[/(\..*)$/]
+      @extension = File.extname file
       @dir = File.dirname file
       @import_base = dir
     end
 
-    def render
-      evaluate file, args
+    def render(args={})
+      @args = args
+      evaluate file
     end
 
     private
 
-    def evaluate(file, args={})
-      content = File.read(file)
+    def evaluate(file)
+      content = read_file file
+      content = eval_erb content
+      content = eval_vars content
+      content = eval_imports content
+      content
+    end
+
+    def read_file(file)
+      raise Kojo::NotFoundError, "File not found: #{file}" unless File.exist? file
+      File.read file
+    end
+
+    def eval_vars(content)
+      content % args
+    rescue ArgumentError, KeyError => e
+      raise Kojo::TemplateError, "#{e.message}\nin: #{file}"
+    end
 
-      content = erb content, args
-      content = content % args
-      content = eval_imports content   
+    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)
@@ -52,7 +75,7 @@ module Kojo
     def import(file, import_args={})
       filename = File.expand_path "#{file}#{extension}", import_base
       all_args = args.merge import_args
-      self.class.new(filename, all_args).render
+      self.class.new(filename).render(all_args)
     end
 
     def erb(template, vars)

data/lib/kojo/version.rb

@@ -1,3 +1,3 @@
 module Kojo
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kojo
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -134,13 +134,15 @@ files:
 - bin/kojo
 - lib/kojo.rb
 - lib/kojo/cli.rb
+- lib/kojo/collection.rb
 - lib/kojo/commands/config.rb
 - lib/kojo/commands/dir.rb
 - lib/kojo/commands/file.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/generator.rb
 - lib/kojo/template.rb
 - lib/kojo/version.rb
 homepage: https://github.com/dannyben/kojo

data/lib/kojo/generator.rb

@@ -1,33 +0,0 @@
-require 'yaml'
-
-module Kojo
-  class Generator
-    attr_reader :config_file, :outdir
-
-    def initialize(config_file)
-      @config_file = config_file
-    end
-
-    def generate(opts={})
-      base_dir = File.dirname config_file
-      infile = "#{base_dir}/#{config['input']}"
-
-      config['output'].each do |outfile, config_opts|      
-        local_opts = opts.merge config_opts.symbolize_keys
-        output = render infile, local_opts
-        yield outfile, output
-      end
-    end
-    
-    private
-
-    def config
-      @config ||= YAML.load_file config_file
-    end
-
-    def render(infile, opts={})
-      Template.new(infile, opts).render      
-    end
-  end
-
-end