marcspec 1.5.0 → 1.6.1

data/CHANGES

@@ -1,45 +1,77 @@
+1.6.1
+  * Change VariableField#asDSLString to reflect compact declaration of spec with subs
+  
+1.6.0
+  * Allow specs like spec('245ac'), with or without a block as well.
+  
+1.5.3
+  * Changed to use Logback::Simple
+  
+1.5.2
+  * Added more docs
+  * Put in actual @deprecated strings in YARD docs
+  
+1.5.1
+  * Fixed lots of DSL bugs
+  * Moved testing to RSpec in anticipation of using Hudson
+
 1.5.0 
   * Added DSL; making it the preferred way to operate. Totally deprecating the aray-of-hashes stuff. 
+
 1.1.1
   * Fixed bug with :noMapKeyDefault => :passthrough for MVMap
+
 1.1.0
   * Added support for Proc objects as the value in a MVMap
+
 1.0.0
   * Added constant specs (:constantValue=>'val' or :constantValue=>['array', 'of', 'values'])
   * Arbitrarily decided this is version 1.0
+
 0.9.0
   * Added ability to benchmark by calling ss.doc_from_marc(r, true) instead of just ss.doc_from_marc(r)
+
 0.8.1
   * Added some specs, squashed some bugs. In particular, make sure the Range passed to a ControlField
     makes sense (x..y, where x<=y and x > 0)
+
 0.8.0
   * Changed the syntax for a variable field from ['245', '*', '*', 'ab'] to just ['245', 'ab']. We'll worry
     about indicators when that bridge gets crossed.
+
 0.7.3
   * Squashed a bug where I forgot to deal with escaping in java .properties files. Now I'm just using 
     a real Java Properties object so I don't have to worry about it.
+
 0.7.2
   * Also change methodArgs to functionArgs
+
 0.7.1
   * Forgot to update this CHANGES file.     
+
 0.7.0
   * Change configuration for custom functions to use :functionSymbol instead of :methodSymbol. Because, you know, they're
     module functions, not class methods. 
   * Split out marcspec stuff into multiple files (leader/control/variable fields).
+
 0.6.0
   * Allow custom functions to return values for multiple solr fields at once; should help avoid duplication of work.
+
 0.5.0
   * Allow solr field names to repeat in a spec set. This allows you to cumulatively add to a solr field based on "regular" 
     and custom (or, say, two custom) specs.
+
 0.4.0
   * MAJOR BACKWARD-INCOMPATIBLE CHANGE!! The signature for custom routines is now def function(doc, record, my, args), where
   "doc" is a hashlike (usually a SolrDocument) that contains all the work that has happened up to this point. The idea is that you 
   can use previously-computed values to determine values for different fields. Use sparingly.
+
 0.3.0
   * Changed behavior with respect to repeated subfields. A spec such as '260 ac' returns the values of the 'a' and
   'c' subfields concatenated together. A request for '631 z' would, similarly, return the values *of all the subfield
   z's* concatenated together. I'm now treating this as a special case. If the request is for a single subfield code,
   multiple values are returned separate from each other.
   
+
 0.2.0
   * First public release

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'rake'
+gem 'ci_reporter'
+require 'ci/reporter/rake/rspec'
 
 begin
   require 'jeweler'
@@ -10,11 +12,12 @@ begin
     gem.email = "bill@dueber.com"
     gem.homepage = "http://github.com/billdueber/marcspec"
     gem.authors = ["BillDueber"]
-    gem.add_development_dependency "bacon", ">= 0"
+    gem.add_development_dependency "rspec"
     gem.add_development_dependency "yard", ">= 0"
