Closes #2 - Adds monkey patching for string

CHANGELOG.md

@@ -6,6 +6,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 N.B. until it hits 1.0 do not make any expectations about API consistency! (SemVer says it's OK so nyah!)
 
+## [0.3.0] - 2020-10-05
+
+- Adds monkey-patch to allow String to call `:emoji_sub` directly
+
 ## [0.2.2] - 2020-08-22
 
 - Some reorganization of files, and cleanup
@@ -42,6 +46,8 @@ emoji HTML entities (hex-unicode) for slack shortcut format (:this_kind:)
 - data/emoji.yml file, 
 - Specs covering basic funcitonality
 
+[0.3.0]: https://github.com/armahillo/emoji_sub/compare/v0.2.2...v0.3.0
+[0.2.2]: https://github.com/armahillo/emoji_sub/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/armahillo/emoji_sub/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/armahillo/emoji_sub/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/armahillo/emoji_sub/releases/tag/v0.1.0

README.md

@@ -38,15 +38,25 @@ text = "I :heart: New York :statue_of_liberty: :pizza: :pigeon:"
 better_text = EmojiSub.emoji_sub(text, additional_emoji)
 ```
 
+You can also include the monkey-patch for it so that you can call `.emoji_sub` directly on a string. To enable this behavior, add this somewhere in your scripts bootstrap (it just needs to be run before other it's used)
+
+```ruby
+  String.prepend CoreExtensions::EmojiSub::String
+```
+
+### Using Custom Mappings / Overrides
+
 You can even, even override the mappings I did with your own! If your expert-moji opinion says that `:smiley_cat:` should be 😸 and `:smile_cat:` should be 😺 who am I to disagree? They're very different, clearly, and obviously the "-y" on the end of "smile-y" means that the cat should have eyes that are more smiley. Very reasonable and I completely understand! YES I'M FINE WHY DO YOU ASK?
 
 In all seriousness, one big reason I could see wanting to do overrides is because emoji shortcodes in Slack are often quite gendered, such as :man_bouncing_ball: => ⛹ and you'd like to use :woman_bouncing_ball: (⛹), which doesn't exist in the current YML mapping because GOOD GOB THERE ARE SO MANY AND I AM BUT ONE PERSON.
 
-Currently, the emoji are also a single skin-tone. I'm still learning how to combine emoji to do skin-tone modifiers, but when I do, you would also use the overrides thing to do that, as well! If you're an e-moji e-xpert and can help out with this, please do!
-
 Other reasons to override might be because you prefer a specific version of `:airplane:` to be mapped to `:airplane:` instead of ✈, and at the end of the day, this is about making it more convenient for you.
 
 
+### Skin-tone variants
+
+Currently, the emoji are also a single skin-tone. I'm still learning how to combine emoji to do skin-tone modifiers, but when I do, you would also use the overrides thing to do that, as well! If you're an e-moji e-xpert and can help out with this, please do!
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

lib/core_extensions/string.rb

@@ -0,0 +1,19 @@
+module CoreExtensions
+  module EmojiSub
+    ##
+    # This monkey patches String so that it can receive emoji_sub directives
+    # cf. https://github.com/armahillo/emoji_sub/issues/2
+    # If you want to monkey patch your use of String, you should be able to include
+    # this module and that should do it.
+    ##
+    module String
+      def emoji_sub(options = {})
+        ::EmojiSub.emoji_sub(self, options)
+      end
+
+      def emoji_sub!(options = {})
+        replace emoji_sub(options)
+      end
+    end
+  end
+end

lib/emoji_sub.rb

@@ -24,5 +24,4 @@ def emoji_definitions
   end
 
   module_function :emoji_sub, :emoji_definitions
-
 end

lib/emoji_sub/version.rb

@@ -1,3 +1,3 @@
 module EmojiSub
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require "bundler/setup"
 require "emoji_sub"
+require 'pry'
+require 'binding_of_caller'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

spec/string_spec.rb

@@ -0,0 +1,35 @@
+require 'core_extensions/string'
+
+RSpec.describe String do
+  before(:each) do
+    String.prepend CoreExtensions::EmojiSub::String
+  end
+
+  subject { "I :heartbeat: NY" }
+
+  describe "emoji_sub" do
+    it { is_expected.to be_respond_to(:emoji_sub) }
+
+    it "replaces the shortcodes with their corresponding unicode" do
+      expect(subject.emoji_sub).to eq('I &#x1F493 NY')
+    end
+
+    it "allows an override to be provided as an argument" do
+      expect(subject.emoji_sub({ heartbeat: "1111" })).to eq('I &#x1111 NY')
+    end
+  end
+
+  describe "emoji_sub!" do
+    it { is_expected.to be_respond_to(:emoji_sub!) }
+
+    it "replaces in-place with the corresponding unicode" do
+      subject.emoji_sub!
+      expect(subject).to eq('I &#x1F493 NY')
+    end
+
+    it "allows an override to be provided as an argument" do
+      subject.emoji_sub!({ heartbeat: "1111" })
+      expect(subject).to eq('I &#x1111 NY')
+    end
+  end
+end