gitmoji-regex 1.0.2 → 1.0.3

data/RUBOCOP.md

@@ -0,0 +1,71 @@
+# RuboCop Usage Guide
+
+## Overview
+
+A tale of two RuboCop plugin gems.
+
+### RuboCop Gradual
+
+This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
+
+### RuboCop LTS
+
+This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
+RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
+
+## Checking RuboCop Violations
+
+To check for RuboCop violations in this project, always use:
+
+```bash
+bundle exec rake rubocop_gradual:check
+```
+
+**Do not use** the standard RuboCop commands like:
+- `bundle exec rubocop`
+- `rubocop`
+
+## Understanding the Lock File
+
+The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
+
+1. Prevent new violations while gradually fixing existing ones
+2. Track progress on code style improvements
+3. Ensure CI builds don't fail due to pre-existing violations
+
+## Common Commands
+
+- **Check violations**
+    - `bundle exec rake rubocop_gradual`
+    - `bundle exec rake rubocop_gradual:check`
+- **(Safe) Autocorrect violations, and update lockfile if no new violations**
+  - `bundle exec rake rubocop_gradual:autocorrect`
+- **Force update the lock file (w/o autocorrect) to match violations present in code**
+  - `bundle exec rake rubocop_gradual:force_update`
+
+## Workflow
+
+1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
+   a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
+2. If there are new violations, either:
+   - Fix them in your code
+   - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
+3. Commit the updated `.rubocop_gradual.lock` file along with your changes
+
+## Never add inline RuboCop disables
+
+Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
+
+- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
+- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
+  - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
+
+In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
+
+## Benefits of rubocop_gradual
+
+- Allows incremental adoption of code style rules
+- Prevents CI failures due to pre-existing violations
+- Provides a clear record of code style debt
+- Enables focused efforts on improving code quality over time

data/SECURITY.md

@@ -7,8 +7,16 @@
 | 1.latest | ✅         |
 | 0.latest | ⛔️        |
 
-## Reporting a Vulnerability
+## Security contact information
 
