pakman 0.0.1 → 0.1.0

data/Manifest.txt

@@ -2,4 +2,16 @@ History.markdown
 Manifest.txt
 README.markdown
 Rakefile
+bin/pakman
 lib/pakman.rb
+lib/pakman/cli/commands/fetch.rb
+lib/pakman/cli/commands/gen.rb
+lib/pakman/cli/commands/list.rb
+lib/pakman/cli/helpers.rb
+lib/pakman/cli/opts.rb
+lib/pakman/cli/runner.rb
+lib/pakman/copier.rb
+lib/pakman/fetcher.rb
+lib/pakman/finder.rb
+lib/pakman/manifest.rb
+lib/pakman/version.rb

data/Rakefile

@@ -1,5 +1,5 @@
 require 'hoe'
-require './lib/pakman.rb'
+require './lib/pakman/version.rb'
 
 Hoe.spec 'pakman' do
   
@@ -12,6 +12,10 @@ Hoe.spec 'pakman' do
   
   self.author  = 'Gerald Bauer'
   self.email   = 'webslideshow@googlegroups.com'
+  
+  self.extra_deps = [
+    ['fetcher','>= 0.1.0']
+  ]
     
   # switch extension to .rdoc for gihub formatting
   self.readme_file  = 'README.markdown'

data/bin/pakman

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/pakman
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/pakman
+#
+
+require 'pakman'
+
+Pakman.main

data/lib/pakman.rb

@@ -1,3 +1,52 @@
+###
+# NB: for local testing run like:
+#
+# 1.8.x: ruby -Ilib -rrubygems lib/pakman.rb
+# 1.9.x: ruby -Ilib lib/pakman.rb
+
+# core and stlibs
+
+require 'yaml'
+require 'pp'
+require 'logger'
+require 'optparse'
+require 'fileutils'
+
+# rubygems
+
+require 'fetcher'   # fetch (download) files
+
+# our own code
+
+require 'pakman/copier'
+require 'pakman/fetcher'
+require 'pakman/finder'
+require 'pakman/manifest'
+require 'pakman/version'
+
+require 'pakman/cli/helpers'
+require 'pakman/cli/opts'
+require 'pakman/cli/runner'
+require 'pakman/cli/commands/fetch'
+require 'pakman/cli/commands/gen'
+require 'pakman/cli/commands/list'
+
+
 module Pakman
-  VERSION = '0.0.1'
-end
+
+  def self.banner
+    "pakman #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
+  end
+
+  def self.main
+    Runner.new.run(ARGV)
+  end
+
+end  # module Pakman
+
+
+Pakman.main if __FILE__ == $0

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

@@ -0,0 +1,33 @@
+module Pakman
+
+class Fetch
+
+  def initialize( logger, opts )
+    @logger  = logger
+    @opts    = opts
+  end
+
+  attr_reader :logger, :opts
+
+
+  def run
+    logger.debug "fetch_uri=#{opts.fetch_uri}"
+    
+    src = opts.fetch_uri
+     
+    # 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( src )
+    logger.debug "scheme: #{uri.scheme}, host: #{uri.host}, port: #{uri.port}, path: #{uri.path}"
+    
+    basename = File.basename( uri.path, '.*' ) # e.g. fullerscreen     (without extension)
+    logger.debug "basename: #{basename}"  
+
+    pakpath = File.expand_path( "#{opts.config_path}/#{basename}" )
+    logger.debug "pakpath: #{pakpath}"
+
+    Fetcher.new( logger ).fetch_pak( src, pakpath )
+  end # method run
+
+end # class Fetch
+end # module Pakman

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

