mast 1.3.0 → 1.4.0

data/.ruby

@@ -0,0 +1,49 @@
+---
+source:
+- meta
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2009'
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/mast.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/mast/
+  code: http://github.com/rubyworks/mast/
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-08-17'
+summary: Mast is a command line tool for generating manifests and digests.
+title: Mast
+version: 1.4.0
+name: mast
+description: ! 'Mast is a command line tool for generating manifests and digests.
+  Mast makes
+
+  it easy to compare a manifest to a current directory structure, and to update
+
+  the manifest with a simple command by storing the command options it the
+
+  manifest file itself.'
+organization: rubyworks
+date: '2011-10-30'

data/COPYING.rdoc

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+
+== Mast
+
+Copyright:: (c) 2009 Rubyworks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/tapout
+
+    Copyright 2009 Rubyworks. All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice,
+          this list of conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright
+          notice, this list of conditions and the following disclaimer in the
+          documentation and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+    OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/HISTORY.rdoc

@@ -1,5 +1,20 @@
 = RELEASE HISTORY
 
+== 1.3.0 / 2011-10-30
+
+This release adds a few additional features, see changes list below. It also 
+changes the license to BSD-2-Clause and modernizes the build configuration.
+
+Changes:
+
+* Add `--recent` command to check if up to date.
+* Add `--no-head` option to suppress header.
+* Improve help system with man-page.
+* Update output shows diff if file changed.
+* Modernize build configuration.
+* Switch to BSD-2-Cluase license.
+
+
 == 1.3.0 / 2010-11-21
 
 Version 1.3 primarily makes a few adjustment under-the-hood. It switches
@@ -7,7 +22,7 @@ GetoptLong out for OptionParser, gets rid of it's dependency on Ruby Facets'
 Kernel#ask method, and changes the diff comment short name from `-d` to `-D`.
 Lowecase `-d` is now used as a short name for the `--dir` option. In the
 process a bug was fixed where this `-d` option was not being added to the
-manifest's bang line. Lastly, the `-s`/`--show` option has been enamed to
+manifest's bang line. Lastly, the `-s`/`--show` option has been renamed to
 `-b`/`--bang`, which is more descriptive.
 
 Changes:

data/{qed/cli/overview.rdoc → QED.rdoc}

@@ -2,7 +2,7 @@
 
 Mast in a manifest and digest generator.
 
-Let say we have a directory containing a set of files as follows:
+Lets say we have a directory containing a set of files as follows:
 
   README.txt
   lib/foo.rb
@@ -84,7 +84,6 @@ a file name:
 Once saved, `mast` has an update mode via the `-u` option:
 
   $ mast -u
-  MANIFEST.txt updated.
 
 By default this works for any manifest file with a name matching "manifest{,.*}",
 case insensitvive. An alternate file name can be supplied using the `-f` option.
@@ -94,7 +93,6 @@ verification that a manifest file matches the current contents of the directory
 can be had via the `-v`/`--verify` option:
 
   $ mast -v
-  Manifest is good.
 
 To see what files are new, that is to say added to the the directory but not
 listed in the manifest file, use the `-n/--new` option. For instance, let's
@@ -131,3 +129,29 @@ on the bang line of a manifest file via the `-b`/`--bang` option:
   lib/bar.rb
   lib/baz.rb
 
+
+== Manifest Generation
+
+Lets say we have a directory containing a set of files as follows:
+
+  README.txt
+  lib/foo.rb
+  lib/bar.rb
+
+We can crate a new Manifest object, utilizing a StringIO object to catch
+the output.
+
+  out = ''
+
+  manifest = Mast::Manifest.new(:io=>StringIO.new(out))
+
+If we call the generate method, then the output should list the 
+above file along with a generic shebang header.
+
+  manifest.generate
+
+  list = out.split("\n").sort
+
+  list.assert == ['#!mast *','README.txt','lib/bar.rb','lib/foo.rb']
+
+

data/README.rdoc

@@ -7,11 +7,18 @@
   '-----------'
 
 
