mab2 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1659413e48d57b2b853237962d2763d20bf6288
-  data.tar.gz: cd5bbecc8442e0769c27539e40283b41e361dc96
+  metadata.gz: 1ddffd930eea7cf17107898031a771fc6dad90be
+  data.tar.gz: b05ecb5a0ac27dfd41c2b6abec9d198a24db5031
 SHA512:
-  metadata.gz: bfde3b1e18c169f751db9faf12fa988c614ef63dcd76600ea9b143a1e9ecc95deebbce608579843b80dbdb3c517d1abfd7f242d7468294a2ea24108bcd684d37
-  data.tar.gz: 54e634c0052d6594bb3cc6e8920d2452baf901f5250bc8de34d0611088a222fb36ca83c63fbe060946d828c640a60b79ac42ba5d16111caf1413c304bdf1671d
+  metadata.gz: fa6d7aac578e249cd39daf51aba91ccacd0430e9950326521637d659703eac0fc0c9733fe65cbe557db5f8b8b8959c792ca216cd1c7cd7bf3469e4fdc3af9dbf
+  data.tar.gz: 4037cb77b8a966576f3e8e7cb0b78fb7393a2410d50b67956392848cb6f03e594e315c52ea640b17754fef00f8bd3c858f42a0d5303a9a2e9c46987b9747b3f2

data/README.md

