traject_profiling 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e0af0cc816155f0d24efd1e61b3291aff736b9a
+  data.tar.gz: 339785fe91fe7114c85627ee48935c9e1e366904
+SHA512:
+  metadata.gz: 8eb43cb020eadf138e87d2dbeedfff53f086507d87060dd0c31649328050979c45903163412ae3bd83a4921cdb5e0fbe6d999018feccbf6a32fa862b3fdfa1fb
+  data.tar.gz: f1d6e12641c74351ce0ffec992afc921b8e9120c9666f9f0c1421fa1dbdb2560d63dbf8f893994ece7f0bf957beacc53750c5e64dbca777f8ca782125f023477

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+script: rake ci
+rvm:
+  - ruby-head
+  - 2.2.3
+  - 2.1.5 # developing here, for now
+  - jruby-9.0.0.0
+  - jruby-1.7.20
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+notifications:
+  email:
+    - ndushay@stanford.edu
+sudo: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in traject_profiling.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright 2015 The Board of Trustees of the Leland Stanford Junior University.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,48 @@
+# traject_profiling
+
+Traject macros to provide profiling information on MARC bibliographic records.
+
+This code is meant to be used with [traject](http://github.com/traject/traject) to index MARC records into [Solr](http://lucene.apache.org/solr).
+
+## Usage
+
+### A sample traject configuration file using macros from traect_profiling
+
+```ruby
+require 'traject'
+require 'traject/profiling'
+extend Traject::Profiling::Macros
+
+to_field 'id',          extract_marc('001', :first=>true)
+to_field 'f700count',   field_count('700')
+to_field 'f700ind1',    field_ind_vals('700', '1')
+to_field 'f700ind2',    field_ind_vals('700', '2')
+to_field 'f700subflds', field_subfield_codes('700')
+to_field 'f880_for',    f880_tags
+to_field 'f880_for',    f880_tags_and_subfields
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'traject_profiling'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install traject_profiling
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/traject_profiling/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler'
+  require "bundler/gem_tasks"
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+  task :doc => :yard
+rescue LoadError
+  # yard not available - we're probably on a prod environment or need to run bundle install
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+ # rspec not available - we're probably on a prod environment or need to run bundle install
+end
+

data/lib/traject/profiling/field_macros.rb

@@ -0,0 +1,25 @@
+module Traject
+  class Profiling
+
+    module Macros
+
+      # to_field 'f100ind1', field_ind('100', '1')
+      # to_field 'f100ind2', field_ind('100', '2')
+      # to_field 'f100subflds', profile_subfields('100')
+
+      # counts the number of occurrences of a field in a marc record.
+      #   If no occurrences, accumulator is not altered (field should be missing in output_hash)
+      # @param [String] tag - marc field tag; three chars (usually but not neccesarily numeric)
+      # @return [lambda] lambda expression appropriate for "to_field", with the number of marc fields
+      #   matching the tag param added to in the lambda's accumulator param
+      def field_count(tag)
+        return lambda do |record, accumulator, context|
+          num_fields = record.fields(tag).size
+          accumulator << num_fields.to_s if num_fields > 0
+        end
+      end
+
+    end # module Macros
+
+  end
+end

data/lib/traject/profiling/version.rb

@@ -0,0 +1,5 @@
+module Traject
+  class Profiling
+    VERSION = "0.0.1"
+  end
+end

data/lib/traject/profiling.rb

@@ -0,0 +1,8 @@
+require "traject/profiling/version"
+require "traject/profiling/field_macros"
+
+module Traject
+  class Profiling
+
+  end
+end

data/spec/field_macros_spec.rb

@@ -0,0 +1,64 @@
+
+RSpec.describe 'field_macros' do
+
+  let!(:indexer) {
+    i = Traject::Indexer.new
+    i.instance_eval do
+      extend Traject::Profiling::Macros
+    end
+    i
+  }
+
+  context "field_count" do
+    let!(:record) {
+      marcxml_str =
+        '<record xmlns="http://www.loc.gov/MARC21/slim">
+            <leader>01052cam a2200313 i 4500</leader>
+            <controlfield tag="001">245a</controlfield>
+            <controlfield tag="008">140604t20152015enk      b    001 0 eng d</controlfield>
+            <datafield ind1="1" ind2="0" tag="245">
+              <subfield code="a">Slippery noodles</subfield>
+            </datafield>
+            <datafield tag="700" ind1="1" ind2=" ">
+              <subfield code="a">Potter, Harry.</subfield>
+            </datafield>
+            <datafield tag="700" ind1="1" ind2=" ">
+              <subfield code="a">Snape, Severus.</subfield>
+            </datafield>
+          </record>'
+      parse_marc(marcxml_str)
+    }
+
+    it 'single occurrence of tag' do
+      indexer.instance_eval do
+        to_field '245count', field_count('245')
+      end
+      output = indexer.map_record(record)
+      expect(output['245count']).to eq ['1']
+    end
+    it 'mult occurrences of tag' do
+      indexer.instance_eval do
+        to_field '700count', field_count('700')
+      end
+      output = indexer.map_record(record)
+      expect(output['700count']).to eq ['2']
+    end
+    it 'no occurrences of tag: field not in output_hash' do
+      indexer.instance_eval do
+        to_field '100count', field_count('100')
+      end
+      output = indexer.map_record(record)
+      expect(output['100count']).to eq nil
+    end
+  end # field_count
+
+end
+
+# @param [String] marcxml_str an xml representation of a MARC record
+# @raise [Marc::Exception] if nil returned from MARC::XMLReader
+# @return [MARC::Record] parsed marc_record
+def parse_marc(marcxml_str)
+  marc_record = MARC::XMLReader.new(StringIO.new(marcxml_str)).to_a.first
+  fail(MARC::Exception, "unable to parse marc record: " + marcxml_str, caller) if marc_record.nil?
+  marc_record
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'traject'
+require 'traject/profiling'
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+#  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+end

data/traject_profiling.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib/", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'traject/profiling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "traject_profiling"
+  spec.version       = Traject::Profiling::VERSION
+  spec.authors       = ["Naomi Dushay"]
+  spec.email         = ["ndushay@stanford.edu"]
+  spec.summary       = %q{Traject macros to provide profiling information on MARC bibliographic records.}
+  spec.description   = %q{Profiling macros for MARC bib records; meant to be used with traject to index MARC records into Solr.}
+  spec.homepage      = "https://github.com/sul-dlss/traject_profiling.git"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "lib/traject", "lib/traject/profiling"]
+
+  spec.add_runtime_dependency 'traject'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: traject_profiling
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naomi Dushay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: traject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Profiling macros for MARC bib records; meant to be used with traject
+  to index MARC records into Solr.
+email:
+- ndushay@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/traject/profiling.rb
+- lib/traject/profiling/field_macros.rb
+- lib/traject/profiling/version.rb
+- spec/field_macros_spec.rb
+- spec/spec_helper.rb
+- traject_profiling.gemspec
+homepage: https://github.com/sul-dlss/traject_profiling.git
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/traject
+- lib/traject/profiling
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Traject macros to provide profiling information on MARC bibliographic records.
+test_files:
+- spec/field_macros_spec.rb
+- spec/spec_helper.rb
+has_rdoc: