marcspec 0.5.0 → 0.6.0

data/CHANGES

@@ -1,3 +1,5 @@
+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.

data/README.rdoc

@@ -3,45 +3,11 @@
 The MARCSpec contains classes designed to make it (relatively) easy to specify
 a data field (my use case specifically is solr) in terms of sets of MARC fields and subfields.
 
-== A simple breakdown of the hierarchy
-
-This is all based on how the excellent [Solrmarc](http://code.google.com/p/solrmarc/)
-deals with configuration. MARCSpec supports a subset of Solrmarc's configuration
-options. 
-
-* A {MARCSpec::SpecSet} consists of a (possibly empty) set of named {MARCSpec::Map}
-  and a list of {MARCSpec::SolrFieldSpec} and/or {MARCSpec::CustomSolrSpec}. 
-* A {MARCSpec::SolrFieldSpec} consists of a field name, a list of MARC field specs (see below),
-  an optional {MARCSpec::Map} for translating raw values to something else, and
-  a bunch of optional specials (e.g., a notation to only use the first value,
-  a default value if no appropriate data is in the MARC record, a default value
-  for when marc data is found, but nothing is in the map, etc.)
-* A {MARCSpec::CustomSolrSpec} occupies the same niche as a {MARCSpec::SolrFieldSpec}, but
-  allows you to use a custom routine instead of the pre-packaged MARC specification syntax.
-* A MARC Field Spec is one of the following
-  * A {MARCSpec::LeaderSpec} for dealing with the leader
-  * A {MARCSpec::ControlFieldSpec}, consisting of a tag (as a string, not a number) and
-    an optional zero-based index (e.g., "001[3]") or range (e.g., "001[11..13]")
-  * A {MARCSpec::VariableFieldSpec}, consisting of a tag, a couple indicator patterns
-    (currently ignored, but stay tuned), an optional list of subfields (default
-    is all), and an optional string used to join the subfields (default is
-    a single space)
-* A *map* is one of:
-  * A {MARCSpec::KVMap}, which is just a Ruby hash. It will match at most one k-v pair, although
-    the "value" might actually be either a scalar or an array of scalars
-  * A {MARCSpec::MultiValueMap}, which is an array of key/value duples. A passed
-    potential map is compared (via ===) with every key, returning all
-    the associated values. Again, a single "key" can be associated with an array of
-    return values; the whole thing is flattened out before returning
-
-Obviously, better descriptions and full documentation is available in each 
-individual class.
-
-== Better examples in marc2solr
-
-Better documented samples are available as part of the marc2solr project
-at http://github.com/billdueber/marc2solr -- look in the simple_sample area.
 
+== Docs and examples in marc2solr
+
+Documented samples are available as part of the marc2solr project
+at http://github.com/billdueber/marc2solr -- look in the simple_sample area.
 
 
 == Note on Patches/Pull Requests

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gem.add_development_dependency "yard", ">= 0"
 
     gem.add_dependency 'marc4j4r', '>=0.9.0'
-    gem.add_dependency 'jruby_streaming_update_solr_server', '>=0.2.0'
+    gem.add_dependency 'jruby_streaming_update_solr_server', '>=0.3.1'
     
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/marcspec/customspec.rb

@@ -40,6 +40,7 @@ module MARCSpec
         raise ArgumentError, "Custom solr spec must have a field name in :solrField, module in :module, and the method name as a symbol in :methodSymbol"
       end
       
+      
       @methodArgs = opts[:methodArgs] || []
       
       @first = opts[:firstOnly] || false      
@@ -47,6 +48,16 @@ module MARCSpec
       @map = opts[:map] || nil
       @noMapKeyDefault = opts[:noMapKeyDefault] || nil
       
+      if @solrField.is_a? Array
+        @arity = @solrField.size
+        if @first or @default or @map or @noMapKeyDefault 
+          raise ArgumentError, "Custom spec with multiple solrFields can't have :first, :map, :default, or :noMapKeyDefault set"
+        end
+      else
+        @arity = 1
+      end
+      
+      
     end
     
     

data/lib/marcspec/solrfieldspec.rb

@@ -1,7 +1,7 @@
 require 'stringio'
 module MARCSpec
   class SolrFieldSpec
-    attr_accessor :solrField, :first, :map, :noMapKeyDefault, :marcfieldspecs, :default
+    attr_accessor :solrField, :first, :map, :noMapKeyDefault, :marcfieldspecs, :default, :arity
 
     def initialize(opts)
       @solrField  = opts[:solrField]
@@ -9,6 +9,7 @@ module MARCSpec
       @default = opts[:default] || nil
       @map = opts[:map] || nil
       @noMapKeyDefault = opts[:noMapKeyDefault] || nil
+      @arity = 1
       @marcfieldspecs = []
     end
 
@@ -27,6 +28,7 @@ module MARCSpec
       
     def marc_values r, doc = {}
       vals = raw_marc_values r, doc
+      return vals if @arity > 1
       unless vals.is_a? Array
         vals = [vals]
       end

data/lib/marcspec/specset.rb

@@ -16,6 +16,13 @@ module MARCSpec
       end
       self[key].flatten!      
     end
+
+    def additive_merge! hashlike
+      hashlike.each  do |k, v|
+        self.add(k, v)
+      end
+    end
+    
   end
 
   class SpecSet
@@ -82,8 +89,14 @@ module MARCSpec
     
     def fill_hashlike_from_marc r, hashlike
       @solrfieldspecs.each do |sfs|
-        hashlike.add(sfs.solrField,sfs.marc_values(r, hashlike))
-        # hashlike[sfs.solrField] = sfs.marc_values(r, hashlike)
+        if sfs.arity == 1
+          hashlike.add(sfs.solrField,sfs.marc_values(r, hashlike))
+        else 
+          vals = sfs.marc_values(r, hashlike)
+          (0..(sfs.arity - 1)).each do |i|
+            hashlike.add(sfs.solrField[i], vals[i])
+          end
+        end
       end
     end
 

data/spec/specset_spec.rb

@@ -22,6 +22,11 @@ module A
       end
       return vals
     end
+    
+    
+    def self.three_value_custom doc, r
+      return [1, 2, ['a', 'b']]
+    end
   end
 end
 
@@ -77,6 +82,21 @@ describe "SpecSet Basics" do
     h = ss.hash_from_marc @one
     h['titleA'].sort.should.equal expected.sort
   end
+  
+  it "should allow multi-headed custom fields" do
+    @speclist << {:solrField => ['one', 'two', 'letters'],
+                  :module => A::B,
+                  :methodSymbol => :three_value_custom,
+      }
+    ss = MARCSpec::SpecSet.new
+    ss.buildSpecsFromList(@speclist)
+    h = ss.hash_from_marc @one
+    h['one'].should.equal [1]
+    h['two'].should.equal [2]
+    h['letters'].should.equal ['a', 'b']
+  end
+    
+    
 end
    
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: marcspec
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - BillDueber
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-16 00:00:00 -04:00
+date: 2010-08-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,12 +70,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 17
         segments: 
         - 0
-        - 2
-        - 0
-        version: 0.2.0
+        - 3
+        - 1
+        version: 0.3.1
   type: :runtime
   version_requirements: *id004
 description: Relies on marc4j4r, based on work in solrmarc