-Peter Boling is the primary maintainer of this gem. Please find a way
-to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
-possible.
+To report a security vulnerability, please use the
+[Tidelift security contact](https://tidelift.com/security).
+Tidelift will coordinate the fix and disclosure.
+
+## Additional Support
+
+If you are interested in support for versions older than the latest release,
+please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
+or find other sponsorship links in the [README].
+
+[README]: README.md

data/checksums/gitmoji-regex-1.0.2.gem.sha256

@@ -0,0 +1 @@
+5fb52a48785f097e9f81632ccec8cf026be432bb1f32e057d3cf61d7ef725faf

data/checksums/gitmoji-regex-1.0.2.gem.sha512

@@ -0,0 +1 @@
+3b6e33a6cd5c90c16730ca1ae2b405629e23635b464b65cec25a7a9a6a6898fd536d84f0499c579c9517d3b98d7c9facc3d10e82208813b5debfac317456e653

data/checksums/gitmoji-regex-1.0.3.gem.sha256

@@ -0,0 +1 @@
+a88394b8f30ae9cab79175d658d6dbcc1e1a5dfb819808a1292edc3f0f97d29b

data/checksums/gitmoji-regex-1.0.3.gem.sha512

@@ -0,0 +1 @@
+e64c9581a9156845db3ab54445bb2e7fc0c51788b5b6db1d7fdc50520b9922c7a237e85ecb071251fdc5846beac2bbea432a6cb1a5e6ae522a5ae11a98d48d4b

data/lib/gitmoji/regex/reference.rb

@@ -6,47 +6,74 @@ require "json"
 
 # Download the list of all possible gitmojis from the project's github repository
 module Gitmoji
-  # Regex provides the namespace for this gem
+  # Namespace for the regex and maintenance tools provided by this gem.
   module Regex
-    # Reference provides utility tools for maintaining and testing this gem
+    # Reference provides utility tools for maintaining and testing this gem.
+    #
+    # It can compare the cached upstream gitmoji list with the latest
+    # fetched list, and can regenerate the library source from a template
+    # to include an up-to-date regular expression.
     class Reference
+      # Remote source of truth for the gitmoji JSON document.
       GITMOJI_REFERENCE = "https://raw.githubusercontent.com/carloscuesta/gitmoji/master/packages/gitmojis/src/gitmojis.json"
+      # Path to the cached JSON document bundled in this repository.
       GITMOJI_PATH = "src/gitmojis.json"
+      # Path to the library file that contains the REGEX constant.
       LIB_SRC = "lib/gitmoji/regex.rb"
+      # Path to the ERB-like template that is used to generate LIB_SRC.
       TEMPLATE_SRC = "src/regex.rb"
 
       include Singleton
 
+      # Compare the cached JSON-derived regex with the latest fetched regex.
+      #
+      # @return [Boolean] true if the regex generated from the cached JSON
+      #   matches the regex generated from the freshly fetched JSON.
       def compare_json
         return true if cached_pattern == fetched_pattern
 
         false
       end
 
+      # Regex generated from the cached JSON file.
+      # @return [Regexp]
       def cached_pattern
         pattern(cached)
       end
 
+      # Regex generated from the fetched remote JSON.
+      # @return [Regexp]
       def fetched_pattern
         pattern(fetch)
       end
 
+      # Compare the current library source with the next generated source.
+      #
+      # @return [Boolean] true if no changes are needed (files are equal).
       def compare_src
         return true if current_src == next_src
 
         false
       end
 
+      # Read the current library source file that defines REGEX.
+      # @return [String]
       def current_src
         File.read(LIB_SRC)
       end
 
+      # Build the next library source content from the template and fetched data.
+      # @return [String] the prospective library source content.
       def next_src
         template_src = File.read(TEMPLATE_SRC)
-        template_src = template_src.sub(/% gitmojiRegex %/, pattern(fetch).to_s)
+        template_src = template_src.sub("% gitmojiRegex %", pattern(fetch).to_s)
         template_src.to_s
       end
 
+      # Parse a JSON body and return the list of emoji strings.
+      #
+      # @param body [String, nil] the JSON document to parse; defaults to cached JSON
+      # @return [Array<String>] list of emoji characters
       def to_a(body = nil)
         body ||= cached
         json = JSON.parse(body)
@@ -54,6 +81,10 @@ module Gitmoji
         gitmoji.map { |g| g["emoji"] }
       end
 
+      # Write the freshly fetched JSON to the cache file.
+      #
+      # Also clears memoized cached values.
+      # @return [Integer] number of bytes written
       def write_json
         file = File.write(GITMOJI_PATH, fetch)
         @cached = nil
@@ -61,20 +92,29 @@ module Gitmoji
         file
       end
 
+      # Regenerate the library file from the template and fetched data.
+      # @return [Integer] number of bytes written
       def write_src
         File.write(LIB_SRC, next_src)
       end
 
       private
 
+      # Build the union regex from a JSON document body.
+      # @param body [String]
+      # @return [Regexp]
       def pattern(body)
         Regexp.union(to_a(body))
       end
 
+      # Fetch the latest gitmoji JSON from the remote source.
+      # @return [String] the raw response body as a string
       def fetch
         @fetch ||= HTTP.get(GITMOJI_REFERENCE).body
       end
 
+      # Read the cached gitmoji JSON from disk.
+      # @return [String]
       def cached
         @cached ||= File.read(GITMOJI_PATH)
       end

data/lib/gitmoji/regex/version.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module Gitmoji
+  # Namespace for all functionality provided by the gitmoji-regex gem.
   module Regex
+    # Version namespace housing the gem version constant.
     module Version
-      VERSION = "1.0.2"
+      # The version of the gitmoji-regex gem.
+      # @return [String]
+      VERSION = "1.0.3"
     end
   end
 end

data/lib/gitmoji/regex.rb

@@ -3,11 +3,26 @@
 require "version_gem"
 
 require "gitmoji/regex/version"
-require "gitmoji/regex/reference"
+# Reference file isn't needed at runtime.
+#   require "gitmoji/regex/reference"
+# Used to update the source of the gem (literally this file) when a new Gitmoji is added to the official list.
+# See: bin/refresh
 
 module Gitmoji
+  # Namespace for all functionality provided by the gitmoji-regex gem.
   module Regex
-    REGEX = Regexp.new("(?-mix:🎨|⚡️|🔥|🐛|🚑️|✨|📝|🚀|💄|🎉|✅|🔒️|🔐|🔖|🚨|🚧|💚|⬇️|⬆️|📌|👷|📈|♻️|➕|➖|🔧|🔨|🌐|✏️|💩|⏪️|🔀|📦️|👽️|🚚|📄|💥|🍱|♿️|💡|🍻|💬|🗃️|🔊|🔇|👥|🚸|🏗️|📱|🤡|🥚|🙈|📸|⚗️|🔍️|🏷️|🌱|🚩|🥅|💫|🗑️|🛂|🩹|🧐|⚰️|🧪|👔|🩺|🧱|🧑‍💻|💸|🧵|🦺)")
+    # Regular expression that matches any official Gitmoji emoji.
+    #
+    # You can use this to validate commit messages or extract leading
+    # gitmoji from strings.
+    #
+    # Examples:
+    #   # Validate a commit title starts with a gitmoji
+    #   (Gitmoji::Regex::REGEX =~ "✨ Add feature") #=> 0
+    #
+    #   # Extract all gitmojis from text
+    #   "✨ Fix bug 🐛".scan(Gitmoji::Regex::REGEX) #=> ["✨", "🐛"]
+    REGEX = Regexp.new("(?-mix:🎨|⚡️|🔥|🐛|🚑️|✨|📝|🚀|💄|🎉|✅|🔒️|🔐|🔖|🚨|🚧|💚|⬇️|⬆️|📌|👷|📈|♻️|➕|➖|🔧|🔨|🌐|✏️|💩|⏪️|🔀|📦️|👽️|🚚|📄|💥|🍱|♿️|💡|🍻|💬|🗃️|🔊|🔇|👥|🚸|🏗️|📱|🤡|🥚|🙈|📸|⚗️|🔍️|🏷️|🌱|🚩|🥅|💫|🗑️|🛂|🩹|🧐|⚰️|🧪|👔|🩺|🧱|🧑‍💻|💸|🧵|🦺|✈️)")
   end
 end
 

data/sig/gitmoji/regex.rbs

@@ -1,6 +1,31 @@
 module Gitmoji
   module Regex
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    REGEX: Regexp
+
+    module Version
+      VERSION: String
+    end
+
+    class Reference
+      GITMOJI_REFERENCE: String
+      GITMOJI_PATH: String
+      LIB_SRC: String
+      TEMPLATE_SRC: String
+
+      def compare_json: () -> bool
+      def cached_pattern: () -> Regexp
+      def fetched_pattern: () -> Regexp
+      def compare_src: () -> bool
+      def current_src: () -> String
+      def next_src: () -> String
+      def to_a: (?String) -> Array[String]
+      def write_json: () -> Integer
+      def write_src: () -> Integer
+
+      private
+      def pattern: (String) -> Regexp
+      def fetch: () -> String
+      def cached: () -> String
+    end
   end
 end

data/src/gitmojis.json

@@ -93,7 +93,7 @@
       "emoji": "🔒️",
       "entity": "🔒",
       "code": ":lock:",
-      "description": "Fix security issues.",
+      "description": "Fix security or privacy issues.",
       "name": "lock",
       "semver": "patch"
     },
@@ -427,7 +427,7 @@
     },
     {
       "emoji": "⚗️",
-      "entity": "📸",
+      "entity": "⚗",
       "code": ":alembic:",
       "description": "Perform experiments.",
       "name": "alembic",
@@ -478,7 +478,7 @@
       "entity": "💫",
       "code": ":dizzy:",
       "description": "Add or update animations and transitions.",
-      "name": "animation",
+      "name": "dizzy",
       "semver": "patch"
     },
     {
@@ -584,6 +584,14 @@
       "description": "Add or update code related to validation.",
       "name": "safety-vest",
       "semver": null
+    },
+    {
+      "emoji": "✈️",
+      "entity": "✈",
+      "code": ":airplane:",
+      "description": "Improve offline support.",
+      "name": "airplane",
+      "semver": null
     }
   ]
 }