quik 0.3.0 → 1.0.0

data/Rakefile

@@ -1,34 +1,33 @@
-require 'hoe'
-require './lib/quik/version.rb'
-
-Hoe.spec 'quik' do
-
-  self.version = Quik::VERSION
-
-  self.summary = 'quik - ruby quick starter template script wizard .:. the missing code generator'
-  self.description = summary
-
-  self.urls    = ['https://github.com/rubylibs/quik']
-
-  self.author  = 'Gerald Bauer'
-  self.email   = 'ruby-talk@ruby-lang.org'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.md'
-  self.history_file = 'HISTORY.md'
-
-  self.extra_deps = [
-    ['logutils'],
-    ['textutils'],
-    ['fetcher'],
-    ['rubyzip'],
-    ['gli'],
-  ]
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-   required_ruby_version: '>= 1.9.2'
-  }
-
-end
+require 'hoe'
+require './lib/quik/version.rb'
+
+Hoe.spec 'quik' do
+
+  self.version = Quik::VERSION
+
+  self.summary = 'qk/quik - ruby quick starter template script wizard .:. the missing code generator'
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/quikstart/quik' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'ruby-talk@ruby-lang.org'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['logutils'],
+    ['fetcher'],
+    ['rubyzip'],
+    ['gli'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.2.2'
+  }
+
+end

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,44 +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/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
-    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,96 +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 )
-      
-      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
+#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

@@ -1,56 +1,73 @@
-# encoding: utf-8
-
-module Quik
-
-class Catalog
-
-  def self.from_url( src )
-    worker = Fetcher::Worker.new
-    text = worker.read_utf8!( src )
-    self.from_string( text )
-  end
-
-  def self.from_file( path )
-    ## read in themes catalog
-    text  = File.read( path )  ## fix: use File.read_utf8 ??
-    self.from_string( text )
-  end
-
-  def self.from_string( text )
-    self.new( text )
-  end
-
-
-  def initialize( text )
-    @scripts     = YAML.load( text )
-  end
-
-  def list( filter=nil )
-    ## pp filter
-
-    @scripts.each_with_index do |h,i|
-      name    = h['name']
-      summary = h['summary']
-
-      line = ''
-      line << "  %3d" % (i+1)
-      line << "..%-10s" % name
-      line << " .:.  #{summary}"
-
-      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
+# 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