anglicize 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fba69b6322d390dc959ccf1219d9ec9ad2429fc
-  data.tar.gz: 76b95cc28dd1f13a9501be41ad761c50e6246cb6
+  metadata.gz: 5041976b78645c948b78d7993e034cdd86c064c7
+  data.tar.gz: b77c9c2e65b7abef132867e0aca3e25b304a501a
 SHA512:
-  metadata.gz: 3c2b6396dc847e2870f1205e2eacf0e0c9514344e49295a2d1fd75cf18e26590aa1cdf8ddf46041caa9eb40610c19d6bf88eb9a01b7f98bdd5c31a41384a86f9
-  data.tar.gz: b7be95dff7f98f46f987cd60b3ac206dca6116e0468003e8fe84b3a097014b508f0d106442f1f5aff78aca1838041afaa628bd8addacd6601d731ed4cb450a64
+  metadata.gz: c5a04d592bfec061bfa7b098c3ba15bc3b2316caa88ddd6420ef24d1badf59ff0b4b7aef977c048226ba5a0233c4387399cdc51c22461577da66535ffe8b9682
+  data.tar.gz: b561de108a15d5536d92f7ef7a7fabf935c1c3d4e524f0e7a3c1f8ea450734362b22f5340b5b17d102dbb578079bbe02a293d5929326f44175a25df9e9e5299f

data/README.rdoc

@@ -1,4 +1,5 @@
 = Anglicize
+{<img src="https://badge.fury.io/rb/anglicize.svg" alt="Gem Version" />}[http://badge.fury.io/rb/anglicize]
 
 Anglicize is a simple gem that converts strings between American and English spellings, based on the list of alternate spellings at [http://www.tysto.com/uk-us-spelling-list.html].
 
@@ -15,8 +16,11 @@ Or, install as a plugin:
 
 == Getting Started
 
-The gem adds four methods to the String object:
-* anglicize - convert to English spelling
+The gem adds second methods to the String object:
+* anglicize - return a copy of the string converted to English spelling
+* anglicize! - convert the string in-place to English spelling
 * has_alternate_english_spelling? - returns true if English spelling of string is different
-* americanize - convert to American spelling
-* has_alternate_american_spelling? - returns true if American spelling of string is different
+* americanize - return a copy of the string converted to American spelling
+* americanize! - convert the string in-place to American spelling
+* has_alternate_american_spelling? - returns true if American spelling of string is different
+* copy_case

data/lib/anglicize.rb

@@ -1,4 +1,2 @@
 require 'anglicize/string'
 
-module Anglicize
-end

data/lib/anglicize/string.rb

@@ -2,51 +2,96 @@ require 'yaml'
 
 # Extensions for string class.
 class String
+  # @return [String] a copy of the string converted into English spelling.
   def anglicize
-    split.map{|token| get_anglicized_word(token) }.join(" ")
+    result = self.dup
+    scan(WORD_RE).uniq.each do |word|
+      result.gsub!(/\b#{word}\b/, get_anglicized_word(word))
+    end
+    result
+  end
+
+  # Converts the string into English spelling.
+  # @return [String] the string converted into English spelling
+  def anglicize!
+    self.replace(self.anglicize)
   end
 
+  # @return [String] a copy of the string converted into American spelling.
   def americanize
-    split.map{|token| get_americanized_word(token) }.join(" ")
+    result = self.dup
+    scan(WORD_RE).uniq.each do |word|
+      result.gsub!(/\b#{word}\b/, get_americanized_word(word))
+    end
+    result
   end
 
+  # Converts the string into American spelling.
+  # @return [String] the string converted into American spelling
+  def americanize!
+    self.replace(self.americanize)
+  end
+
+  # @return [Boolean] a value indicating whether the English spelling differs.
   def has_alternate_english_spelling?
     self != anglicize
   end
 
+  # @return [Boolean] a value indicating whether the American spelling differs.
   def has_alternate_american_spelling?
     self != americanize
   end
 
+  # @param word [String] used as the case template
+  # @return [String] a copy of the string with the same case as the template.
   def copy_case(word)
-    if word == word.capitalize
-      capitalize
-    elsif word == word.upcase
-      upcase
+    result = ""
+    if word.upcase == word
+      result = self.upcase
+    elsif word.downcase == word
+      result = self.downcase
     else
-      downcase
+      self.chars.each_with_index do |char, index|
+        word_char = word[index] || "a"
+        result << (word_char.upcase == word_char ? char.upcase : char.downcase)
+      end
     end
+    result
+  end
+
+  # Changes the string to have the same case as the string parameter.
+  # @param word [String] used as the case template
+  # @return [String] the string with the same case as the template.
+  def copy_case!(word)
+    self.replace(self.copy_case)
   end
 
   private
 
+  # A regular expression for identifying words
+  WORD_RE = /\b[a-zA-Z]+\b/
+
   def get_anglicized_word(word)
+    # Load american to english conversion hash if not already loaded
     @@american_to_english ||= load_american_to_english
     key = word.downcase
     (@@american_to_english[key] || word).copy_case(word)
   end
 
   def get_americanized_word(word)
+    # Load english to american hash if not already loaded
     @@english_to_american ||= load_english_to_american
     key = word.downcase
     (@@english_to_american[key] || word).copy_case(word)
   end
 
+  # Load alternate spellings if not already loaded and insert values and keys
   def load_american_to_english
     @@alternate_spellings ||= load_alternate_spellings
     @@alternate_spellings.invert
   end
 
+  # Load alternate spellings if not already loaded
   def load_english_to_american
     @@alternate_spellings ||= load_alternate_spellings
   end

data/lib/anglicize/version.rb

@@ -1,3 +1,5 @@
+# default module
 module Anglicize
-  VERSION = "0.0.1"
+  # version number
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anglicize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Webb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -65,3 +65,4 @@ signing_key:
 specification_version: 4
 summary: Converts strings from American spelling to English spelling and vice versa.
 test_files: []
+has_rdoc: