mistaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c599e4bbea945f91c6e5b6333037e18c51323d7721b49e40e46d75bcef816a7b
+  data.tar.gz: 53970a7bb6d7507f6204f0f425c4c2e21f3abaccca5df4978e1039b03a9047f7
+SHA512:
+  metadata.gz: 027f082c6bf5efbc9440781bab619bc5d453a4104f86ce350ef6d5a5c0f3b38c3ea2229540b4f9f69bb973e2b7d3fbfb397e8da1d15da1fc7f10dc408db573e3
+  data.tar.gz: b3f73c5379f18970d9795161e539e0d67c97d0fc56a0479812e9fd83c5111b4534dc1a41813caa5eb2b9a39a6ef2e07a35e737eab9a1a004a76cf16c0516d36a

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 mcowden@codeforamerica.org. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mistaker.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    mistaker (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    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-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mistaker!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Michael Cowden
+
+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,46 @@
+# Mistaker
+
+Mistaker is a gem for emulating common data entry errors that arise from transcription, OCR and numerical data entry.  Use the gem to generate common variations of strings, numerics and dates you might find in older, hand entered data sets.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mistaker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mistaker
+
+## Usage
+
+```ruby
+
+Mistaker::Name.mistake 'FALLOUT'
+
+```
+
+## 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/[USERNAME]/mistaker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/mistaker/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Mistaker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mistaker/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 "mistaker"
+
+# 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/mistaker.rb

@@ -0,0 +1,164 @@
+require "mistaker/version"
+require "mistaker/base"
+require "mistaker/date"
+require "mistaker/number"
+require "mistaker/name"
+
+module Mistaker
+  class Error < StandardError; end
+
+  NUMBER_MAX = 5
+  DATE_MAX = 8
+  NAME_MAX = 7
+
+  ONE_DIGIT_UP, ONE_DIGIT_DOWN, NUMERIC_KEY_PAD, DIGIT_SHIFT, MISREAD, KEY_SWAP = (0..NUMBER_MAX).to_a
+  MONTH_DAY_SWAP, ONE_DECADE_DOWN, Y2K = ((NUMBER_MAX + 1)..DATE_MAX).to_a
+
+  DROPPED_LETTER, DOUBLE_LETTER, MISREAD_LETTER, MISTYPED_LETTER, EXTRA_LETTER, VOWEL_REPLACEMENT, CONSONANT_REPLACEMENT = (0..NAME_MAX).to_a
+
+  MISREAD_NUMBERS = {
+    '0' => '8',
+    '1' => '7',
+    '2' => '5',
+    '3' => '8',
+    '4' => '9',
+    '5' => '6',
+    '6' => '5',
+    '7' => '1',
+    '8' => '3',
+    '9' => '4'
+  }.freeze
+
+  MISREAD_LETTERS = {
+    'A' => 'E',
+    'B' => 'D',
+    'C' => 'E',
+    'D' => 'B',
+    'E' => 'A',
+    'F' => 'F',
+    'G' => 'C',
+    'H' => 'M',
+    'I' => 'L',
+    'J' => 'Q',
+    'K' => 'X',
+    'L' => 'I',
+    'M' => 'H',
+    'N' => 'N',
+    'O' => 'A',
+    'P' => 'Q',
+    'Q' => 'G',
+    'R' => 'V',
+    'S' => 'Z',
+    'T' => 'I',
+    'U' => 'V',
+    'V' => 'U',
+    'W' => 'W',
+    'X' => 'K',
+    'Y' => 'T',
+    'Z' => 'S',
+    ' ' => ' '
+  }.freeze
+
+  MISTYPED_LETTERS = {
+    'A' => 'S',
+    'B' => 'G',
+    'C' => 'V',
+    'D' => 'F',
+    'E' => 'A',
+    'F' => 'G',
+    'G' => 'F',
+    'H' => 'J',
+    'I' => 'U',
+    'J' => 'H',
+    'K' => 'L',
+    'L' => 'P',
+    'M' => 'N',
+    'N' => 'N',
+    'O' => 'H',
+    'P' => 'O',
+    'Q' => 'W',
+    'R' => 'E',
+    'S' => 'D',
+    'T' => 'R',
+    'U' => 'Y',
+    'V' => 'C',
+    'W' => 'Q',
+    'X' => 'C',
+    'Y' => 'U',
+    'Z' => 'X',
+    ' ' => ' '
+  }.freeze
+
+  TEN_KEYS = {
+    '0' => '1',
+    '1' => '4',
+    '2' => '5',
+    '3' => '6',
+    '4' => '1',
+    '5' => '2',
+    '6' => '3',
+    '7' => '4',
+    '8' => '5',
+    '9' => '6'
+  }.freeze
+
+  MISHEARD_LETTERS = {
+    'A' => 'AE',
+    'E' => 'EE',
+    'I' => 'E',
+    'O' => 'OU',
+    'U' => 'O',
+    'Y' => 'JA',
+    'B' => 'P',
+    'C' => 'K',
+    'D' => 'T',
+    'F' => 'VA',
+    'G' => 'CH',
+    'H' => 'GH',
+    'J' => 'Y',
+    'K' => 'C',
+    'L' => 'LL',
+    'M' => 'MM',
+    'N' => 'MN',
+    'P' => 'B',
+    'Q' => 'CU',
+    'R' => 'RR',
+    'S' => 'SS',
+    'T' => 'D',
+    'V' => 'F',
+    'W' => 'WH',
+    'X' => 'CKS',
+    'Z' => 'D',
+    ' ' => ' '
+  }.freeze
+
+  EXTRA_LETTERS = {
+    'A' => 'E',
+    'B' => 'S',
+    'C' => 'E',
+    'D' => 'T',
+    'E' => 'S',
+    'F' => 'E',
+    'G' => 'UE',
+    'H' => 'S',
+    'I' => 'E',
+    'J' => 'S',
+    'K' => 'S',
+    'L' => 'L',
+    'M' => 'N',
+    'N' => 'E',
+    'O' => 'T',
+    'P' => 'H',
+    'Q' => 'UE',
+    'R' => 'E',
+    'S' => 'S',
+    'T' => 'T',
+    'U' => 'E',
+    'V' => 'E',
+    'W' => 'E',
+    'X' => 'E',
+    'Y' => 'S',
+    'Z' => 'E',
+    ' ' => ''
+  }.freeze
+end

data/lib/mistaker/base.rb

@@ -0,0 +1,18 @@
+module Mistaker
+  class Base
+    attr_reader :str, :rand, :length
+
+    def self.mistake(str)
+      new(str).mistake
+    end
+
+    def initialize(str = nil)
+      @str = str
+      @rand = Random.new
+    end
+
+    def reformat(str)
+      str
+    end
+  end
+end

data/lib/mistaker/date.rb

@@ -0,0 +1,95 @@
+require 'date'
+
+module Mistaker
+  class Date < Base
+    YEAR, MONTH, DAY = (0..2).to_a
+
+    def reformat(str)
+      case str
+      when /\A(\d{1,2})\/(\d{1,2})\/(\d{4})\z/
+        "#{$3}-#{$1.rjust(2, '0')}-#{$2.rjust(2, '0')}"
+      when /\A(\d{1,2})\/(\d{1,2})\/(\d{2})\z/
+        "20#{$3}-#{$1.rjust(2, '0')}-#{$2.rjust(2, '0')}"
+      when /\A(\d{4})\-(\d{2})\-(\d{2})\z/
+        str
+      else
+        ::Date.parse(str).to_s
+      end
+    end
+
+    def mistake(err_type = rand.rand(DATE_MAX), mdy = rand.rand(3))
+      @str = reformat(str)
+      y,m,d = reformat(str).split('-').map &:to_i
+
+      case err_type
+      when ONE_DIGIT_UP
+        case mdy
+        when YEAR
+          y += 1
+        when MONTH
+          m += 1
+        when DAY
+          d += 1
+        end
+      when ONE_DIGIT_DOWN
+        case mdy
+        when YEAR
+          y -= 1
+        when MONTH
+          m -= 1
+        when DAY
+          d -= 1
+        end
+      when KEY_SWAP
+        case mdy
+        when YEAR
+          y = y.to_s
+          a,b = y[2],y[3]
+          y[2], y[3] = b, a
+        when MONTH
+          m = m.to_s.rjust(2,'0')
+          m.reverse!
+        when DAY
+          d = d.to_s.rjust(2,'0')
+          d.reverse!
+        end
+      when ONE_DECADE_DOWN
+        y -= 10
+      when Y2K
+        y = y >= 2000 ? "00#{y.to_s[2..3]}" : "20#{y.to_s[2..3]}"
+      when MONTH_DAY_SWAP
+        m, d = d, m
+      when MISREAD
+        case mdy
+        when YEAR
+          y = y.to_s
+          y[2] = MISREAD_NUMBERS[y[2]]
+        when MONTH
+          m = m.to_s
+          m[m.length - 1] = MISREAD_NUMBERS[m[m.length - 1]]
+        when DAY
+          d = d.to_s
+          d[d.length - 1] = MISREAD_NUMBERS[d[d.length - 1]]
+        end
+      when NUMERIC_KEY_PAD
+        case mdy
+        when YEAR
+          y = y.to_s
+          y[3] = TEN_KEYS[y[3]]
+        when MONTH
+          m = m.to_s
+          m[m.length - 1] = TEN_KEYS[m[m.length - 1]]
+        when DAY
+          d = d.to_s
+          d[d.length - 1] = TEN_KEYS[d[d.length - 1]]
+        end
+      when DIGIT_SHIFT
+        d = m
+        m = y.to_s[2..3]
+        y = "00#{y.to_s[0..1]}"
+      end
+
+      "#{y}-#{m.to_s.rjust(2,'0')}-#{d.to_s.rjust(2,'0')}"
+    end
+  end
+end

data/lib/mistaker/name.rb

@@ -0,0 +1,31 @@
+module Mistaker
+  class Name < Base
+    def reformat(str)
+      str.to_s.tr('^A-z ', '').upcase
+    end
+
+    def mistake(err_type = rand.rand(NAME_MAX), index = nil)
+      @str = reformat(@str)
+      @length = @str.length
+
+      index ||= rand.rand(@length)
+
+      case err_type
+      when DROPPED_LETTER
+        @str.slice! index
+      when DOUBLE_LETTER
+        @str.insert(index, @str[index])
+      when MISREAD_LETTER
+        @str[index] = MISREAD_LETTERS[@str[index]]
+      when MISTYPED_LETTER
+        @str[index] = MISTYPED_LETTERS[@str[index]]
+      when EXTRA_LETTER
+        @str << EXTRA_LETTERS[@str[@length - 1]]
+      when MISHEARD_LETTERS
+        @str = "#{ @str.slice(0...index) }#{ MISHEARD_LETTERS[@str[index]] }#{ @str.slice((index+1)..@length) }"
+      end
+
+      @str
+    end
+  end
+end

data/lib/mistaker/number.rb

@@ -0,0 +1,40 @@
+module Mistaker
+  class Number < Base
+    def reformat(str)
+      str.to_s.tr('^0-9', '')
+    end
+
+    def mistake(err_type = rand.rand(NUMBER_MAX), index = nil)
+      @str = reformat(@str)
+      @length = @str.length
+
+      index ||= rand.rand(@length)
+
+      n = @str[index].to_i
+
+      case err_type
+      when ONE_DIGIT_UP
+        n += 1
+      when ONE_DIGIT_DOWN
+        n -= 1
+      when KEY_SWAP
+        a, b = @str[index], @str[(index - 1).abs]
+        @str[index], @str[(index - 1).abs] = b, a
+        return str
+      when NUMERIC_KEY_PAD
+        n = TEN_KEYS[n.to_s].to_i
+      when DIGIT_SHIFT
+        if index >= @length
+          return '0' * @length
+        else
+          return ('0' * index + @str)[0...@length]
+        end
+      when MISREAD
+        n = MISREAD_NUMBERS[n.to_s].to_i
+      end
+
+      @str[index] = n.abs.to_s
+      @str
+    end
+  end
+end

data/lib/mistaker/version.rb

@@ -0,0 +1,3 @@
+module Mistaker
+  VERSION = "0.1.0"
+end

data/mistaker.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/mistaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mistaker"
+  spec.version       = Mistaker::VERSION
+  spec.authors       = ["Michael Cowden"]
+  spec.email         = ["mcowden@codeforamerica.org"]
+
+  spec.summary       = %q{Gem for emulating data entry errors}
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: mistaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Cowden
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- mcowden@codeforamerica.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mistaker.rb
+- lib/mistaker/base.rb
+- lib/mistaker/date.rb
+- lib/mistaker/name.rb
+- lib/mistaker/number.rb
+- lib/mistaker/version.rb
+- mistaker.gemspec
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Gem for emulating data entry errors
+test_files: []