-
-    gem.add_dependency 'marc4j4r', '>=0.9.0'
-    gem.add_dependency 'jruby_streaming_update_solr_server', '>=0.3.1'
+    gem.add_development_dependency 'ci_reporter'
+    gem.add_dependency 'marc4j4r', '>=1.1.0'
+    gem.add_dependency 'logback-simple'
+    gem.add_dependency 'jruby_streaming_update_solr_server', '>=0.5.0'
     
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -24,13 +27,20 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.verbose = true
+
+require 'spec/rake/spectask'
+desc "Run rspec specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run Rspec tests with CI output in spec/reports"
+Spec::Rake::SpecTask.new('cispec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
 end
 
+
+
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |spec|
@@ -40,12 +50,12 @@ begin
   end
 rescue LoadError
   task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    abort "RCov is not available. In order to run rcov, you must: jgem install rcov-java"
   end
 end
 
 task :spec => :check_dependencies
-
+task :cispec => :"ci:setup:rspec"
 task :default => :spec
 
 begin

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.1

data/lib/marcspec.rb

@@ -1,8 +1,7 @@
-require 'logger'
 require 'marc4j4r'
+require "logback-simple"
+
 
-$LOG = Logger.new(STDOUT)
-$LOG.level = Logger::WARN
 
 require "marcspec/customspec"
 require "marcspec/solrfieldspec"
@@ -13,11 +12,14 @@ require "marcspec/specset"
 require "marcspec/marcfieldspec"
 require "marcspec/dsl"
 
-# Build up a little module to include in MARC4J4R::Record that
-# gives us a way to cache computed values within the record itself
-# It's just a hash.
-
 module CacheSpot
+  # Build up a little module to include in MARC4J4R::Record that
+  # gives us a way to cache computed values within the record itself
+  # It's just a hash.
+  #
+  # Pretty sure this belongs somewhere else; not sure where.
+  #
+  # @return [Hash] the cachespot hash
   def cachespot
     @_cachespot ||= {}
     return @_cachespot

data/lib/marcspec/constantspec.rb

@@ -2,10 +2,11 @@ require 'marcspec/solrfieldspec'
 
 
 module MARCSpec
+  
+  # A ConstantSolrSpec always returns the same value(s) no matter what's in the record.
   class ConstantSolrSpec < SolrFieldSpec
     attr_accessor :constantValue
     
-    #attr_accessor :solrField, :first, :map, :noMapKeyDefault, :marcfieldspecs, :default, :arity
     
     def initialize opts = {}
       @solrField  = opts[:solrField]
@@ -20,18 +21,32 @@ module MARCSpec
       end
     end
     
+    # Return the constant value associated with this spec
+    # @param [MARC4J4R::Record] r The record. IGNORED. It's a constant ;-)
+    # @param [Hash, SolrInputDocument] doc The hash-like object that contains previously-generated content. IGNORED
+    # @return [String, Array] The constant value(s) associated with this object.
+    
     def marc_values r, doc = {}
       return @constantValue
     end
     
+    # Basic equality
     def == other
       return @constantValue == other.constantValue
     end
     
+    # Build up from a ruby hash
+    # @deprecated Use the DSL
     def self.fromHash h
       return self.new(h)
     end
     
+    def asDSLString
+      return "constant('#{@solrField}') do\n  value #{@constantValue.inspect}\nend"
+    end
+    
+    # Used to round-trip to/from hash syntax
+    # @deprecated Use the DSL
     def asPPString
       s = StringIO.new
       s.print "{\n :solrField=> "

data/lib/marcspec/controlfieldspec.rb

@@ -17,6 +17,8 @@ module MARCSpec
   # substrings are specified.
   
   class ControlFieldSpec
+    include Logback::Simple
+    
     attr_accessor :tag, :range, :rangehistory
     
     def initialize (tag, range=nil)
@@ -33,7 +35,8 @@ module MARCSpec
               (self.range == other.range))
     end
     
-    
+    # Set the range of characters to use (nil for all)
+    #
     # Always force a real range, since in Ruby 1.9 a string subscript with a single fixnum
     # will return the character code of that character (e.g., "Bill"[0] => 66, wherease 
     # "Bill"[0..0] gives the expected 'B'
@@ -76,10 +79,25 @@ module MARCSpec
       end
     end
     
+    # Print it out has a ruby hash
+    # @deprecated Use the DSL
+  
     def pretty_print pp
       pp.pp eval(self.asPPString)
     end
     
+    # Print out as a DSL segment
+    def asDSLString
+      if (@range)
+        return "spec('#{@tag}') {chars #{@range}}"
+      else
+        return "spec('#{@tag}')"
+      end
+    end
+    
+    # Print out as a ruby hash.
+    # @deprecated Use the DSL
+    
     def asPPString
       s = StringIO.new
       if @range
@@ -90,6 +108,9 @@ module MARCSpec
       return s.string
     end
     
+    # Recreate from an asPPString call
+    # @deprecated Use the DSL
+    
     def self.fromPPString str
       a = eval(str)
       return self.new(*a)

data/lib/marcspec/customspec.rb

@@ -47,6 +47,8 @@ module MARCSpec
     # no key in the map that matches the value. 
     #
     # Note that the last four options don't make sense if multiple :solrFields are given, and are illegal in that case.
+    #
+    # Also note that using the DSL to produce these is easier from config file.
     
     def initialize(opts)
       @solrField  = opts[:solrField]
@@ -85,11 +87,45 @@ module MARCSpec
     end
     
     
+    # Produce one from the results of eval'ing a asPPString string
+    # @deprecated Use the DSL
+    
     def self.fromHash h
       return self.new(h)
     end
   
-    
+    # Produce DSL code that will reproduce this object
+    def asDSLString
+      s = StringIO.new
+      s.puts "custom('#{@solrField}') do"
+      s.puts "  firstOnly" if @first
+      if @defaultValue
+        s.puts "  default " + 
+        PP.singleline_pp(@defaultValue + "\n", s)
+      end
+      if @map
+        s.print "  mapname "
+        PP.pp(@map.mapname, s)
+      end
+      if @noMapKeyDefault
+        s.print("  mapMissDefault ")
+        PP.singleline_pp(@noMapKeyDefault, s)
+        s.print("\n ")
+      end
+
+      s.puts("  function(:#{@functionSymbol}) {")
+      s.puts("    mod  #{@module}")
+      if  @functionArgs and @functionArgs.size > 0
+        args = @functionArgs.map{|a| a.inspect}.join(', ')
+        s.puts "    args #{args}"
+      end
+      s.puts "  }"
+      s.puts "end"
+      return s.string
+    end
+
+    # Print out as a ruby hash.
+    # @deprecated Use the DSL
     def asPPString
       s = StringIO.new
       s.print "{\n :solrField=> "

