punctuation_name 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 684c3f5e13875e1a1d76b78ca8975d559a723728637135208c298af5882b73ad
-  data.tar.gz: f65a627fca39f82c93bd5e25a9cbd2e00c03045bd0940d3c889db1991bdb5753
+  metadata.gz: 5e7b2b1922abd3559422a903362c06f5390b31b5d99802fc5a6d1e8ccc27fa24
+  data.tar.gz: e78a647d187a1cd9d722da7839a9dbee60e0ee324472dc20f8d84730ba78e3fb
 SHA512:
-  metadata.gz: bb02cfe153b846d167a62bae21d2ab49df37947f947a564b1a6ccdb4732d0066302c3285f3c2c1cb2c1f4df583730b045189e79bb4c21d6355fb3be91efdc9cc
-  data.tar.gz: c98fadd0960ac792566a9f7ff30c47a74e2942992dd1425c3d41264d04f641eb4ecd1748e539b3848b76858ea6ee0f191d23ff8004c4542265154825d58b98b8
+  metadata.gz: 178f1bd860503e47aaabbffde827ea663eed2c96dfef7de38fc957aa2ea4bc350da97497f29ab96af7679dec215e5416442e74ebb0d5a2bec196313364d914a7
+  data.tar.gz: 3940c99ecdf209376e1e5857c6992ecf2145cd43a0a240758ee5bb52bffb45177c5d7c7c5e67611983f330bacbe56aef61b8c504c0893d1a7a7944ddd9deb846

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.punctuation_name 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 UK/English.
 
 ```ruby
-  p = PunctuationName.new
+  require 'punctuation_name'
 
-  puts p.name('!')
+  puts PunctuationName::Punctuation.name('!')
+
+  # or
+
+  puts '!'.punctuation_name
 ```
 
 ### Extended Usage
@@ -43,9 +47,13 @@ You can use the default built in dictionary which is UK/English.
 You can also use the built-in US dictionary.
 
 ```ruby
-  p = PunctuationName.new
+  require 'punctuation_name'
+
+  puts PunctuationName::Punctuation.name('!', 'us')
+
+  # or
 
-  puts p.name('!', 'us')
+  puts '!'.punctuation_name('us')
 ```
 
 ### Advanced Usage
@@ -53,9 +61,15 @@ You can also use the built-in US dictionary.
 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.
 
 ```
-  p = PunctuationName.new
-  p.custom('custom', { '!' => 'shouty marker' })
-  puts p.name('!', 'custom')
+  require 'punctuation_name'
+
+  PunctuationName::Punctuation.custom('custom', { '!' => 'shouty marker' })
+
+  puts PunctuationName::Punctuation.name('!', 'custom')
+
+  # or
+
+  puts '!'.punctuation_name('custom')
 ```
 
 ## Return Value

data/exe/punctuation_name

@@ -10,12 +10,10 @@ require 'punctuation_name'
 # -------------------------------------------------------------------------------- #
 
 def punctuation_name(options)
-    pn = PunctuationName.new
-
     if options[:dictionary]
-        puts pn.name(options[:punctuation], options[:dictionary])
+        puts PunctuationName::Punctuation.name(options[:punctuation], options[:dictionary])
     else
-        puts pn.name(options[:punctuation])
+        puts PunctuationName::Punctuation.name(options[:punctuation])
     end
 end
 

data/lib/punctuation_name.rb

@@ -1,31 +1,39 @@
-require 'punctuation_name/version'
-require 'punctuation_name/dicts/uk.rb'
-require 'punctuation_name/dicts/us.rb'
+require_relative 'punctuation_name/version'
+require_relative 'punctuation_name/strings'
+require_relative 'punctuation_name/dicts/uk.rb'
+require_relative 'punctuation_name/dicts/us.rb'
 
 #
 # Add docs
 #
-class PunctuationName
-    def initialize
-        @dict = {}
+module PunctuationName
+    #
+    # To go here
+    #
+    class Punctuation
+        $dict = {}
 
-        @dict['uk'] = UK_NAMES
-        @dict['us'] = US_NAMES
-    end
+        def self.setup
+            $dict['uk'] = UK_NAMES
+            $dict['us'] = US_NAMES
+        end
 
-    def custom(name, dict)
-        @dict[name] = dict
-    end
+        def self.custom(name, dict)
+            $dict[name] = dict
+        end
 
-    def name_from_dictionary(punctuation, dict)
-        dict.key?(punctuation) ? dict[punctuation] : punctuation
-    end
+        def self.name_from_dictionary(punctuation, dict)
+            dict.key?(punctuation) ? dict[punctuation] : punctuation
+        end
+
+        def self.name(punctuation, dict_name = 'uk')
+            setup
 
-    def name(punctuation, dict_name = 'uk')
-        dict_name = 'uk' if dict_name.empty?
+            dict_name = 'uk' if dict_name.empty?
 
-        return punctuation unless @dict.key?(dict_name)
+            return punctuation unless $dict.key?(dict_name)
 
-        name_from_dictionary(punctuation, @dict[dict_name])
+            name_from_dictionary(punctuation, $dict[dict_name])
+        end
     end
 end

data/lib/punctuation_name/dicts/uk.rb

@@ -1,4 +1,4 @@
-class PunctuationName
+module PunctuationName
     UK_NAMES = { '!' => 'exclamation mark',
                  '@' => 'at sign',
                  '#' => 'hash',

data/lib/punctuation_name/dicts/us.rb

@@ -1,4 +1,4 @@
-class PunctuationName
+module PunctuationName
     US_NAMES = { '!' => 'exclamation mark',
                  '@' => 'at sign',
                  '#' => 'hash',

data/lib/punctuation_name/strings.rb

@@ -0,0 +1,12 @@
+#
+# Overload the string class
+#
+class String
+    def punctuation_name(dict = 'uk')
+        PunctuationName::Punctuation.name(self, dict)
+    end
+
+    def punctuation_name!(dict = 'uk')
+        replace punctuation_name(dict)
+    end
+end

data/lib/punctuation_name/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punctuation_name
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
@@ -78,6 +78,7 @@ files:
 - lib/punctuation_name.rb
 - lib/punctuation_name/dicts/uk.rb
 - lib/punctuation_name/dicts/us.rb
+- lib/punctuation_name/strings.rb
 - lib/punctuation_name/version.rb
 - punctuation_name.gemspec
 homepage: https://github.com/WolfSoftware/punctuation_name