@@ -0,0 +1,42 @@
+module Pakman
+
+class Gen
+  
+  include ManifestHelper
+
+  def initialize( logger, opts )
+    @logger  = logger
+    @opts    = opts
+  end
+
+  attr_reader :logger, :opts
+
+  def run
+    manifest_name = opts.manifest
+    
+    # add .txt file extension if missing (for convenience)
+    ## fix: might not work with impress.js or deck.js
+    ##  check if extname is txt and add it to become deck.js.txt etc.
+    manifest_name << ".txt"   if File.extname( manifest_name ).empty?
+    
+    logger.debug "manifest=#{manifest_name}"
+    
+    manifests = installed_template_manifests
+    
+    # check for builtin generator manifests
+    matches = manifests.select { |m| m[0] == manifest_name }
+    
+    if matches.empty?
+      puts "*** error: unknown template manifest '#{manifest_name}'"
+      # todo: list installed manifests
+      exit 2
+    end
+        
+    manifestsrc = matches[0][1]
+    pakpath     = opts.output_path
+    
+    Copier.new( logger ).copy_pak( manifestsrc, pakpath )
+  end
+
+end # class Gen
+end # module Pakman

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

@@ -0,0 +1,30 @@
+module Pakman
+
+class List
+
+  include ManifestHelper
+
+  def initialize( logger, opts )
+    @logger  = logger
+    @opts    = opts
+  end
+
+  attr_reader :logger, :opts
+
+  def run
+    manifests = installed_template_manifests
+    
+    puts 'Installed template packs in search path'
+    
+    installed_template_manifest_patterns.each_with_index do |pattern,i|
+      puts "    [#{i+1}] #{pattern}"
+    end
+    puts '  include:'
+    
+    manifests.each do |manifest|
+      puts "%16s (%s)" % [manifest[0], manifest[1]]
+    end
+  end
+
+end # class List
+end # module Pakman

data/lib/pakman/cli/helpers.rb

@@ -0,0 +1,33 @@
+module Pakman
+
+module ManifestHelper
+
+  def installed_template_manifest_patterns
+    # 1) search .    # that is, working/current dir
+    # 2) search <config_dir>
+    # 3) search <gem>/templates
+
+    builtin_patterns = [
+      "#{Pakman.root}/templates/*.txt"
+    ]
+    config_patterns  = [
+      "#{File.expand_path(opts.config_path)}/*.txt",
+      "#{File.expand_path(opts.config_path)}/*/*.txt"
+    ]
+    current_patterns = [
+      "*.txt",
+      "*/*.txt"
+    ]
+    
+    patterns = []
+    patterns += current_patterns
+    patterns += config_patterns
+    patterns += builtin_patterns
+  end
+
+  def installed_template_manifests
+    Finder.new( logger ).find_manifests( installed_template_manifest_patterns )
+  end
+
+end # module ManifestHelper
+end # module Pakman

data/lib/pakman/cli/opts.rb

@@ -0,0 +1,66 @@
+module Pakman
+
+class Opts
+
+  def list=(value)
+    @list = value
+  end
+  
+  def list?
+    return false if @list.nil?  # default list flag is false
+    @list == true
+  end
+
+
+  def generate=(value)
+    @generate = value
+  end
+
+  def generate?
+    return false if @generate.nil?   # default generate flag is false
+    @generate == true
+  end
+
+
+  def fetch_uri=(value)
+    @fetch_uri = value
+  end
+
+  def fetch_uri
+    @fetch_uri || '-fetch uri required-'
+  end
+  
+  def fetch?
+    @fetch_uri.nil? ? false : true
+  end
+
+
+  def manifest=(value)
+    @manifest = value
+  end
+  
+  ## fix:/todo: use a different default manifest
+  def manifest
+    @manifest || 's6.txt'
+  end
+
+
+  def config_path=(value)
+    @config_path = value
+  end
+  
+  def config_path
+    @config_path || '~/.pak'
+  end
+
+
+  def output_path=(value)
+    @output_path = value
+  end
+  
+  def output_path
+    @output_path || '.'
+  end
+
+end # class Opts
+end # module Pakman

data/lib/pakman/cli/runner.rb

