quik 0.1.1 → 1.0.0

data/lib/quik/package.rb

@@ -1,99 +1,116 @@
-# 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
-
+# encoding: utf-8
+
+module Quik
+
+class Package
+
+  def initialize( key )   ## e.g. quikstart/gems
+    if key.index( '/' ).nil?  ## if just 'gems' etc; assumbe quikstart "standard" github org
+      @key = "quikstart/#{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.exist?( 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.exist?( 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.
+
+    ##
+    ## note:
+    ##  skip all files in "root" folder
+    ##   only unzip files in /template(s)/ folder
+
+    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
+
+          ## note: name must start w/ template/ or templates/
+          ##   otherwise gets skipped as "top level" docu
+          if name =~ /^template(s)?\//
+            name = name[ name.index('/')+1..-1] ## cut-off first path entry (e.g. template(s)/)
+
+            path = File.join( dest, name)
+            puts " unzip file zip entry - #{file.name} to #{path}"
+            FileUtils.mkdir_p( File.dirname( path) )
+            ## todo/fix: check - always overwrite if file exists - why? why not??
+            zipfile.extract(file, path) unless File.exist?(path)
+          else
+            puts " skip top-level docu file entry - #{file.name}"
+          end
+        end
+      end
+    end
+  end # method unzip_theme
+
+
+end # class Package
+
+end # module Quik
+

data/lib/quik/version.rb

@@ -1,24 +1,24 @@
-# encoding: utf-8
-
-module Quik
-
-  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
-  PATCH = 1
-  VERSION = [MAJOR,MINOR,PATCH].join('.')
-
-  def self.version
-    VERSION
-  end
-
-  # version string for generator meta tag (includes ruby version)
-  def self.banner
-    "quik/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
-
-  def self.root
-    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
-  end
-
-end  # module Quik
-
+# encoding: utf-8
+
+module Quik
+
+  MAJOR = 1    ## todo: namespace inside version or something - why? why not??
+  MINOR = 0
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  # version string for generator meta tag (includes ruby version)
+  def self.banner
+    "quik/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end  # module Quik
+

data/lib/quik/wizard.rb

@@ -1,88 +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
+# 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/test/data/gem-starter-template/Manifest.txt

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