mast 1.0.0 → 1.1

data/MANIFEST

@@ -1,23 +1,20 @@
-#!mast bin lib meta test [A-Z]*
-bin
+HISTORY.rdoc
+LICENSE
+MANIFEST
+README.rdoc
 bin/mast
-lib
 lib/mast
+lib/mast.rb
 lib/mast/cli.rb
 lib/mast/core_ext.rb
 lib/mast/manifest.rb
-lib/mast.rb
-meta
 meta/authors
 meta/contact
 meta/description
+meta/homepage
+meta/namespace
 meta/package
-meta/project
+meta/repository
 meta/ruby
 meta/sitemap
-meta/version
-test
-TUTORIAL.rdoc
-HISTORY.rdoc
-LICENSE
-README.rdoc
+meta/version

data/README.rdoc

@@ -1,7 +1,7 @@
 = Mast
 
-* http://proutils.rubyforge.org
-* http://protuils.rubyforge.org/mast
+* home:   http://proutils.github.com/mast
+* source: http://github.com/proutils/mast
 
 
 == DESCRIPTION
@@ -11,7 +11,7 @@ It can be useful in conjunction with packaging tools (such as Box), or as a stan
 tool for monitoring file changes.
 
 
-== FEATURES/ISSUES
+== FEATURES
 
 * Self-referential header makes updating manifests easy.
 * Checksum lists can highlight changes to current files.
@@ -24,11 +24,86 @@ Please see the HISTORY.rdoc file.
 
 == SYNOPSIS
 
-Usage is fairly straight forward.
+Mast is a convenient commandline tool for generating manifest and file hash lists.
+It makes the process very simple, and even allows manifests to be updated
+without repeating inclusion/exclusion criteria by storing the command parameters
+in a comment line at the top of the generated output.
 
