emoji_sub 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6452a3a122c4fc7168b83a44871acd14ef5c37bf6ff7fc402cb17c4dcc6f6989
-  data.tar.gz: 85582412e9e009aac38c38652a422219f4843919dd01f0ff3446a09fd740e5dc
+  metadata.gz: 2042ce47d58672b62d17ddf7b5cc520e965a505464399644fa79da7f0eba3140
+  data.tar.gz: f15703e29f303373308f017ae4be00c8f7f4ca8ff741ccf21c5f8c0e834198a7
 SHA512:
-  metadata.gz: edec0d0eb2edf0631447e0f58b6eeaea807389c7b862e8d6b90df28055e4775026e12ee48952e0fc5830a32f85e0cd0fa2dd7ae4aee3d1a0d7359c90444a5db8
-  data.tar.gz: f9140447eda1854375e50984fedc2c5f3653539941b94fd1865f08caf67ba96f9c01417964554c42cc91036e7d2e1d10c854bc4e1c2d2cd04ee21aacfa6c6eb4
+  metadata.gz: 76a9b86548c4f1f5059657e112d4d0b59bf87477b1d75e54dd442dc1201dcf73bf4a98749a3b5534e3f506f1d0dd46b11da79aa5b7469f6ea8586b78eee06daa
+  data.tar.gz: d029e8c17df35017faf3409b904c62d955aa403769cdfcb8940937df9240e9d6d04d794056b31a6d970ab9f05286aa0ed1bb371168abee689a4f13e98aef4844

data/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

data/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.

data/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

data/lib/emoji_sub.rb

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

data/lib/emoji_sub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emoji_sub
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Aaron Hill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-22 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies: []
 description: 'EmojiSub allows you to use :short_code_emoji: in your text and quickly
   replace it with the natural Unicode versions via a bit of string parsing logic'
@@ -32,6 +32,7 @@ files:
 - bin/setup
 - data/emoji.yaml
 - emoji_sub.gemspec
+- lib/core_extensions/string.rb
 - lib/emoji_sub.rb
 - lib/emoji_sub/version.rb
 homepage: https://github.com/armahillo/emoji_sub