+{Homepage}[http://rubyworks.github.com/mast/] |
+{Source Code}[http://github.com/rubyworks/mast/] | #rubyworks
+
+
+{<img src="http://travis-ci.org/rubyworks/mast.png" />}[http://travis-ci.org/rubyworks/mast]
+
+
 == DESCRIPTION
 
 Mast is a commandline utility for generating MANIFEST and DIGEST lists.
-It can be useful in conjunction with packaging tools (such as Box),
-or as a stand-alone tool for monitoring file changes.
+It can be useful in conjunction with packaging tools, or as a stand-alone
+tool for monitoring file changes.
 
 
 == FEATURES
@@ -21,13 +28,6 @@ or as a stand-alone tool for monitoring file changes.
 * Checksum digests can highlight file changes.
 
 
-== RESOURCES
-
-* home: http://rubyworks.github.com/mast/
-* work: http://github.com/rubyworks/mast/
-* wiki: http://wiki.github.com/rubyworks/mast/
-
-
 == USAGE
 
 Mast makes the process of generating manifests very easy, and even allows
@@ -135,17 +135,8 @@ See {Ruby Setup}[http://rubyworks.github.com/setup] for more information.
 
 == COPYRIGHT
 
-Copyright (c) 2009 Thomas Sawyer
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
+Copyright (c) 2009 Rubyworks
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Mast is distributable according to the terms of the BSD-2-Clause license.
 
+See COPYING.rdoc for details.

data/lib/mast.rb

@@ -1,2 +1,20 @@
-require 'mast/meta/data'
+module Mast
+  # Access to project metadata.
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/mast.yml'))
+    )
+  end
+
+  # Access project metadata via constants.
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    package[key] || super(name)
+  end
+
+  # becuase Ruby 1.8~ gets in the way
+  VERSION = metadata['version']
+end
+
 require 'mast/manifest'

data/lib/mast.yml

@@ -0,0 +1,49 @@
+---
+source:
+- meta
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2009'
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/mast.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/mast/
+  code: http://github.com/rubyworks/mast/
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2009-08-17'
+summary: Mast is a command line tool for generating manifests and digests.
+title: Mast
+version: 1.4.0
+name: mast
+description: ! 'Mast is a command line tool for generating manifests and digests.
+  Mast makes
+
+  it easy to compare a manifest to a current directory structure, and to update
+
+  the manifest with a simple command by storing the command options it the
+
+  manifest file itself.'
+organization: rubyworks
+date: '2011-10-30'

data/lib/mast/cli.rb

@@ -1,50 +1,3 @@
-#  mast v1.0.0
-#
-#  Usage:
-#    mast [command] [options...]
-#
-#  The manifest listing tool is used to list, create or update a
-#  manifest for a directory (eg. to define a "package"), or compare
-#  a manifest to actual directory contents. Mast is part of the
-#  ProUtils set of tools.
-#
-#  When no command is given, a manifest is dumped to standard out.
-#  If --file is specified, it will generate to that file instead.
-#
-#  Examples:
-#    mast
-#    mast -u -f PUBLISH
-#
-#  Commands:
-#    -c --create         Generate a new manifest. (default)
-#    -u --update         Update an existing manifest.
-#    -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         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.
-#    -d --dir            When creating a list include directory paths; by default
-#                        only files are listed.
-#    -b --bang           Produce new manifest but using options from the bang line of the manifest file.
-#    -f --file PATH      Path to manifest file. This applies to comparison commands.
-#                        If not given then the file matching 'MANIFEST', case-insensitive
-#                        and with an optional '.txt' extension, in the current directory
-#                        is used. If the path of the manifest file is anything else then
-#                        the --file option must be specified.
-#    -g --digest TYPE    Include crytographic signiture. Type can be either
-#                        md5, sha1, sha128, sha256, or sha512.
-#    -x --exclude PATH   Exclude a file or dir from the manifest matching against
-#                        full pathname. You can use --exclude repeatedly.
-#    -i --ignore PATH    Exclude a file or dir from the manifest matching against 
-#                        an entries basename. You can use --ignore repeatedly.
-#    -q --quiet          Suppress any extraneous output.
-
 require 'mast'
 require 'optparse'
 
@@ -117,6 +70,7 @@ module Mast
       when :old      then old
       when :verify   then verify
       when :clean    then clean
+      when :recent   then recent
       else
         generate
       end
@@ -125,58 +79,68 @@ module Mast
     # Parse command line options.
     def option_parser
       OptionParser.new do |opt|
-        opt.on "--file", "-f FILE" do |file|
+        opt.on "-f", "--file FILE", "Path to manifest file. Looks for file matching /MANIFEST(|.txt)/i by default." do |file|
           @options[:file] = file
         end
-        opt.on "--digest", "-g TYPE" do |digest|
+        opt.on "-g", "--digest TYPE", "Include cryptographic signature. Type can be either md5, sha1, sha128, sha256, or sha512." do |digest|
           @options[:digest] = digest
         end
-        opt.on "--exclude", "-x GLOB" do |glob|
+        opt.on "-x", "--exclude GLOB", "Exclude file or dir from the manifest matching against full pathname. Can be used repeatedly." do |glob|
           @options[:exclude] << glob
         end
-        opt.on "--ignore", "-i GLOB" do |glob|
+        opt.on "-i", "--ignore GLOB",
+               "Exclude file or dir from manifest matching against an entry's basename. Can be used repeatedly." do |glob|
           @options[:ignore] << glob
         end
-        opt.on "--all", "-a" do |bool|
+        opt.on "-a", "--all", "Include all files. This deactivates default exclusions so it is possible to make complete list of all contents." do |bool|
           @options[:all] = true
         end
-        opt.on "--bang", "-b" do |bool|
+        opt.on "--bang", "-b", "Generate manifest using the options from the bang line of the manifest file." do |bool|
           @options[:bang] = true
         end
-        opt.on "--dir", "-d" do |bool|
+        opt.on "--dir", "-d", "When creating a list include directory paths; by default only files are listed." do |bool|
           @options[:dir] = bool
         end
-        #opt.on "--quiet", "-q", "" do |bool|
-        #  @quiet = bool
-        #end
-        opt.on "--create", "-c" do
+        opt.on "--[no-]head", "Suppress mast header from output." do |bool|
+          @options[:headless] = !bool
+        end
+        opt.on "-c", "--create", "Generate a new manifest. (default)" do
           @command << :create
         end
-        opt.on "--update", "-u" do
+        opt.on "-u", "--update", "Update an existing manifest." do
           @command << :update
         end
-        opt.on "--list", "-l" do
+        opt.on "-l", "--list", "List the files given in the manifest file. (Use -f to specify an alternate file.)" do
           @command << :list
         end
-        opt.on "--diff", "-D" do
+        opt.on "-D", "--diff", "Diff manifest file against actual." do
           @command << :diff
         end
-        opt.on "--new", "-n" do
+        opt.on "-n", "--new", "List existent files that are not given in the manifest." do
           @command << :new
         end
-        opt.on "--old", "-o" do
+        opt.on "-o", "--old", "List files given in the manifest but are non-existent." do
           @command << :old
         end
-        opt.on "--verify", "-v" do
+        opt.on "-v", "--verify", "Verify that a manifest matches actual." do
           @command << :verify
         end
-        opt.on "--clean" do
+        opt.on "--clean", "Remove non-manifest files. (Will ask for confirmation first.)" do
           @command << :clean
         end
-        opt.on "--help" do
+        opt.on "-r", "--recent", "Verify that a manifest is more recent than actual." do
+          @command << :recent
+        end
+        opt.on "-h", "--help", "Display this help message." do
           @command << :help
         end
-        opt.on "--debug" do
+        opt.on "-H" do
+          puts opt; exit
+        end
+        opt.on "-q", "--quiet", "Suppress all extraneous output." do
+          @quiet = true
+        end
+        opt.on "--debug", "Run in debug mode." do
           $DEBUG = true
         end
       end
@@ -193,13 +157,18 @@ module Mast
 
     # Update a MANIFEST file for this package.
     def update
-      begin
-        file = manifest.update
-      rescue NoManifestError => e
-        puts e.message
-        exit -1
+      if manifest.verify  
+      else
+        begin
+          diff = manifest.diff
+          file = manifest.update
+        rescue Manifest::NoManifestError => e
+          puts e.message
+          exit -1
+        end
+        report_difference(diff)
+        #report_updated(file)
       end
-      report_updated(file)
     end
 
     alias_method :up, :update
@@ -255,6 +224,20 @@ module Mast
       end
     end
 
+    # Verify manifest, then check to see that it is not older than files
+    # it lists.
+    def recent
+      check = manifest.verify
+      if !check
+        report_verify(check)
+        exit -1 
+      end
+      if !FileUtils.uptodate?(manifest.file, manifest.filelist)
+        report_outofdate
+        exit -1
+      end
+    end
+
     # Display command help information.
     def help
       report_help
@@ -345,13 +328,12 @@ module Mast
     # Show help.
     def report_help
       doc = false
-      File.readlines(__FILE__).each do |line|
-        line = line.strip
-        break if doc && line.empty?
-        next if line =~ /^#!/
-        next if line.empty?
-        puts line[1..-1].sub(/^\ \ /,'')
-        doc = true
+      man_page  = File.dirname(__FILE__) + '/../../man/man1/mast.1'
+      ronn_file = File.dirname(__FILE__) + '/../../man/man1/mast.1.ronn'
+      if File.exist?(man_page)
+        system "man #{man_page}" || puts(File.read(ronn_file))
+      else
+        puts option_parser
       end
     end
 
@@ -384,6 +366,11 @@ module Mast
       end
     end
 
+    #
+    def report_outofdate
+      report "Manifest is older than listed file(s)."
+    end
+
     #
     def ask(prompt=nil)
       $stdout << "#{prompt}"