quik 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785b1927725b5af2d4d264dc3132321c3f131c1d
-  data.tar.gz: b6434cd8d1f3efa6ecc20f7c4d22816344349ded
+  metadata.gz: ec4d08a256216dfb3a8551980b43722a36f120c3
+  data.tar.gz: 371f5399bc9662da8d31f42b2127d41454ad1228
 SHA512:
-  metadata.gz: 30a338f561763c7598ebc0bc178bbbd9b728728adae312646f55e132fed137c3f82e0a58625001b9b366bf4d6c3466fd6723de0be2ad4b5b207f7fa7ebfd2fa2
-  data.tar.gz: 27b4f8c2845a1755bcead194bce36dc9b7d543d1914a78f7e124261722df64b2ebd824fc06ef44a3f60304c2ac6a84924503e8f29257793d196b46dd6858f8b5
+  metadata.gz: 1728295b7296be2f344409c4f0bdbbd2433d5c9f0a27a950b2b661395129220b946898517a8e0850dc9b99cb2fafb933292c0989266287d4f932052a0a3101be
+  data.tar.gz: ab52d9f8afde30ef62a06127720d902944e7e499bf6644ca882c6622146ac2c0f924a9e13902ef6ac5d4d987bbf156f08c9a512a2664c21983e914653d993ac6

data/Manifest.txt

@@ -8,6 +8,7 @@ lib/quik.rb
 lib/quik/builder.rb
 lib/quik/cli/main.rb
 lib/quik/cli/opts.rb
+lib/quik/colors.rb
 lib/quik/config.rb
 lib/quik/merger.rb
 lib/quik/package.rb
@@ -20,5 +21,8 @@ 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_colors.rb
+test/test_config.rb
 test/test_merger.rb
 test/test_package.rb
+test/test_wizard.rb

data/README.md

@@ -83,8 +83,9 @@ folder.
 
 **More Quick Starter Wizard Scripts**
 
-See the [Rubyref Scripts](https://github.com/rubyref/scripts) library.
+For more ruby quick starter scripts, see the [Rubyref Scripts](https://github.com/rubyref/scripts) library.
 
+For static site (e.g. jekyll) quick starter scripts, see the  [Mr. Hyde's Scripts](https://github.com/mrhydescripts/scripts) library.
 
 
 

data/lib/quik.rb

@@ -22,7 +22,7 @@ require 'quik/merger'
 require 'quik/config'
 require 'quik/wizard'
 require 'quik/builder'
-
+require 'quik/colors'
 
 
 require 'quik/cli/opts'

data/lib/quik/builder.rb

@@ -47,6 +47,8 @@ class Builder
       # 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

data/lib/quik/cli/main.rb

@@ -58,6 +58,9 @@ def self.fetch_script( name )
   else  ## fetch remote script
     url = "https://github.com/rubyref/scripts/raw/master/#{name}.rb"
     ## 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

data/lib/quik/colors.rb

@@ -0,0 +1,147 @@
+# encoding: utf-8
+
+### todo: move to textutils for (re)use - why? why not??
+###   todo add some references to alternative color gems
+##
+##  e.g. https://github.com/fazibear/colorize
+##       http://github.com/ssoroka/ansi
+##       http://flori.github.com/term-ansicolor/
+##       http://github.com/sickill/rainbow
+
+
+## move to core_ext.rb - why? why not??
+
+###
+## fix: use css style
+##  e.g. color( :red )
+##       color( :blue )
+##       background_color( :red )
+##       font_style( :bold )  -- why? why not??
+
+class String
+
+  def self.use_colors?
+    @@use_color ||=  true
+    ##  todo/fix: check for windows on load (set to false;otherwise true)
+    @@use_color
+  end
+
+  def self.use_colors=(value)
+    @@use_color = value
+  end
+
+
+  def red()      colorize(31); end
+  def green()    colorize(32); end
+  def yellow()   colorize(33); end   ## note: more brown-ish (if not used w/ bold/bright mode) ??
+  def blue()     colorize(34); end
+  def magenta()  colorize(35); end   ## pink ??
+  def cyan()     colorize(36); end   ## light blue ?? 
+
+  def bold()     colorize(1); end    ## just use 0 clear for now; instead of BOLD_OFF (22) code; use bright as an alias??
+
+private
+  def colorize(code)
+    if self.class.use_colors?
+      "\e[#{code}m#{self}\e[0m"
+    else
+      self
+    end
+  end
+
+
+   ## todo - add modes e.g. bold/underscore/etc.
+=begin
+class String
+def black;          "\e[30m#{self}\e[0m" end
+def red;            "\e[31m#{self}\e[0m" end
+def green;          "\e[32m#{self}\e[0m" end
+def brown;          "\e[33m#{self}\e[0m" end
+def blue;           "\e[34m#{self}\e[0m" end
+def magenta;        "\e[35m#{self}\e[0m" end
+def cyan;           "\e[36m#{self}\e[0m" end
+def gray;           "\e[37m#{self}\e[0m" end
+
+def on_black;       "\e[40m#{self}\e[0m" end
+def on_red;         "\e[41m#{self}\e[0m" end
+def on_green;       "\e[42m#{self}\e[0m" end
+def on_brown;       "\e[43m#{self}\e[0m" end
+def on_blue;        "\e[44m#{self}\e[0m" end
+def on_magenta;     "\e[45m#{self}\e[0m" end
+def on_cyan;        "\e[46m#{self}\e[0m" end
+def on_gray;        "\e[47m#{self}\e[0m" end
+
+def bold;           "\e[1m#{self}\e[21m" end
+def italic;         "\e[3m#{self}\e[23m" end
+def underline;      "\e[4m#{self}\e[24m" end
+def blink;          "\e[5m#{self}\e[25m" end
+def reverse_color;  "\e[7m#{self}\e[27m" end
+
+use Ansi constants - why? why not? e.g.:
+//foreground color
+public static final String BLACK_TEXT()   { return "\033[30m";}
+public static final String RED_TEXT()     { return "\033[31m";}
+public static final String GREEN_TEXT()   { return "\033[32m";}
+public static final String BROWN_TEXT()   { return "\033[33m";}
+public static final String BLUE_TEXT()    { return "\033[34m";}
+public static final String MAGENTA_TEXT() { return "\033[35m";}
+public static final String CYAN_TEXT()    { return "\033[36m";}
+public static final String GRAY_TEXT()    { return "\033[37m";}
+
+//background color
+public static final String BLACK_BACK()   { return "\033[40m";}
+public static final String RED_BACK()     { return "\033[41m";}
+public static final String GREEN_BACK()   { return "\033[42m";}
+public static final String BROWN_BACK()   { return "\033[43m";}
+public static final String BLUE_BACK()    { return "\033[44m";}
+public static final String MAGENTA_BACK() { return "\033[45m";}
+public static final String CYAN_BACK()    { return "\033[46m";}
+public static final String WHITE_BACK()   { return "\033[47m";}
+
+//ANSI control chars
+public static final String RESET_COLORS() { return "\033[0m";}
+public static final String BOLD_ON()      { return "\033[1m";}
+public static final String BLINK_ON()     { return "\033[5m";}
+public static final String REVERSE_ON()   { return "\033[7m";}
+public static final String BOLD_OFF()     { return "\033[22m";}
+public static final String BLINK_OFF()    { return "\033[25m";}
+public static final String REVERSE_OFF()  { return "\033[27m";}
+end
+
+Code 	Effect
+0 	Turn off all attributes
+1 	Set bright mode
+4 	Set underline mode
+5 	Set blink mode
+7 	Exchange foreground and background colors
+8 	Hide text (foreground color would be the same as background)
+30 	Black text
+31 	Red text
+32 	Green text
+33 	Yellow text
+34 	Blue text
+35 	Magenta text
+36 	Cyan text
+37 	White text
+39 	Default text color
+40 	Black background
+41 	Red background
+42 	Green background
+43 	Yellow background
+44 	Blue background
+45 	Magenta background
+46 	Cyan background
+47 	White background
+49 	Default background color
+
+note:
+puts "\e[31m" # set format (red foreground)
+puts "\e[0"   # clear format
+puts "green-#{"red".red}-green".green # will be green-red-normal, because of \e[0
+e.g. for now colors can NOT get nested
+     plus if you bold/italic/etc. use it before the color e.g.
+      bold.red etc.
+=end
+
+
+end # class String

data/lib/quik/package.rb

@@ -36,7 +36,7 @@ class Package
     dest_zip = local_zip_path
 
     ## make sure dest folder exists
-    FileUtils.mkdir_p( local_zip_dir ) unless Dir.exists?( local_zip_dir )
+    FileUtils.mkdir_p( local_zip_dir ) unless Dir.exist?( local_zip_dir )
     fetch_archive( src, dest_zip )
   end
 
@@ -45,7 +45,7 @@ class Package
     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 )
+    FileUtils.mkdir_p( dest_unzip ) unless Dir.exist?( dest_unzip )
     unzip_archive( src, dest_unzip )
   end
 
@@ -75,6 +75,12 @@ private
     # 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?
@@ -83,10 +89,20 @@ private
           ### 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)
+
+          ## 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

data/lib/quik/version.rb

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

data/test/test_colors.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+###
+# to run use
+#   ruby -I ./lib -I ./test test/test_colors.rb
+
+
+require 'helper'
+
+
+class TestColors < MiniTest::Test
+
+  def test_colors
+
+    puts "this text is blue".blue
+    puts "this text is red".red
+    puts "this text is green".green + "this text is yellow".yellow
+    puts "this text is magenta".magenta
+    puts "this text is cyan".cyan
+
+    puts "this text is blue".bold.blue
+    puts "this text is red".bold.red
+    puts "this text is green".bold.green + "this text is yellow".bold.yellow
+
+    pp String.use_colors?
+
+    assert true  ## if we get here; everything is ok
+  end
+  
+  def test_codes
+    assert_equal "\e[31mred\e[0m",                 "red".red
+    assert_equal "\e[34m\e[31mblue\e[0m\e[0m",     "blue".red.blue
+    ##  better to generate "\e[34m;[31m"  -- why? why not? e.g. one starting escpape and codes delimited by ; ??
+    assert_equal "\e[1mway bold\e[0m",             "way bold".bold
+    assert_equal "\e[36m\e[1mcyan bold\e[0m\e[0m", "cyan bold".bold.cyan
+  end
+
+end # class TestColors
+

data/test/test_config.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+###
+# to run use
+#   ruby -I ./lib -I ./test test/test_config.rb
+
+
+require 'helper'
+
+
+class TestConfig < MiniTest::Test
+
+  def test_config
+
+    c = Quik::OpenConfig.new
+    c.title        = 'title'
+    c.author.name  = 'name'
+
+    c.mrhyde.last_updated = Time.now
+    c.mrhyde.title        = 'title'
+    c.mrhyde.name         = 'name'
+    c.mrhyde.theme        = 'theme'
+    c.mrhyde.meta.info    = 'test nested nested value'
+
+    pp c.to_h
+
+    assert true  ## if we get here; everything is ok
+  end
+
+
+end # class TestConfig

data/test/test_wizard.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+###
+# to run use
+#   ruby -I ./lib -I ./test test/test_wizard.rb
+
+
+require 'helper'
+
+
+class TestWizard < MiniTest::Test
+
+  include Quik::Wizard   ## lets you use ask etc.
+
+  def test_ask
+
+    $QUIK_WIZARD_IN = EchoIO.new( <<EOS )
+Another Beautiful Static Site
+
+H. J.
+
+2
+n
+y
+EOS
+
+    say "Hello, Wizard!"
+
+    title = ask "What's your site's title", "Your Site Title"
+    assert_equal 'Another Beautiful Static Site', title
+
+    title = ask "What's your site's title", "Your Site Title"
+    assert_equal 'Your Site Title', title
+
+    name = ask "Your Name"
+    assert_equal 'H. J.', name
+
+    theme = select "Select your theme", ["Starter", "Bootstrap", "Minimal"]
+    assert_equal 'Starter', theme
+
+    theme = select "Select your theme", ["Starter", "Bootstrap", "Minimal"]
+    assert_equal 'Bootstrap', theme
+
+    assert_equal false, yes?( "Add to GitHub" )
+    assert_equal false, no?( "Add to GitHub" )
+
+    assert true  ## if we get here; everything is ok
+  end
+
+end # class TestWizard

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quik
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -131,6 +131,7 @@ files:
 - lib/quik/builder.rb
 - lib/quik/cli/main.rb
 - lib/quik/cli/opts.rb
+- lib/quik/colors.rb
 - lib/quik/config.rb
 - lib/quik/merger.rb
 - lib/quik/package.rb
@@ -143,8 +144,11 @@ files:
 - test/data/gem-starter-template/lib/__filename__/__filename__/test.rb
 - test/data/gem-starter-template/lib/__filename__/version.rb
 - test/helper.rb
+- test/test_colors.rb
+- test/test_config.rb
 - test/test_merger.rb
 - test/test_package.rb
+- test/test_wizard.rb
 homepage: https://github.com/rubylibs/quik
 licenses:
 - Public Domain
@@ -172,5 +176,8 @@ signing_key:
 specification_version: 4
 summary: quik - ruby quick starter template script wizard .:. the missing code generator
 test_files:
+- test/test_wizard.rb
 - test/test_merger.rb
+- test/test_colors.rb
+- test/test_config.rb
 - test/test_package.rb