@@ -20,6 +20,19 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+## Notes
+
+The code is slightly optimized for performance.
+
+### Bang operators
+Bang (!) operators are used where possible (http://www.skorks.com/2010/04/merging-ruby-hashes-and-bang-method-usage/), because they are faster than their non-bang counterparts.
+
+### Circumvent attribute accessors internally
+In order to minimize function calls, instance variables are accessed directly where possible, not through (own) accessors.
+
+### Shortcuts
+There are attemps to shortcut execution as soon as possible, e.g. by checking certain 'show stoppers' right in front of a function.
+
 ## Contributing
 
 1. Fork it

data/lib/mab2/document/scope.rb

@@ -1,89 +1,56 @@
 class Mab2::Document::Scope
 
-  attr_accessor :scope_subfields
-
   def initialize(document)
     @document = document
   end
 
   def controlfield(tag)
-    @document.controlfields[tag.to_sym].try(:chars) || []
-  end
-
-  def datafield(tag, indicators)
-    @scope_datafields = []
-    indicators = sanitize_indicators(indicators)
-
-    selected_datafields = if !(datafields_by_tag = @document.datafields[tag.to_sym]).nil?
-      datafields_by_tag.select do |indicator_one_key, indicator_one_value|
-        indicators[:ind1].nil? || (indicators[:ind1].any? { |ind1| ind1.length > 1 && ind1.to_s.starts_with?('-') } ^ indicators[:ind1].include?(indicator_one_key)) && indicator_one_value.any? do |indicator_two_key, indicator_two_value|
-          indicators[:ind2].nil? || indicators[:ind2].include?(indicator_two_key)
-        end
-      end
-    end
-
-    if !selected_datafields.nil?
-      selected_datafields.each_pair do |indicator_one_key, indicator_one_value|
-        indicator_one_value.each_pair do |indicator_two_key, indicator_two_value|
-          indicator_two_value.each do |subfields|
-            @scope_datafields.push Mab2::Document::Datafield.new(tag, indicators, subfields)
-          end
-        end
-      end
-    end
-
-    self
+    @document.controlfields_by(tag: tag)
   end
 
-  def get
+  def datafield(tag, indicators = {})
+    @scope_datafields = @document.datafields_by(tag: tag, indicators: indicators)
     self
   end
 
-  def fields
-    @scope_datafields
-  end
-
-  def scope_subfields
-    @scope_subfields || @scope_datafields.map { |datafield| datafield.subfields }.flatten.presence
-  end
-
   def subfield(subfield_codes)
-    # make subfield_codes an array (always)
-    subfield_codes = subfield_codes.is_a?(Array) ? subfield_codes : [subfield_codes]
+    subfield_codes = subfield_codes.is_a?(Array) ? subfield_codes : [subfield_codes] # subfield_codes should be an array
 
-    @scope_subfields = []
-
-    @scope_datafields.each do |datafield|
-      @scope_subfields.push datafield.subfields.select { |subfield| subfield_codes.include? subfield.name.to_s }
-    end
-
-    @scope_subfields.flatten!
+    @scope_subfields = @scope_datafields.map do |datafield|
+      datafield.subfields.select { |subfield| subfield_codes.include? subfield.name.to_s }
+    end.flatten! || []
 
     self
   end
 
-  def subfields
-    scope_subfields
-  end
-
   def value(options = {})
-    if !(_values = values(options)).nil?
-      _values.first
-    end
+    values.first
   end
 
   def values(options = {})
-    if !scope_subfields.nil?
-      subfield_values = scope_subfields.map { |subfield| subfield.value }
-      @scope_values = (join_string = options[:join_subfields]) ? subfield_values.join(join_string == true ? '' : join_string) : subfield_values
+    unless @scope_values
+      # if no subfields where specified so far, take all (e.g. doc.datafield('100').values))
+      @scope_subfields ||= (@scope_datafields.map { |datafield| datafield.subfields }).flatten! || []
+      subfield_values = @scope_subfields.map { |subfield| subfield.value }
+      @scope_values = options[:join_subfields] ? subfield_values.join(options[:join_subfields]) : subfield_values
+    else
+      @scope_values
     end
   end
 
- private
+  #
+  # compatibility
+  #
+  def get
+    self
+  end
 
-  # ensure a hash with array values
-  def sanitize_indicators(indicators)
-    indicators.inject({}) { |hash, (k, v)| hash[k] = (v.is_a?(Array) ? v.map(&:to_sym) : [v.to_sym]); hash }
+  def fields
+    @scope_datafields
+  end
+
+  def subfields
+    @scope_subfields
   end
 
 end

data/lib/mab2/document.rb

@@ -24,13 +24,52 @@ class Mab2::Document
     @datafields = mab.datafields
   end
 
+  #
+  # scope functions
+  #
   def controlfield(tag)
+    tag = tag.to_sym # tag should be a symbol
     Mab2::Document::Scope.new(self).controlfield(tag)
   end
 
   # mabmapper uses field instead of datafield
-  def field(tag, options = {})
-    Mab2::Document::Scope.new(self).datafield(tag, options)
+  def field(tag, indicators = {})
+    tag = tag.to_sym                                                                                          # tag should be a symbol
+    indicators.each_pair { |key, val| indicators[key] = val.is_a?(Array) ? val.map(&:to_sym) : [val.to_sym] } # indicators should be hash of symbol arrays
+    Mab2::Document::Scope.new(self).datafield(tag, indicators)
+  end
+
+  #
+  # query functions
+  #
+  def controlfields_by(options = {})
+    (result = @controlfields[options[:tag]]).nil? ? [] : result.chars
+  end
+
+  def datafields_by(options = {})
+    indicators = options[:indicators]
+    tag = options[:tag]
+    query_result = []
+
+    return [] if @datafields[tag].nil? # shortcut for 'no datafield with that tag exists'
+
+    matching_datafields = @datafields[tag].select do |indicator_one_key, indicator_one_value|
+      indicators[:ind1].nil? || (indicators[:ind1].any? { |ind1| ind1.length > 1 && ind1.to_s.starts_with?('-') } ^ indicators[:ind1].include?(indicator_one_key)) && indicator_one_value.any? do |indicator_two_key, indicator_two_value|
+        indicators[:ind2].nil? || indicators[:ind2].include?(indicator_two_key)
+      end
+    end
+
+    if !matching_datafields.nil?
+      matching_datafields.each_pair do |indicator_one_key, indicator_one_value|
+        indicator_one_value.each_pair do |indicator_two_key, indicator_two_value|
+          indicator_two_value.each do |subfields|
+            query_result.push Mab2::Document::Datafield.new(tag, indicators, subfields)
+          end
+        end
+      end
+    end
+
+    return query_result
   end
 
 end

data/lib/mab2/version.rb

@@ -1,3 +1,3 @@
 module Mab2
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mab2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Michael Sievers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri