kojo 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45f5390450577b2234342140411f0e0f2c0d35922dcea389217797ec2937c4f6
-  data.tar.gz: 6646baf64c8ca5df34c0d93b4937ed045efe35514b5f07e25abcf73b92392c6d
+  metadata.gz: 66b59e59e2a7d874db8c30218544c194798aa8b0e0680dbc1a906f3f75f67e59
+  data.tar.gz: 56ff38e17c7cedd6df3373275fdacc65e9bc7fe8f2df5bdf7bdd650edea5eb37
 SHA512:
-  metadata.gz: ce8e0883e9c75c615d88c2597554e0b0f927ddef024a36ab62873b4ee67e9193a128f25c70dab4adc70fda927ccdfa1aa0684308c9a82377fb16acf123db6ff9
-  data.tar.gz: d4e562cc197c81f125a43f81ab5c5a0d625cc607fea2556cb5f9baa4b698027291208ca224d719f87421e57812b305f97f8c5804375ba655eb3e81a76c0cd12f
+  metadata.gz: 1202ad70051723bcbeceaf4ef641704f133685177dc42f9479bb7d4391d69e0b1d6b80245b684c68788627933be382843865654a6b7766e4ad6379d5963d4c89
+  data.tar.gz: 312a0a592b342cef71bbe08f5c38c3db2007047fa052ae3f34faa65910d4cb41af60deb9b241804290a2ab3d2e42c269e8581ece1c543fae3ddf9c2349d94387

data/README.md

@@ -18,6 +18,19 @@ It is a command line utility, and it works on any text file format.
 
 ---
 
+Table of Contents
+--------------------------------------------------
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Variables](#variables)
+  - [Import](#import)
+  - [One to Many Generation](#one-to-many-generation)
+  - [Compile an Entire Folder](#compile-an-entire-folder)
+  - [Conditions and Loops with ERB](#conditions-and-loops-with-erb)
+
+---
+
 Installation
 --------------------------------------------------
 
@@ -48,6 +61,7 @@ Include variables in your configuration templates using this syntax:
   with any additional variables that are defined in subsequent `@imports`.
 
 
+
 ### Import
 
 ![kojo](images/features-import.svg)
@@ -70,6 +84,7 @@ resulting configuration file.
 The space after `filename` is optional.
 
 
+
 ### One to Many Generation
 
 ![kojo](images/features-config.svg)
@@ -95,9 +110,28 @@ output:
 ```
 
 
+
 ### 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.
+
+
+
+### Conditions and Loops with ERB
+
+![kojo](images/features-erb.svg)
+
+Template files are evaluated using ERB, so you can use any Ruby code for more
+advanced templates (for conditions, loops etc.).
+
+Use this syntax for ruby code:
+
+```erb
+<%- ruby code here -%>     # for code that should not be printed
+<%= ruby code here -%>     # for code that should be printed
+```
+
+

data/lib/kojo/cli.rb

@@ -1,5 +1,4 @@
 require 'mister_bin'
-require 'kojo/commands'
 
 module Kojo
   class CLI

data/lib/kojo/commands/config.rb

@@ -1,52 +1,62 @@
 require 'fileutils'
+require 'mister_bin'
 
-module Kojo
-  module Commands
-    class ConfigCmd < MisterBin::Command
-      include Colsole
-
-      help "Generate based on instructions from a config file"
-
-      usage "kojo config CONFIG [--save DIR --args FILE] [ARGS...]"
-      usage "kojo config (-h|--help)"
-
-      option "-s --save DIR", "Save output to directory instead of printing"
-      option "-a --args FILE", "Load arguments from YAML file"
-
-      param "ARGS", "Optional key=value pairs"
-
-      example "kojo config config.yml"
-      example "kojo config config.yml --save output"
-      example "kojo config config.yml -s output scale=3"
-      example "kojo config config.yml -s output --args args.yml"
-
-      def run(args)
-        gen = Kojo::Generator.new args['CONFIG']
-        outdir = args['--save']
-        opts = args['ARGS'].args_to_hash
-        argfile = args['--args']
-
-        if argfile
-          fileopts = YAML.load_file(argfile).symbolize_keys
-          opts = fileopts.merge opts
-        end
-
-        gen.generate opts do |file, output|
-          path = "#{outdir}/#{file}"
-          if outdir
-            dir = File.dirname path
-            FileUtils.mkdir_p dir unless Dir.exist? dir
-
-            File.write path, output
-            say "Saved #{path}"
-          else
-            say "\n!txtgrn!# #{file}"
-            say output
-          end
-        end
+module Kojo::Commands
+  class ConfigCmd < MisterBin::Command
+    attr_reader :gen, :outdir, :opts
+
+    help "Generate based on instructions from a config file"
+
+    usage "kojo config CONFIG [--save DIR --args FILE] [ARGS...]"
+    usage "kojo config (-h|--help)"
+
+    option "-s --save DIR", "Save output to directory instead of printing"
+    option "-a --args FILE", "Load arguments from YAML file"
+
+    param "ARGS", "Optional key=value pairs"
+
+    example "kojo config config.yml"
+    example "kojo config config.yml --save output"
+    example "kojo config config.yml -s output scale=3"
+    example "kojo config config.yml -s output --args args.yml"
+
+    def run(args)
+      @gen = Kojo::Generator.new args['CONFIG']
+      @outdir = args['--save']
+      @opts = args['ARGS'].args_to_hash
+      argfile = args['--args']
+
+      if argfile
+        fileopts = YAML.load_file(argfile).symbolize_keys
+        @opts = fileopts.merge opts
+      end
+
+      run!
+    end
+
+    def run!
+      gen.generate opts do |file, output|
+        handle file, output
       end
+    end
 
+    private
+
+    def handle(file, output)
+      if outdir
+        save "#{outdir}/#{file}", output
+      else
+        say "\n!txtgrn!# #{file}"
+        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

@@ -1,61 +1,72 @@
-module Kojo
-  module Commands
-    class DirCmd < MisterBin::Command
-      include Colsole
-
-      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 (-h|--help)"
-
-      option "-s --save DIR", "Save output to directory instead of printing"
-      option "-i --import 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 -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']
-        argfile = args['--args']
-
-        if argfile
-          fileopts = YAML.load_file(argfile).symbolize_keys
-          opts = fileopts.merge opts
-        end
-
-        files = Dir["#{indir}/**/*"].reject { |file| File.directory? file }
-
-        files.each do |file|
-
-          template = Kojo::Template.new(file, opts)
-          template.import_base = import_base if import_base
-          output = template.render
-
-          if outdir
-            outpath = file.sub(/#{indir}/, outdir)
-            
-            dir = File.dirname outpath
-            FileUtils.mkdir_p dir unless Dir.exist? dir
-
-            File.write outpath, output
-            say "Saved #{outpath}"  
-          else
-            outpath = file.sub(/#{indir}/, '')
-            say "\n!txtgrn!# #{outpath}"
-            say output
-          end
-        end
+require 'mister_bin'
+
+module Kojo::Commands
+  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 (-h|--help)"
+
+    option "-s --save DIR", "Save output to directory instead of printing"
+    option "-i --import 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 -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']
+      argfile = args['--args']
+
+      if argfile
+        fileopts = YAML.load_file(argfile).symbolize_keys
+        @opts = fileopts.merge @opts
       end
 
+      run!
+    end
+
+    private
+
+    def files
+      @files ||= Dir["#{indir}/**/*"].reject { |file| File.directory? file }
+    end
+
+    def run!
+      files.each do |file|
+        handle file
+      end
+    end
+
+    def handle(file)
+      template = Kojo::Template.new(file, opts)
+      template.import_base = import_base if import_base
+      output = template.render
+
+      if outdir
+        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)
+      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

@@ -1,47 +1,48 @@
-require 'kojo'
+require 'mister_bin'
 
-module Kojo
-  module Commands
-    class FileCmd < MisterBin::Command
-      include Colsole
+module Kojo::Commands
+  class FileCmd < MisterBin::Command
+    attr_reader :opts, :outfile, :infile
 
-      help "Compile a file from a template"
+    help "Compile a file from a template"
 
-      usage "kojo file INFILE [--save FILE --args FILE] [ARGS...]"
-      usage "kojo file (-h|--help)"
+    usage "kojo file INFILE [--save FILE --args FILE] [ARGS...]"
+    usage "kojo file (-h|--help)"
 
-      option "-s --save FILE", "Save to file instead of printing"
-      option "-a --args FILE", "Load arguments from YAML file"
+    option "-s --save FILE", "Save to file instead of printing"
+    option "-a --args FILE", "Load arguments from YAML file"
 
-      param "ARGS", "Optional key=value pairs"
+    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"
+    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(args)
-        opts = args['ARGS'].args_to_hash
-        outfile = args['--save']
-        infile = args['INFILE']
-        argfile = args['--args']
+    def run(args)
+      @opts = args['ARGS'].args_to_hash
+      @outfile = args['--save']
+      @infile = args['INFILE']
+      argfile = args['--args']
 
-        if argfile
-          fileopts = YAML.load_file(argfile).symbolize_keys
-          opts = fileopts.merge opts
-        end
+      if argfile
+        fileopts = YAML.load_file(argfile).symbolize_keys
+        @opts = fileopts.merge opts
+      end
 
-        output = Kojo::Template.new(infile, opts).render
+      run!
+    end
 
-        if outfile
-          File.write outfile, output
-          say "Saved #{outfile}"
-        else
-          puts output
-        end
-      end
+    def run!
+      output = Kojo::Template.new(infile, opts).render
 
+      if outfile
+        File.write outfile, output
+        say "Saved #{outfile}"
+      else
+        puts output
+      end
     end
+
   end
 end
-

data/lib/kojo/extensions/array.rb

@@ -1,5 +1,10 @@
+require 'kojo/extensions/hash'
+
 class Array
   def args_to_hash
-    collect { |a| k, v = a.split '=' }.to_h.transform_keys(&:to_sym)
+    collect { |a| k, v = a.split '=' }
+      .to_h
+      .symbolize_keys
+      .typecast_values
   end
 end

data/lib/kojo/extensions/hash.rb

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

@@ -0,0 +1,17 @@
+class String
+  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? self.downcase
+      %w[yes true].include? self.downcase
+
+    else
+      self
+
+    end
+  end
+end

data/lib/kojo/template.rb

@@ -1,3 +1,6 @@
+require 'erb'
+require 'ostruct'
+
 module Kojo
   class Template
     attr_reader :file, :extension, :args, :dir
@@ -17,14 +20,15 @@ module Kojo
 
     private
 
-    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
+    def evaluate(file, args={})
+      content = File.read(file)
+
+      content = erb content, args
+      content = content % args
+      content = eval_imports content   
     end
 
-    def evaluate(file, args={})
-      content = File.read(file) % args
+    def eval_imports(content)
       result = []
       
       content.lines.each do |line|
@@ -41,9 +45,20 @@ module Kojo
         
         result.push line
       end
+
       result.join "\n"
     end
 
+    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
+    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

data/lib/kojo/version.rb

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

data/lib/kojo.rb

@@ -1,9 +1,8 @@
-require 'kojo/extensions/array'
-require 'kojo/extensions/hash'
-
-require 'kojo/cli'
-require 'kojo/template'
-require 'kojo/generator'
-require 'kojo/version'
-
+require 'requires'
 require 'byebug' if ENV['BYEBUG']
+requires 'kojo'
+
+module Kojo
+  module Commands
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kojo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-05 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mister_bin
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: requires
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -120,12 +134,12 @@ files:
 - bin/kojo
 - lib/kojo.rb
 - lib/kojo/cli.rb
-- lib/kojo/commands.rb
 - lib/kojo/commands/config.rb
 - lib/kojo/commands/dir.rb
 - lib/kojo/commands/file.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

data/lib/kojo/commands.rb

@@ -1,3 +0,0 @@
-require 'kojo/commands/config'
-require 'kojo/commands/dir'
-require 'kojo/commands/file'