@@ -0,0 +1,89 @@
+module Pakman
+
+class Runner
+
+  def initialize
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+
+    @opts    = Opts.new
+  end
+
+  attr_reader :logger, :opts
+
+  def run( args )
+    opt=OptionParser.new do |cmd|
+    
+      cmd.banner = "Usage: pakman [options]"
+
+      cmd.on( '-f', '--fetch URI', 'Fetch Templates' ) do |uri|
+        opts.fetch_uri = uri
+      end
+
+      cmd.on( '-t', '--template MANIFEST',  'Generate Templates' ) do |manifest|
+        opts.generate = true
+        opts.manifest = manifest
+      end
+    
+      cmd.on( '-l', '--list', "List Installed Templates" ) { opts.list = true }
+
+      cmd.on( '-c', '--config PATH', "Configuration Path (default is #{opts.config_path})" ) do |path|
+        opts.config_path = path
+      end
+    
+      cmd.on( '-o', '--output PATH', "Output Path (default is #{opts.output_path})" ) { |path| opts.output_path = path }
+
+      cmd.on( '-v', '--version', "Show version" ) do
+        puts Pakman.banner
+        exit
+      end
+
+      cmd.on( "--verbose", "Show debug trace" )  do
+        logger.datetime_format = "%H:%H:%S"
+        logger.level = Logger::DEBUG
+      end
+
+      cmd.on_tail( "-h", "--help", "Show this message" ) do
+        puts <<EOS
+
+pakman - Lets you manage template packs.
+
+#{cmd.help}
+
+Examples:
+    pakman -f URI                             # to be done
+    pakman -f URI  -c ~/.slideshow/templates
+
+    pakman -l                                 # to be done
+    pakman -l -c ~/.slideshow/templates
+
+    pakman -t s6
+    pakman -t s6 -o o
+    pakman -t s6 -c ~/.slideshow/templates
+
+Further information:
+  http://geraldb.github.com/pakman
+  
+EOS
+        exit
+      end
+    end
+
+    opt.parse!( args )
+  
+    puts Pakman.banner
+    
+    if opts.list?
+      List.new( logger, opts ).run
+    elsif opts.generate?
+      Gen.new( logger, opts ).run
+    elsif opts.fetch?
+      Fetch.new( logger, opts ).run
+    else
+      puts "-- No command do nothing for now.  --"  ## run help??
+      puts "Done."
+    end
+  end   # method run
+
+end # class Runner
+end # module Pakman

data/lib/pakman/copier.rb

@@ -0,0 +1,47 @@
+module Pakman
+
+class Copier
+
+  attr_reader :logger
+    
+  def initialize( logger )
+    @logger   = logger
+  end
+
+  def copy_pak( manifestsrc, pakpath )
+
+    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
+
+    manifest.each do |entry|
+      dest   = entry[0]
+      source = entry[1]
+                  
+      puts "Copying to #{dest} from #{source}..."
+      FileUtils.copy( source, with_output_path( dest, outpath ) )
+    end
+    
+    puts "Done."
+  end # method copy_pak
+
+private
+
+   ## fix: remove with_output_path helper (code it directly w/o helper)
+
+   def with_output_path( dest, output_path )
+    dest_full = File.expand_path( dest, output_path )
+    logger.debug "dest_full=#{dest_full}"
+      
+    # make sure dest path exists
+    dest_path = File.dirname( dest_full )
+    logger.debug "dest_path=#{dest_path}"
+    FileUtils.makedirs( dest_path ) unless File.directory? dest_path
+    dest_full
+  end
+
+end # class Copier
+end # module Pakman

data/lib/pakman/fetcher.rb

@@ -0,0 +1,76 @@
+module Pakman
+
+class Fetcher
+
+  attr_reader :logger
+    
+  def initialize( logger )
+    @logger   = logger
+  end
+
+
+  def fetch_pak( manifestsrc, pakpath )
+
+    # 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 )
+  
+    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}"
+
+    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}'"
+  
+    # download manifest
+    dest = "#{pakpath}/#{filename}"
+
+    puts "  Downloading manifest '#{filename}'..."
+
+    fetch_file( manifestsrc, dest )
+
+    manifest = Manifest.load_file_core( logger, dest )
+      
+    # download templates listed in manifest
+    manifest.each do |values|
+      values[1..-1].each do |file|
+      
+        dest = "#{pakpath}/#{file}"
+
+        # make sure path exists
+        destpath = File.dirname( dest )
+        FileUtils.makedirs( destpath ) unless File.directory? destpath
+    
+        src = "#{dlbase}/#{file}"
+    
+        puts "  Downloading template '#{file}'..."
+        fetch_file( src, dest )
+      end
+    end   
+    puts "Done."
+  end # method fetch_pak
+
+private
+
+  def fetch_file( src, dest )
+     ## note: code moved to its own gem, that is, fetcher
+     ## see https://github.com/geraldb/fetcher
+    
+    ::Fetcher::Worker.new( logger ).copy( src, dest )
+  end
+
+end # class Fetcher
+end # module Pakman

