indoor_voice 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af440632e16925a955aadd1d1d788d0d07e9b32
+  data.tar.gz: 75a3a8afb8df286336d56ec889d890e2a578b249
+SHA512:
+  metadata.gz: 1d0aeec7a2dd9b28bff8f1c390bbe3789d170b9ebae70302ba8fe43c48dc893f3a15c2fc679116f3433e3b78de9b8537d8cdcf214551c00e1f5b64afc72d3efe
+  data.tar.gz: 508cd37f8ebb3e6e247d004e3a1cdcf1932fa64f2d019a2f7b4d57787561272453726cbca4a97a3308f44d02de324d10d01c641f25f48318736af7a1318e6f6f

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+doc/*
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  # No Enumerator#size in 1.9.3
+  # No Set#intersect? in 2.0.0 https://bugs.ruby-lang.org/issues/6588
+  - 2.1.0
+  - 2.2.0

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 James McKinney
+
+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,44 @@
+# IndoorVoice: Lowercase all-caps strings excluding acronyms
+
+[![Gem Version](https://badge.fury.io/rb/indoor_voice.svg)](https://badge.fury.io/rb/indoor_voice)
+[![Build Status](https://secure.travis-ci.org/jpmckinney/indoor_voice.png)](https://travis-ci.org/jpmckinney/indoor_voice)
+[![Dependency Status](https://gemnasium.com/jpmckinney/indoor_voice.png)](https://gemnasium.com/jpmckinney/indoor_voice)
+[![Coverage Status](https://coveralls.io/repos/jpmckinney/indoor_voice/badge.png)](https://coveralls.io/r/jpmckinney/indoor_voice)
+[![Code Climate](https://codeclimate.com/github/jpmckinney/indoor_voice.png)](https://codeclimate.com/github/jpmckinney/indoor_voice)
+
+DOES YOUR DATA CONTAIN ALL-CAPS TEXT THAT YOU WISH WAS PROPERLY CASED?
+
+Have your data use its indoor voice.
+
+```ruby
+require 'open-uri'
+
+require 'indoor_voice'
+
+# You can use any word list and any language. Here's we use Scrabble words. 
+url = 'https://scrabblehelper.googlecode.com/svn/trunk/ScrabbleHelper/src/dictionaries/TWL06.txt'
+words = open(url).readlines.map(&:chomp)
+
+# :en is the BCP 47 code for English.
+model = IndoorVoice.new(words, :en)
+model.setup
+
+model.downcase('HP AND IBM ARE TECHNOLOGY CORPORATIONS.')
+# => "HP and IBM are technology corporations."
+```
+
+![This gem is magic.](http://i.giphy.com/ol57TlMlftsQg.gif)
+
+IndoorVoice is based on the assumption that most acronyms contain non-word character sequences. For example, no English word has the character sequence `bm` in a word-final position, therefore `IBM` must be an acronym.
+
+Once you have a string with only acronyms in uppercase, you can (in your own code) selectively uppercase letters, like the first letter in each sentence, or the first letter of each word. Since most titlecasing gems recase acronyms, titlecasing is a planned feature.
+
+# Why?
+
+No gem for titlecasing dealt with acronyms well. In case this gem doesn't suit your needs, see:
+
+* [titleize](https://rubygems.org/gems/titleize), [titlecase](https://rubygems.org/gems/titlecase), [title_case](https://rubygems.org/gems/title_case) and [gruber-case](https://rubygems.org/gems/gruber-case), based on [TitleCase.pl](http://daringfireball.net/2008/05/title_case) by John Gruber
+* [namecase](https://rubygems.org/gems/namecase), based on [Lingua::EN::NameCase](http://search.cpan.org/~barbie/Lingua-EN-NameCase-1.19/lib/Lingua/EN/NameCase.pm) by Mark Summerfield
+* [clever_title](https://rubygems.org/gems/clever_title)
+
+Copyright (c) 2014 James McKinney, released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/USAGE

@@ -0,0 +1 @@
+See README.md for full usage details.

data/indoor_voice.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/indoor_voice/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "indoor_voice"
+  s.version     = IndoorVoice::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["James McKinney"]
+  s.homepage    = "https://github.com/jpmckinney/indoor_voice"
+  s.summary     = %q{Lowercase all-caps strings excluding acronyms}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('unicode_utils', '~> 1.4.0')
+
+  s.add_development_dependency('coveralls')
+  s.add_development_dependency('json', '~> 1.8') # to silence coveralls warning
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 3.1')
+end

data/lib/indoor_voice.rb

@@ -0,0 +1,110 @@
+require 'set'
+
+require 'unicode_utils/downcase'
+require 'unicode_utils/each_word'
+require 'unicode_utils/upcase'
+
+# Lowercases uppercase strings excluding acronyms.
+class IndoorVoice
+  # @return [Array<String>] the words in the language
+  attr_reader :words
+
+  # @return [Symbol] the language's BCP 47 code
+  attr_reader :language_id
+
+  # @return [Array<String>] the characters in the language
+  attr_reader :characters
+
+  # @return [Array<Regexp>] regular expressions for non-word character sequences
+  attr_reader :patterns
+
+  # Excludes "\t", "\n", "\v", "\f", "\r", " " and "#".
+  # "(", ")", "*", "+", "?", "[" and "\\" can cause SyntaxError.
+  SPECIAL_CHARACTERS = Set.new(["$", "(", ")", "*", "+", "-", ".", "?", "[", "\\", "]", "^", "{", "|", "}"])
+
+  # @param [Array<String>] words the words in the language
+  # @param [Symbol] language_id the language's BCP 47 code
+  # @see http://tools.ietf.org/html/bcp47
+  def initialize(words, language_id = :en)
+    @words = words
+    @language_id = language_id
+    @characters = Set.new
+    @patterns = []
+  end
+
+  # Determines the regular expressions for non-word character sequences.
+  def setup
+    types = [:prefix, :suffix, :infix]
+
+    data = {}
+    types.each do |type|
+      data[type] = Hash.new do |hash,character|
+        hash[character] = Set.new
+      end
+    end
+
+    # Determine the possible two-character sequences. Should be O(n) of all characters in all words.
+    @words.each do |word|
+      chars = UnicodeUtils.upcase(word, @language_id).chars
+      @characters.merge(chars)
+      if chars.size > 1
+        data[:prefix][chars[0]].add(chars[1])
+        data[:suffix][chars[-2]].add(chars[-1])
+        chars[2..-2].each_with_index do |character,i|
+          data[:infix][chars[i + 1]].add(character)
+        end
+      end
+    end
+
+    # Determine whether the language contains any characters requiring escaping.
+    escape = @characters.intersect?(SPECIAL_CHARACTERS)
+
+    patterns = {}
+    types.each do |type|
+      patterns[type] = []
+    end
+
+    # Build the regular expressions for non-word character sequences.
+    data.each do |type,hash|
+      hash.each do |character,set|
+        difference = @characters - set
+        unless difference.empty?
+          # The first condition is just to make the patterns more human-readable.
+          patterns[type] << if difference.one?
+            if escape
+              "#{Regexp.escape(character)}#{Regexp.escape(difference.to_a.first)}"
+            else
+              "#{character}#{difference.to_a.first}"
+            end
+          else
+            if escape
+              "#{Regexp.escape(character)}[#{Regexp.escape(difference.to_a.join)}]"
+            else
+              "#{character}[#{difference.to_a.join}]"
+            end
+          end
+        end
+      end
+    end
+
+    @patterns = [
+      Regexp.new("^(?:#{patterns[:prefix].join('|')})"),
+      Regexp.new("(?:#{patterns[:suffix].join('|')})$"),
+      Regexp.new("\\B(?:#{patterns[:infix].join('|')})\\B"),
+    ]
+  end
+
+  # Downcases all words except for acronyms.
+  #
+  # @param [String] string an uppercase string
+  # @return [String] a string with only acronyms in uppercase
+  def downcase(string)
+    UnicodeUtils.each_word(string).map do |word|
+      if @patterns.any?{|pattern| word[pattern]}
+        word
+      else
+        UnicodeUtils.downcase(word, @language_id)
+      end
+    end.join
+  end
+end

data/lib/indoor_voice/version.rb

@@ -0,0 +1,3 @@
+class IndoorVoice
+  VERSION = "0.0.1"
+end

data/spec/indoor_voice_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe IndoorVoice do
+  describe '#downcase' do
+    # @see http://en.wikipedia.org/wiki/Most_common_words_in_English
+    let :words do
+      %w(the be to of and a in that have I it for not on with he as you do at this but his by from they we say her she or an will my one all would there their what so up out if about who get which go me when make can like time no just him know take people into year your good some could them see other than then now look only come its over think also back after use two how our work first well way even new want because any these give day most us)
+    end
+
+    let :model do
+      model = IndoorVoice.new(words, :en)
+      model.setup
+      model
+    end
+
+    it 'should downcase only non-acronyms' do
+      expect(model.downcase('THE CAT WILL BEAT THE ROBOT')).to eq('the cat will beat the ROBOT')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/indoor_voice'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: indoor_voice
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James McKinney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- USAGE
+- indoor_voice.gemspec
+- lib/indoor_voice.rb
+- lib/indoor_voice/version.rb
+- spec/indoor_voice_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jpmckinney/indoor_voice
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Lowercase all-caps strings excluding acronyms
+test_files:
+- spec/indoor_voice_spec.rb
+- spec/spec_helper.rb