marcman 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c76322157b266a0da1293745a4d5ed35ba7c28ad
+  data.tar.gz: 7f4d2f7e12ead3184bed9ed9702b425cfdf6d690
+SHA512:
+  metadata.gz: ba9a7575e80b7087c3d8c417fbd36509d6d6c405ad7f6467c7f213a9e04f389ef321784b14cef4749800657893614e5b9de410be9d554ce7dd805a27e8dfcb5a
+  data.tar.gz: 420e1654fd0bd8b14aa8ecbaf521b762b68ea5d644cc0ae92e0d306646698d6a3abe9c47a4a35144dc641c93b10389aa3d47f3c74ba6c16df8a313d507fa688f

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+Gemfile.lock
+*~

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at github-smr@sneakemail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in marcman.gemspec
+gemspec
+
+# Added at 2018-05-17 13:31:31 -0400 by seanredmond:
+gem "launchy", "~> 2.4"
+
+# Added at 2018-05-20 17:47:34 -0400 by sean:
+gem "colorize", "~> 0.8.1"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sean Redmond
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Marcman
+
+Like a man page for MARC. Marcman provides an executable (`marcman`)
+for quickly looking up MARC bibliographic fields by their code. It
+also provides a little quiz (`marcquiz`) to test your knowledge of
+MARC fields and subfields (because once I'd written the rest, making a
+quiz was easy and fun).
+
+## Installation
+
+Install the gem:
+
+    $ gem install marcman
+
+Run the program:
+
+    $ bundle
+
+## Usage
+
+Give `marcman` a MARC field code to see its definition:
+
+    $ marcman 245
+    245: Title Statement
+
+If you want to see the indicators user the `-i` flag:
+
+    $ marcman 245 -i
+    245: Title Statement
+      First indicator: Title added entry
+        0 - No added entry
+        1 - Added entry
+      Second indicator: Nonfiling characters
+        0 - No nonfiling characters
+        1-9 - Number of nonfiling characters
+
+Or to see the subfields use `-s`:
+
+    $ marcman 245 -s
+	245: Title Statement
+      Subfields:
+        $a - Title
+        $b - Remainder of title
+        $c - Statement of responsibility, etc.
+        $f - Inclusive dates
+        $g - Bulk dates
+        $h - Medium
+        $k - Form
+        $n - Number of part/section of a work
+        $p - Name of part/section of a work
+        $s - Version
+        $6 - Linkage
+        $8 - Field link and sequence number
+
+If you want to know what is repeatable, use `-r` (and the flags can
+all be combined):
+
+    $ marcman 245 -sr
+    245: Title Statement (non-repeatable)
+      Subfields:
+        $a - Title (non-repeatable)
+        $b - Remainder of title (non-repeatable)
+        $c - Statement of responsibility, etc. (non-repeatable)
+        $f - Inclusive dates (non-repeatable)
+        $g - Bulk dates (non-repeatable)
+        $h - Medium (non-repeatable)
+        $k - Form (repeatable)
+        $n - Number of part/section of a work (repeatable)
+        $p - Name of part/section of a work (repeatable)
+        $s - Version (non-repeatable)
+        $6 - Linkage (non-repeatable)
+        $8 - Field link and sequence number (repeatable)
+
+The `-b` flag will try to open the web documentation in your
+default browser. For example:
+
+    $ marcman 245 -b
+
+Should open https://www.loc.gov/marc/bibliographic/bd245.html 
+
+## Take the quiz
+
+Run `marcquiz` to test your knowledge of MARC in an interarctive quiz:
+
+    ~ marcquiz
+    Question 1 of 10
+    Which field is "Content Type"?
+    
+    1. 538
+    2. 026
+    3. 787
+    4. 336
+    
+    Enter your answer (Q to quit):
+
+Use the `-q` flag to change the number of questions. But really it's a
+demo of using the MARC spec data in Marcman for another purpose. if
+you `require "marcman"` in your own code you will have access to
+`Marcman::MARC` -- a big data structure with all the bibliographic
+field definitions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seanredmond/marcman. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Marcman project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/seanredmond/marcman/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "marcman"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/marcman

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require "launchy"
+require "marcman"
+
+
+options = {:browser => false,
+           :indicators => false,
+           :repeat=>false,
+           :subfields => false}
+
+# show help if there is no field argument
+ARGV << '-h' if ARGV.empty?
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: marcman [CODE] [options]"
+
+  opts.on("-i", "--[no-]indicators", "Show indicator definitions") do |i|
+    options[:indicators] = i
+  end
+
+  opts.on("-s", "--[no-]subfields", "Show subfield definitions") do |s|
+    options[:subfields] = s
+  end
+
+  opts.on("-r", "--[no-]repeatable",
+          "Show repeatability of fields and subfields") do |r|
+    options[:repeat] = r
+  end
+
+  opts.on("-b", "--[no-]browse", "Open in browser") do |b|
+    options[:browser] = b
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts Marcman::VERSION
+    exit
+  end
+
+end.parse!
+
+begin
+  code, field = Marcman::getFieldFromCode(ARGV.first)
+
+  puts "%s: %s%s" % [code, field[:definition], Marcman::formatRepeat(field[:repeat], options[:repeat])]
+  if options[:indicators] and field[:indicators]
+    (1..2).each do |i|
+      puts Marcman::formatIndicators(code, i).join("\n")
+    end
+  end
+  
+  if options[:subfields] and field[:subfields]
+    puts "  Subfields:"
+    puts Marcman::formatSubfields(code, options[:repeat]).join("\n")
+  end
+  
+  if options[:browser]
+    if field[:docurl].nil?
+      Launchy.open(
+        "https://www.loc.gov/marc/bibliographic/bd%s.html" % code.downcase
+      )
+    else
+      Launchy.open(field[:docurl])
+    end
+  end
+rescue Marcman::BadMarcFieldFormatError => e
+  puts e
+  exit 1
+rescue Marcman::NoMarcFieldError => e
+  puts e
+end

