lccnorm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cb6ef7fdef3c20b96000fdf3fc90e4c6f77ec81602b67d2776e4ee7df545584
+  data.tar.gz: 5e94dddf3362b697d6e9e1c5046089fbba489c035ee73b6a9fd0807b7c584931
+SHA512:
+  metadata.gz: 98e8aee0d556479982d818d8a5c467afd609094cf0eb68a6a788913f3cfbebc1130f2cdb166e31f6eab2fce628190597e5485de8106c06e77103125a413b7f1a
+  data.tar.gz: 271079a2ac453366fc71277eb899ef9d5fc72b83589d529c218fcd79725f255b71563c607f54aa6088778198cdd1b0a096f86563e10121119a67c07a8b1fa907

data/.gitignore

@@ -0,0 +1,13 @@
+/.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,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.4
+  - 2.3
+  - 2.2
+  - 2.1
+before_install: gem install bundler -v 1.16.2

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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lccnorm.gemspec
+gemspec

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,58 @@
+# Lccnorm
+
+[![Gem Version](http://img.shields.io/gem/v/lccnorm.svg)][gem]
+[![Build Status](http://img.shields.io/travis/seanredmond/lccnorm-rb.svg)][travis]
+
+[gem]: https://rubygems.org/gems/lccnorm
+[travis]: http://travis-ci.org/seanredmond/lccnorm-rb
+
+Normalize and validate Library of Congress Control Numbers according to [LOC
+guidelines](https://www.loc.gov/marc/lccn-namespace.html)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lccnorm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lccnorm
+
+## Usage
+
+Get a normalized version of an LCCN:
+
+    > Lccnorm::normalize("75-425165//r75")
+     => "75425165"
+     
+Check that an LCCN is valid:
+
+    > Lccnorm::valid?("75425165")
+     => true
+    > Lccnorm::valid?("not even a number")
+     => false
+
+## 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/lccnorm. 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 Lccnorm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/seanredmond/lccnorm/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 "lccnorm"
+
+# 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/lccnorm.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lccnorm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lccnorm"
+  spec.version       = Lccnorm::VERSION
+  spec.authors       = ["Sean Redmond"]
+  spec.email         = ["github-smr@sneakemail.com"]
+
+  spec.summary       = %q{Normalize Library of Congress Control Numbers.}
+  spec.homepage      = "https://github.com/seanredmond/lccnorm-rb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/lccnorm.rb

@@ -0,0 +1,72 @@
+require "lccnorm/version"
+
+
+module Lccnorm
+  class InvalidLccnError < StandardError; end
+
+  # Normalize LCCN according to Library of Congress rules
+  # (https://www.loc.gov/marc/lccn-namespace.html)
+  #
+  # An LCCN is to be normalized to its canonical form described in the syntax
+  # description above, as follows:
+  #
+  # 1. Remove all blanks.
+  # 
+  # 2. If there is a forward slash (/) in the string, remove it, and remove all
+  # characters to the right of the forward slash.
+  #
+  # 3. If there is a hyphen in the string:
+  #    * Remove it.
+  #    * Inspect the substring following (to the right of) the (removed)
+  #      hyphen. Then (and assuming that steps 1 and 2 have been carried out):
+  #         *  All these characters should be digits, and there should be six
+  #            or less.
+  #         *  If the length of the substring is less than 6, left-fill the
+  #            substring with zeros until the length is six.
+  #
+  def self.normalize(lccn)
+    l, r = lccn.tr(' ', '').split('/')[0].split('-', 2)
+
+    # No hyphen? Easy
+    if r.nil?
+      return l
+    end
+
+    # Make sure there are 6 or fewer characters to the right of the hyphen
+    # (there has to be at least on or we already would have returned) and pad to
+    # the left with zeros
+    if r =~ /\A\d{1,6}\z/
+      return l + r.rjust(6, '0')
+    end
+
+    # If we get this far, something is wrong with the number
+    raise InvalidLccnError.new(
+            "%s is not a valid LCCN " % lccn + \
+            "(part to the right of hyphen should be 6 numeric characters " + \
+            "or fewer")
+    
+  end
+
+  # Validate LCCN according to Library of Congress rules
+  # (https://www.loc.gov/marc/lccn-namespace.html)
+  #
+  # A normalized LCCN is a character string eight to twelve characters in
+  # length. (For purposes of this description characters are ordered from left
+  # to right -- "first" means "leftmost".)
+  #
+  # * The rightmost eight characters are always digits.
+  # * If the length is 9, then the first character must be alphabetic.
+  # * If the length is 10, then the first two characters must be either both
+  #   digits or both alphabetic.
+  # * If the length is 11, then the first character must be alphabetic and the
+  #   next two characters must be either both digits or both alphabetic.
+  # * If the length is 12, then the first two characters must be alphabetic and
+  #   the remaining characters digits.
+  def self.valid?(lccn)
+    if lccn =~ /\A([A-z]{2}\d{2}|([A-z]?([A-z]{2}|\d{2}))|[A-z])?\d{8}\z/
+      return true
+    end
+
+    return false
+  end                                                
+end

data/lib/lccnorm/version.rb

@@ -0,0 +1,3 @@
+module Lccnorm
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: lccnorm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sean Redmond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- github-smr@sneakemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lccnorm.gemspec
+- lib/lccnorm.rb
+- lib/lccnorm/version.rb
+homepage: https://github.com/seanredmond/lccnorm-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Normalize Library of Congress Control Numbers.
+test_files: []