data/lib/marcspec/dsl.rb

@@ -9,11 +9,11 @@ module MARCSpec
   
   # Re-open SpecSet to add the necessary methods
   
-  class SpecSet
+  class SpecSet    
     
     # create a normal field
     def field(name, &blk)
-      $LOG.debug "Creating regular field #{name}"
+      log.debug "Creating regular field #{name}"
       sfs = SolrFieldSpec.new(:solrField=>name)
       sfs.instance_eval(&blk)
       self << sfs
@@ -22,7 +22,7 @@ module MARCSpec
     
     # Create a constant field
     def constant(name, &blk)
-      $LOG.debug "Creating constant field #{name}"
+      log.debug "Creating constant field #{name}"
       
       constant = ConstantSolrSpec.new(:solrField=>name)
       constant.instance_eval(&blk)
@@ -31,7 +31,7 @@ module MARCSpec
     end
     
     def custom(name, &blk)
-      $LOG.debug "Creating custom field #{name}"
+      log.debug "Creating custom field #{name}"
       custom = CustomSolrSpec.new(:solrField=>name)
       custom.instance_eval(&blk)
       
@@ -45,17 +45,32 @@ module MARCSpec
   
   class SolrFieldSpec
     def spec(tag, &blk)
+      
+      subs = nil
+      if tag =~ /^(...)(.+)$/
+        tag = $1
+        subs = $2
+      end
+      
       if tag.to_i == tag
         tag = '%03d' % tag
       end
       
       marcfieldspec = nil
-      if MARC4J4R::ControlField.control_tag? tag
+      
+      if tag == 'LDR'
+        marcfieldspec = MARCSpec::LeaderSpec.new('LDR')
+      elsif MARC4J4R::ControlField.control_tag? tag
         marcfieldspec = MARCSpec::ControlFieldSpec.new(tag)
       else
         marcfieldspec = MARCSpec::VariableFieldSpec.new(tag)
       end
       
+      # Did we get subs? If so, add them now.
+      if subs
+        marcfieldspec.codes = subs
+      end
+      
       marcfieldspec.instance_eval(&blk) if block_given?
       
       # If we had multiple sub calls, get them from the codehistory

data/lib/marcspec/map.rb

@@ -10,14 +10,15 @@ module MARCSpec
   # NOTE: THIS IS AN ABSTRACT SUPERCLASS. DO NOT INSTANTIATE IT DIRECTLY
   
   class Map
+    include Logback::Simple
+    
     attr_accessor :mapname, :map
     
-    # Create a new map. The passed map is either
-    # a standard hash or a list of duples
+    # Create a new map. The passed map is either a standard hash (KVMap) or a list of duples
+    # (for a MultiValueMap)
     #
     # @param [String] mapname The name of this map; can be used to find it later on.
-    # @param [Hash, Array<2-value-arrays>] map Either a normal key-value hash (for a KV Map) or an
-    # array of duples (2-value arrays) for a MultiValueMap.
+    # @param [Hash, Array] map Either a normal key-value hash (for a KV Map) or an array of duples (2-value arrays) for a MultiValueMap.
     def initialize(mapname, map)
       @mapname = mapname
       @map = map
@@ -34,14 +35,14 @@ module MARCSpec
       begin
         str = File.open(filename).read
       rescue Exception => e
-        $LOG.error "Problem opening #{filename}: #{e.message}"
+        log.fatal "Problem opening #{filename}: #{e.message}"
         raise e
       end
       
       begin 
         rawmap = eval(str)
       rescue Exception => e
-        $LOG.error "Problem evaluating (with 'eval') file #{filename}: #{e.message}"
+        log.fatal "Problem evaluating (with 'eval') file #{filename}: #{e.message}"
         raise e
       end
       
@@ -58,7 +59,7 @@ module MARCSpec
       when :multi
         return MultiValueMap.new(rawmap[:mapname], rawmap[:map])
       else
-        $LOG.error "Map file #{filename} doesn't seem to be either a KV map or a MuliValueMap according to :maptype (#{rawmap[:maptype]})"
+        log.fatal "Map file #{filename} doesn't seem to be either a KV map or a MuliValueMap according to :maptype (#{rawmap[:maptype]})"
         raise ArgumentError, "File #{filename} doesn't evaluate to a valid map"
       end
       

data/lib/marcspec/multivaluemap.rb

@@ -91,7 +91,7 @@ module MARCSpec
         prop.load(f.to_inputstream)
         prop.each do |patstring,kv|
           unless patstring =~ /^pattern/ and kv =~ /.+=>.+/
-            $LOG.warn "MultiValueMap import skipping weird line in #{filename}\n  #{l}"
+            log.warn "MultiValueMap import skipping weird line in #{filename}\n  #{l}"
             next
           end
           match = /^\s*(.+?)\s*=>\s*(.+?)\s*$/.match(kv)