Typoglycaemic 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ae1ea8319112439be690a9efe4f6556b41d193bd0a6c0fa7f8a942dacd93e5c
+  data.tar.gz: 73c41516431a17f534c55956714084fec8fbaa6bd4ec6f315d4cebd776d9e6ff
+SHA512:
+  metadata.gz: ff1d7c4bc783c6d4d2051c892d57f63c1a5c406d2673740b27c7de23cb574f3404c16d16919ab955103e446b5341d756c1c7d08e98ac855483def04688d24a45
+  data.tar.gz: d114dff6d3fcbaa8f1ffea0257822c6c1b6f89431a1c013b1a1d699e6b2f6b667cac538211449a975cca82f46d4c76e48e63f3a4a04a8c35eecc6fa93d618223

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 14th of July 2019
+
+- Error in gemspec, fixed.
+
+## [0.1.0] - 14th of July 2019
+
+- The `Typoglycaemic(str)` method now returns the object instead of the jumbled string.
+- Inside the object all the strings are frozen, no pesky mutations.
+- The `Typoglycaemic(str)` method (and the initializer) will also accept a Typoglycaemic object and preserve the original and jumbled text.
+
+## [0.0.1] - 10th of July 2019
+
+### Added
+
+- First working version.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "minitest"
+gem 'pry-byebug'

data/LICENCE.txt

@@ -0,0 +1,7 @@
+Copyright 2019 Iain Barnett
+
+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,83 @@
+# Typoglycaemic
+
+## Usage
+
+```ruby
+require 'typoglycaemic'
+```
+
+
+```ruby
+words = <<~STR
+According to a researcher at Cambridge University, it doesn't matter in what order the letters in a word are, the only important thing is that the first and last letter be at the right place. The rest can be a total mess and you can still read it without problem. This is because the human mind does not read every letter by itself but the word as a whole.
+STR
+
+puts Typoglycaemic(words).jumbled
+```
+
+The output:
+
+> Accorindg to a reeascrehr at Cmbairdge Uivnesrtiy, it deso'nt matter in what order the letters in a word are, the only ipmortnat tinhg is that the fisrt and last letter be at the rgiht pacle. The rset can be a toatl mses and you can still raed it wtiouht poblerm. Tihs is bceasue the huamn mnid does not read eevry letter by iteslf but the wrod as a wolhe.
+
+```ruby
+str = "A doctor has admitted the manslaughter of a teenage cancer patient who died after a hospital drug blunder."
+puts Typoglycaemic(str).jumbled
+```
+
+The output:
+
+> A docotr has amditted the mnsalugather of a teengae cnaecr ptiaent who died after a hspotail drug blnduer.
+
+
+```ruby
+str = "In the Victorian era, a lovely emerald green, partially formulated from arsenic, was used in fabrics and popular floral headdresses."
+puts Typoglycaemic(str).jumbled
+```
+
+The output:
+
+> In the Vitorcain era, a lovley emreald green, patirally fromlauetd form asenric, was uesd in fbarics and poplaur folarl headdersses.
+
+The original is around if needed:
+
+```ruby
+tc = Typoglycaemic(str)
+tc.original
+```
+
+
+## The rules
+
+It follows the rules set out [in this article](https://www.dictionary.com/e/typoglycemia/).
+
+
+## Why this library?
+
+Mainly because I was getting bored of debugging and wanted to do something else, but also because I read this:
+
+> In a final study, Gervais and Norenzayan used an even more subtle way of activating analytic thinking: by having participants fill out a survey measuring their religious beliefs that was printed in either clear font or font that was difficult to read. Prior research has shown that difficult-to-read font promotes analytic thinking by forcing participants to slow down and think more carefully about the meaning of what they are reading. The researchers found that participants who filled out a survey that was printed in unclear font expressed less belief as compared to those who filled out the same survey in the clear font.
+
+[How Critical Thinkers Lose Their Faith in God, Daisy Grewal, May 1, 2012, Scientific American](https://www.scientificamerican.com/article/how-critical-thinkers-lose-faith-god/)
+
+I might try using it on social networks when I want my "opponent" in a debate to bypass "System 1".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typoglycaemic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typoglycaemic
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yb66/typoglycaemic.

data/lib/typoglycaemic.rb

@@ -0,0 +1,118 @@
+# Jumble words in a typoglycaemic fashion.
+class Typoglycaemic
+  class Error < StandardError; end
+
+  # Ignore these functional words.
+  BESIDES = %w{a and at be by it on the to}
+
+  # The chance of a pair of letters being jumbled is 50/50.
+  DEFAULT_CHANCE = 50
+
+
+  # @example
+  #   str = "In the Victorian era, a lovely emerald green, partially formulated from arsenic, was used in fabrics and popular floral headdresses."
+  #   puts Typoglycaemic(str)
+  #   > In the Vitorcain era, a lovley emreald green, patirally fromlauetd form asenric, was uesd in fbarics and poplaur folarl headdersses.
+  #
+  # @param [String] original
+  def initialize original
+    if original.respond_to?(:typoglycaemized)
+      @original = original.original
+      @typoglycaemized = original.typoglycaemized
+    else
+      @original = original
+      @chance = DEFAULT_CHANCE
+      @typoglycaemized = self.class.typoglycaemize @original, @chance
+    end
+    @original.freeze and @typoglycaemized.freeze and @frozen = true
+  end
+
+  # @return [String]
+  attr_reader :typoglycaemized, :original, :frozen
+
+  # because that's a mouthful
+  alias_method :jumbled, :typoglycaemized
+
+
+  class << self
+
+    # @param [String] original
+    # @param [Integer] chance
+    def typoglycaemize original, chance
+      if original =~ /\s/
+        original.split(/\s/).map{|word|
+          if word.size <= 3 or BESIDES.include?(word.downcase)
+            word
+          else
+            to_typo( word, chance)
+          end
+        }.join(" ")
+      else
+        to_typo original, chance
+      end
+    end
+
+
+    # Regex to partition by.
+  	PATTERN = /
+  	  (?:
+  	    (?<=\b)\s           # end of a word
+  	  )
+  	    |
+  	  (?:
+  	    [[:punct:]](?=\s)   # punctuation at the end of a word
+  	  )
+  	    |
+  	  (?:
+  	    ([a-z])\1           # repeated letters
+  	  )
+  	/x
+
+    # @api private
+    # @see #typoglycaemize
+    def to_typo original, chance
+      h,*middle,t = original.split //
+      newstring = h
+      t ||= ""
+      t = middle.delete_at(-1) + t if /[[:punct:]]/ =~ t
+
+      middle = middle.join
+      middle.size >= 7 ?  chance -= 10 : chance += 10
+
+      until middle.empty?
+        head,wall,tail = middle.partition PATTERN
+        head = head.split //
+        # use an external iterator as the array is being mutated.
+        for i in 0..head.size-1 do
+          if b = head[i+1] # control the jumbling
+            # as it gets more jumbled the chance of being jumbled
+            # goes down
+            if rand(0..99) < chance              
+              a = head[i]
+              head[i] = b
+              head[i+1] = a
+              chance -= 10 unless chance <= 10
+            else
+              # and goes up if less jumbled
+              chance += 10 unless chance >= 90
+            end
+          end
+        end
+        newstring << head.join
+        newstring << wall
+        middle = tail
+      end
+      newstring << t
+    end
+
+  end
+
+end
+
+
+# For convenience.
+# @param [Typoglycaemic,String] original
+# @return [Typoglycaemic]
+def Typoglycaemic(original)
+  Typoglycaemic.new(original)
+end

data/lib/typoglycaemic/version.rb

@@ -0,0 +1,4 @@
+class Typoglycaemic
+  #@see https://semver.org/spec/v2.0.0.html
+  VERSION = "0.1.1"
+end

data/typoglycaemic.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "typoglycaemic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "Typoglycaemic"
+  spec.version       = Typoglycaemic::VERSION
+  spec.authors       = ["iain barnett"]
+  spec.email         = ["helpful-iain@theprintedbird.com"]
+  spec.summary       = %q{An implementation of typoglycaemic word jumbling. Yu'oll hvae no difficltuy raeidng tihs, rgiht?}
+  spec.description   = %q{Accorindg to a reeascrehr at Cmbairdge Uivnesrtiy, it deso'nt matter in what order the letters in a word are, the only ipmortnat tinhg is that the fisrt and last letter be at the rgiht pacle. The rset can be a toatl mses and you can still raed it wtiouht poblerm. Tihs is bceasue the huamn mnid does not read eevry letter by iteslf but the wrod as a wolhe.}
+  spec.homepage      = "https://github.com/yb66/typoglycaemic"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata = {
+      "homepage_uri"    => spec.homepage,
+      "source_code_uri" => "https://github.com/yb66/typoglycaemic",
+      "changelog_uri"   => "https://github.com/yb66/typoglycaemic/blob/master/CHANGELOG.md",
+    }
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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", "~> 2.0"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: Typoglycaemic
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- iain barnett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Accorindg to a reeascrehr at Cmbairdge Uivnesrtiy, it deso'nt matter
+  in what order the letters in a word are, the only ipmortnat tinhg is that the fisrt
+  and last letter be at the rgiht pacle. The rset can be a toatl mses and you can
+  still raed it wtiouht poblerm. Tihs is bceasue the huamn mnid does not read eevry
+  letter by iteslf but the wrod as a wolhe.
+email:
+- helpful-iain@theprintedbird.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENCE.txt
+- README.md
+- lib/typoglycaemic.rb
+- lib/typoglycaemic/version.rb
+- typoglycaemic.gemspec
+homepage: https://github.com/yb66/typoglycaemic
+licenses: []
+metadata:
+  homepage_uri: https://github.com/yb66/typoglycaemic
+  source_code_uri: https://github.com/yb66/typoglycaemic
+  changelog_uri: https://github.com/yb66/typoglycaemic/blob/master/CHANGELOG.md
+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: An implementation of typoglycaemic word jumbling. Yu'oll hvae no difficltuy
+  raeidng tihs, rgiht?
+test_files: []