kenny_speak 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9560189f07a2cb7560075bf31a43305cd99ba1b6154b7866187ebcb23d3f7c7b
-  data.tar.gz: c97708c00f56d218093d32bb3aac520e2c98b0bae29d66f0d3c1b3ebdd75b78f
+  metadata.gz: 5e00dd7017e8a0ab2101bd487e9f2f25939ee5b7cb6332ab68d8829e75c68ea8
+  data.tar.gz: 8b98f3423afa7364b48b4c504a8c467979b24f89d9b337d1b6e4130ce4e1c2cf
 SHA512:
-  metadata.gz: 6e75a80ecbb6ae33b8dc341ca3eaa02363b32f0b4b653d34db58ae861a64982f7430feeea2b8f14d08be63840467045f2b71db017402cfb2f4b73fa4c3d9fc96
-  data.tar.gz: 345e9d0233c13689ddd550be28b0060597b638bbd64dbc77a1d95c016be61e9aca709d1beb336af892dded136eac747c82d751cfed7d110611a7d528ef0b10d2
+  metadata.gz: 291c3917b88e7d23187f9e54fd362e0ef7881f7f74ac46e076d5cd9755a4e6a176b64bc95fae1abee7332274dee53bb079e67a8d8e823f93e2c900cc1da9626b
+  data.tar.gz: 6ba2a748788ca2275afb6dd6344ee6b9f98b2666d1f18753738ef85e667a177902d97b9450d54589b546d72ff0d3a705c52d5a00534ef2511682f7ae02880ea0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.1.0 (January 24, 2019)
+
+IMPROVEMENTS:
+
+* Move the code inside of a module namespace. ([@TGWolf][])
+* Extend the strings class so that str.to_kenny and str.from_kenny work. ([@TGWolf][])
+* Update the documentation. ([@TGWolf][])
+
 ## 1.0.0 (January 22, 2019)
 
 * Initial Release ([@TGWolf][])

data/README.md

@@ -33,9 +33,11 @@ Or install it yourself as:
 ```ruby
   require 'kenny_speak'
 
-  ks = KennySpeak.new
+  puts KennySpeak::Kenny.to_kenny(message)
 
-  puts ks.to_kenny(message)
+  # or
+
+  puts message.to_kenny
 ```
 
 ### Decode
@@ -43,9 +45,11 @@ Or install it yourself as:
 ```ruby
   require 'kenny_speak'
 
-  ks = KennySpeak.new
+  puts KennySpeak::Kenny.from_kenny(message)
+
+  # or
 
-  puts ks.from_kenny(message)
+  puts message.from_kenny
 ```
 
 ### Command Line

data/exe/kenny

@@ -10,10 +10,8 @@ require 'kenny_speak'
 # -------------------------------------------------------------------------------- #
 
 def handle_kenny(options)
-    ks = KennySpeak.new
-
-    puts ks.to_kenny(options[:message]) if options[:encode]
-    puts ks.from_kenny(options[:message]) if options[:decode]
+    puts KennySpeak::Kenny.to_kenny(options[:message]) if options[:encode]
+    puts KennySpeak::Kenny.from_kenny(options[:message]) if options[:decode]
 end
 
 # -------------------------------------------------------------------------------- #

data/lib/kenny_speak.rb

@@ -1,74 +1,75 @@
 require 'kenny_speak/version'
+require 'kenny_speak/letters'
+require 'kenny_speak/strings'
 
 #
 # To Follow
 #
-class KennySpeak
-    def initialize
-        @letters = ['mmm', 'mmp', 'mmf', 'mpm', 'mpp', 'mpf', 'mfm', 'mfp', 'mff', 'pmm', 'pmp', 'pmf', 'ppm', 'ppp', 'ppf', 'pfm', 'pfp', 'pff', 'fmm', 'fmp', 'fmf', 'fpm', 'fpp', 'fpf', 'ffm', 'ffp']
-    end
-
-    def to_kenny(str)
-        result = ''
-
-        str.split('').each do |c|
-            result << if c =~ /[[:alpha:]]/
-                          kenny_from_letter(c)
-                      else
-                          c
-                      end
+module KennySpeak
+    #
+    # To Follow
+    #
+    class Kenny
+        def self.to_kenny(str)
+            result = ''
+
+            str.split('').each do |c|
+                result << if c =~ /[[:alpha:]]/
+                              kenny_from_letter(c)
+                          else
+                              c
+                          end
+            end
+            result
         end
