quik 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cfcd6959a822c4714b21cb7e385f9d285b0c836
-  data.tar.gz: a6b7379512cd27faabfa8eefbc73bedf52387d40
+  metadata.gz: 723a9dc766a9d81825110f6f76d6f6ca6f7bcf19
+  data.tar.gz: 53bf723602e937cdd75375a61f7cd9b4c84d8908
 SHA512:
-  metadata.gz: 583dc0e25b9c7ed40dd5892c2165e94a1c9b7a0d224e31ded7b09832243646306ff28657a010a40ff80fa746493a618d992b873b7a20a545e55472e6b91c0be0
-  data.tar.gz: 44f335c50fe615d16e6e33a5dab497695c0a69483ed66a522fccbad02e9af28369546e8f8b6bd54720fcb678d0a4f6f5f27d96b339c23a1e4c08bdc4f8a3bebd
+  metadata.gz: 288e9e98f8f687353ff4d4df11ad3f7227f509fda8cd2f3cea91145af38b4c38634c069ddb96271a62d166f6bee27e62022b4753d98d62321a3cd1e89363e223
+  data.tar.gz: 97c17d397e54d6eb68d8e348e4cbdd57248f846b4743f8957d8199d0ccf4c54e48f63d237dfda2d708aacbf403c5b79eb881866470cab5cfea1d61f54c938aad

data/Manifest.txt

@@ -2,5 +2,23 @@ HISTORY.md
 Manifest.txt
 README.md
 Rakefile
+bin/qk
+bin/quik
 lib/quik.rb
+lib/quik/builder.rb
+lib/quik/cli/main.rb
+lib/quik/cli/opts.rb
+lib/quik/config.rb
+lib/quik/merger.rb
+lib/quik/package.rb
 lib/quik/version.rb
+lib/quik/wizard.rb
+test/data/gem-starter-template/Manifest.txt
+test/data/gem-starter-template/README.md
+test/data/gem-starter-template/lib/$filename$.rb
+test/data/gem-starter-template/lib/__filename__/$filename$.rb
+test/data/gem-starter-template/lib/__filename__/__filename__/test.rb
+test/data/gem-starter-template/lib/__filename__/version.rb
+test/helper.rb
+test/test_merger.rb
+test/test_package.rb

data/README.md

