indoor_voice 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5af440632e16925a955aadd1d1d788d0d07e9b32
-  data.tar.gz: 75a3a8afb8df286336d56ec889d890e2a578b249
+  metadata.gz: 7c1f354160ec3defa55dd660399cc0963cdad5b6
+  data.tar.gz: b3db382d94fb98da2893a329a371cab996df1d21
 SHA512:
-  metadata.gz: 1d0aeec7a2dd9b28bff8f1c390bbe3789d170b9ebae70302ba8fe43c48dc893f3a15c2fc679116f3433e3b78de9b8537d8cdcf214551c00e1f5b64afc72d3efe
-  data.tar.gz: 508cd37f8ebb3e6e247d004e3a1cdcf1932fa64f2d019a2f7b4d57787561272453726cbca4a97a3308f44d02de324d10d01c641f25f48318736af7a1318e6f6f
+  metadata.gz: e5fd5ed460d7a47b4c63d2f8d0b3c423e81249c8855d4a3c5eede696eb1a9f6f697b9142b07fa8a8ff441f05a03c09d5284ae33dff93a6a694cdc8f0a5e70b46
+  data.tar.gz: 22d03b2b980d189f8ffe4f1ccd6bc062d787f4147627da04efabfdf19a76f45e6d6b00e9c1c6b7d3eae5bea0e01e3d79558732d6470acc7aa2e34fbf0e891de0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 James McKinney
+Copyright (c) 2015 James McKinney
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -15,16 +15,25 @@ require 'open-uri'
 
 require 'indoor_voice'
 
-# You can use any word list and any language. Here's we use Scrabble words. 
+# You can use any word list. Here 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.
+# You can use any language. :en is the BCP 47 code for English.
 model = IndoorVoice.new(words, :en)
-model.setup
+model.setup # wait a moment
 
-model.downcase('HP AND IBM ARE TECHNOLOGY CORPORATIONS.')
-# => "HP and IBM are technology corporations."
+model.downcase('HP, IBM AND MICROSOFT ARE TECHNOLOGY CORPORATIONS.')
+# => "HP, IBM and microsoft are technology corporations."
+
+model.titlecase('HP, IBM AND MICROSOFT ARE TECHNOLOGY CORPORATIONS.')
+# => "HP, IBM And Microsoft Are Technology Corporations."
+
+model.titlecase('HP, IBM AND MICROSOFT ARE TECHNOLOGY CORPORATIONS.', except: %w(a an and as at but by en for if in of on or the to via))
+# => "HP, IBM and Microsoft Are Technology Corporations."
+
+model.titlecase('HP, IBM AND MICROSOFT ARE TECHNOLOGY CORPORATIONS.', except: words)
+# => "HP, IBM and Microsoft are technology corporations."
 ```
 
 ![This gem is magic.](http://i.giphy.com/ol57TlMlftsQg.gif)
@@ -41,4 +50,4 @@ No gem for titlecasing dealt with acronyms well. In case this gem doesn't suit y
 * [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
+Copyright (c) 2015 James McKinney, released under the MIT license

data/lib/indoor_voice.rb

@@ -1,7 +1,9 @@
 require 'set'
 
+require 'unicode_utils/casefold'
 require 'unicode_utils/downcase'
 require 'unicode_utils/each_word'
+require 'unicode_utils/titlecase'
 require 'unicode_utils/upcase'
 
 # Lowercases uppercase strings excluding acronyms.
@@ -12,10 +14,10 @@ class IndoorVoice
   # @return [Symbol] the language's BCP 47 code
   attr_reader :language_id
 
-  # @return [Array<String>] the characters in the language
+  # @return [Set<String>] the characters in the language
   attr_reader :characters
 
-  # @return [Array<Regexp>] regular expressions for non-word character sequences
+  # @return [Array<Regexp>] regular expressions matching non-word character sequences
   attr_reader :patterns
 
   # Excludes "\t", "\n", "\v", "\f", "\r", " " and "#".
@@ -107,4 +109,26 @@ class IndoorVoice
       end
     end.join
   end
+
+  # Titlecases all words except for acronyms.
+  #
+  # @param [String] string a string
+  # @param [Hash] options optional arguments
+  # @option options [Array<String>] :except words to downcase, e.g. conjunctions
+  # @return [String] a string with acronyms in uppercase and others in titlecase
+  def titlecase(string, options = {})
+    blacklist = options.fetch(:except, []).map do |word|
+      UnicodeUtils.casefold(word)
+    end
+
+    UnicodeUtils.each_word(string).map do |word|
+      if @patterns.any?{|pattern| word[pattern]}
+        word
+      elsif blacklist.include?(UnicodeUtils.casefold(word))
+        UnicodeUtils.downcase(word, @language_id)
+      else
+        UnicodeUtils.titlecase(word, @language_id)
+      end
+    end.join
+  end
 end

data/lib/indoor_voice/version.rb

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

data/spec/indoor_voice_spec.rb

@@ -1,20 +1,48 @@
 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)
+  # @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
+
+  describe '#words' do
+    it 'should return the words in the language' do
+      expect(model.words).to eq(words)
+    end
+  end
+
+  describe '#language_id' do
+    it 'should return the language ID' do
+      expect(model.language_id).to eq(:en)
     end
+  end
 
-    let :model do
-      model = IndoorVoice.new(words, :en)
-      model.setup
-      model
+  describe '#characters' do
+    it 'should return the characters in the language' do
+      expect(model.characters).to eq(Set.new(%w(A B C D E F G H I J K L M N O P R S T U V W Y)))
     end
+  end
 
+  describe '#downcase' do
     it 'should downcase only non-acronyms' do
-      expect(model.downcase('THE CAT WILL BEAT THE ROBOT')).to eq('the cat will beat the ROBOT')
+      expect(model.downcase('THE CAT WILL BEAT THE ROBOT')).to eq('the cat will beat the ROBOT') # "cat" and "beat" are not in the word list
+    end
+  end
+
+  describe '#titlecase' do
+    it 'should titlecase only non-acronyms' do
+      expect(model.titlecase('THE CAT WILL BEAT THE ROBOT')).to eq('The Cat Will Beat The ROBOT')
+    end
+
+    it 'should titlecase only non-acronyms and non-exceptions' do
+      expect(model.titlecase('THE CAT WILL BEAT THE ROBOT', except: words)).to eq('the Cat will Beat the ROBOT')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: indoor_voice
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James McKinney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils