phonetic_encoder 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b350ed382c99460a6e3c8a3262759053ee6498955782ac4457da61330608a260
-  data.tar.gz: b1332831700d6cfa2315d989cbf4bca072f71a8e8375982548bfced0d85e7674
+  metadata.gz: ef09ba6e1ff4070a55837c16e282cb74c00d650f7532091ad0f192360be31056
+  data.tar.gz: cf43b47eae23bce2a4195cbf3819eedc688251579f42864142f1686f489e89cd
 SHA512:
-  metadata.gz: 02b997bb9acd574dffdfe39e1f8c1e869d6a39433396ba69eb14fd40ddeea049280e16ddf55cc2be0e97eeb8b5074865adedd28397f396f5e9daffc55607968d
-  data.tar.gz: 6b60eb712e646fbdfe307c11765a39dc2bb268f7c1cf4f7d5cec05b24308caab901470034e8d7d2deb80df451f589fdb265261eb4f171492560c59e62318e329
+  metadata.gz: 0f41d259ad06f95e562ee5ffcd89ad9e5f00b9ba6db463cd057aaebf3aecf1b4666df6dc7f1ae8c9caa38a8987abc3a8956a68263287a17fc92bca5c5b84afe6
+  data.tar.gz: 4739dd1378159379e83e14ca5adf9755608b51047caee47960ce7c70df0b51ca9c27e6418205cba4a5571b584124cb4bc83c9788f5bf4e4129750f9e7e112b05

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.1.1 (January 24, 2019)
+
+IMPROVEMENTS:
+
+* Small tweak to rename the strings.rb to overloads.rb to keep it generic across multiple gems. ([@TGWolf][])
+
+## 1.1.0 (January 24, 2019)
+
+IMPROVEMENTS:
+
+* Move the code inside of a module namespace. ([@TGWolf][])
+* Extend the strings class so that str.phonetic_encoder works. ([@TGWolf][])
+* Update the documentation. ([@TGWolf][])
+
 ## 1.0.0 (January 24, 2019)
 
 * Initial Release ([@TGWolf][])

data/README.md

@@ -33,9 +33,13 @@ Or install it yourself as:
 You can use the default built in dictionary which is NATO.
 
 ```ruby
-  pe = PhoneticEncoder.new
+  require 'phonetic_encoder'
 
-  puts pe.encode('abc')
+  puts PhoneticEncoder::Encoder.encode('abc')
+
+  # or
+
+  puts 'abc'.phonetic_encode
 ```
 
 ### Extended Usage
@@ -43,21 +47,29 @@ You can use the default built in dictionary which is NATO.
 You can also use the built-in 'sounds' dictionary.
 
 ```ruby
-  pe = PhoneticEncoder.new
+  require 'phonetic_encoder'
+
+  puts PhoneticEncoder::Encoder.encode('abc', 'sounds')
+
+  # or
 
-  puts pe.encode('abc', 'sounds')
+  'abc'.phonetic_encode('sounds')
 ```
 
 ### Advanced Usage
 
 You can define your own dictionary, the below example just does a single item, but you can make the set as large as you need.
 
-```
-  pe = PhoneticEncoder.new
+```ruby
+  require 'phonetic_encoder'
+
+  PhoneticEncoder::Encoder.custom('custom', 'a' => 'apple', 'b' => 'ballon', 'c' => 'cat')
+
+  puts PhoneticEncoder::Encoder.encode('abc', 'custom')
 
-  pe.custom('custom', 'a' => 'apple', 'b' => 'ballon', 'c' => 'cat')
+  # or
 
-  puts pe.encode('abc', 'custom')
+  'abc'.phonetic_encode('custom')
 ```
 
 ## Development

data/lib/phonetic_encoder/version.rb

@@ -1,3 +1,3 @@
 module PhoneticEncoder
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.1.1'.freeze
 end

data/lib/phonetic_encoder.rb

@@ -1,5 +1,5 @@
 require_relative 'phonetic_encoder/version'
-require_relative 'phonetic_encoder/strings'
+require_relative 'phonetic_encoder/overloads'
 require_relative 'phonetic_encoder/dicts/nato'
 require_relative 'phonetic_encoder/dicts/sounds'
 
@@ -22,6 +22,10 @@ module PhoneticEncoder
             $dict[name] = dict
         end
 
+        def self.letter_from_dictionary(letter, dict)
+            dict.key?(letter) ? dict[letter].downcase : letter
+        end
+
         def self.encode(text, dict_name = 'nato')
             setup
 
@@ -36,9 +40,5 @@ module PhoneticEncoder
             end
             result.rstrip
         end
-
-        def self.letter_from_dictionary(letter, dict)
-            dict.key?(letter) ? dict[letter].downcase : letter
-        end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phonetic_encoder
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Tim Gurney
@@ -78,7 +78,7 @@ files:
 - lib/phonetic_encoder.rb
 - lib/phonetic_encoder/dicts/nato.rb
 - lib/phonetic_encoder/dicts/sounds.rb
-- lib/phonetic_encoder/strings.rb
+- lib/phonetic_encoder/overloads.rb
 - lib/phonetic_encoder/version.rb
 - phonetic_encoder.gemspec
 homepage: https://github.com/WolfSoftware/phonetic_encoder