quik 0.1.1 → 1.0.0

data/bin/qk

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

data/bin/quik

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

data/lib/quik.rb

@@ -1,43 +1,55 @@
-# 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
-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
+# encoding: utf-8
+
+# stdlibs
+require 'pp'
+require 'fileutils'
+require 'yaml'
+require 'json'
+require 'uri'
+require 'time'
+require 'date'
+
+
+# 3rd party libs/gems
+require 'fetcher'
+
+## more 3rd party gems
+require 'zip'      # use $ gem install rubyzip
+require 'gli'
+
+
+# our own code
+require 'quik/version'   # let version always go first
+
+
+module Quik
+  ### builtin default urls
+  QUIK_SCRIPTS_URL = "https://github.com/quikstart/scripts/raw/master/scripts.yml"
+end
+
+
+
+require 'quik/catalog'
+require 'quik/package'
+require 'quik/merger'
+require 'quik/config'
+require 'quik/wizard'
+require 'quik/builder'
+require 'quik/colors'
+
+
+require 'quik/cli/opts'
+require 'quik/cli/main'
+
+
+module Quik
+  def self.main( args=ARGV )
+    exit Tool.new.run( args )
+  end
+end # module Quik
+
+
+
+
+## say hello
+puts Quik.banner   if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG

data/lib/quik/builder.rb

@@ -1,94 +1,96 @@
-#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 = "./#{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
+#encoding: utf-8
+
+module Quik
+
+class Builder
+
+  def self.load_file( path, opts={} )
+    code = File.open( path, 'r:utf-8' ) { |f| f.read }
+    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 with options #{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}< with options #{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 )
+
+      puts "GET #{@pak.remote_zip_url}".bold.green   ## output network access in green bold
+      @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 = "./#{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/catalog.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module Quik
+
+class Catalog
+
+  def self.from_url( src )
+    worker = Fetcher::Worker.new
+    text = worker.read_utf8!( src )
+    new( text )
+  end
+
+  def self.from_file( path )
+    ## read in themes catalog
+    text = File.open( path, 'r:utf-8' ) { |f| f.read }
+    new( text )
+  end
+
+#  def self.from_string( text )
+#    self.new( text )
+#  end
+
+
+  def initialize( text )
+    recs = YAML.load( text )
+    ## note: convert array to hash (lookup by name)
+    ##    todo: check for missing name property? - why? why not?
+    @scripts = recs.reduce( {} ) { |h,rec| h[rec['name']] = rec; h }
+  end
+
+
+  def find( name )
+    @scripts[ name ]
+  end
+
+  def list( filter=nil )
+    ## pp filter
+
+    @scripts.each_with_index do |(_,rec),i|
+      name    = rec['name']
+      summary = rec['summary']
+      script  = rec['script']
+
+      if script && script.index( '//github.com/')
+        ## "beautify" / shorten github links - remove raw/master/
+        script = script.gsub('raw/master/', '' )
+      end
+
+      ## pp h
+
+      line = ''
+      line << "  %3d" % (i+1)
+      line << "..%-10s" % name
+      line << " .:.  #{summary}"
+      line << " @ (#{script})"
+
+      if filter
+        ## note: ignore case (upper/lower/downcase) for now
+        ##  filter on name/title and
+        ##            tags for now
+        if name.downcase.index(filter.downcase)    != nil ||    ## note: 0 is match found on index 0; only nil is not found
+           summary.downcase.index(filter.downcase) != nil
+          puts line
+        end
+      else
+        puts line
+      end
+    end
+  end  # method filter
+
+end # class Catalog
+
+end # module Quik

data/lib/quik/cli/main.rb

@@ -1,150 +1,213 @@
-# 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
-
+################
+## 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_catalog
+  ## scripts_dir = "#{Quik.root}/test/data"
+  ## catalog    = Catalog.new( "#{scripts_dir}/scripts.yml" )
+
+  url = QUIK_SCRIPTS_URL
+
+  puts "GET #{url}".bold.green   ## output network access in green bold
+
+  catalog = Catalog.from_url( url )
+  catalog
+end
+
+
+def self.fetch_script( name_or_path )
+
+  ## first try local version in working folder
+
+  text = ''
+
+  extname = File.extname( name_or_path )
+
+
+  ## try local first
+  ##   todo/fix:  check in ~/.quik/ dir too?
+
+  path =  if extname == '.rb' && File.exist?( name_or_path )
+            name_or_path
+          elsif extname == '' && File.exist?( "#{name_or_path}.rb" )
+            "#{name_or_path}.rb"
+          elsif extname == '' && File.exist?( "~/.quik/#{name_or_path}.rb" )
+            "~/.quik/#{name_or_path}.rb"   ## todo/check - if (~) shortcut works in windows -too?
+          else
+            nil
+          end
+
+  if path
+    text = File.open( path, 'r:utf-8' ) { |f| f.read }
+  else  ## try fetch remote script
+
+    url = nil
+
+    if name_or_path.index( '/' ).nil?   ## assume short-cut name if no (/) in name
+        ## do a lookup from catalog!!!
+        catalog = fetch_catalog
+        rec = catalog.find( name_or_path )
+        url = rec['script']  if rec
+
+        if url.nil?
+            puts "!! ERROR - sorry no wizard script found / available for name >#{name_or_path}<"
+            exit 1
+        end
+    else
+        ## assume custom github url shortcut
+        url = "https://github.com/#{name_or_path}/raw/master/quik.rb"
+    end
+
+    ## assume utf8 text encoding for now
+    puts "GET #{url}".bold.green   ## output network access in green bold
+
+    worker = Fetcher::Worker.new
+    text = worker.read_utf8!( url )
+  end
+
+  text
+end
+
+
+
+desc "List ruby quick starter scripts"
+arg_name 'QUERY'   # optional search query/filter
+command [:list,:ls,:l] do |c|
+
+  c.action do |g,o,args|
+    ## read in scripts diretory
+    catalog = fetch_catalog
+    catalog.list( args[0] )   ## note: pass in filter e.g. args[0]; may be nil (no filter)
+    puts 'Done.'
+  end # action
+end  # command list
+
+
+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
+