-        result
-    end
 
-    def from_kenny(str)
-        result = ''
+        def self.from_kenny(str)
+            result = ''
 
-        str.gsub(/\s+/m, ' ').strip.split(' ').each do |word|
-            word.scan(/.{1,3}/).each do |tuple|
-                result << letter_from_kenny(tuple)
+            str.gsub(/\s+/m, ' ').strip.split(' ').each do |word|
+                word.scan(/.{1,3}/).each do |tuple|
+                    result << letter_from_kenny(tuple)
+                end
+                result << ' '
             end
-            result << ' '
+            result.rstrip
         end
-        result.rstrip
-    end
-
-    private
 
-    def kenny_from_letter(letter)
-        upper = false
+        def self.kenny_from_letter(letter)
+            upper = false
 
-        upper = true if letter =~ /[[:upper:]]/
+            upper = true if letter =~ /[[:upper:]]/
 
-        tmp = letter.downcase
+            tmp = letter.downcase
 
-        offset = tmp.ord - 97
+            offset = tmp.ord - 97
 
-        tuple = @letters[offset]
+            tuple = KENNY_LETTERS[offset]
 
-        return tuple.capitalize if upper
+            return tuple.capitalize if upper
 
-        tuple
-    end
+            tuple
+        end
 
-    def letter_from_kenny(tuple)
-        return tuple if tuple.length != 3                # Not a tuple
-        return tuple if tuple[/[a-zA-Z0-9]+/] != tuple   # Not just letters
+        def self.letter_from_kenny(tuple)
+            return tuple if tuple.length != 3                # Not a tuple
+            return tuple if tuple[/[a-zA-Z0-9]+/] != tuple   # Not just letters
 
-        upper = false
+            upper = false
 
-        upper = true if tuple.chr =~ /[[:upper:]]/
+            upper = true if tuple.chr =~ /[[:upper:]]/
 
-        tmp = tuple.downcase
+            tmp = tuple.downcase
 
-        offset = @letters.index(tmp)
+            offset = KENNY_LETTERS.index(tmp)
 
-        return tuple if offset.nil?
+            return tuple if offset.nil?
 
-        letter = (offset.to_i + 97).chr
+            letter = (offset.to_i + 97).chr
 
-        return letter.upcase if upper
+            return letter.upcase if upper
 
-        letter
+            letter
+        end
     end
 end

data/lib/kenny_speak/letters.rb

@@ -0,0 +1,3 @@
+module KennySpeak
+    KENNY_LETTERS = ['mmm', 'mmp', 'mmf', 'mpm', 'mpp', 'mpf', 'mfm', 'mfp', 'mff', 'pmm', 'pmp', 'pmf', 'ppm', 'ppp', 'ppf', 'pfm', 'pfp', 'pff', 'fmm', 'fmp', 'fmf', 'fpm', 'fpp', 'fpf', 'ffm', 'ffp'].freeze
+end

data/lib/kenny_speak/strings.rb

@@ -0,0 +1,20 @@
+#
+# Overload the string class
+#
+class String
+    def to_kenny
+        KennySpeak::Kenny.to_kenny(self)
+    end
+
+    def to_kenny!
+        replace to_kenny
+    end
+
+    def from_kenny
+        KennySpeak::Kenny.from_kenny(self)
+    end
+
+    def from_kenny!
+        replace from_kenny
+    end
+end

data/lib/kenny_speak/version.rb

@@ -1,3 +1,3 @@
-class KennySpeak
-    VERSION = '1.0.0'.freeze
+module KennySpeak
+    VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kenny_speak
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,8 @@ files:
 - exe/kenny
 - kenny_speak.gemspec
 - lib/kenny_speak.rb
+- lib/kenny_speak/letters.rb
+- lib/kenny_speak/strings.rb
 - lib/kenny_speak/version.rb
 homepage: https://github.com/WolfSoftware/kenny_speak
 licenses: