drjekyll 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1abacc0051e57841738784b05c84d1adb06051ad
-  data.tar.gz: d756a8cd82ef92f2310f8dd40445583c8abf3c7c
+  metadata.gz: 5f8388480e3692910b92dcd78a42097b242f72f9
+  data.tar.gz: 8ac266778b6fcf94ed8e86e6a80454e378fb3d6e
 SHA512:
-  metadata.gz: 0c127f82e87a8eaf5e5dc2be3440c11863d61c0282917e5fd03925531cb7e8281407a7273ad2feb6f4d51bb620a45dea1b759a170993fd8ae528457af5cf805b
-  data.tar.gz: 09f07a808b355bbcb8cb06ea2a5c466af3d22ab84829dfe813128ae5fa4212cc5053827c9862848bcd49c228504632ecdec6bfca9e703bec839dcbb8993ad52a
+  metadata.gz: 1970d2319f64132371a156f9a6b128568401781bd91a59d254b8fde164f7f8b960800e8b7682b14792515eb17ad4c294edd00fbc3284c6ad19da710d41e7195f
+  data.tar.gz: 88523b5e8dce44330ffb9612703b0a345a39b30f927a7a3dbcc91f97a1a4d3334342d684f76700f9f3ef9685efead37bf502338a6f8d7bce0a6438863e5434d5

data/Manifest.txt

@@ -9,7 +9,9 @@ lib/drjekyll/catalog.rb
 lib/drjekyll/cli/download.rb
 lib/drjekyll/cli/list.rb
 lib/drjekyll/cli/main.rb
+lib/drjekyll/cli/new.rb
 lib/drjekyll/cli/opts.rb
 lib/drjekyll/cli/unzip.rb
+lib/drjekyll/package.rb
 lib/drjekyll/version.rb
 test/data/themes.yml

data/README.md

