emoji_mixer 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c984da7efabcafed3c35c42f81f45f4ec4f7de819e840f5a65260fbaf0890bb
+  data.tar.gz: 403cda69dd1790753c20f06d0c2640c10087e442788301cb9bab931dbc8bce89
+SHA512:
+  metadata.gz: cf26b44aa3f3e4953456d2f981e0f8114d04795bdb427fbcb22601300bb0df2ba3938c33e0dbe8ef860f062365e5b8be457206ee27db562d2c1e1be3ffc6d3bb
+  data.tar.gz: bd9715be69ed348b10e981a24b3cd0ca2014356ce43002fe385f918f91171ea2e9fbd8efe89db9d0c350e0d12f36688d948928cc09befa837bd3a1e488cb4070

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MattFor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# Emoji Mixer
+
+[![CI](https://github.com/MattFor/emoji-mixer/actions/workflows/ci.yml/badge.svg)](https://github.com/MattFor/emoji-mixer/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/emoji-mixer)](https://www.npmjs.com/package/emoji-mixer)
+[![PyPI](https://img.shields.io/pypi/v/emoji-mixer)](https://pypi.org/project/emoji-mixer/)
+[![crates.io](https://img.shields.io/crates/v/emoji-mixer)](https://crates.io/crates/emoji-mixer)
+[![Go Reference](https://pkg.go.dev/badge/github.com/MattFor/emoji-mixer/v2.svg)](https://pkg.go.dev/github.com/MattFor/emoji-mixer/v2)
+[![JSR](https://jsr.io/badges/@mattfor/emoji-mixer)](https://jsr.io/@mattfor/emoji-mixer)
+[![Packagist](https://img.shields.io/packagist/v/mattfor/emoji-mixer)](https://packagist.org/packages/mattfor/emoji-mixer)
+[![Gem](https://img.shields.io/gem/v/emoji_mixer)](https://rubygems.org/gems/emoji_mixer)
+[![NuGet](https://img.shields.io/nuget/v/EmojiMixer)](https://www.nuget.org/packages/EmojiMixer)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Get the URL of a Google Emoji Kitchen image for two emojis.
+
+## Install
+
+```sh
+npm install emoji-mixer   # JavaScript / TypeScript, Node.js 20.19+
+pip install emoji-mixer   # Python 3.10+
+cargo add emoji-mixer     # Rust
+go get github.com/MattFor/emoji-mixer/v2   # Go 1.21+
+deno add jsr:@mattfor/emoji-mixer   # Deno, or npx jsr add @mattfor/emoji-mixer
+composer require mattfor/emoji-mixer   # PHP 8.2+
+gem install emoji_mixer   # Ruby 3.3+
+dotnet add package EmojiMixer   # .NET 10+
+```
+
+## Usage
+
+```js
+import getEmojiMixUrl from 'emoji-mixer';
+// or: const { default: getEmojiMixUrl } = require("emoji-mixer");
+
+getEmojiMixUrl('🔥', '😃');
+// https://www.gstatic.com/android/keyboard/emojikitchen/20201001/u1f603/u1f603_u1f525.png
+```
+
+```python
+from emoji_mixer import get_emoji_mix_url
+
+get_emoji_mix_url("🔥", "😃")
+```
+
+```rust
+emoji_mixer::get_emoji_mix_url("🔥", "😃"); // Some(url)
+```
+
+```go
+import emojimixer "github.com/MattFor/emoji-mixer/v2"
+
+url, err := emojimixer.EmojiMixURL("🔥", "😃")
+```
+
+```php
+use MattFor\EmojiMixer\EmojiMixer;
+
+EmojiMixer::getEmojiMixUrl('🔥', '😃');
+```
+
+```ruby
+require "emoji_mixer"
+
+EmojiMixer.emoji_mix_url("🔥", "😃")
+```
+
+```csharp
+using EmojiMixer;
+
+EmojiKitchen.GetEmojiMixUrl("🔥", "😃");
+```
+
+Emojis can be passed as characters (`"☕"`) or codepoint strings (`"2615"`, `"1F600"`, `"2764-fe0f"`). The FE0F variation selector is optional.
+
+## Functions
+
+- `getEmojiMixUrl(leftEmoji, rightEmoji, detailedErrors = false)` (default export)  
+  Returns the image URL, or `undefined` if an emoji is unsupported or the pair has no mix. With `detailedErrors`, throws an error explaining why instead.
+
+- `toUnicode(input)`  
+  Returns the codepoint key of one supported emoji, e.g. `"☕"` → `"2615"`, or `undefined`.
+
+- `getEmojiCombo(leftEmoji, rightEmoji)`  
+  Takes two codepoint keys and returns the newest `{ leftEmoji, rightEmoji, date }` combination, or `undefined`. `leftEmoji` and `rightEmoji` are in the order Google hosts the image under, which may differ from the argument order.
+
+- `checkSupported(emoji)`  
+  Returns every combination containing the emoji (on either side), or `null` if it is unsupported.
+
+- `googleRequestUrl(combo)` / `googleRequestUrlEmojiPart(emoji)`  
+  Build the image URL from a combination / format one emoji for the URL.
+
+- `getExpandedEmojiCompatibilityData(useCache = false)`  
+  Returns `{ [emoji]: combination[] }` for every supported emoji.
+
+- `supportedEmojis`, `emojiCompatibilityData`, `baseUrl`  
+  The supported codepoint keys, the compressed database and the image base URL.
+
+**Python** has the same API in snake_case (`get_emoji_mix_url`, `to_unicode`, …, `BASE_URL`). It returns `None` instead of `undefined`/`null`, `detailed_errors` raises `ValueError`, and combinations are `EmojiCombo(left_emoji, right_emoji, date)` named tuples.
+
+**Rust** has `get_emoji_mix_url`, `to_unicode`, `get_emoji_combo`, `check_supported`, `google_request_url`, `google_request_url_emoji_part`, `supported_emojis()` and `BASE_URL`, returning `Option`s.
+
+**Go** has `EmojiMixURL` (an `error` says why there is no URL), `ToUnicode`, `EmojiCombo`, `CheckSupported`,
+`ExpandedEmojiCompatibilityData`, `GoogleRequestURL`, `GoogleRequestURLEmojiPart`, `SupportedEmojis()` and `BaseURL`;
+lookups return `(value, ok)` and combinations are `Combo{LeftEmoji, RightEmoji, Date}`.
+
+**JSR** is the same TypeScript as the npm package.
+
+**PHP** has the same API as static methods of `MattFor\EmojiMixer\EmojiMixer` (`getEmojiMixUrl`, `toUnicode`, …,
+`BASE_URL`), returning `null`; `$detailedErrors` throws `InvalidArgumentException`, and combinations are `EmojiCombo`
+objects with `leftEmoji`, `rightEmoji` and `date`.
+
+**Ruby** has `EmojiMixer.emoji_mix_url(left, right, detailed_errors: false)`, `to_unicode`, `emoji_combo`,
+`check_supported`, `expanded_emoji_compatibility_data`, `google_request_url`, `google_request_url_emoji_part`,
+`supported_emojis` and `BASE_URL`, returning `nil`; `detailed_errors` raises `ArgumentError`, and combinations are
+`EmojiMixer::EmojiCombo` values.
+
+**C#** has the same API as static members of `EmojiMixer.EmojiKitchen` (`GetEmojiMixUrl`, `ToUnicode`, …,
+`SupportedEmojis`, `BaseUrl`), returning `null`; `detailedErrors` throws `ArgumentException`, and combinations are
+`EmojiCombo(LeftEmoji, RightEmoji, Date)` records.
+
+## Data format
+
+`emojiCompatibilityData` is generated from [emojikitchen.dev](https://emojikitchen.dev/metadata.json) by `converter.ts`:
+
+```js
+{
+    "$d": [20201001, 20260128],   // unique dates
+    "$e": [9749, 9800],           // unique emojis: codepoints as integers, sequences as strings
+    "2615": [[0, 0], [1, 1]],     // [emojiIndex, dateIndex]
+    "2648": [[-1, 1]]
+}
+```
+
+A negative `emojiIndex` (`~i`) means the key emoji is the right-hand emoji in Google's URL. Above, both entries `[1, 1]` and `[-1, 1]` describe ☕ (left) + ♈ (right).
+
+## Attributions
+
+- Created by MattFor | Discord tag: mattfor | [Github](https://github.com/MattFor)
+- Inspired by [emoji-kitchen](https://github.com/xsalazar/emoji-kitchen) [made by Xavier Salazar a.k.a [xsalazar](https://github.com/xsalazar)]
+
+## License
+
+MIT, see [LICENSE](LICENSE). By [MattFor](https://github.com/MattFor).

data/bindings/ruby/lib/emoji_mixer.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "json"
+
+module EmojiMixer
+  BASE_URL = "https://www.gstatic.com/android/keyboard/emojikitchen"
+
+  EmojiCombo = Data.define(:left_emoji, :right_emoji, :date)
+
+  DATA_FILE = File.expand_path("../../../compatibility.json", __dir__)
+  private_constant :DATA_FILE
+
+  class << self
+    def supported_emojis
+      data[:supported].dup
+    end
+
+    def to_unicode(input)
+      return nil unless input.is_a?(String) && input.valid_encoding?
+
+      codepoints = if input.match?(/\A[0-9a-f]+(-[0-9a-f]+)*\z/i)
+        input.downcase
+      else
+        input.each_char.map { |char| char.ord.to_s(16) }.join("-")
+      end
+      data[:by_stripped][strip_fe0f(codepoints)]
+    end
+
+    def check_supported(emoji)
+      key = to_unicode(emoji)
+      key && combos_of(key).map { |entry| expand(key, entry) }
+    end
+
+    def expanded_emoji_compatibility_data
+      data[:supported].to_h { |key| [key, check_supported(key)] }
+    end
+
+    def google_request_url_emoji_part(emoji)
+      emoji.split("-").map { |part| "u#{part.downcase}" }.join("-")
+    end
+
+    def google_request_url(combo)
+      left = google_request_url_emoji_part(combo.left_emoji)
+      "#{BASE_URL}/#{combo.date}/#{left}/#{left}_#{google_request_url_emoji_part(combo.right_emoji)}.png"
+    end
+
+    def emoji_combo(left_emoji, right_emoji)
+      [[left_emoji, right_emoji], [right_emoji, left_emoji]]
+        .flat_map { |anchor, other| combos_of(anchor).select { |index, _| emoji_at(index) == other }.map { |entry| expand(anchor, entry) } }
+        .max_by(&:date)
+    end
+
+    def emoji_mix_url(left_emoji, right_emoji, detailed_errors: false)
+      left = to_unicode(left_emoji)
+      right = to_unicode(right_emoji)
+      combo = left && right && emoji_combo(left, right)
+
+      return google_request_url(combo) if combo
+      return nil unless detailed_errors
+
+      raise ArgumentError, "'#{left_emoji}' [left_emoji] is not a supported emoji." unless left
+      raise ArgumentError, "'#{right_emoji}' [right_emoji] is not a supported emoji." unless right
+
+      compatible = combos_of(right).map { |index, _| emoji_at(index) }.join(", ")
+      raise ArgumentError,
+        "'#{left}' is not compatible with '#{right}'. Here are all emojis compatible with '#{right}':\n[#{compatible}]"
+    end
+
+    private
+
+    def data
+      @data ||= begin
+        raw = JSON.parse(File.read(DATA_FILE))
+        combos = raw.reject { |key, _| key.start_with?("$") }
+        supported = combos.keys.sort
+        {
+          emojis: raw["$e"].map { |emoji| emoji.is_a?(Integer) ? emoji.to_s(16) : emoji },
+          dates: raw["$d"].map(&:to_s),
+          combos: combos,
+          supported: supported,
+          by_stripped: supported.to_h { |key| [strip_fe0f(key), key] }
+        }
+      end
+    end
+
+    def strip_fe0f(codepoints)
+      codepoints.split("-").reject { |part| part == "fe0f" }.join("-")
+    end
+
+    def combos_of(emoji)
+      data[:combos].fetch(emoji, [])
+    end
+
+    def emoji_at(index)
+      data[:emojis][index.negative? ? ~index : index]
+    end
+
+    def expand(anchor, (index, date_index))
+      other = emoji_at(index)
+      date = data[:dates][date_index]
+      index.negative? ? EmojiCombo.new(other, anchor, date) : EmojiCombo.new(anchor, other, date)
+    end
+  end
+end