dir_validator 0.12.15 → 0.13.0

data/CHANGELOG.rdoc

@@ -9,3 +9,7 @@
 * Minor tutorial edits.
 * Removed dependency on lyberteam-devel.
 * Set up travis-ci, rcov/simplecov, etc.
+
+== 0.13.0 (2012-08-02)
+
+* Added bin/validate-dir and a general scripting functionality.

data/bin/validate-dir

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'dir_validator'
+
+DirValidator.run_script(ARGV).report()

data/lib/dir_validator.rb

@@ -8,6 +8,39 @@ module DirValidator
     return DirValidator::Validator.new(*args, &block)
   end
 
+  # Takes the file name of a Ruby script as a command-line argument.
+  # The script should define the following methods:
+  #
+  #   module DirValidator
+  #     def initialize_validator
+  #       # Should return the arguments to DirValidator.new().
+  #     end
+  #
+  #     def run_validator(dv)
+  #       # Receives the DirValidator::Validator object.
+  #       # Should execute the desired validation code.
+  #     end
+  #   end
+  #
+  # Requires the script, runs its code, and returns the validator.
+  #
+  # Used by the validate-dir executable. Also useful for applications
+  # wanting to offer the functionality of the dir_validator gem and
+  # to receive the validation code as an input.
+  def self.run_script(args)
+    # Require the script, and add its functions to the module.
+    script = args.first
+    abort "Usage: #{$PROGRAM_NAME} SCRIPT" unless File.file?(script.to_s)
+    require script
+    module_function(:initialize_validator, :run_validator)
+    # Create validator, run the validation code supplied by user.
+    dv = DirValidator.new(initialize_validator)
+    run_validator(dv)
+    dv.validate()
+    # Return the validator.
+    return dv
+  end
+
 end
 
 require 'dir_validator/catalog'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dir_validator
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 43
   prerelease: 
   segments: 
   - 0
-  - 12
-  - 15
-  version: 0.12.15
+  - 13
+  - 0
+  version: 0.13.0
 platform: ruby
 authors: 
 - Monty Hindman
@@ -77,8 +77,8 @@ dependencies:
 description: This gem provides a convenient syntax for checking whether the contents of a directory structure match your expectations.
 email: 
 - hindman@stanford.edu
-executables: []
-
+executables: 
+- validate-dir
 extensions: []
 
 extra_rdoc_files: []
@@ -95,6 +95,7 @@ files:
 - CHANGELOG.rdoc
 - tutorial/tutorial.rb
 - .yardopts
+- bin/validate-dir
 homepage: https://github.com/sul-dlss
 licenses: []