@@ -1,2 +1,165 @@
-# drjekyll
-drjekyll
+# drjekyll - the missing theme package manager
+
+jekyll command line tool
+
+* home  :: [github.com/drjekyllthemes/drjekyll](https://github.com/drjekyllthemes/drjekyll)
+* bugs  :: [github.com/drjekyllthemes/drjekyll/issues](https://github.com/drjekyllthemes/drjekyll/issues)
+* gem   :: [rubygems.org/gems/drjekyll](https://rubygems.org/gems/drjekyll)
+* rdoc  :: [rubydoc.info/gems/drjekyll](http://rubydoc.info/gems/drjekyll)
+* forum :: [wwwmake](http://groups.google.com/group/wwwmake)
+
+
+## Usage
+
+The drjekyll gem includes a command line tool that
+lets you manage static site theme packages.
+
+Try:
+
+```
+$ drjekyll --help      # or
+$ drj -h
+```
+
+Resulting in:
+
+```
+NAME
+    drjekyll/drj - jekyll command line tool .:. the missing static site package manager
+
+SYNOPSIS
+    drjekyll/drj [global options] command [command options] [arguments...]
+
+VERSION
+    0.1.0
+
+GLOBAL OPTIONS
+    --help    - Show this message
+    --verbose - (Debug) Show debug messages
+    --version - Display the program version
+
+COMMANDS
+    list, ls, l             - List themes
+    new, n                  - Download 'n' setup (unzip/unpack) theme
+    download, dl, d, get, g - (Debug) Step 1: Download theme; .zip archive saved in working folder (./)
+    unpack, pk, p, setup, s - (Debug) Step 2: Setup (unzip/unpack) theme; uses saved .zip archive in working folder (./)
+    help                    - Shows a list of commands or help for one command
+    test                    - (Debug) Test command suite
+```
+
+
+### List Themes Command - `list`, `ls`, `l`
+
+Use:
+
+```
+$ drjekyll list    # or
+$ drjekyll ls      # or
+$ drjekyll l       # or
+$ drj l
+```
+
+Resulting in:
+
+```
+  1..Planet Jekyll's Starter (Minimal) (starter | planetjekyllsstarterminimal) by Gerald Bauer - #white 
+  2..Dr Jekyll's Minimal (minimial | drjekyllsminimal) by Gerald Bauer - #white 
+  3..Dr Jekyll's Bootstrap (bootstrap | drjekyllsbootstrap) by Gerald Bauer - #bootstrap #scss #white 
+  4..Dr Jekyll's Classics Book (classics | drjekyllsclassicsbook) by Gerald Bauer - #books #white 
+  5..Poole (poole) by Mark Otto - #poole 
+  6..Poole's Hyde (pooleshyde) by Mark Otto - #poole 
+  7..Poole's Lanyon (pooleslanyon) by Mark Otto - #poole 
+  8..Beautiful Jekyll (beautifuljekyll) by Dean Attali
+...
+```
+
+Note: You can filter by name or tags; just add the query e.g.:
+
+```
+$ drjekyll list resume    # or
+$ drjkeyll ls resume      # or
+$ drjkeyll l resume       # or
+$ drj l resume
+```
+
+Resulting in:
+
+```
+ 68..Resume Cards (resumecards) by Elle Kasai - #resume
+104..iCard Resume (icardresume) by Dong Liang - #resume 
+109..Resume (resume) by Joel Glovier - #resume 
+```
+
+
+### New Theme Command - `new`, `n`
+
+To download and install (unzip/unpack) a theme archive use:
+
+```
+$ drjekyll new starter    # or
+$ drjekyll n starter      # or
+$ drj n starter
+```
+
+This will download the `starter.zip` to your working folder and
+unzip the archive into the `./starter` folder.
+
+
+**More Examples**
+
+To download and install (unzip/unpack):
+
+```
+  7..Poole's Lanyon (pooleslanyon) by Mark Otto - #poole 
+```
+
+Use:
+
+```
+$ drjekyll new pooleslanyon     # or
+$ drjekyll n pooleslanyon       # or
+$ drj      n pooleslanyon
+```
+
+To download and install (unzip/unpack):
+
+```
+  8..Beautiful Jekyll (beautifuljekyll) by Dean Attali
+```
+
+Use:
+
+```
+$ drjekyll new beautifuljekyll   # or
+$ drjekyll n beautifuljekyll     # or
+$ drj      n beautifuljekyll
+```
+
+And so on and so forth.
+
+
+
+**More Themes**
+
+See the [Dr. Jekyll's Themes](https://drjekyllthemes.github.io) directory .
+
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install drjekyll
+
+
+## License
+
+The `drjekyll` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Send them along to the [wwwmake forum](http://groups.google.com/group/wwwmake).
+Thanks!
+

data/Rakefile

@@ -18,8 +18,12 @@ Hoe.spec 'drjekyll' do
   self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
-    ## 3rd party
+    ['props', '>=1.1.2'],
+    ['logutils', '>=0.6.1'],
     ['fetcher', '>= 0.4.5'],
+    ## 3rd party
+    ['gli', '>=2.12.2'],
+    ['rubyzip', '>=1.1.7'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/drjekyll.rb

@@ -13,26 +13,26 @@ require 'yaml'
 ## 3rd party gems
 require 'props'        ## Use Env.home
 require 'logutils'
+require 'fetcher'
 
 
-## require 'fetcher'
-
 ## more 3rd party gems
+require 'zip'    # use $ gem install rubyzip
 require 'gli'
 
 
-
 # our own code
 
 require 'drjekyll/version'    # note: version always goes first
 require 'drjekyll/catalog'
+require 'drjekyll/package'
 
 require 'drjekyll/cli/opts'
 require 'drjekyll/cli/main'
 require 'drjekyll/cli/list'
 require 'drjekyll/cli/download'
 require 'drjekyll/cli/unzip'
-
+require 'drjekyll/cli/new'
 
 
 module DrJekyll
@@ -47,7 +47,7 @@ end  # module DrJekyll
 ## DrJekyll.banner  ## say hello
 
 ## for debugging
-pp Env.home
-pp DrJekyll.root
+## pp Env.home
+## pp DrJekyll.root
 
 DrJekyll.main  if __FILE__ == $0

data/lib/drjekyll/catalog.rb

@@ -3,10 +3,25 @@
 module DrJekyll
 
 class Catalog
-  
-  def initialize( path )
+
+  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 )
+    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 )
     @themes     = YAML.load( text )    
 
     ## auto-add keys for now (for quick testing)
@@ -70,7 +85,7 @@ class Catalog
     end
   end  # method filter
 
-  def get( key )   ## use fetch or different name - why? why not??
+  def find( key )   ## use fetch/get/? or different name - why? why not??
     ## find theme by key
     ##  fix/todo: use linear search for now; use hash lookup later
 

data/lib/drjekyll/cli/download.rb

@@ -14,20 +14,21 @@ class DownloadCommand   ## find a better name - why, why not ??
     ## note: required template name (defaults to starter for now)
     key = args[0] || 'starter'
 
-    theme = @catalog.get( key )
-    
+    theme = @catalog.find( key )
+
     if theme
-      download( theme )
+      download( key, theme )
     else
       ## todo: issue warning - why, why not??
+      puts "*** theme '#{key}' not found; sorry"
     end
   end
-  
-  def download( theme )
-    ## to be done
-    pp theme
+
+  def download( key, theme )
+    pak = Package.new( key, theme )
+    pak.download
   end
-  
+
 end ## class DownloadCommand
 
 end # module DrJekyll

data/lib/drjekyll/cli/main.rb

@@ -33,20 +33,30 @@ logger = LogUtils::Logger.root
 opts   = Opts.new 
 
 
-program_desc 'drjekyll command line tool'
+program_desc 'jekyll command line tool .:. the missing static site package manager'
 version VERSION
 
 
-desc 'Use only local (offline) cached data; no (online) remote network access'
-switch [:l, :local], negatable: false
+## 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 'Only show warnings, errors and fatal messages'
-switch [:q, :quiet], negatable: false
+## desc 'Only show warnings, errors and fatal messages'
+## switch [:q, :quiet], negatable: false
 
 
+def self.fetch_catalog
+  ## themes_dir = "#{DrJekyll.root}/test/data"
+  ## catalog    = Catalog.new( "#{themes_dir}/themes.yml" )
+
+  url = "https://github.com/drjekyllthemes/themes/raw/master/o/themes.yml"
+
+  catalog = Catalog.from_url( url )
+  catalog
+end
+
 
 desc "List themes"
 arg_name 'QUERY'   # optional search query/filter
@@ -54,8 +64,7 @@ command [:list,:ls,:l] do |c|
 
   c.action do |g,o,args|
     ## read in themes diretory    
-    themes_dir = "#{DrJekyll.root}/test/data"
-    catalog    = Catalog.new( "#{themes_dir}/themes.yml" )
+    catalog = fetch_catalog
 
     cmd = ListCommand.new( catalog, opts )
     cmd.run( args )
@@ -65,14 +74,13 @@ end  # command list
 
 
 ## use get or fetch - why, why not??
-desc "Download theme; saved in ~/.drjekyll/cache"
+desc "(Debug) Step 1: Download theme; .zip archive saved in working folder (./)"
 arg_name 'NAME'   # required theme name
 command [:download,:dl,:d,:get,:g] do |c|
 
   c.action do |g,o,args|
     ## read in themes diretory    
-    themes_dir = "#{DrJekyll.root}/test/data"
-    catalog    = Catalog.new( "#{themes_dir}/themes.yml" )
+    catalog = fetch_catalog
 
     cmd = DownloadCommand.new( catalog, opts )
     cmd.run( args )
@@ -82,14 +90,13 @@ end  # command download
 
 
 ## use install or unzip/unpack - why, why not??
-desc "Setup (unzip/unpack) theme; use archive in ~/.drjekyll/cache"
+desc "(Debug) Step 2: Setup (unzip/unpack) theme; uses saved .zip archive in working folder (./)"
 arg_name 'NAME'   # required theme name
 command [:unpack,:pk,:p,:setup,:s] do |c|
 
   c.action do |g,o,args|
     ## read in themes diretory    
-    themes_dir = "#{DrJekyll.root}/test/data"
-    catalog    = Catalog.new( "#{themes_dir}/themes.yml" )
+    catalog = fetch_catalog
 
     cmd = UnzipCommand.new( catalog, opts )
     cmd.run( args )
@@ -103,12 +110,11 @@ arg_name 'NAME'   # required theme name
 command [:new,:n] do |c|
 
   c.action do |g,o,args|
+    ## read in themes diretory    
+    catalog = fetch_catalog
 
-    ## todo: required template name (defaults to starter for now)
-    name = args[0] || 'starter'
-
-    puts "  download theme here"
-    puts "  unzip/unpack (setup) here"
+    cmd = NewCommand.new( catalog, opts )
+    cmd.run( args )
     puts 'Done.'
   end # action
 end  # command setup

data/lib/drjekyll/cli/new.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+
+module DrJekyll
+
+class NewCommand   ## find a better name - why, why not ??
+
+  def initialize( catalog, opts )
+    @catalog = catalog
+    @opts    = opts
+  end
+
+  def run( args )
+    ## note: required template name (defaults to starter for now)
+    key = args[0] || 'starter'
+
+    theme = @catalog.find( key )
+
+    if theme
+      download_and_unzip( key, theme )
+    else
+      ## todo: issue warning - why, why not??
+      puts "*** theme '#{key}' not found; sorry"
+    end
+  end
+
+  def download_and_unzip( key, theme )
+    pak = Package.new( key, theme )
+    pak.download
+    pak.unzip( "./#{key}" )
+  end
+
+end ## class NewCommand
+
+end # module DrJekyll

data/lib/drjekyll/cli/unzip.rb

@@ -14,20 +14,21 @@ class UnzipCommand   ## find a better name - why, why not ??
     ## note: required template name (defaults to starter for now)
     key = args[0] || 'starter'
 
-    theme = @catalog.get( key )
-    
+    theme = @catalog.find( key )
+
     if theme
-      unzip( theme )
+      unzip( key, theme )
     else
       ## todo: issue warning - why, why not??
+      puts "*** theme '#{key}' not found; sorry"
     end
   end
 
-  def unzip( theme )
-    ## to be done
-    pp theme
+  def unzip( key, theme )
+    pak = Package.new( key, theme )
+    pak.unzip( "./#{key}" )
   end
-  
+
 end ## class UnzipCommand
 
 end # module DrJekyll

data/lib/drjekyll/package.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+module DrJekyll
+
+class Package
+
+  def initialize( key, hash )  ## note: for now pass in key as its own arg (not part/included in hash)
+    @key  = key
+    @hash = hash
+
+    @download_url = @hash['download_url']  # as string
+  end
+
+  def remote_zip_url # remote zip url
+    @download_url   # as string
+  end
+
+  def local_zip_name
+    @key   # note: will NOT include/return .zip extension
+  end
+
+  def local_zip_dir
+    "."    ## use ./tmp or ./dl  or ~/.drjekyll/cache ??
+  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_theme( 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_theme( src, dest_unzip )
+  end
+
+private
+  def fetch_theme( 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_theme( 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 DrJekyll
+

data/lib/drjekyll/version.rb

@@ -4,8 +4,8 @@
 module DrJekyll
 
   MAJOR = 0
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: drjekyll
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: props
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: logutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: fetcher
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +131,10 @@ files:
 - lib/drjekyll/cli/download.rb
 - lib/drjekyll/cli/list.rb
 - lib/drjekyll/cli/main.rb
+- lib/drjekyll/cli/new.rb
 - lib/drjekyll/cli/opts.rb
 - lib/drjekyll/cli/unzip.rb
+- lib/drjekyll/package.rb
 - lib/drjekyll/version.rb
 - test/data/themes.yml
 homepage: https://github.com/drjekyllthemes/drjekyll