dejunk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11a02210b2135091e658c20aea3611ccb4b22627
+  data.tar.gz: 6bd647976a92dff85ade9fca15f45848ed577118
+SHA512:
+  metadata.gz: b6f54d2dd4a8ec45dd8209d34ee6bbc1eb6ba76819f25720cec74f3a0af4233eb71c4059dfe58b33ec668bec0a19a616eadf6a822648485a714b610254d338dc
+  data.tar.gz: 5e92d10677561fa1b2b3afdf4e6ba582098266c9a51a92053e7cc80eb13107a54cec524c1921fbf4ad46937b0f44e37e00b88533d3d5992fec08d3c7b07141e7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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,73 @@
+# Dejunk
+
+Detect keyboard mashing and other junk in your data.
+
+For example, if you allow user-entered tags, but want to hide bad ones. Or if
+you want to detect user frustration filling out a particular field, and do
+something about it!
+
+Uses a variety of heuristics, the most sophisticated being a comparison of
+bigrams in the input to the frequencies in a "known-good" corpus vs. their
+proximity on a keyboard. Achieves pretty good precision on Academia.edu's data,
+but might need adjustment for yours.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dejunk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dejunk
+
+## Usage
+
+The main interface is `Dejunk.is_junk?`. Pass a string, and get a truthy value
+if it looks junky, and false otherwise.
+
+```ruby
+$ Dejunk.is_junk?('Hello World')
+=> false
+$ Dejunk.is_junk?('qwefqwef')
+=> :mashing_bigrams
+
+$ Dejunk.is_junk?('asdf')
+=> :asdf_row
+$ Dejunk.is_junk?('fads')
+=> false
+
+$ Dejunk.is_junk?('Hi')
+=> :too_short
+$ Dejunk.is_junk?('Hi', whitelist_regexes: [/\Ahi\z/i])
+=> false
+```
+
+Returns a reason when junk is detected for aid in debugging. Optional parameters
+are `min_alnum_chars` (defaults to 3), and `whitelist_strings` and
+`whitelist_regexes` (both default to none).
+
+## 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/academia-edu/dejunk
+
+## License
+
+Apache 2.0

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 "dejunk"
+
+# 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

data/bin/setup

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

data/dejunk.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dejunk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dejunk"
+  spec.version       = Dejunk::VERSION
+  spec.authors       = ["David Judd"]
+  spec.email         = ["david@academia.edu"]
+
+  spec.summary       = 'Detect keyboard mashing and other junk in your data.'
+  spec.homepage      = 'https://github.com/academia-edu/dejunk'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/dejunk.rb

