marc_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b554d620d2e9958dbd0911ccff5232df5ef37f15fa6395d71ae3984f42f7a7fe
+  data.tar.gz: 496241156b3cb4913573fd12bdcd6b12d9d47456303ae03b925d2a9d7f928b01
+SHA512:
+  metadata.gz: 664d05078912b06e07ce7aac508a295ee87753450df541bcccc51404e2190c221202e01b723c36ac730849c9b9e56b3e540250c077212df8985c42973b956c88
+  data.tar.gz: 18e9d92aca1226b69ff1065231e2b5a24312e35251b09b6f6b14c5b026d18af65751c1a26603d11e9c29147c73c0a217de93ce52ebdd65f342b91291b407abd7

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.3
+        bundler-cache: true
+    - name: Run standard Ruby check
+      run: bundle exec standardrb
+    - name: Run the spec tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in marc-bot.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    marc_bot (0.1.0)
+      marc (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    faker (2.18.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    marc (1.1.1)
+      rexml
+      scrub_rb (>= 1.0.1, < 2)
+      unf
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    scrub_rb (1.0.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    standard (1.1.2)
+      rubocop (= 1.17.0)
+      rubocop-performance (= 1.11.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  faker
+  marc_bot!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-its
+  simplecov
+  standard (~> 1.1)
+
+BUNDLED WITH
+   2.2.20

data/README.md

@@ -0,0 +1,101 @@
+# MarcBot
+
+A MARC record generator inspired by [FactoryBot](https://github.com/thoughtbot/factory_bot). 
+Use it to create sample MARC records for testing your applications.
+
+Note: This is in a very alpha state. Comments, architecture suggestions, and feature requests are all welcome
+
+## Setup
+
+Add the gem to you Gemfile. You'll probably only want this in your dev and test environments. And, while you're at
+it, why don't you add Faker too?
+
+Add this line to your application's Gemfile
+
+``` ruby
+group :development, :test do 
+  gem 'faker'
+  gem 'marc_bot'
+end
+```
+
+And then execute:
+
+    bundle install
+
+Or install the gem directly:
+
+    gem install marc_bot
+
+### Usage with RSpec
+
+If you're running this in a test suite, such as RSpec, you'll need to initialize your factory definitions:
+
+``` ruby
+require 'faker'
+require 'marc_bot'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    MarcBot.reload
+  end
+end
+```
+
+## Usage
+
+Create a directory to store all of you different factory definitions. Borrowing from FactoryBot, these directories
+are:
+
+* records
+* test/records
+* spec/records
+
+Create a file in one of those directories--it can have any name, so long as it ends in `.rb`--and 
+define a factory for a given kind of record you'd like to create and assign its values:
+
+``` ruby
+MarcBot.define do
+  factory :book do
+    f008 { "191003s2020 maua b 001 0 eng d"
+    f100 { "Thomas, David" }
+    f245 do
+      { 
+        a: "The pragmatic programmer :",
+        b: "your journey to mastery /",
+        c: "Dave Thomas, Andy Hunt."
+      }
+    end
+  end
+end
+```
+
+Then call-up the factory when you need it:
+
+``` ruby
+book = MarcBot.build(:book)
+```
+
+You can also pass in additional fields at build time:
+
+``` ruby
+book = MarcBot.build(:book, f949: { a: "QA76.6.T4494 2020", w: "LC" })
+```
+
+### Syntax
+
+All tagged fields should be prefaced with an "f", although technically, any non-numeric set of letters is fine. We're
+just looking for three numbers. If no subfield is specified, `$a` is assumed.
+
+## 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 the created tag, 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/awead/marc_bot.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "marc_bot"
+
+# 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/lib/marc_bot.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "marc"
+
+module MarcBot
+  require "marc_bot/factory"
+  require "marc_bot/field_builder"
+  require "marc_bot/find_definitions"
+  require "marc_bot/registry"
+  require "marc_bot/version"
+
+  class Error < StandardError; end
+
+  class << self
+    def define(&block)
+      instance_exec(&block)
+    end
+
+    def factory(record_name, &block)
+      block ||= ->(result) { result }
+      factories.register(record_name, block)
+    end
+
+    def build(record_symbol, **options)
+      find_definitions if factories.nil?
+
+      record_factory = factories.find(record_symbol)
+      factory = Factory.new
+      factory.instance_exec(&record_factory)
+      options.map do |option|
+        factory.send(option[0]) { option[1] }
+      end
+      factory.record
+    end
+
+    def reload
+      @factories = nil
+      find_definitions
+    end
+
+    def factories
+      @factories ||= Registry.new("Factory")
+    end
+  end
+end

data/lib/marc_bot/factory.rb

@@ -0,0 +1,21 @@
+module MarcBot
+  class Factory
+    attr_reader :record
+
+    def initialize
+      @record = MARC::Record.new
+    end
+
+    def method_missing(method, *args, &block)
+      if method == :leader
+        record.leader = yield
+      else
+        record.append MarcBot::FieldBuilder.call(method: method, input: yield, args: args)
+      end
+    end
+
+    def respond_to_missing?
+      super
+    end
+  end
+end

data/lib/marc_bot/field_builder.rb

@@ -0,0 +1,64 @@
+module MarcBot
+  class FieldBuilder
+    SKIP_KEYS = %i[
+      indicator1
+      indicator2
+    ]
+
+    def self.call(**args)
+      new(args.delete(:method), args.delete(:input), args).fields
+    end
+
+    attr_reader :method, :input
+
+    def initialize(method, input, options)
+      @method = method
+      @input = input
+    end
+
+    # @return [MARC::ControlField, MARC::DataField]
+    def fields
+      if input.is_a?(String)
+        data_or_control_field(input)
+      elsif input.is_a?(Hash)
+        MARC::DataField.new(tag, indicator1, indicator2, *subfield_array)
+      else
+        raise ArgumentError, "#{input.class} isn't a supported factory type"
+      end
+    end
+
+    private
+
+    def data_or_control_field(input)
+      if MARC::ControlField.control_tag?(tag)
+        MARC::ControlField.new(tag, input)
+      else
+        MARC::DataField.new(tag, "0", " ", ["a", input])
+      end
+    end
+
+    def subfield_array
+      input
+        .reject { |key, _value| SKIP_KEYS.include?(key) }
+        .to_a
+        .map { |subfield| subfield.map(&:to_s) }
+    end
+
+    def tag
+      @tag ||= begin
+        result = method.to_s.match(/\d{3}/).to_s
+        raise MarcBot::Error, "could not determine tag for :#{method}" if result == ""
+
+        result
+      end
+    end
+
+    def indicator1
+      input.fetch(:indicator1, "0")
+    end
+
+    def indicator2
+      input.fetch(:indicator2, " ")
+    end
+  end
+end

data/lib/marc_bot/find_definitions.rb

@@ -0,0 +1,27 @@
+# @note Shamelessly copied from
+# https://github.com/thoughtbot/factory_bot/blob/master/lib/factory_bot/find_definitions.rb
+module MarcBot
+  class << self
+    # An Array of strings specifying locations that should be searched for MARC record definitions. By default, marc_bot
+    # will attempt to require "records", "test/records" and "spec/records". Only the first existing file will be loaded.
+    attr_accessor :definition_file_paths
+  end
+
+  self.definition_file_paths = %w[records test/records spec/records]
+
+  def self.find_definitions
+    absolute_definition_file_paths = definition_file_paths.map { |path|
+      File.expand_path(path)
+    }
+
+    absolute_definition_file_paths.uniq.each do |path|
+      load("{path}.rb") if File.exist?("{path}.rb")
+
+      if File.directory? path
+        Dir[File.join(path, "**", "*.rb")].sort.each do |file|
+          load file
+        end
+      end
+    end
+  end
+end

data/lib/marc_bot/registry.rb

@@ -0,0 +1,33 @@
+module MarcBot
+  class Registry
+    include Enumerable
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @items = {}
+    end
+
+    def clear
+      items.clear
+    end
+
+    def find(name)
+      items[name] || raise(Error, "item :#{name} does not exist in the registry. Did you define it?")
+    end
+    alias_method :[], :find
+
+    def register(name, item)
+      items[name] = item
+    end
+
+    def registered?(name)
+      items.key?(name)
+    end
+
+    private
+
+    attr_reader :items
+  end
+end

data/lib/marc_bot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MarcBot
+  VERSION = "0.1.0"
+end

data/marc_bot.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/marc_bot/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "marc_bot"
+  spec.version = MarcBot::VERSION
+  spec.authors = ["Adam Wead"]
+  spec.email = ["awead@users.noreply.github.com"]
+
+  spec.summary = "A MARC record generator used for testing library systems"
+  spec.description = "Uses FactorBot-style syntax to generate MARC records with various random content in them."
+  spec.homepage = "https://github.com/awead/marc_bot"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "marc", "~> 1.1"
+
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "standard", "~> 1.1"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "rspec-its"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: marc_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Wead
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: marc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: simplecov
+  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: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: Uses FactorBot-style syntax to generate MARC records with various random
+  content in them.
+email:
+- awead@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/marc_bot.rb
+- lib/marc_bot/factory.rb
+- lib/marc_bot/field_builder.rb
+- lib/marc_bot/find_definitions.rb
+- lib/marc_bot/registry.rb
+- lib/marc_bot/version.rb
+- marc_bot.gemspec
+homepage: https://github.com/awead/marc_bot
+licenses: []
+metadata:
+  homepage_uri: https://github.com/awead/marc_bot
+  source_code_uri: https://github.com/awead/marc_bot
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.20
+signing_key:
+specification_version: 4
+summary: A MARC record generator used for testing library systems
+test_files: []