mast 1.1 → 1.2.0

data/HISTORY.rdoc

@@ -1,12 +1,33 @@
 = RELEASE HISTORY
 
-== 1.0.0 / 2009-07-02
+== 1.2 / 2010-02-19
 
-This is the initial release of Mast.
+This release adjusts the plugins directory to conform
+to the new Plugin gem and add the -i shortcut to the 
+command-line help.
+
+Changes:
+
+* Rename lib/plugin to lib/plugins.
+* Add -i to help output.
+
+
+== 1.1 / 2009-10-24
+
+This release fixes the show and clean commands and makes
+some additional adjustments under the hood.
 
 Changes:
 
-* 1 Major Enhancement
+* Fix clean and show commands.
+* Change to MIT license.
+
+
+== 1.0 / 2009-07-02
+
+This is the initial release of Mast.
+
+Changes:
 
-    * Happy Birthday!
+* Happy Birthday!
 

data/README.rdoc

@@ -1,35 +1,37 @@
 = Mast
+         ___
+  .-----'---'-.
+  |           |
+  |           |
+  |           |
+  '-----------'
 
-* home:   http://proutils.github.com/mast
-* source: http://github.com/proutils/mast
-
+* home: http://proutils.github.com/mast/
+* work: http://github.com/proutils/mast/
+* wiki: http://wiki.github.com/proutils/mast/
 
 == DESCRIPTION
 
-Mast is a commandline utility for generating MANIFEST lists and optionally checksums.
-It can be useful in conjunction with packaging tools (such as Box), or as a stand-alone
-tool for monitoring file changes.
+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.
 
 
 == FEATURES
 
+* Intuitive command-line interface --simply specify what to include.
 * Self-referential header makes updating manifests easy.
-* Checksum lists can highlight changes to current files.
-
-
-== RELEASE NOTES
+* Checksum digests can highlight file changes.
 
-Please see the HISTORY.rdoc file.
 
+== USAGE
 
-== SYNOPSIS
+Mast makes the process of generating manifests very easy, 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 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.
-
-Lets try a simple example. Lets say we have the following folder structure:
+Lets try a simple example. Lets say we have the following folder structure, using 
+<tt>ls -R</tt> we see:
 
     $ ls -R
     .:
@@ -90,14 +92,15 @@ lets say the mint directory is extraneous and we do not want it included in the
     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+.
+this is that if you save the output to a standard location, i.e. 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
+
+    $ mast --update
     MANIFEST updated.
 
-You can also add a checksum to the file list.
+You can also add a checksum to the file list to create a *DIGEST*.
 
     $ mast -x mint -g sha1
 

data/lib/mast.rb

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

data/lib/mast/cli.rb

@@ -32,18 +32,18 @@
 #       --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
-#                        in the current directory. If the path of the manifest file
-#                        is anything else then --file option must be specified.
-#    -g --digest TYPE    Include crytogrpahic signiture. Type can be either
+#    -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.
-#       --ignore PATH    Exclude a file or dir from the manifest matching against 
+#    -i --ignore PATH    Exclude a file or dir from the manifest matching against 
 #                        an entries basename. You can use --ignore repeatedly.
-#    -q --quiet          Suppress extraneous output.
+#    -q --quiet          Suppress any extraneous output.
 
 require 'mast'
 
@@ -406,9 +406,9 @@ module Mast
     #
     def report_verify(check)
       if check
-        report "Manifest if good."
+        report "Manifest is good."
       else
-        report "Manifest if bad!"
+        report "Manifest is bad!"
       end
     end
   end

data/lib/plugins/syckle/mast.rb