@@ -0,0 +1,270 @@
+require "dejunk/version"
+require "yaml"
+require "active_support/core_ext/string"
+
+module Dejunk
+  extend self
+
+  # All characters on the middle row of a QWERTY keyboard
+  MASH_CHARS = 'ASDFGHJKLasdfghjkl;: '
+
+  # All neighboring key pairs on a QWERTY keyboard, except "er" and "re" which
+  # each make up >1% of bigrams in our "good" sample, plus each letter repeated
+  # or with a space
+  MASH_BIGRAMS = (
+    ("abcdefghijklmnopqrstuvwxyz".chars.flat_map { |l| ["#{l} ", "#{l}#{l}"] }) +
+    %w( qw we rt ty yu ui op as sd df fg gh hj jk kl zx xd cv vb bn nm qa az ws sx ed dc rf fv tg gb yh hn uj jm ik ol )
+  ).flat_map { |bigram| [bigram, bigram.reverse] }.to_set.freeze
+
+  def is_junk?(string, min_alnum_chars: 3, whitelist_regexes: [], whitelist_strings: [])
+    if string && (whitelist_strings.include?(string) || whitelist_regexes.any? { |re| string =~ re })
+      return false
+    end
+
+    return :no_alpha if string.nil? || string !~ /[[:alpha:]]/
+
+    normed = normalize_for_comparison(string)
+
+    return :too_short if too_few_alphanumeric_chars?(normed, min_alnum_chars)
+    return :one_char_repeat if excessive_single_character_repeats?(string, normed)
+    return :starts_with_punct if starts_with_disallowed_punctuation?(string)
+    return :too_many_short_words if too_many_short_words?(string)
+    return :three_chars_repeat_twice if three_plus_chars_repeat_twice?(string)
+    return :fuck if string =~ /\bfuck/i
+    return :missing_vowels if missing_vowels?(string, normed)
+    return :asdf_row if asdf_row_and_suspicious?(string)
+
+    ascii_proportion = string.chars.count { |c| c.ord < 128 }.to_f / string.length
+
+    # The bigrams look like the ones you'd get from keyboard mashing
+    # (the probability shouldn't be taken too literally, > 0.25 is almost all
+    # mashing in practice on our corpus)
+    if string.length > 1 && ascii_proportion > 0.8
+      if probability_of_keyboard_mashing(string) > 0.25
+        return :mashing_bigrams
+      end
+    end
+
+    # The bigrams don't look like the bigrams in legitimate strings
+    if string.length > 6 && ascii_proportion > 0.8
+      corpus_similarity = bigram_similarity_to_corpus(string)
+
+      # The similarity is more accurate for longer strings, and with more ASCII,
+      # so increase the value (= lower the threshold) for shorter strings and
+      # strings with less ASCII.
+      score = corpus_similarity * (1.0/ascii_proportion**2) * (1.0/(1 - Math.exp(-0.1*string.length)))
+
+      if score < 0.03
+        return :unlikely_bigrams
+      elsif score < 0.08 && string !~ /\A([[:upper:]][[:lower:]]+ )*[[:upper:]][[:lower:]]+\z/
+        # The similarity ignores casing, so instead use a higher threshold if
+        # the casing looks wrong
+        return :unlikely_bigrams
+      elsif score < bigram_similarity_to_mashing(string)
+        return :mashing_bigrams
+      end
+    end
+
+    false
+  end
+
+  # Cosine similarity between vector of frequencies of bigrams within string,
+  # and vector of frequencies of all bigrams within corpus
+  def bigram_similarity_to_corpus(string)
+    bigrams = bigrams(string)
+
+    freqs = bigrams.
+      each_with_object(Hash.new(0)) { |bigram, counts| counts[bigram] += 1 }.
+      each_with_object({}) do |(bigram,count), freqs|
+        freqs[bigram] = count.to_f / bigrams.length
+      end
+
+    numerator = freqs.
+      map{ |bigram, freq| corpus_bigram_frequencies[bigram].to_f * freq }.inject(&:+)
+    denominator = corpus_bigram_magnitude * ((freqs.values.map{ |v| v**2 }.inject(&:+)) ** 0.5)
+
+    numerator / denominator
+  end
+
+  # Cosine similarity between vector of frequencies of bigrams within string,
+  # and vector which assumes all bigrams made of neighboring pairs on the keyboard
+  # are equally likely, and no others appear
+  def bigram_similarity_to_mashing(string)
+    bigrams = bigrams(string)
+
+    freqs = bigrams.
+      each_with_object(Hash.new(0)) { |bigram, counts| counts[bigram] += 1 }.
+      each_with_object({}) do |(bigram,count), freqs|
+        freqs[bigram] = count.to_f / bigrams.length
+      end
+
+    numerator = freqs.map{ |bigram, freq| freq * mashing_bigram_frequencies[bigram].to_f }.inject(&:+)
+    denominator = mashing_bigram_magnitude * ((freqs.values.map{ |v| v**2 }.inject(&:+)) ** 0.5)
+
+    numerator / denominator
+  end
+
+  def bigrams(string)
+    return [] if string.nil?
+
+    string = string.strip
+    return [] if string.length < 2
+
+    string.
+      chars.
+      zip(string.chars[1..-1]).
+      map { |c1,c2| "#{c1.mb_chars.downcase}#{c2.mb_chars.downcase}" if c1 && c2 }.
+      compact.
+      map { |bigram| bigram.gsub(/[0-9]/, '0'.freeze) }.
+      map { |bigram| bigram.gsub(/[[:space:]]/, ' '.freeze) }
+  end
+
+  # The Bayesian probability of a string being keyboard mashing, given the
+  # probability of each bigram if drawn either from the legit corpus or from
+  # mashing, and an a priori probability of mashing.
+  #
+  # The probability shouldn't be taken too literally, but it's a useful
+  # indicator.
+  def probability_of_keyboard_mashing(string, apriori_probability_of_mashing: 0.1)
+    bigrams = bigrams(string)
+
+    return 0 unless bigrams.present?
+
+    prob_bigrams_given_mashing = bigrams.
+      map { |bigram| BigDecimal.new(mashing_probability(bigram).to_s) }.
+      inject(&:*)
+
+    prob_bigrams_given_corpus = bigrams.
+      map { |bigram| BigDecimal.new(corpus_probability(bigram).to_s) }.
+      inject(&:*)
+
+    numerator = prob_bigrams_given_mashing * apriori_probability_of_mashing
+
+    numerator / (numerator + prob_bigrams_given_corpus * (1 - apriori_probability_of_mashing))
+  end
+
+  def normalize_for_comparison(string)
+    string.
+      mb_chars.
+      normalize(:kd).
+      gsub(/\p{Mn}+/, ''.freeze).
+      gsub(/[^[:alnum:]]+/, ''.freeze).
+      downcase
+  end
+
+  private
+
+  def missing_vowels?(string, normed)
+    # Missing vowels (and doesn't look like acronym, and is ASCII so we can tell)
+    unless normed.chars.any? { |c| c.ord >= 128 } || string == string.upcase
+      return true if normed !~ /[aeiouy]/i
+    end
+
+    false
+  end
+
+  # One character repeated 5 or more times, or 3 or more times and not an
+  # acronym, roman numeral, or www
+  def excessive_single_character_repeats?(string, normed)
+    return true if normed.chars.uniq.count == 1
+
+    if string =~ /([^[:space:]i])\1\1/i
+      return true if normed =~ /([^0-9])\1\1\1\1/i
+
+      string.split(/[[:space:][:punct:]]/).each do |word|
+        return true if word =~ /([^iw0-9])\1\1/i && word != word.upcase
+      end
+    end
+
+    false
+  end
+
+  def three_plus_chars_repeat_twice?(string)
+    # At least 3 characters repeated at least twice in a row (but only on short
+    # strings, otherwise there are false positives)
+    string.length < 80 && string =~ /(....*)[[:space:][:punct:]]*\1[[:space:][:punct:]]*\1/
+  end
+
+  def asdf_row_and_suspicious?(string)
+    # All characters from the same row of the keyboard is suspicious, but we
+    # need additional confirmation
+    if string.chars.all? { |c| MASH_CHARS.include?(c) }
+      return true if string.length >= 16
+      return true if string =~ /(...).*\1/ # Three-plus characters, repeated
+      return true if string =~ /(..).*\1.*\1/ # Two characters, repeated twice
+      return true if string =~ /\b[sdfghjkl]\b/ # Stray lowercase letter
+      return true if string =~ /[^aeiouy]{3}/i && (string.length > 5 || string != string.upcase) # Three consonants in a row, non-acronym
+    end
+
+    false
+  end
+
+  def too_few_alphanumeric_chars?(normed, min_alnum_chars)
+    # Too short (unless we're dealing with a large alphabet with legitimate
+    # single-char words)
+    if normed.length < min_alnum_chars
+      unless normed =~ /\p{Han}|\p{Hangul}|\p{Hiragana}|\p{Katakana}/
+        return true
+      end
+    end
+
+    false
+  end
+
+  def starts_with_disallowed_punctuation?(string)
+    # Starting punctuation, except opening parens or quote
+    string =~ /\A[[:punct:]]/ && string !~ /\A(\p{Pi}|\p{Ps}|['"¿»’]).+/
+  end
+
+  def too_many_short_words?(string)
+    words = string.split
+    two_chars = words.select { |w| w.length < 3 }.count
+    if two_chars > 2 && two_chars > 0.75 * words.length
+      return true
+    end
+
+    false
+  end
+
+  def mashing_probability(bigram)
+    if (f = mashing_bigram_frequencies[bigram])
+      f
+    elsif f =~ /[a-z]{2}/i
+      # 26**2 = 676, so 1 in 2k seems a reasonable probability for an arbitrary two-letter bigram given mashing
+      0.0005
+    else
+      # An arbitrary (non-ASCII) bigram with mashing is slightly more probable than with legit strings
+      1e-6
+    end
+  end
+
+  def corpus_probability(bigram)
+    corpus_bigram_frequencies[bigram] || 1e-7 # Around the smallest frequency we store for the corpus
+  end
+
+  def corpus_bigram_frequencies
+    @corpus_bigram_frequencies ||= YAML.load_file(File.expand_path('../../resources/bigram_frequencies.yml', __FILE__)).freeze
+  end
+
+  def corpus_bigram_magnitude
+    @corpus_bigram_magnitude ||= (corpus_bigram_frequencies.values.map{ |v| v**2 }.inject(&:+)) ** 0.5
+  end
+
+  def mashing_bigram_frequencies
+    # This is a guess because we don't have a good corpus, but we assume that
+    # 50% of mashing bigrams are a neighboring pair on the ASDF row or a duplicate
+    # and the rest are evenly distributed among other neighboring pairs or char-
+    # plus-space.
+    @mashing_bigram_frequencies ||= MASH_BIGRAMS.each_with_object({}) do |bigram, freqs|
+      if bigram.first == bigram.last || bigram.chars.all? { |c| c != ' '.freeze && MASH_CHARS.include?(c) }
+        freqs[bigram] = 0.5 / (16 + 26)
+      else
+        freqs[bigram] = 0.5 / (MASH_BIGRAMS.length - 16 - 26)
+      end
+    end
+  end
+
+  def mashing_bigram_magnitude
+    @mashing_bigram_magnitude ||= (mashing_bigram_frequencies.values.map{ |v| v**2 }.inject(&:+)) ** 0.5
+  end
+end