manman 0.1.0 → 0.2.0

data/Manifest.txt

@@ -7,3 +7,4 @@ lib/manman.rb
 lib/manman/opts.rb
 lib/manman/runner.rb
 lib/manman/version.rb
+lib/manman/worker.rb

data/README.markdown

@@ -4,10 +4,26 @@ Manifest Manager in Ruby
 
 * [geraldb.github.com/manman](http://geraldb.github.com/manman)
 
+`manman` calculates MD5 digests/hashes for files listed in manifest template.
 
 ## Usage
 
-TBD
+    manman - Manifest Manager
+    
+    Usage: manman [options]
+        -r, --release RELEASE            Release Version (e.g. 2013.08)
+        -e, --env ENV                    Environment (e.g. TEST)
+        -u, --valid_until VALID          Valid until (e.g. 2014.01.31)
+        -d, --dir PATH                   Path to Packages (default is ./paket)
+        -t, --template FILE              Input Template (default is paket.txt.erb)
+        -o, --out FILE                   Output File (default is paket.txt)
+        -v, --version                    Show version
+            --verbose                    Show debug trace
+        -h, --help                       Show this message
+    
+    Examples:
+        manman -r 2013.08 -e TEST
+        manman -r 2013.08 -e TEST -u 2014.12.31
 
 
 ## Install
@@ -17,6 +33,54 @@ Just install the gem:
     $ gem install manman
 
 
+
+
+## MD5 Digest Samples/Notes
+
+### What is MD5?
+
+MD5 is a one-way hashing algorithm for 128 bit (16 byte) digest "signatures" or checksums
+(e.g. `bd2e45b8fde5af0ead14ceb80ce3256a`).
+
+### MD5 Digest for Strings
+
+    require 'digest/md5'
+    
+    digest = Digest::MD5.hexdigest( "Hello MD5 Digest!\n" )
+    puts digest
+    
+    # => bd2e45b8fde5af0ead14ceb80ce3256a
+
+
+### MD5 Digest for Files
+
+    require 'digest/md5'
+    
+    digest = Digest::MD5.hexdigest( File.read( ARGV[0] ) )
+    puts digest
+    
+    # => fc2f4ec029715550401c99a188b904b1
+
+### MD5 Digest Calculation in Steps/Chunks
+
+    require 'digest/md5'
+    
+    all_digest = Digest::MD5.hexdigest( File.read( ARGV[0] ) )
+    
+    inc_digest = Digest::MD5.new
+    file = File.open( ARGV[0], 'r' )
+    file.each_line do |line|
+      inc_digest.update( line )   # or use <<-alias e.g. inc_digest << line
+    end
+    
+    puts inc_digest.hexdigest
+    puts all_digest
+    
+    # => fc2f4ec029715550401c99a188b904b1
+    # => fc2f4ec029715550401c99a188b904b1
+
+
+
 ## License
 
 The `manman` scripts are dedicated to the public domain.

data/Rakefile

@@ -11,7 +11,7 @@ Hoe.spec 'manman' do
   self.urls    = ['http://geraldb.github.com/manman']
   
   self.author  = 'Gerald Bauer'
-  self.email   = 'webslideshow@googlegroups.com'
+  self.email   = 'gerald.bauer@example.com'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.markdown'

data/lib/manman.rb

@@ -18,6 +18,7 @@ require 'digest/md5'
 require 'manman/version'
 require 'manman/opts'
 require 'manman/runner'
+require 'manman/worker'
 
 module Manman
 
@@ -25,10 +26,6 @@ module Manman
     "manman #{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

data/lib/manman/opts.rb

@@ -2,6 +2,45 @@ module Manman
 
 class Opts
 
+  # extra headers for manifest
+  #  - headers get ignored (assumed NOT to be files that get md5 checksum/digest/hash calculated)
+  def headers=(value)
+    # NB: value is supposed to be an array of strings
+    @headers = value
+  end
+
+  ## fix/todo:
+  ##  also make it into a command line option!!
+  
+  def headers
+    # NB: return value is supposed to be an array of strings
+    @headers || []
+  end
+  
+  
+  ## NB: for now pass in an obj, that is, self
+  ##   in the future pass in proc? or something else?? to make it more configurable??
+    
+  def filter_callback=(value)
+    @filter = value
+  end
+  
+  def filter_callback
+    @filter    # NB: has no default; returns nil if not set
+  end
+  
+  def encrypt_callback=(value)
+    @encrypt = value
+  end
+  
+  def encrypt_callback
+    @encrypt    # NB: has no default; returns nil if not set
+  end
+  
+  
+  
+    
+  
   def base=(value)
     @base = value
   end
@@ -54,15 +93,7 @@ class Opts
   def valid
     @valid     # NB: has no default; required arg
   end
-      
  
-  def config_path=(value)
-    @config_path = value
-  end
-  
-  def config_path
-    @config_path || '~/.manman'
-  end
 
 end # class Opts
 

data/lib/manman/runner.rb

@@ -2,9 +2,13 @@ module Manman
 
 class Runner
 
-  def initialize
-    @logger = Logger.new(STDOUT)
-    @logger.level = Logger::INFO
+  def initialize( logger=nil )
+    if logger.nil?
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+    else
+      @logger = logger
+    end
 
     @opts    = Opts.new
   end
@@ -42,11 +46,6 @@ class Runner
       end
       
       
-      
-      cmd.on( '-c', '--config PATH', "Configuration Path (default is #{opts.config_path})" ) do |path|
-        opts.config_path = path
-      end
-    
       cmd.on( '-v', '--version', "Show version" ) do
         puts Manman.banner
         exit
@@ -79,130 +78,24 @@ EOS
     
     # check for required args
     
-    puts "*** Missing Argument: Release Argument Required"      if opts.release.nil?
-    puts "*** Missing Argument: Environment Argument Required"  if opts.env.nil?
-    puts "*** Missing Argument: Environment Argument Required"  if opts.valid.nil?
+    puts "*** Missing Argument: -r/--release Release Argument Required"   if opts.release.nil?
+    puts "*** Missing Argument: -e/--env Argument Required"               if opts.env.nil?
      
-    if opts.release.nil? || opts.env.nil? || opts.valid.nil?
+    if opts.release.nil? || opts.env.nil?
       puts
       puts "Use -h/--help for usage options."
       return    ## exit ??
     end
 
-    puts "Using settings:"
-    pp opts
-    
-    
-    generate_manifest()
-    
-    puts 'Done.'
-    
-  end   # method run
-
-
-
-  def generate_manifest
-
-    puts "  working folder is: #{Dir.pwd}"
-    
-    puts "Loading template #{opts.template}..."
-    
-    old_lines = File.read( opts.template )
-
-    new_lines = []
-
-    header_lines = []
-
+    # puts "Using settings:"
+    # pp opts
     
-    ### todo/fix: move to template  ???
-    header_lines << "####################################################\n"
-    header_lines << "# generated on  #{Time.now} using  #{Manman.banner}\n"
-    header_lines << "# - version: #{opts.release}, env: #{opts.env}, valid until: #{opts.valid}\n"
-  
-    old_lines.each_line do |line|
-  
-      if line =~ /^\s*#/
-        # skip komments and do NOT copy to result (keep comments secret!)
-        logger.debug 'skipping comment line'
-        next
-      end
+    worker = Worker.new( logger, opts )
+    worker.run
         
-      if line =~ /^\s*$/ 
-        # kommentar oder leerzeile überspringen 
-        logger.debug 'skipping blank line'
-        new_lines << line
-        next
-      end
-  
-      # split/process key value pair
-  
-      tokens = line.split( ':' )
-  
-      key    = tokens[0]
-      values = tokens[1]
-
-      
-      ## special keys (NOT files; do NOT calculate md5 digest)
-      
-      ## todo: make headers configurable
-     
-      if [ 'VERSION', 'UMGEBUNG', 'MANDANT', 'GUELTIG_BIS', 'CHECKSUM' ].include?( key )
-        if key == 'VERSION'
-          new_lines << "#{key}: #{opts.release}\n"
-        elsif key == 'UMGEBUNG'
-          new_lines << "#{key}: #{opts.env}\n"
-        elsif key == 'GUELTIG_BIS'
-          new_lines << "#{key}: #{opts.valid}\n"
-        else
-          new_lines << line     ## just pass header line throug; not modified
-        end
-        next
-      end
-
-      ### calculate md5 digests
-      
-      md5 = ""  
-      fn = "#{opts.base}/#{key}"   # filename
-      
-      if File.exists?( fn ) == false
-        md5 = "xxxxxxx"
-        msg = "*** ERROR: #{key} missing; using path #{fn}"
-        puts msg
-        header_lines << "#  #{msg}\n"     # add error to header in manifest
-      else
-        md5 = calc_digest_md5( fn )
-        puts "OK #{key} -> #{md5}"
-      end
-      
-      new_lines << "#{key}: #{md5}, #{values}"
-             
-    end # oldlines.each
-
-
-    header_lines << "#####################################\n"
-    header_lines << "\n"
-
-    new_lines = header_lines + new_lines
-
-    File.open( opts.output, 'w') do |f|
-      new_lines.each do |line|
-        f.write( line )
-      end
-    end
+    # puts 'Done.'
     
-  end # method generate_manifest
-
-
-  def calc_digest_md5( fn )
-    # digest/hash is a string of 20 hexadecimal 8-bit numbers
-    # example:
-    #   5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8
-  
-    md5 = Digest::MD5.hexdigest( File.open( fn, 'rb') { |f| f.read } )
-    md5
-  end
-
-
+  end   # method run
 
 end # class Runner
 end # module Manman

data/lib/manman/version.rb

@@ -1,4 +1,4 @@
 
 module Manman
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/manman/worker.rb

@@ -0,0 +1,189 @@
+module Manman
+
+class Worker
+
+  def initialize( logger=nil, opts=nil )
+    if logger.nil?    
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+    else
+      @logger = logger
+    end
+
+    if opts.nil?
+      @opts    = Opts.new
+    else
+      @opts = opts
+    end
+  end
+
+  attr_reader :logger, :opts
+
+  
+  def run
+    puts "Using settings:"
+    pp opts
+    
+    generate_manifest()
+    
+    puts 'Done.'
+  end   # method run
+
+
+  def generate_manifest
+
+    puts "  working folder is: #{Dir.pwd}"
+    
+    puts "Loading template #{opts.template}..."
+    
+    old_lines = File.read( opts.template )
+
+    new_lines = []
+
+    header_lines = []
+
+    
+    ### todo/fix: move to template  ???
+    header_lines << "####################################################\n"
+    header_lines << "# generated on  #{Time.now} using  #{Manman.banner}\n"
+    header_lines << "# - version: #{opts.release}, env: #{opts.env}\n"
+  
+    old_lines.each_line do |line|
+  
+      if line =~ /^\s*#/
+        # skip komments and do NOT copy to result (keep comments secret!)
+        logger.debug 'skipping comment line'
+        next
+      end
+        
+      if line =~ /^\s*$/ 
+        # kommentar oder leerzeile überspringen 
+        logger.debug 'skipping blank line'
+        new_lines << line
+        next
+      end
+  
+      # split/process key value pair
+  
+      tokens = line.split( ':' )
+  
+      key    = tokens[0]
+      values = tokens[1]
+
+      ## special keys (NOT files; do NOT calculate md5 digest)
+     
+      headers_release  = [ 'RELEASE', 'VERSION' ]
+      headers_env      = [ 'ENV', 'UMGEBUNG' ]
+      headers_valid    = [ 'VALID_UNTIL', 'GUELTIG_BIS' ]
+      headers_checksum = [ 'CHECKSUM' ]
+     
+      headers = headers_release + headers_env + headers_valid + headers_checksum
+      headers += opts.headers   # add possible user defined extra headers
+     
+      if headers.include?( key )
+        if headers_release.include?( key )
+          new_lines << "#{key}: #{opts.release}\n"
+        elsif headers_env.include?( key )
+          new_lines << "#{key}: #{opts.env}\n"
+        elsif headers_valid.include?( key )
+          new_lines << "#{key}: #{opts.valid}\n"
+        else    # assume extra headers or checksum
+          new_lines << line     ## just pass header line throug; not modified
+        end
+        next
+      end
+
+      ### calculate md5 digests
+      
+      md5 = ""  
+      fn = "#{opts.base}/#{key}"   # filename
+      
+      if File.exists?( fn ) == false
+        md5 = "xxxxxxx"
+        msg = "*** ERROR: #{key} missing; using path #{fn}"
+        puts msg
+        header_lines << "#  #{msg}\n"     # add error to header in manifest
+      else
+        md5 = calc_digest_md5( fn )
+        puts "OK #{key} -> #{md5}"
+      end
+      
+      new_lines << "#{key}: #{md5}, #{values}"
+             
+    end # oldlines.each
+
+
+    header_lines << "#####################################\n"
+    header_lines << "\n"
+
+    new_lines = header_lines + new_lines
+
+    # lines all in one string (no array/ary of lines)
+    new_lines_all_in_one = ""
+    new_lines.each do |line|
+      new_lines_all_in_one << line
+    end
+
+    puts "[debug] new_lines_all_in_one:"
+    puts new_lines_all_in_one
+    
+    ## allow custom filter (lets you add custom headers,checksums,etc.)
+    new_lines_all_in_one = filter_callback( new_lines_all_in_one )
+
+    ## last step - calculate checksum
+    new_lines_all_in_one = generate_checksum( new_lines_all_in_one )
+    
+    File.open( opts.output, 'w') do |f|
+      f.write( new_lines_all_in_one )
+    end
+    
+  end # method generate_manifest
+
+
+  def encrypt_callback( text )
+    if opts.encrypt_callback.nil?    
+      puts "[debug] no encrypt callback configured"
+      text   # pass through; identity; do nothing
+    else
+      opts.encrypt_callback.encrypt_callback( text )
+    end
+  end
+
+  def filter_callback( text )
+    if opts.filter_callback.nil?
+      puts "[debug] no filter callback configured"     
+      text
+    else
+      opts.filter_callback.filter_callback( text )
+    end
+  end
+
+  def generate_checksum( text )
+
+    # NB: remove possible old checksum in checksum line w/ empty line before md5 calculation
+    hash = Digest::MD5.hexdigest( text.gsub( /^CHECKSUM:.*/, '' ) )
+    puts "Paket-Hash >#{hash}<"
+    encrypted_hash = encrypt_callback( hash )
+
+    ## use strip why? why not?
+    ##  was encrypted_hash.strip
+ 
+    text.gsub( /^CHECKSUM:.*/, "CHECKSUM: #{encrypted_hash}" )
+  end
+
+  def calc_digest_md5( fn )
+    # digest/hash is a string of 20 hexadecimal 8-bit numbers
+    # example:
+    #   5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8
+  
+    ## NB: use b - binary
+    #  required for Windows-only (avoids changing of newlines \n to \n\r or similar)
+  
+    md5 = Digest::MD5.hexdigest( File.open( fn, 'rb') { |f| f.read } )
+    md5
+  end
+
+
+
+end # class Worker
+end # module Manman

metadata

@@ -1,61 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: manman
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rdoc
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &17647704 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 10
-        version: "3.10"
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *17647704
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &17647416 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *17647416
 description: manman - Manifest Manager
-email: webslideshow@googlegroups.com
-executables: 
+email: gerald.bauer@example.com
+executables:
 - manman
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - Manifest.txt
-files: 
+files:
 - History.markdown
 - Manifest.txt
 - README.markdown
@@ -65,39 +50,31 @@ files:
 - lib/manman/opts.rb
 - lib/manman/runner.rb
 - lib/manman/version.rb
+- lib/manman/worker.rb
 homepage: http://geraldb.github.com/manman
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.markdown
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: manman
-rubygems_version: 1.8.24
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: manman - Manifest Manager
 test_files: []
-