data/lib/pakman/finder.rb

@@ -0,0 +1,27 @@
+module Pakman
+
+class Finder
+
+  attr_reader :logger
+    
+  def initialize( logger )
+    @logger = logger
+  end
+
+  def find_manifests( patterns )
+    manifests = []
+    
+    patterns.each do |pattern|
+      pattern.gsub!( '\\', '/')  # normalize path; make sure all path use / only
+      logger.debug "Checking #{pattern}"
+      Dir.glob( pattern ) do |file|
+        logger.debug "  Found manifest: #{file}"
+        manifests << [ File.basename( file ), file ]
+      end
+    end
+    
+    manifests
+  end
+
+end # class Finder
+end # module Pakman

data/lib/pakman/manifest.rb

@@ -0,0 +1,73 @@
+module Pakman
+
+class Manifest
+
+  attr_reader :logger
+    
+  def initialize( logger )
+    @logger   = logger
+    @manifest = []
+  end
+
+  def self.load_file_core( logger, path )
+    obj = self.new( logger )
+    obj.load_file_core_worker( path )
+    obj
+  end
+  
+  def self.load_file( logger, path )
+    obj = self.new( logger )
+    obj.load_file_worker( path )
+    obj
+  end
+
+  def each
+    @manifest.each { |ary| yield ary }
+  end
+
+
+
+  def load_file_core_worker( path )
+    @manifest = []
+  
+    File.open( path ).readlines.each_with_index do |line,i|
+      case line
+      when /^\s*$/
+        # skip empty lines
+      when /^\s*#.*$/
+        # skip comment lines
+      else
+        logger.debug "line #{i+1}: #{line.strip}"
+        values = line.strip.split( /[ <,+]+/ )
+        
+        # add source for shortcuts (assumes relative path; if not issue warning/error)
+        values << values[0] if values.size == 1
+                
+        @manifest << values
+      end
+    end
+  end
+
+  def load_file_worker( path )
+    filename = path
+ 
+    puts "  Loading template manifest #{filename}..."  
+    load_file_core_worker( filename )
+    
+    # post-processing
+    # normalize all source paths (1..-1) /make full path/add template dir
+
+    templatesdir = File.dirname( path )
+    logger.debug "templatesdir=#{templatesdir}"
+
+    @manifest.each do |values|
+      (1..values.size-1).each do |i|
+        values[i] = "#{templatesdir}/#{values[i]}"
+        logger.debug "  path[#{i}]=>#{values[i]}<"
+      end
+    end
+  end
+
+
+end  # class Manifest
+end  # module Pakman

data/lib/pakman/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pakman
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -15,12 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-17 00:00:00 Z
+date: 2012-06-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: fetcher
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,11 +47,11 @@ dependencies:
         - 10
         version: "3.10"
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,11 +62,11 @@ dependencies:
         - 0
         version: "3.0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: pakman - Template Pack Manager
 email: webslideshow@googlegroups.com
-executables: []
-
+executables: 
+- pakman
 extensions: []
 
 extra_rdoc_files: 
@@ -60,7 +76,19 @@ files:
 - Manifest.txt
 - README.markdown
 - Rakefile
+- bin/pakman
 - lib/pakman.rb
+- lib/pakman/cli/commands/fetch.rb
+- lib/pakman/cli/commands/gen.rb
+- lib/pakman/cli/commands/list.rb
+- lib/pakman/cli/helpers.rb
+- lib/pakman/cli/opts.rb
+- lib/pakman/cli/runner.rb
+- lib/pakman/copier.rb
+- lib/pakman/fetcher.rb
+- lib/pakman/finder.rb
+- lib/pakman/manifest.rb
+- lib/pakman/version.rb
 homepage: http://geraldb.github.com/pakman
 licenses: []