mast 1.2.0 → 1.3.0

data/lib/mast/manifest.rb

@@ -71,9 +71,8 @@ module Mast
     # Include directories.
     attr_accessor :dir
 
-    # Show as if another manifest (eg. use files options).
-    # TODO: Change name?
-    attr_accessor :show
+    # Show as if another manifest (i.e. use file's bang options).
+    attr_accessor :bang
 
     # What files to include. Defaults to ['*'].
     # Note that Mast automatically recurses through
@@ -100,7 +99,7 @@ module Mast
     alias_method :dir?, :dir
 
     #
-    alias_method :show?, :show
+    alias_method :bang?, :bang
 
     # New Manifest object.
     #
@@ -111,7 +110,7 @@ module Mast
       @format    = 'csf'
       @all       = false
       @dir       = false
-      @show      = false
+      @bang      = false
       @digest    = nil
       @directory = Dir.pwd
 
@@ -155,6 +154,15 @@ module Mast
       @read
     end
 
+    # Is the current mainfest in need of updating?
+    def changed?
+      raise NoManifestError unless file and FileTest.file?(file)
+      txt = File.read(file)
+      out = StringIO.new #('', 'w')
+      generate(out)
+      out.string != txt
+    end
+
     # Create a digest/manifest file. This saves the list of files
     # and optionally their checksum.
     #def create(options=nil)
@@ -166,7 +174,7 @@ module Mast
 
     # Generate manifest.
     def generate(out=$stdout)
-      parse_topline unless read? if show?
+      parse_topline unless read? if bang?
       out << topline_string
       output(out)
     end
@@ -433,7 +441,9 @@ module Mast
     def checksum(file, digest=nil)
       return nil unless digest
       if FileTest.directory?(file)
-        @null_string ||= digester(digest).hexdigest("")
+        #@null_string ||= digester(digest).hexdigest("")
+        listing = (Dir.entries(file) - %w{. ..}).join("\n")
+        digester(digest).hexdigest(listing)
       else
         digester(digest).hexdigest(File.read(file))
       end
@@ -515,20 +525,27 @@ module Mast
             [ '-i', '--ignore' , GetoptLong::REQUIRED_ARGUMENT ],
             [ '-a', '--all'    , GetoptLong::NO_ARGUMENT ]
         )
-        a, d, x, i = false, nil, [], []
+        a, d, g, x, i = false, false, nil, [], []
         opts.each do |opt, arg|
           case opt
-          when '-g': d = arg.downcase
-          when '-a': a = true
-          when '-x': x << arg
-          when '-i': i << arg
+          when '-g'
+            g = arg.downcase
+          when '-a'
+            a = true
+          when '-x'
+            x << arg
+          when '-i'
+            i << arg
+          when '-d'
+            d = true
           end
         end
 
         @all     = a
-        @digest  = d
+        @digest  = g
         @exclude = x
         @ignore  = i
+        @dir     = d
         @include = ARGV.empty? ? nil : ARGV.dup
       end
     end
@@ -560,6 +577,7 @@ module Mast
       #end
       top = []
       top << "-a" if all?
+      top << "-d" if dir?
       top << "-g #{digest.to_s.downcase}" if digest
       exclude.each do |e|
         top << "-x #{e}"

data/lib/mast/meta/data.rb

@@ -0,0 +1,25 @@
+module Mast
+
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/package'))
+    )
+  end
+
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/profile'))
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    package[key] || profile[key] || super(name)
+  end
+
+end
+
+# becuase Ruby 1.8~ gets in the way
+Object.__send__(:remove_const, :VERSION) if Object.const_defined?(:VERSION)

data/lib/mast/meta/package

@@ -0,0 +1,8 @@
+name    : mast
+date    : 2010-11-21
+version : 1.3.0
+
+requires:
+  - syckle (build)
+  - qed    (test)
+

data/lib/mast/meta/profile

@@ -0,0 +1,21 @@
+--- 
+title  : Mast
+suite  : proutils
+contact: proutils@googlegroups.com
+summary: Mast is a command line tool for generating manifests and digests.
+
+authors: 
+  - Thomas Sawyer
+
+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.
+
+resources:
+  homepage: http://proutils.github.com/mast
+  repository: git://github.com/proutils/mast.git
+  wiki: http://wiki.github.com/proutils/mast/
+  download: http://github.com/proutils/mast/downloads
+

data/lib/plugins/syckle/mast.rb

@@ -4,12 +4,15 @@ module Syckle::Plugins
   #
   class Mast < Service
 
-    precycle :main, :package => :generate
+    # Pre-package phase.
+    precycle :main, :package do
+      generate
+    end
 
     cycle :main, :reset
     cycle :main, :clean
 
-    # not that this is necessary, but ...
+    # Not that this is necessary, but ...
     available do |project|
       begin
         require 'mast'
@@ -23,14 +26,14 @@ module Syckle::Plugins
     DEFAULT_FILENAME = 'MANIFEST'
 
     # Default files/dirs to include.
-    DEFAULT_INCLUDE = %w{ bin lib meta script test [A-Z]* }
+    DEFAULT_INCLUDE = %w{ bin data etc features lib man meta qed script spec test [A-Z]* }
 
     # Default files/dirs to exclude.
-    DEFAULT_EXCLUDE = %w{ }
+    DEFAULT_EXCLUDE = nil #%w{}
 
     # Default files/dirs to ignore. Unlike exclude, this work
-    # on files basenames, and not full pathnames.
-    DEFAULT_IGNORE = %w{ .svn }
+    # on path basenames, and not full pathnames.
+    DEFAULT_IGNORE = nil #%w{}
 
     #
     attr_accessor :include
@@ -51,13 +54,19 @@ module Syckle::Plugins
 
     #
     def manifest
-      @manifest ||= Manifest.new(options)
+      @manifest ||= ::Mast::Manifest.new(options)
     end
 
     # Generate manifest.
+    # TODO: don't overwrite if it hasn't changed
     def generate
-      manifest.generate
-      report "Updated #{output.to_s.sub(Dir.pwd+'/','')}"
+      if manifest.changed?
+        file = manifest.save #update #generate
+        report "Updated #{file.to_s.sub(Dir.pwd+'/','')}"
+        #report "Updated #{output.to_s.sub(Dir.pwd+'/','')}"
+      else
+        report "#{output.to_s.sub(Dir.pwd+'/','')} is current"
+      end
     end
 
     # Mark MANIFEST as out-of-date.
@@ -66,7 +75,7 @@ module Syckle::Plugins
     end
 
     # Remove MANIFEST.
-    # TODO: Currently a noop. Not sure removing manfest is a good idea.
+    # TODO: Currently a noop. Not sure removing manfest is ever a good idea.
     def clean
     end
 

data/man/man1/mast.1

@@ -0,0 +1,97 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "MAST" "1" "November 2010" "RubyWorks" "Mast"
+.
+.SH "NAME"
+\fBmast\fR \- manifest generator
+.
+.SH "SYNOPSIS"
+\fBmast [<command>] [<options>\.\.\.]\fR
+.
+.SH "DESCRIPTION"
+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\.
+.
+.P
+When no command is given, a manifest is dumped to standard out\. If \-\-file is specified, it will generate to that file instead\.
+.
+.SH "COMMANDS"
+.
+.TP
+\fB\-c\fR, \fB\-\-create\fR
+Generate a new manifest\. (default)
+.
+.TP
+\fB\-u\fR, \fB\-\-update\fR
+Update an existing manifest\.
+.
+.TP
+\fB\-l\fR, \fB\-\-list\fR
+List the files given in the manifest file\. (Use \-f to specify an alternate file\.)
+.
+.TP
+\fB\-D\fR, \fB\-\-diff\fR
+Diff manifest file against actual\.
+.
+.TP
+\fB\-n\fR, \fB\-\-new\fR
+List existant files that are not given in the manifest\.
+.
+.TP
+\fB\-o\fR, \fB\-\-old\fR
+List files given in the manifest but are non\-existent\.
+.
+.TP
+\fB\-v\fR, \fB\-\-verify\fR
+Verify that a manifest matches actual\.
+.
+.TP
+\fB\-\-clean\fR
+Remove non\-manifest files\. (Will ask for confirmation first\.)
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display this help message\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+Include all files\. This deactivates deafult exclusions so it is possible to make complete list of all contents\.
+.
+.TP
+\fB\-d\fR, \fB\-\-dir\fR
+When creating a list include directory paths; by default only files are listed\.
+.
+.TP
+\fB\-b\fR, \fB\-\-bang\fR
+Generate manifest using the options from the bang line of the manifest file\.
+.
+.TP
+\fB\-f\fR, \fB\-\-file PATH\fR
+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\.
+.
+.TP
+\fB\-g\fR, \fB\-\-digest TYPE\fR
+Include crytographic signiture\. Type can be either md5, sha1, sha128, sha256, or sha512\.
+.
+.TP
+\fB\-x\fR, \fB\-\-exclude PATH\fR
+Exclude a file or dir from the manifest matching against full pathname\. You can use \-\-exclude repeatedly\.
+.
+.TP
+\fB\-i\fR, \fB\-\-ignore PATH\fR
+Exclude a file or dir from the manifest matching against an entries basename\. You can use \-\-ignore repeatedly\.
+.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress any extraneous output\.
+.
+.SH "EXAMPLES"
+\fBmast\fR
+.
+.br
+\fBmast \-u \-f PUBLISH\fR
+.
+.SH "SEE ALSO"
+ls(1)

data/meta/data.rb

@@ -0,0 +1,25 @@
+module Mast
+
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/package'))
+    )
+  end
+
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(File.dirname(__FILE__) + '/profile'))
+    )
+  end
+
+  def self.const_missing(name)
+    key = name.to_s.downcase
+    package[key] || profile[key] || super(name)
+  end
+
+end
+
+# becuase Ruby 1.8~ gets in the way
+Object.__send__(:remove_const, :VERSION) if Object.const_defined?(:VERSION)

data/meta/package

@@ -0,0 +1,8 @@
+name    : mast
+date    : 2010-11-21
+version : 1.3.0
+
+requires:
+  - syckle (build)
+  - qed    (test)
+

data/meta/profile

@@ -0,0 +1,21 @@
+--- 
+title  : Mast
+suite  : proutils
+contact: proutils@googlegroups.com
+summary: Mast is a command line tool for generating manifests and digests.
+
+authors: 
+  - Thomas Sawyer
+
+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.
+
+resources:
+  homepage: http://proutils.github.com/mast
+  repository: git://github.com/proutils/mast.git
+  wiki: http://wiki.github.com/proutils/mast/
+  download: http://github.com/proutils/mast/downloads
+

data/qed/cli/applique/env.rb

@@ -0,0 +1,60 @@
+require 'fileutils'
+require 'open3'
+
+def assert_bash(text)
+  lines  = text.lines.to_a
+  bash   = lines[0]
+  result = lines[1..-1].join.strip
+
+  bash.sub!('$', '')
+
+  stdin, stdout, stderr = Open3.popen3(bash)
+
+  output = (stderr.read + stdout.read).strip
+
+  result.assert == output
+end
+
+Before :demo do
+  if /tmp\/qed$/ =~ Dir.pwd
+    Dir['*'].each do |file|
+      FileUtils.rm_r(file)
+    end
+  end
+end
+
+When "Let say we have a directory containing a set of files as follows" do |text|
+  text.lines.each do |line|
+    file = line.strip
+    FileUtils.mkdir_p(File.dirname(file))
+    File.open(file, 'w') do |f|
+      f << file
+    end
+  end
+end
+
+When "let's say we have a new file" do |text|
+  text.lines.each do |line|
+    file = line.strip
+    FileUtils.mkdir_p(File.dirname(file))
+    File.open(file, 'w') do |f|
+      f << file
+    end
+  end
+end
+
+When "let's remove a file" do |text|
+  text.lines.each do |line|
+    file = line.strip
+    FileUtils.rm(file)
+  end
+end
+
+When :data do |step|
+  text = step.sample_text
+  if text.start_with?('$')
+    assert_bash(text)
+  end
+end
+
+