pakman 0.1.0 → 0.2.0

data/README.markdown

@@ -2,10 +2,51 @@
 
 * [geraldb.github.com/pakman](http://geraldb.github.com/pakman)
 
-## Usage
+## Usage - Ruby Code
 
-TBD
+Fetch a template pack:
 
+```ruby
+Pakman::Fetcher.new( logger ).fetch_pak( src, pakpath )
+```
+
+Copy a template pack from your cache:
+
+```ruby
+Pakman::Copier.new( logger ).copy_pak( src, pakpath )
+```
+
+List all template packs in your cache (using passed in search path):
+
+```ruby
+patterns  = [
+  "#{File.expand_path('~/.pak')}/*.txt",
+  "#{File.expand_path('~/.pak')}/*/*.txt",
+  "*.txt",
+  "*/*.txt"
+]
+
+Pakman::Finder.new( logger ).find_manifests( patterns )
+```
+
+
+## Usage - Command Line
+
+The `pakman` gem includes a little command line tool. Try `pakman -h` for details:
+
+```
+pakman - Lets you manage template packs.
+
+Usage: pakman [options]
+    -f, --fetch URI                  Fetch Templates
+    -t, --template MANIFEST          Generate Templates
+    -l, --list                       List Installed Templates
+    -c, --config PATH                Configuration Path (default is ~/.pak)
+    -o, --output PATH                Output Path (default is .)
+    -v, --version                    Show version
+        --verbose                    Show debug trace
+    -h, --help                       Show this message
+```
 
 ## Install
 

data/lib/pakman/cli/commands/list.rb

@@ -21,8 +21,12 @@ class List
     end
     puts '  include:'
     
-    manifests.each do |manifest|
-      puts "%16s (%s)" % [manifest[0], manifest[1]]
+    if manifests.empty?
+      puts "    -- none --"    
+    else
+      manifests.each do |manifest|
+        puts "%16s (%s)" % [manifest[0], manifest[1]]
+      end
     end
   end
 

data/lib/pakman/cli/helpers.rb

@@ -26,7 +26,12 @@ module ManifestHelper
   end
 
   def installed_template_manifests
-    Finder.new( logger ).find_manifests( installed_template_manifest_patterns )
+    excludes = [
+      "Manifest.txt",
+      "*/Manifest.txt"
+    ]    
+    
+    Finder.new( logger ).find_manifests( installed_template_manifest_patterns, excludes )
   end
 
 end # module ManifestHelper

data/lib/pakman/copier.rb

@@ -10,26 +10,37 @@ class Copier
 
   def copy_pak( manifestsrc, pakpath )
 
+    start = Time.now
+
+    # downcase and remove .txt (if anywhere in name)
+    # e.g. welcome.quick.txt becomes welcome.quick
+    #      welcome.txt.quick becomse welcome.quick
+    pakname = File.basename( manifestsrc ).downcase.gsub( '.txt', '' )
+
+    puts "Copying template pack '#{pakname}'"
+
     manifest = Manifest.load_file( logger, manifestsrc )
 
     # expand output path in current dir (if relative) and make sure output path exists
     outpath = File.expand_path( pakpath )
     logger.debug "outpath=#{outpath}"
-    FileUtils.makedirs( outpath ) unless File.directory? outpath
+    FileUtils.makedirs( outpath ) unless File.directory?( outpath )
 
     manifest.each do |entry|
       dest   = entry[0]
       source = entry[1]
                   
-      puts "Copying to #{dest} from #{source}..."
+      puts "  Copying to #{dest} from #{source}..."
       FileUtils.copy( source, with_output_path( dest, outpath ) )
     end
     
-    puts "Done."
+    puts "Done (in #{Time.now-start} s)."
   end # method copy_pak
 
 private
 
+   ############################
+   ## fix/todo: cleanup needed
    ## fix: remove with_output_path helper (code it directly w/o helper)
 
    def with_output_path( dest, output_path )

data/lib/pakman/fetcher.rb

@@ -11,6 +11,8 @@ class Fetcher
 
   def fetch_pak( manifestsrc, pakpath )
 
+    start = Time.now
+
     # src = 'http://github.com/geraldb/slideshow/raw/d98e5b02b87ee66485431b1bee8fb6378297bfe4/code/templates/fullerscreen.txt'
     # src = 'http://github.com/geraldb/sandbox/raw/13d4fec0908fbfcc456b74dfe2f88621614b5244/s5blank/s5blank.txt'
     uri = URI.parse( manifestsrc )
@@ -18,22 +20,25 @@ class Fetcher
     logger.debug "scheme: #{uri.scheme}, host: #{uri.host}, port: #{uri.port}, path: #{uri.path}"
   
     dirname  = File.dirname( uri.path )
-    basename = File.basename( uri.path, '.*' ) # e.g. fullerscreen     (without extension)
     filename = File.basename( uri.path )       # e.g. fullerscreen.txt (with extension)
 
-    logger.debug "dirname: #{dirname}"
-    logger.debug "basename: #{basename}, filename: #{filename}"
+    # downcase and remove .txt (if anywhere in name)
+    # e.g. welcome.quick.txt becomes welcome.quick
+    #      welcome.txt.quick becomse welcome.quick
+    pakname = File.basename( uri.path ).downcase.gsub( '.txt', '' )
+
+    logger.debug "dirname >#{dirname}<"
+    logger.debug "pakname >#{pakname}<, filename >#{filename}<"
 
     dlbase = "#{uri.scheme}://#{uri.host}:#{uri.port}#{dirname}"
-  
     logger.debug "dlpath: #{dlbase}"
     logger.debug "pakpath: #{pakpath}"
-  
-    FileUtils.makedirs( pakpath ) unless File.directory? pakpath
-   
-    puts "Fetching template package '#{basename}'"
-    puts "  : from '#{dlbase}'"
-    puts "  : saving to '#{pakpath}'"
+
+    FileUtils.makedirs( pakpath ) unless File.directory?( pakpath )
+
+    puts "Fetching template pack '#{pakname}'"
+    puts "    from '#{dlbase}'"
+    puts "    saving to '#{pakpath}'"
   
     # download manifest
     dest = "#{pakpath}/#{filename}"
@@ -52,7 +57,7 @@ class Fetcher
 
         # make sure path exists
         destpath = File.dirname( dest )
-        FileUtils.makedirs( destpath ) unless File.directory? destpath
+        FileUtils.makedirs( destpath ) unless File.directory?( destpath )
     
         src = "#{dlbase}/#{file}"
     
@@ -60,7 +65,7 @@ class Fetcher
         fetch_file( src, dest )
       end
     end   
-    puts "Done."
+    puts "Done (in #{Time.now-start} s)."
   end # method fetch_pak
 
 private

data/lib/pakman/finder.rb

@@ -8,20 +8,39 @@ class Finder
     @logger = logger
   end
 
-  def find_manifests( patterns )
+  def find_manifests( patterns, excludes=[] )
     manifests = []
     
     patterns.each do |pattern|
       pattern.gsub!( '\\', '/')  # normalize path; make sure all path use / only
-      logger.debug "Checking #{pattern}"
+      logger.debug "Checking >#{pattern}<"
       Dir.glob( pattern ) do |file|
-        logger.debug "  Found manifest: #{file}"
-        manifests << [ File.basename( file ), file ]
+        logger.debug "  Found manifest candidate >#{file}<"
+        if File.directory?( file ) # NB: do not include directories
+          logger.debug "  Skipping match; it's a directory"
+        else
+          unless exclude?( file, excludes )  # check for excludes; skip if excluded
+            logger.debug "  Adding match >#{file}<"
+            manifests << [ File.basename( file ), file ]
+          end
+        end
       end
     end
     
     manifests
   end
+  
+private
+  def exclude?( file, excludes )
+    excludes.each do |pattern|
+      ## todo: FNM_DOTMATCH helps or not?? (make up some tests??)
+      if File.fnmatch?( pattern, file, File::FNM_CASEFOLD | File::FNM_DOTMATCH )
+        logger.debug "  Skipping match; it's excluded by pattern >#{pattern}<"         
+        return true
+      end
+    end
+    false
+  end
 
 end # class Finder
 end # module Pakman

data/lib/pakman/version.rb

@@ -1,3 +1,3 @@
 module Pakman
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pakman
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-18 00:00:00 Z
+date: 2012-06-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fetcher