@@ -0,0 +1,100 @@
+module Syckle::Plugins
+
+  # = Mast Manifest Plugin
+  #
+  class Mast < Service
+
+    precycle :main, :package => :generate
+
+    cycle :main, :reset
+    cycle :main, :clean
+
+    # not that this is necessary, but ...
+    available do |project|
+      begin
+        require 'mast'
+        true
+      rescue LoadError
+        false
+      end
+    end
+
+    # Default MANIFEST filename.
+    DEFAULT_FILENAME = 'MANIFEST'
+
+    # Default files/dirs to include.
+    DEFAULT_INCLUDE = %w{ bin lib meta script test [A-Z]* }
+
+    # Default files/dirs to exclude.
+    DEFAULT_EXCLUDE = %w{ }
+
+    # Default files/dirs to ignore. Unlike exclude, this work
+    # on files basenames, and not full pathnames.
+    DEFAULT_IGNORE = %w{ .svn }
+
+    #
+    attr_accessor :include
+
+    #
+    attr_accessor :exclude
+
+    #
+    attr_accessor :ignore
+
+    #
+    attr_accessor :output
+
+    #
+    #def output=(path)
+    #  @output = Pathname.new(path)
+    #end
+
+    #
+    def manifest
+      @manifest ||= Manifest.new(options)
+    end
+
+    # Generate manifest.
+    def generate
+      manifest.generate
+      report "Updated #{output.to_s.sub(Dir.pwd+'/','')}"
+    end
+
+    # Mark MANIFEST as out-of-date.
+    # TODO: Implement reset.
+    def reset
+    end
+
+    # Remove MANIFEST.
+    # TODO: Currently a noop. Not sure removing manfest is a good idea.
+    def clean
+    end
+
+  private
+
+    #
+    def initialize_defaults
+      @include = DEFAULT_INCLUDE
+      @exclude = DEFAULT_EXCLUDE
+      @ignore  = DEFAULT_IGNORE
+      @output  = (file || project.root + DEFAULT_FILENAME).to_s
+    end
+
+    #
+    def file
+      project.root.glob("MANIFEST{,.txt}").first
+    end
+
+    #
+    def options
+      { :include => include,
+        :exclude => exclude,
+        :ignore  => ignore,
+        :file    => output
+      }
+    end
+
+  end
+
+end
+

data/meta/contact

@@ -1 +1 @@
-<tigerops-community@googlegroups.com>
+proutils@googlegroups.com

data/meta/description

@@ -1 +1,4 @@
-Mast is a command line tool for generating manifests.
+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
+option it the manifest file itself.

data/meta/download

@@ -0,0 +1 @@
+http://github.com/proutils/mast/downloads

data/meta/homepage

@@ -1 +1 @@
-http://proutils.rubyforge.org/mast
+http://proutils.github.com/mast

data/meta/ruby

@@ -1,2 +1,3 @@
+---
 - 1.8.6
 - 1.8.7

data/meta/summary

@@ -0,0 +1 @@
+Mast is a command line tool for generating manifests and digests.

data/meta/version

@@ -1 +1 @@
-1.1
+1.2.0

data/meta/wiki

@@ -0,0 +1 @@
+http://wiki.github.com/proutils/mast/

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mast
 version: !ruby/object:Gem::Version 
-  version: "1.1"
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - "- Thomas Sawyer <transfire@gmail.com>"
@@ -9,43 +14,47 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-24 00:00:00 -04:00
+date: 2010-02-19 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: Mast is a command line tool for generating manifests.
-email: <tigerops-community@googlegroups.com>
+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
+  option it the manifest file itself.
+email: 
 executables: 
 - mast
 extensions: []
 
-extra_rdoc_files: 
-- HISTORY.rdoc
-- MANIFEST
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- HISTORY.rdoc
-- LICENSE
-- MANIFEST
-- README.rdoc
 - bin/mast
-- lib/mast.rb
 - lib/mast/cli.rb
 - lib/mast/core_ext.rb
 - lib/mast/manifest.rb
+- lib/mast.rb
+- lib/plugins/syckle/mast.rb
 - meta/authors
 - meta/contact
 - meta/description
+- meta/download
 - meta/homepage
-- meta/namespace
-- meta/package
+- meta/name
 - meta/repository
 - meta/ruby
 - meta/sitemap
+- meta/suite
+- meta/summary
 - meta/version
+- meta/wiki
+- HISTORY.rdoc
+- LICENSE
+- README.rdoc
 has_rdoc: true
-homepage: http://proutils.rubyforge.org/mast
+homepage: http://proutils.github.com/mast
 licenses: []
 
 post_install_message: 
@@ -58,20 +67,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: proutils
-rubygems_version: 1.3.5
+rubyforge_project: mast
+rubygems_version: 1.3.6.pre.3
 signing_key: 
 specification_version: 3
-summary: Mast is a command line tool for generating manifests.
+summary: Mast is a command line tool for generating manifests and digests.
 test_files: []
 

data/MANIFEST

@@ -1,20 +0,0 @@
-HISTORY.rdoc
-LICENSE
-MANIFEST
-README.rdoc
-bin/mast
-lib/mast
-lib/mast.rb
-lib/mast/cli.rb
-lib/mast/core_ext.rb
-lib/mast/manifest.rb
-meta/authors
-meta/contact
-meta/description
-meta/homepage
-meta/namespace
-meta/package
-meta/repository
-meta/ruby
-meta/sitemap
-meta/version