data/exe/marcquiz

@@ -0,0 +1,185 @@
+#!/usr/bin/env ruby
+
+require "colorize"
+require "marcman"
+require "optparse"
+
+class StopTheQuiz < StandardError; end
+
+# Loop until a valid response is given. Return the answer as an integer
+def getAnswer(cnt)
+  print "Enter your answer (Q to quit): "
+
+  loop do
+    answer = gets.chomp
+    if answer.downcase == "q"
+      raise StopTheQuiz.new
+    end
+
+    if answer >= "1" and answer <= cnt.to_s
+      return answer.to_i
+      break
+    end
+
+    print "Enter a number between 1 and %d, or Q to quit:" % cnt
+  end
+end
+
+# Print message saying whether you were right or wrong. Return 1 point for
+# right, 0 for wrong
+def evaluate(correct, candidates)
+  cnt = candidates.count
+  code = candidates[correct-1][0]
+  definition = candidates[correct-1][1][:definition]
+  
+  if getAnswer(cnt) == correct
+    puts "Correct!".colorize(:green)
+    return 1
+  end
+
+  puts"Sorry, the right answer was #%d. %s: %s"
+    .colorize(:red) % [correct, code, definition]
+
+  return 0
+end
+
+# Print out codes as possible answers
+def askCodes(candidates)
+  candidates.each_with_index do |c, i|
+    puts "%d. %s" % [i + 1, c[0]]
+  end
+  puts ""
+end
+
+# Print out definitiosn as possible answers
+def askDefs(candidates)
+  candidates.each_with_index do |c, i|
+    puts "%d. %s" % [i + 1, c[1][:definition]]
+  end
+  puts ""
+end  
+
+# Question Format 1:
+# Give the code for a field definition
+def qformat1(candidates, correct)
+  puts "Which field is \"%s\"?".
+         underline % candidates[correct-1][1][:definition]
+  puts ""
+
+  askCodes(candidates)
+
+  return evaluate(correct, candidates)
+end
+
+# Question Format 2:
+# Give the definitions for a field code
+def qformat2(candidates, correct)
+
+  puts "Which is field %s?".underline % candidates[correct-1][0]
+  puts ""
+
+  askDefs(candidates)
+
+  return evaluate(correct, candidates)
+end
+
+# Question Format 3:
+# Give the definition for a subfield code
+def qformat3(test_field, candidates, correct)
+  puts "For field %s: \"%s\" which subfield is subfield %s?"
+         .underline % [test_field[0],
+                       test_field[1][:definition],
+                       candidates[correct - 1][0]]
+  puts ""
+
+  askDefs(candidates)
+
+  return evaluate(correct, candidates)
+end
+
+# Question Format 4:
+# Give the code for a subfield candidate
+def qformat4(test_field, candidates, correct)
+  puts "For field %s: \"%s\" which subfield is \"%s\"?"
+         .underline % [test_field[0],
+                       test_field[1][:definition],
+                       candidates[correct - 1][1][:definition]]
+  puts ""
+
+  askCodes(candidates)
+
+  return evaluate(correct, candidates)
+end
+
+# Recursively find a field that a) has subfields and b) has more than one
+# subfield for question formats 3 & 4
+def getFieldWithSubfields(fields)
+  f = fields.sample(1).first
+  if f[1][:subfields].nil? or f[1][:subfields].count < 2
+    return getFieldWithSubfields(fields)
+  end
+  return f
+end
+
+def formatScore(score, n)
+  "%d/%d (%d%%)" % [score, n, ((score / n) * 100).round]
+end
+  
+
+# Pose a question in one of 4 formats. Recurse until the full number of
+# questions has been asked
+def ask(fields, n, q, score = 0.0)
+  return score if n > q # We're done
+
+  puts "Question %d of %d" % [n, q]
+
+  # Pick a question format
+  format = [1,2,3,4].sample(1).first
+
+  if format < 3
+    candidates = fields.sample(4).shuffle
+    correct = [1,2,3,4].sample(1).first
+
+    if format == 1
+      score += qformat1(candidates, correct)
+    else format == 2
+      score += qformat2(candidates, correct)
+    end
+  else
+    test_field = getFieldWithSubfields(fields)
+    candidates = test_field[1][:subfields].map{|k, v| [k, v]}.sample(4)
+    correct = (1..candidates.count).to_a.sample(1).first
+
+    if format == 3
+      score += qformat3(test_field, candidates, correct)
+    else
+      score += qformat4(test_field, candidates, correct)
+    end
+  end
+    
+#  puts "Score: %d out of %d (%d%%)" % [score, n, ((score / n) * 100).round]
+
+  puts "Score: %s" % formatScore(score, n)
+  puts ""
+  
+  return ask(fields, n+1, q, score)
+end
+
+options = {:q => 10}
+OptionParser.new do |opts|
+  opts.banner = "Usage: marcquiz [options]"
+
+  opts.on("-q", "--questions=QUESTIONS",
+          "Number of questions for the quiz (Default: 10") do |q|
+    options[:q] = q.to_i
+  end
+end.parse!
+
+
+begin
+  puts "Your final score: %s" % formatScore(
+         ask(Marcman::MARC.map{|k, v| [k, v]},1, options[:q]),
+         options[:q])
+rescue StopTheQuiz
+  puts "Thanks for playing!"
+end