-  $ mast **/*
+Lets try a simple example. Lets say we have the following folder structure:
 
-Please see the TUTORIAL file for further details.
+    $ ls -R
+    .:
+    demo_rtar  mint
+
+    ./demo_rtar:
+    Lorem_ipsum.txt  lib  meta  web
+
+    ./demo_rtar/lib:
+    demo_rock
+
+    ./demo_rtar/lib/demo_rock:
+    tryme.rb
+
+    ./demo_rtar/meta:
+    data
+
+    ./demo_rtar/web:
+    index.html  rocklobster.jpg
+
+    ./mint:
+    loremipsum.txt  tryme.rb
+
+Now lets look at the same folder via 'mast'.
+
+    $ mast
+    #!mast
+    demo_rtar
+    demo_rtar/Lorem_ipsum.txt
+    demo_rtar/lib
+    demo_rtar/lib/demo_rock
+    demo_rtar/lib/demo_rock/tryme.rb
+    demo_rtar/meta
+    demo_rtar/meta/data
+    demo_rtar/web
+    demo_rtar/web/index.html
+    demo_rtar/web/rocklobster.jpg
+    mint
+    mint/loremipsum.txt
+    mint/tryme.rb
+
+As you can see it has listed all the files contained in the current folder. Notice also the first
+line is empty except for the '#' character. This is a standard shell comment mark. We can specify
+special criteria to the mast command and these options will be reflected on this line. For example,
+lets say the mint directory is extraneous and we do not want it included in the list of files.
+
+    $ mast -x mint
+    #!mast -x mint
+    demo_rtar
+    demo_rtar/Lorem_ipsum.txt
+    demo_rtar/lib
+    demo_rtar/lib/demo_rock
+    demo_rtar/lib/demo_rock/tryme.rb
+    demo_rtar/meta
+    demo_rtar/meta/data
+    demo_rtar/web
+    demo_rtar/web/index.html
+    demo_rtar/web/rocklobster.jpg
+
+So you can see how the commandline options carry over to the top comment line of the ouput. The advantage of
+this is that if you save the output to a standard location, ie. a file named MANIFEST or meta/manifest with
+an optional .txt prefix (case insensitive), then you can automaitcally update the file by calling +mast update+.
+
+    $ mast -x mint > MANIFEST
+    $ mast update
+    MANIFEST updated.
+
+You can also add a checksum to the file list.
+
+    $ mast -x mint -g sha1
+
+Mast also provides options for ignoring files based on their basename, as well
+as omitting default excludes and ignores so that all files are lists. Use the
+--help option for more details.
 
 
 == HOW TO INSTALL
@@ -47,11 +122,11 @@ then download the tarball package and type:
 Windows users use 'ruby setup.rb all'.
 
 
-== LICENSE
+== COPYRIGHT
 
 Copyright (c) 2009 Thomas Sawyer <transfire@gmail.com>
 
-This program is ditributed unser the terms of the GPL license.
+This program is ditributed unser the terms of the MIT license.
 
-See COPYING file for details.
+See LICENSE or COPYING file for details.
 

data/lib/mast.rb

@@ -1 +1,5 @@
+module Mast
+  VERSION = "1.1" #:till: VERSION="<%= version %>"
+end
+
 require 'mast/manifest'

data/lib/mast/cli.rb

@@ -18,18 +18,20 @@
 #  Commands:
 #    -c --create         Generate a new manifest. (default)
 #    -u --update         Update an existing manifest.
-#    -l --list           List the files give in the manifest file. (Use -f to specify an alternate file.)
-#    -s --show           Show all files that would appear in the manifest file if it were updated.
+#    -l --list           List the files given in the manifest file. (Use -f to specify an alternate file.)
 #    -d --diff           Diff manifest file against actual.
 #    -n --new            List existant files that are not given in the manifest.
 #    -o --old            List files given in the manifest but are non-existent.
 #       --clean          Remove non-manifest files. (Will ask for confirmation first.)
-#    -v --verify         (TODO) Verify that a manifest matches actual.
+#    -v --verify         Verify that a manifest matches actual.
 #    -h --help           Display this help message.
 #
 #  Options:
 #    -a --all            Include all files. This deactivates deafult exclusions
 #                        so it is possible to make complete list of all contents.
+#       --dir            When creating a list include directory paths; by default
+#                        only files are listed.
+#    -s --show           Show files using the options from the manifest file.
 #    -f --file PATH      Path to manifest file. When using update command, if not
 #                        given then the file matching 'MANIFEST', case-insensitive
 #                        and with an optional '.txt' extension, will be looked for
@@ -40,7 +42,7 @@
 #    -x --exclude PATH   Exclude a file or dir from the manifest matching against
 #                        full pathname. You can use --exclude repeatedly.
 #       --ignore PATH    Exclude a file or dir from the manifest matching against 
-#                        an extires basename. You can use --ignore repeatedly.
+#                        an entries basename. You can use --ignore repeatedly.
 #    -q --quiet          Suppress extraneous output.
 
 require 'mast'
@@ -70,6 +72,8 @@ module Mast
     attr_accessor :include
     attr_accessor :exclude
     attr_accessor :all
+    attr_accessor :dir
+    attr_accessor :show
 
     #
     def initialize
@@ -83,8 +87,18 @@ module Mast
       @command = []
     end
 
-    # Run command.
+    #
     def run
+      begin
+        run_command
+      rescue => err
+        raise err if $DEBUG
+        report err
+      end
+    end
+
+    # Run command.
+    def run_command
       optparse
       if @command.size > 1
         raise ArgumentError, "Please issue only one command."
@@ -94,7 +108,7 @@ module Mast
       when :create   then generate
       when :update   then update
       when :list     then list
-      when :show     then show
+      #when :show     then show
       when :diff     then diff
       when :new      then new
       when :old      then old
@@ -113,15 +127,16 @@ module Mast
         [ '--digest' , '-g', GetoptLong::REQUIRED_ARGUMENT ],
         [ '--exclude', '-x', GetoptLong::REQUIRED_ARGUMENT ],
         #[ '--include', '-i', GetoptLong::REQUIRED_ARGUMENT ],
-        [ '--ignore',        GetoptLong::REQUIRED_ARGUMENT ],
+        [ '--ignore' , '-i', GetoptLong::REQUIRED_ARGUMENT ],
         [ '--all'    , '-a', GetoptLong::NO_ARGUMENT ],
+        [ '--dir'    ,       GetoptLong::NO_ARGUMENT ],
+        [ '--show'   , '-s', GetoptLong::NO_ARGUMENT ],
         [ '--quiet'  , '-q', GetoptLong::NO_ARGUMENT ],
         # commands
         [ '--help'   , '-h', GetoptLong::NO_ARGUMENT ],
         [ '--create' , '-c', GetoptLong::NO_ARGUMENT ],
         [ '--update' , '-u', GetoptLong::NO_ARGUMENT ],
         [ '--list'   , '-l', GetoptLong::NO_ARGUMENT ],
-        [ '--show'   , '-s', GetoptLong::NO_ARGUMENT ],
         [ '--diff'   , '-d', GetoptLong::NO_ARGUMENT ],
         [ '--new'    , '-n', GetoptLong::NO_ARGUMENT ],
         [ '--old'    , '-o', GetoptLong::NO_ARGUMENT ],
@@ -139,8 +154,8 @@ module Mast
           @command << :update
         when '--list'
           @command << :list
-        when '--show'
-          @command << :show
+        #when '--show'
+        #  @command << :show
         when '--diff'
           @command << :diff
         when '--new'
@@ -162,6 +177,10 @@ module Mast
         #  @include << val
         #when '--ignore'
         #  @ignore << val
+        when '--show'
+          @show = true
+        when '--dir'
+          @dir = true
         when '--all'
           @all = true
         when '--quiet'
@@ -213,10 +232,10 @@ module Mast
       puts manifest.filelist
     end
 
-    # List files in manifest file.
-    def show
-      puts manifest.showlist
-    end
+    #
+    #def show
+    #  puts manifest.showlist
+    #end
 
     # Show diff comparison between listed and actual.
     def diff
@@ -282,7 +301,7 @@ module Mast
 
     # Options for Manifest class taken from commandline arguments.
     def manifest_options
-      { :file=>file, :digest=>digest, :exclude=>exclude, :ignore=>ignore, :all=>all, :include=>include }
+      { :file=>file, :digest=>digest, :exclude=>exclude, :ignore=>ignore, :all=>all, :dir=>dir, :include=>include, :show=>show }
     end
 
     # Quiet opertation?
@@ -302,19 +321,24 @@ module Mast
       ask("The above files will be removed. Continue?", "yN")
     end
 
+    #
+    def report(message)
+      $stderr << "#{message}\n" unless quiet?
+    end
+
     # Report manifest created.
     def report_created(file)
       file = File.basename(file)
-      puts "#{file} created." unless quiet?
+      report "#{file} created."
     end
 
     # Report manifest updated.
     def report_updated(file)
       if file
         file = File.basename(file)
-        puts "#{file} updated." unless quiet?
+        report "#{file} updated."
       else
-        puts "Manifest file doesn't exit."
+        report "Manifest file doesn't exit."
       end
     end
 
@@ -341,7 +365,7 @@ module Mast
       puts list.join("\n")
     end
 
-    # Report missing manifest file.
+    #
     def report_whatsold(list)
       puts list.join("\n")
     end
@@ -361,30 +385,30 @@ module Mast
 
     # Report missing manifest file.
     def report_manifest_missing
-      puts "No manifest file."
+      report "No manifest file."
     end
 
     # Report action cancelled.
     def report_cancelled(action)
-      puts "#{action} cancelled."
+      report "#{action} cancelled."
     end
 
     # Report manifest overwrite.
     def report_overwrite(manifest)
-      puts "#{manifest.filename} already exists."
+      report "#{manifest.filename} already exists."
     end
 
     # Warn that a manifest already exist higher in this hierarchy.
     def report_warn_shadowing(manifest)
-      puts "Shadowing #{manifest.file}."
+      report "Shadowing #{manifest.file}."
     end
 
     #
     def report_verify(check)
       if check
-        puts "Manifest if good."
+        report "Manifest if good."
       else
-        puts "Manifest if bad!"
+        report "Manifest if bad!"
       end
     end
   end

data/lib/mast/manifest.rb

@@ -17,7 +17,7 @@ module Mast
   # TODO: Consider adding @include options rather then scanning entire directory.
   # But this can't be done unless we can write a routine that can look at @include
   # and reduce it to non-overlapping matches. Eg. [doc, doc/rdoc] should reduce
-  # to just [doc]. Otherwise we will get duplicate entries, b/c the #output 
+  # to just [doc]. Otherwise we will get duplicate entries, b/c the #output
   # method is written for speed and low memory footprint. This might mean @include
   # can't use file globs.
   #
@@ -50,7 +50,7 @@ module Mast
     def self.open(file=nil, options={})
       unless file
         file = Dir.glob(filename, File::FNM_CASEFOLD).first
-        raise LoadError, "Manifest file is required." unless file
+        raise NoManifestError, "Manifest file is required." unless file
       end
       options[:file] = file
       new(options)
@@ -68,6 +68,13 @@ module Mast
     # Do not exclude standard exclusions.
     attr_accessor :all
 
+    # Include directories.
+    attr_accessor :dir
+
+    # Show as if another manifest (eg. use files options).
+    # TODO: Change name?
+    attr_accessor :show
+
     # What files to include. Defaults to ['*'].
     # Note that Mast automatically recurses through
     # directory entries, so using '**/*' would simply
@@ -89,6 +96,12 @@ module Mast
     #
     alias_method :all?, :all
 
+    #
+    alias_method :dir?, :dir
+
+    #
+    alias_method :show?, :show
+
     # New Manifest object.
     #
     def initialize(options={})
@@ -97,6 +110,8 @@ module Mast
       @ignore    = []
       @format    = 'csf'
       @all       = false
+      @dir       = false
+      @show      = false
       @digest    = nil
       @directory = Dir.pwd
 
@@ -132,7 +147,7 @@ module Mast
 
     #
     def file
-      @file ||= Dir[File.join(directory, DEFAULT_FILE)].first || 'MANIFEST'
+      @file ||= Dir.glob(File.join(directory, DEFAULT_FILE), File::FNM_CASEFOLD).first || 'MANIFEST'
     end
 
     #
@@ -151,6 +166,7 @@ module Mast
 
     # Generate manifest.
     def generate(out=$stdout)
+      parse_topline unless read? if show?
       out << topline_string
       output(out)
     end
@@ -210,8 +226,12 @@ module Mast
     # Clean non-manifest files.
     def clean
       cfiles, cdirs = cleanlist.partition{ |f| !File.directory?(f) }
-      FileUtils.rm(cfiles)
-      FileUtils.rmdir(cdirs)
+      if cfiles.empty? && cdirs.empty?
+        $stderr < "No difference between list and actual.\n"
+      else
+        FileUtils.rm(cfiles)
+        FileUtils.rmdir(cdirs)
+      end
     end
 
     # List of current files.
@@ -236,13 +256,16 @@ module Mast
 
     #
     def cleanlist
+      showlist - filelist
+    end
+
+    # Files not listed in manifest.
+    def unlisted
       list = []
       Dir.chdir(directory) do
-        keep = Dir.glob('*').select{|f| File.directory?(f)} # keep top-level directories?
-        keep << filename # keep manifest file
-        list = Dir.glob('**/*') - (filelist + keep)
+        list = Dir.glob('**/*')
       end
-      list
+      list - filelist
     end
 
     #
@@ -293,11 +316,14 @@ module Mast
       files = files.reject{ |f| ignores.any?{ |i| File.fnmatch(i, File.basename(f)) } }
       files = files.sort
       files.each do |file|
-        sum = checksum(file,digest)
-        sum = sum + ' ' if sum
-        out << "#{sum}#{file}"
-        out << "\n" unless Array === out
-        if File.directory?(file)
+        is_dir = File.directory?(file)
+        if !is_dir || (is_dir && dir?)
+          sum = checksum(file,digest)
+          sum = sum + ' ' if sum
+          out << "#{sum}#{file}"
+          out << "\n" unless Array === out
+        end
+        if is_dir
           rec_output(File.join(file,'*'), out)
         end
       end