@@ -1,4 +1,4 @@
-# quik
+# qk/quik - ruby quick starter template script wizard .:. the missing code generator
 
 * home  :: [github.com/rubylibs/quik](https://github.com/rubylibs/quik)
 * bugs  :: [github.com/rubylibs/quik/issues](https://github.com/rubylibs/quik/issues)
@@ -8,7 +8,84 @@
 
 ## Usage
 
-TBD
+The quick gem includes a command line tool that lets you
+run quick starter template scripts. Try:
+
+```
+$ quik --help      # or
+$ qk -h
+```
+
+Resulting in:
+
+```
+NAME
+    qk/quik - ruby quick starter template script wizard .:. the missing code generator
+
+SYNOPSIS
+    quik [global options] command [command options] [arguments...]
+
+VERSION
+    0.1.0
+
+GLOBAL OPTIONS
+    --help            - Show this message
+    --test, --dry_run - (Debug) Dry run; run script in simulation for testing
+    --verbose         - (Debug) Show debug messages
+    --version         - Display the program version
+
+COMMANDS
+    new, n - Run ruby quick starter script
+
+    help   - Shows a list of commands or help for one command
+    test   - (Debug) Test command suite
+```
+
+
+### Commands
+
+[New Wizard](#new-wizard-command---new-n)
+
+#### New Wizard Command - `new`, `n`
+
+To run a quick starter template wizard script
+to download and install (unzip/unpack) a template archive and configure
+the code ready-to-use. Try:
+
+
+```
+$ quik new gem    # or
+$ quik n gem      # or
+$ qk n gem
+```
+
+This will download the `gem.rb` wizard script
+from the [Rubyref Scripts](https://github.com/rubyref/scripts) repo
+and run through all steps e.g.:
+
+```
+Welcome, to the gem quick starter script.
+
+Q: What's your gem's name? [hola]:   hello
+Q: What's your gem's module? [Hola]: Hello
+
+Thanks! Ready-to-go. Stand back.
+
+  Downloading Rubyref Gem Starter Template...
+  Setting up Rubyref Starter Template...
+  ...
+Done.
+```
+
+That's it. Now the gem starter code is ready in the `hello`
+folder.
+
+
+**More Quick Starter Wizard Scripts**
+
+See the [Rubyref Scripts](https://github.com/rubyref/scripts) library.
+
+
 
 
 ## Install
@@ -23,3 +100,7 @@ Just install the gem:
 The `quik` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
 
+## Questions? Comments?
+
+Send them along to the ruby-talk mailing list.
+Thanks!

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'quik' do
 
   self.version = Quik::VERSION
 
-  self.summary = 'quik'
+  self.summary = 'quik - ruby quick starter template script wizard .:. the missing code generator'
   self.description = summary
 
   self.urls    = ['https://github.com/rubylibs/quik']
@@ -19,7 +19,10 @@ Hoe.spec 'quik' do
 
   self.extra_deps = [
     ['logutils'],
-    ['fetcher']
+    ['textutils'],
+    ['fetcher'],
+    ['rubyzip'],
+    ['gli'],
   ]
 
   self.licenses = ['Public Domain']

data/bin/qk

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'quik'
+
+Quik.main

data/bin/quik

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'quik'
+
+Quik.main

data/lib/quik/builder.rb

@@ -0,0 +1,94 @@
+#encoding: utf-8
+
+module Quik
+
+class Builder
+
+  def self.load_file( path, opts={} )
+    code = File.read_utf8( path )
+    self.load( code, opts )
+  end
+
+  def self.load( code, opts={} )
+    builder = Builder.new( opts )
+    builder.instance_eval( code )
+    builder
+  end
+
+
+  include Wizard   ## mixin helpers for say, ask, yes?, no?, select, etc.
+
+  def initialize( opts={} )
+    puts "starting new Quik script #{opts.inspect}; lets go"
+
+    @test       = opts[:dry_run] || opts[:test] || false
+    @output_dir = opts[:o] || '.'
+    @pak        = nil   ## for now reference last template pack (in future support many - why?? why not??)
+  end
+
+  ## "global" builder options
+  def test?()      @test;       end   ## dry_run option (defaults to false)
+  def output_dir() @output_dir; end   ## ouptput (root) dir (defaults to . e.g. working folder)
+
+
+
+  def use( name, opts={} )  ## short alias for install_template
+    install_template( name, opts )
+  end
+
+  def install_template( name, opts= {} )
+    puts "  handle install_template #{name}, #{opts.inspect}"
+
+    ## note for now assume name is key
+    ##   e.g. always downcase (e.g. Gem => gem)
+    key = name.downcase
+
+    if test?
+      # do nothing; dry run
+    else
+      @pak = Package.new( key )
+      @pak.download
+      ##  pak.unzip( "#{@output_dir}/#{key}" )
+    end
+  end
+
+
+  def config( opts={} )
+    puts "  handle config block"
+    c = OpenConfig.new
+    yield( c )
+    ## pp c
+    h = c.to_h
+
+    pp h
+
+    ##
+    # check for name
+    ##  required for output
+    ##  if no name
+    ##  use ./ working folder for output!!!
+
+    name = h['name']
+
+    if name.nil? || name.empty?
+      fail 'sorry; for now name is required for output folder'
+    end
+
+    if test?
+      ## do nothing; dry run
+    else
+      if @pak
+        unzip_dir = "./o/#{name}"
+        ## step 1: unzip templates
+        @pak.unzip( unzip_dir )
+        ## step 2: merge templates (using hash/config settings)
+        m = Quik::Merger.new
+        m.merge( unzip_dir, h )
+      end
+    end    
+  end # method config
+
+
+end # class Builder
+
+end # module Quik

data/lib/quik/cli/main.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+
+### NOTE: wrap gli config into a class
+##  see github.com/davetron5000/gli/issues/153
+
+module Quik
+
+class Tool
+  def initialize
+    LogUtils::Logger.root.level = :info   # set logging level to info 
+  end
+
+  def run( args )
+    puts Quik.banner
+    Toolii.run( args )
+  end
+end
+
+## NOTE: gli added function are class methods (thus, wrap class Toolii in Tool for now)
+
+class Toolii
+  extend GLI::App
+
+  def self.logger=(value) @@logger=value; end
+  def self.logger()       @@logger; end
+
+  ## todo: find a better name e.g. change to settings? config? safe_opts? why? why not?
+  def self.opts=(value)  @@opts = value; end
+  def self.opts()        @@opts; end
+
+
+logger = LogUtils::Logger.root
+opts   = Opts.new 
+
+
+program_desc 'ruby quick starter template script wizard .:. the missing code generator'
+version VERSION
+
+
+## desc 'Use only local (offline) cached data; no (online) remote network access'
+## switch [:l, :local], negatable: false
+
+desc '(Debug) Show debug messages'
+switch [:verbose], negatable: false    ## todo: use -w for short form? check ruby interpreter if in use too?
+
+desc '(Debug) Dry run; run script in simulation for testing'
+switch [:test, :dry_run], negatable: false
+
+
+def self.fetch_script( name )
+
+  ## first try local version in working folder
+
+  text = ''
+  local_script = "./#{name}.rb"
+  if File.exist?( local_script )
+    text = File.read_utf8( local_script )
+  else  ## fetch remote script
+    url = "https://github.com/rubyref/scripts/raw/master/#{name}.rb"
+    ## assume utf8 text encoding for now
+    worker = Fetcher::Worker.new
+    text = worker.read_utf8!( url )
+  end
+
+  text
+end
+
+
+desc "Run ruby quick starter script"
+arg_name 'NAME'   # required theme name
+command [:new,:n] do |c|
+
+  c.action do |g,o,args|
+
+    name = args[0] || 'gem'
+
+    script = fetch_script( name )
+    if opts.test?
+      puts "dry (test) run:"
+      Builder.load( script, test: true )
+    else
+      Builder.load( script )
+    end
+
+    puts 'Done.'
+  end # action
+end  # command setup
+
+
+
+desc '(Debug) Test command suite'
+command :test do |c|
+  c.action do |g,o,args|
+
+    puts "hello from test command"
+    puts "args (#{args.class.name}):"
+    pp args
+    puts "o (#{o.class.name}):"
+    pp o
+    puts "g (#{g.class.name}):"
+    pp g
+    
+    LogUtils::Logger.root.debug 'test debug msg'
+    LogUtils::Logger.root.info 'test info msg'
+    LogUtils::Logger.root.warn 'test warn msg'
+    
+    puts 'Done.'
+  end
+end
+
+
+
+pre do |g,c,o,args|
+  opts.merge_gli_options!( g )
+  opts.merge_gli_options!( o )
+
+  puts Quik.banner
+
+  if opts.verbose?
+    LogUtils::Logger.root.level = :debug
+  end
+
+  logger.debug "Executing #{c.name}"   
+  true
+end
+
+post do |global,c,o,args|
+  logger.debug "Executed #{c.name}"
+  true
+end
+
+
+on_error do |e|
+  puts
+  puts "*** error: #{e.message}"
+
+  if opts.verbose?
+    puts e.backtrace
+  end
+
+  false # skip default error handling
+end
+
+
+### exit run(ARGV)  ## note: use Toolii.run( ARGV ) outside of class
+
+end  # class Toolii
+
+end # module Quik
+

data/lib/quik/cli/opts.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module Quik
+
+class Opts
+
+  def merge_gli_options!( options = {} )
+    @test    = true     if options[:test]    == true
+    @verbose = true     if options[:verbose] == true
+  end
+
+
+  def verbose=(boolean)   # add: alias for debug ??
+    @verbose = boolean
+  end
+
+  def verbose?
+    return false if @verbose.nil?   # default verbose/debug flag is false
+    @verbose == true
+  end
+
+  def test=(boolean)
+    @test = boolean
+  end
+
+  def test?
+    return false if @test.nil?   # default test/dry-run flag is false
+    @test == true
+  end
+
+end # class Opts
+
+end # module Quik

data/lib/quik/config.rb

@@ -0,0 +1,60 @@
+#encoding: utf-8
+
+module Quik
+
+##
+# used for config block
+#   lets you access props (even nested) that don't yet exist
+#    and all props get stored in a hash
+#
+#  e.g
+#  c = OpenConfig.new
+#  c.title        = 'title'
+#  c.author.name  = 'name'
+
+#  c.quik.last_updated = Time.now
+#  c.quik.title        = 'title'
+#  c.quik.name         = 'name'
+#  c.quik.theme        = 'theme'
+
+class OpenConfig
+
+  def initialize
+    @h = {}
+  end
+
+  def to_h
+    h = {}
+    @h.each do |k,v|
+      if v.is_a? OpenConfig
+        h[ k ] = v.to_h
+      else
+        h[ k ] = v  ## just pass along as is
+      end
+    end
+    h
+  end
+
+  def method_missing( m, *args, &block)
+    if m.to_s =~ /^(.*)=$/   ## setter
+      puts "config lookup (setter) >#{m}< #{m.class.name}, #{args.inspect}"
+      key = m[0..-2].to_s  ## cut off trailing =
+      @h[ key ] = args[0].to_s    # note: assume first arg is value for setter
+                                # note: for now all values are strings (always use to_s)
+    else       ## assume getter
+      ## fix: add check for args??  must be 0 for getters??
+      ##       use else super to delegate non-getters??
+      puts "config lookup (getter) >#{m}< #{m.class.name}"
+      key = m.to_s
+      value = @h[ key ]
+      if value.nil?
+        puts "  config add (nested) hash"
+        value = @h[ key ] = OpenConfig.new
+      end
+      value
+    end  
+  end # method_missing
+
+end # class OpenConfig
+   
+end  # module Quik

data/lib/quik/merger.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+
+module Quik
+
+class Merger
+
+
+
+  def find_files( root_dir )
+    tree = []
+
+    files =  Dir.entries( root_dir )
+    files = files.sort
+    puts "#{root_dir}:"
+    pp files
+
+    files.each do |file|
+      if File.directory?( "#{root_dir}/#{file}" )
+        ## note: skip directory if it starts with dot e.g. . or .. or .git etc.
+        if file.start_with?( '.' )
+          puts "skipping directory >#{file}< (#{root_dir})"
+          next
+        end
+        subtree = find_files( "#{root_dir}/#{file}" )
+        tree << [ file, subtree ]
+      else
+        ## just a "regular" file
+        tree << file
+      end
+    end
+    tree
+  end
+
+
+  def merge_filenames( root_dir, hash, opts={} )  ## flags e.g. noop, verbose, etc. see FileUtils
+    tree = find_files( root_dir )
+    pp tree
+
+    flags = {     ## always use verbose mode for now
+      verbose: true
+    }
+
+    ## todo/check: move opts={} to initialize e.g. Merger.new( opts={}) why? why not??
+
+    ## check for noop e.g. test mode/dry run
+    flags[ :noop ] = true  if opts[:test] || opts[:dry_run] || opts[:noop]
+
+    puts "walk tree:"
+    merge_filenames_worker_step1( root_dir, hash, tree, flags )
+    merge_filenames_worker_step2( root_dir, hash, tree, flags )
+  end
+
+  def merge_filenames_worker_step1( root_dir, hash, tree, flags )
+    ## note:  step 1 move all files
+    ##        step 2 move all dirs
+
+    tree.each do |node|
+      if node.is_a? Array ## assume it's a directory
+        merge_filenames_worker_step1( "#{root_dir}/#{node[0]}", hash, node[1], flags )
+      else  ## assume it's a file
+        old_name = node
+        new_name = merge_path( old_name, hash )
+        if old_name == new_name
+           puts "  keep file #{node} (#{root_dir})"
+        else
+           puts "  *** move file #{old_name} => #{new_name} (#{root_dir})"
+           src_path  = "#{root_dir}/#{old_name}"
+           dest_path = "#{root_dir}/#{new_name}"
+           FileUtils.mv( src_path, dest_path, flags )
+        end
+      end
+    end
+  end
+
+  def merge_filenames_worker_step2( root_dir, hash, tree, flags )
+    ## note:  step 1 move all files
+    ##        step 2 move all dirs
+
+    tree.each do |node|
+      if node.is_a? Array ## assume it's a directory
+        merge_filenames_worker_step2( "#{root_dir}/#{node[0]}", hash, node[1], flags )
+        old_name = node[0]
+        new_name = merge_path( old_name, hash )
+        if old_name == new_name
+           puts "  keep dir #{node[0]} (#{root_dir})"
+        else
+           puts "  *** move dir #{old_name} => #{new_name} (#{root_dir})"
+           src_path  = "#{root_dir}/#{old_name}"
+           dest_path = "#{root_dir}/#{new_name}"
+           FileUtils.mv( src_path, dest_path, flags )
+        end
+      end
+    end
+  end
+
+
+
+  def merge_files( root_dir, hash, opts={} )
+    ## note: rescan files (after renames)
+    tree = find_files( root_dir )
+    pp tree
+
+    puts "walk tree:"
+    merge_files_worker( root_dir, '', hash, tree, opts )
+  end
+
+  def merge_files_worker( root_dir, relative_dir, hash, tree, opts )
+    tree.each do |node|
+      if node.is_a? Array ## assume it's a directory
+        if relative_dir.empty?   # e.g. just add w/o leading slash e.g. 'lib' and not '/lib'
+          new_relative_dir = node[0].dup  # note: create a new string; just in case
+        else
+          new_relative_dir = "#{relative_dir}/#{node[0]}"
+        end
+        merge_files_worker( root_dir, new_relative_dir, hash, node[1], opts )
+      else  ## assume it's a file
+        if relative_dir.empty?
+          relative_path = node
+        else
+          relative_path = "#{relative_dir}/#{node}"
+        end
+
+        src_path = "#{root_dir}/#{relative_path}"
+        
+        ## note: for now assume always assume text files/utf8
+        ##  fix: change to File.read_utf8 ??
+        old_text = File.read( src_path )
+        new_text = merge_text( old_text, hash )
+
+        if opts[:o]
+          dest_root = opts[:o]
+          dest_path = "#{dest_root}/#{relative_path}"
+          ## make sure dest_path exists
+          dest_dir = File.dirname( dest_path )
+          FileUtils.mkdir_p( dest_dir ) unless Dir.exists?( dest_dir )
+        else
+          dest_root = root_dir
+          dest_path = "#{dest_root}/#{relative_path}"
+        end
+
+        if old_text == new_text
+           if opts[:o]  ## for testing copy file 1:1
+             puts "  copy file 1:1 #{node} (#{relative_dir}) in (#{dest_root})"
+             FileUtils.cp( src_path, dest_path, verbose: true )
+           else
+             puts "  skip file #{node} (#{relative_dir})"
+           end
+        else
+           puts "  *** update file #{node} (#{relative_dir}) in (#{dest_root})"
+           File.open( dest_path, 'w' ) do |f|
+             f.write new_text
+           end
+        end
+      end
+    end
+  end
+
+
+
+  def merge_path( path, hash )
+    ## e.g. allow
+    ##  __filename__  or
+    ##  $filename$   for now
+    path.gsub( /(__|\$)([a-z]+)\1/i ) do |_|
+      key   = $2.to_s
+      value = hash[ key ]
+      puts "   [path] replacing #{key} w/ >#{value}< in (#{path})"
+      value
+    end
+  end
+
+  def merge_text( text, hash )
+    ## e.g. allow
+    ##  $filename$  for now only in text
+    ##  note: must include leading and trailing word boundry (/B)
+    ##   e.g. hello$test$ will not match only "free-standing $test
+    ##  or in quote e.g. "$test$"
+    ##  e.g. no letters or digits allowed before or after $ to match
+
+    ## pp text
+
+    text.gsub( /\B\$([a-z]+)\$\B/i ) do |_|
+      key   = $1.to_s
+      value = hash[ key ]
+      puts "   [text] replacing #{key} w/ >#{value}<"
+      value
+    end
+  end
+
+
+
+  def merge( root_dir, hash, opts={} )
+    puts "  merge #{root_dir}, #{hash.inspect}"
+
+    merge_filenames( root_dir, hash, opts )
+    merge_files( root_dir, hash, opts )
+  end
+
+end # class Merger
+
+end # module Quik
+

data/lib/quik/package.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+module Quik
+
+class Package
+
+  def initialize( key )   ## e.g. rubyref/gems
+    if key.index( '/' ).nil?  ## if just 'gems' etc; assumbe rubyref "standard" github org
+      @key = "rubyref/#{key}"
+    else
+      @key = key   # use as is e.g. seattlerb/hoe etc.
+    end
+  end
+
+  def remote_zip_url # remote zip url
+    "https://github.com/#{@key}/archive/master.zip"
+  end
+
+  def local_zip_name
+    ## note: change / to --I-- for "flat" structure (e.g. no dirs)
+    @key.sub( '/', '--I--' )   # note: will NOT include/return .zip extension
+  end
+
+  def local_zip_dir
+    "."    ## use ./tmp or ./dl  or ~/.quik/cache  - why?? why not??
+  end
+
+  def local_zip_path # local zip path
+    "#{local_zip_dir}/#{local_zip_name}.zip"
+  end
+
+
+
+  def download
+    src      = remote_zip_url
+    dest_zip = local_zip_path
+
+    ## make sure dest folder exists
+    FileUtils.mkdir_p( local_zip_dir ) unless Dir.exists?( local_zip_dir )
+    fetch_archive( src, dest_zip )
+  end
+
+  def unzip( unzip_dir )
+    src        = local_zip_path
+    dest_unzip = unzip_dir ## local_unzip_dir
+
+    ## check if folders exists? if not create folder in path
+    FileUtils.mkdir_p( dest_unzip ) unless Dir.exists?( dest_unzip )
+    unzip_archive( src, dest_unzip )
+  end
+
+
+  def merge( root_dir, hash )
+    ## replace/merge variable in files
+    Dir.chdir( "#{root_dir}" ) do
+      files = Dir[ '**/*' ]   ## get all files
+      pp files
+    end
+  end
+
+
+private
+  def fetch_archive( src, dest )
+    ## step 1 - fetch archive
+    worker = Fetcher::Worker.new
+    worker.copy( src, dest )
+    ### fix: add src.sha5
+    ### inside folder
+    ### lets us check if current HEAD version is in place across datafiles etc.
+    ## - try HTTP HEAD ?? to check?
+  end
+
+  def unzip_archive( src, dest, opts={} )
+    ### todo/fix: rename or remove root folder -- use opts { root: false or something??}
+    # e.g
+    # !/starter-gh-pages/_layouts/ becomes
+    # !/_layouts/ etc.
+    Zip::File.open( src ) do |zipfile|
+      zipfile.each do |file|
+        if file.directory?
+          puts " skip directory zip entry - #{file.name}"
+        else
+          ### fix: only cut-off if master or gh-pages ???
+          ##  check if others include root folder?
+          name = file.name[ file.name.index('/')+1..-1] ## cut-off root/first path entry
+          path = File.join( dest, name)
+          puts " unzip file zip entry - #{file.name} to #{path}"
+          FileUtils.mkdir_p( File.dirname( path) )
+          zipfile.extract(file, path) unless File.exist?(path)
+        end
+      end
+    end
+  end # method unzip_theme
+
+
+end # class Package
+
+end # module Quik
+

data/lib/quik/version.rb

@@ -3,8 +3,8 @@
 module Quik
 
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/quik/wizard.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+
+## note:
+##  use global $QUIK_WIZARD_STDIN
+##    lets you redirect stdin for testing  e.g $QUIK_WIZARD_STDIN = StringIO.new( 'test/n' )
+$QUIK_WIZARD_IN = $stdin
+
+
+module Quik
+
+module Wizard   ## use a different name e.g. WizardHelpers, FormHelpers, InputHelper, etc - why, why not??
+
+def getstr  ## use getstr to avoid conflict w/ gets (use better name? read_string, readline (already exists too), etc.?)
+  ## note: gets will include trailing newline (user hits return to enter data)
+  ##   - use strip for now (remove leading and traling whitspaces) - might later just use chomp ? (jsut removes newlines)
+  $QUIK_WIZARD_IN.gets.strip
+end
+
+def say( text )
+  puts text
+end
+
+
+YES_REGEX = /y|yes|on|t|true/i      ## support YAML true values - double check (YAML does NOT support t/f)
+NO_REGEX  = /n|no|off|f|false/i
+
+def yes?( question )   ## defaults to yes - why, why not??
+  ## todo: strip trailing question mark (?) if present (gets auto-included)
+  print( "Q: #{question} (y/n)? [y]: " )
+  str = getstr
+  if str.empty? || str =~ YES_REGEX
+    true
+  elsif str =~ NO_REGEX
+    false
+  else    ## warn: unknown value??
+    true
+  end
+end
+
+def no?( question )   ## defaults to yes - why, why not??
+  ## todo: strip trailing question mark (?) if present (gets auto-included)
+  print( "Q: #{question} (y/n)? [n]: " )
+  str = getstr
+  if str.empty? || str =~ NO_REGEX
+    true
+  elsif str =~ YES_REGEX
+    false
+  else    ## warn: unknown value??
+    true
+  end
+end
+
+
+def ask( question, default=nil )
+  ## todo: strip trailing question mark (?) if present (gets auto-included)
+  if default
+    print( "Q: #{question}? [#{default}]: " )
+  else
+    print( "Q: #{question}?: " )
+  end
+
+  str = getstr
+  if default && str.empty?   ## todo: best way to check for empty string?
+    str = default
+  end
+  str  
+end
+
+
+def select( title, options )
+  puts( "Q: #{title}: " )
+  options.each_with_index do |opt,i|
+    puts "    #{i+1} - #{opt}"
+  end
+  print( "   Your choice (1-#{options.size})? [1]: " )
+  str = getstr
+  if str.empty?   ## todo: best way to check for empty string?
+    num = 0   ## default to first option for now
+  else
+    num = str.to_i   ## note: defaults to 0 if cannot convert?
+    num -= 1   if num > 0    ## note: "convert" from 1-based to 0-based for ary; if invalid entry; default to 0
+  end
+  options[ num ]
+end
+
+end # module Wizard
+end # module Quik

data/lib/quik.rb

@@ -1,14 +1,43 @@
 # encoding: utf-8
 
+# stdlibs
+require 'pp'
+require 'fileutils'
+require 'yaml'
+require 'uri'
 
+# 3rd party libs/gems
+require 'fetcher'
+require 'textutils' ## used for File.read_utf8
+
+## more 3rd party gems
+require 'zip' # use $ gem install rubyzip
+require 'gli'
 
-# our own code
 
+# our own code
 require 'quik/version'   # let version always go first
+require 'quik/package'
+require 'quik/merger'
+require 'quik/config'
+require 'quik/wizard'
+require 'quik/builder'
+
 
 
+require 'quik/cli/opts'
+require 'quik/cli/main'
 
 
+module Quik
+  def self.main
+    exit Tool.new.run( ARGV )
+  end
+end # module Quik
+
 
 ## say hello
 puts Quik.banner   if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG
+
+
+Quik.main if __FILE__ == $0

data/test/data/gem-starter-template/Manifest.txt

@@ -0,0 +1,9 @@
+---
+# Gem Starter Template
+---
+Manifest.txt
+HISTORY.md
+README.md
+Rakefile
+lib/{{filename}}.rb
+lib/{{filename}}/version.rb

data/test/data/gem-starter-template/README.md

@@ -0,0 +1,22 @@
+# gem-starter-template
+
+gem starter template
+
+
+## Settings / Config
+
+~~~
+{{ filename }}        used for lib/{{ filename }}.rb
+{{ project }}         used for gem name
+{{ klass }}           used for class name  (use class - why? why not?)
+~~~
+
+filename encode with --filename-- for variables  e.g. lib/--filename--.rb  -- why? why not?
+
+
+use three jekyll conventions:
+
+- folders w/ underscore get ignored
+- files w/ front matter e.g. ---...--- get (pre)processed
+- files w/o front matter get copied 1:1
+

data/test/data/gem-starter-template/lib/__filename__/version.rb

@@ -0,0 +1,12 @@
+
+
+module $klass$
+  VERSION  = $version$
+  VERSION2 = "$version$" 
+  VERSION3 = '$version$'
+  VERSION4 = $test
+  VERSION5 = test$test$hello
+  VERSION6 = test$test$
+  VERSION7 = $$
+  VERSION8 = $1$2
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+class EchoIO
+  def initialize( buf )
+    @io = StringIO.new( buf )
+  end
+  
+  def gets
+    str = @io.gets
+    puts "|>#{str.chomp}<|"   ## remove newline (w/ chomp) in debug/echo output 
+    str
+  end
+end
+
+
+## our own code
+require 'quik'

data/test/test_merger.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+###
+# to run use
+#   ruby -I ./lib -I ./test test/test_merger.rb
+
+
+require 'helper'
+
+
+class TestMerger < MiniTest::Test
+
+  def test_gem_starter_template
+
+    config = { 'filename' => 'hola',
+               'version' => '0.0.1',
+               'klass'  => 'Hola',
+             }
+
+    m = Quik::Merger.new
+
+    ## m.merge_filenames( "#{Quik.root}/test/data/gem-starter-template", config, test: true )
+    ## m.merge_filenames( "./o/gem", config )
+
+    ## note: set  output path (for testing; not in place)
+    ## m.merge_files( "#{Quik.root}/test/data/gem-starter-template", config, test: true, o: "./o/#{Time.now.to_i}" )
+
+    ## note: set  output path (for testing; not in place)
+    m.merge( "#{Quik.root}/test/data/gem-starter-template", config, test: true, o: "./o/#{Time.now.to_i}" )
+    ## m.merge( "./o/gem", config )
+
+    assert true  ## if we get here; everything is ok
+  end
+
+end # class TestMerger

data/test/test_package.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+###
+# to run use
+#   ruby -I ./lib -I ./test test/test_package.rb
+
+
+require 'helper'
+
+
+class TestPackage < MiniTest::Test
+
+  def test_gem_starter_template
+
+    pak = Quik::Package.new( 'gem-starter-template' )
+    pak.download
+    pak.unzip( './o/gem' )
+
+    assert true  ## if we get here; everything is ok
+  end
+
+end # class TestPackage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quik
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: textutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fetcher
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -66,21 +108,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.13'
-description: quik
+description: quik - ruby quick starter template script wizard .:. the missing code
+  generator
 email: ruby-talk@ruby-lang.org
-executables: []
+executables:
+- qk
+- quik
 extensions: []
 extra_rdoc_files:
 - HISTORY.md
 - Manifest.txt
 - README.md
 files:
+- ".gemtest"
 - HISTORY.md
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/qk
+- bin/quik
 - lib/quik.rb
+- lib/quik/builder.rb
+- lib/quik/cli/main.rb
+- lib/quik/cli/opts.rb
+- lib/quik/config.rb
+- lib/quik/merger.rb
+- lib/quik/package.rb
 - lib/quik/version.rb
+- lib/quik/wizard.rb
+- test/data/gem-starter-template/Manifest.txt
+- test/data/gem-starter-template/README.md
+- test/data/gem-starter-template/lib/$filename$.rb
+- test/data/gem-starter-template/lib/__filename__/$filename$.rb
+- test/data/gem-starter-template/lib/__filename__/__filename__/test.rb
+- test/data/gem-starter-template/lib/__filename__/version.rb
+- test/helper.rb
+- test/test_merger.rb
+- test/test_package.rb
 homepage: https://github.com/rubylibs/quik
 licenses:
 - Public Domain
@@ -106,5 +170,7 @@ rubyforge_project:
 rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: quik
-test_files: []
+summary: quik - ruby quick starter template script wizard .:. the missing code generator
+test_files:
+- test/test_merger.rb
+- test/test_package.rb