data/lib/marcman/constants.rb

@@ -0,0 +1,60 @@
+module Marcman
+    # Constants for widely used subfield definitions. These are roughly in
+  # descending order of use
+  
+  LINKAGE = {"$6"=>{:definition=>"Linkage", :repeat=>false}}
+  FIELDLINK = {"$8"=>{:definition=>"Field link and sequence number", :repeat=>true}}
+
+  MATSPEC = {:definition=>"Materials specified", :repeat=>false}
+  RWURI   = {:definition=>"Real World Object URI"}
+  ARECNUM = {:definition=>"Authority record control number or standard number"}
+  RELAT   = {:definition=>"Relationship"}
+  ISSNR   = {:definition=>"International Standard Serial Number"}
+  ISSNNR  = {:definition=>"International Standard Serial Number",
+             :repeat=>false}
+  MISCINF = {:definition=>"Miscellaneous information"}
+  INSTAPP = {:definition=>"Institution to which field applies", :repeat=>false}
+  SOURCE  = {:definition=>"Source", :repeat=>false}
+  NAMEPRT = {:definition=>"Name of part/section of a work"}
+  RELINFO = {:definition=>"Relationship information"}
+  UNIFORM = {:definition=>"Uniform title", :repeat=>false}
+  MEDIUM  = {:definition=>"Medium", :repeat=>false}
+  RELATOR = {:definition=>"Relator term"}
+  CTRLSUB = {:definition=>"Control subfield", :repeat=>false}  
+  NOTER   = {:definition=>"Note"}
+  FORMSUB = {:definition=>"Form subheading"}
+  TITLENR = {:definition=>"Title", :repeat=>false}
+  LANGNR  = {:definition=>"Language of a work", :repeat=>false}
+  DATENR  = {:definition=>"Date of a work", :repeat=>false}
+  PUBNOTE = {:definition=>"Public note"}
+  RECCTRL = {:definition=>"Record control number"}
+  WRKTITL = {:definition=>"Title of a work", :repeat=>false}
+  QUALINF = {:definition=>"Qualifying information", :repeat=>false}
+  ISBNR   = {:definition=>"International Standard Book Number"}
+  PLCPUB  = {:definition=>"Place, publisher, and date of publication",
+             :repeat=>false}
+  EDTNNR  = {:definition=>"Edition", :repeat=>false}
+  RELPRTS = {:definition=>"Related parts"}
+  PHYSDSC = {:definition=>"Physical description", :repeat=>false}
+  MSDETL  = {:definition=>"Material-specific details", :repeat=>false}
+  VRSNR   = {:definition=>"Version"}
+  OIID    = {:definition=>"Other item identifier"}  
+  NPUBNOT = {:definition=>"Nonpublic note"}
+  CODENR  = {:definition=>"CODEN designation", :repeat=>false}
+  MAINENT = {:definition=>"Main entry heading", :repeat=>false}
+  NUMPART = {:definition=>"Number of part/section of a work"}
+  TECHREP = {:definition=>"Standard Technical Report Number", :repeat=>false}  
+  SRCTERM = {:definition=>"Source of term", :repeat=>false}
+  RELSERD = {:definition=>"Series data for related item"}
+  REPNUM  = {:definition=>"Report number"}  
+  MUSKEY  = {:definition=>"Key for music", :repeat=>false}
+  MUSMED  = {:definition=>"Medium of performance for music"}
+  HEADSRC = {:definition=>"Source of heading or term", :repeat=>false}
+  AFFIL   = {:definition=>"Affiliation", :repeat=>false}
+  GEOSUB  = {:definition=>"Geographic subdivision"}
+  CRONSUB = {:definition=>"Chronological subdivision"}
+  FRMSUBD = {:definition=>"Form subdivision"}
+  ARRANGE = {:definition=>"Arranged statement for music", :repeat=>false}
+  GNRLSUB = {:definition=>"General subdivision"}
+  ITEMNUM = {:definition=>"Item number", :repeat=>false}
+end

data/lib/marcman/errors.rb

@@ -0,0 +1,4 @@
+module Marcman
+  class BadMarcFieldFormatError < StandardError; end
+  class NoMarcFieldError < StandardError; end
+end