cmdx-i18n 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ad9f38d389bf57b7e9e16aca616782e3493e5db6c133784a3ec48a05173293c
+  data.tar.gz: e4e91914156a83731d8c1a48c36a6d78e52562e414c9ec228f43458fd4de4552
+SHA512:
+  metadata.gz: 23ca825e44298e0356b14d572b47530d6e0904e5615d4cebe9ee9ee67a61b31fa68336f0dff570467ce1b09e86b99f84a1fdbd63c738c92d3eedb6438a87f7fb
+  data.tar.gz: a4c8c4731aa104a3f8b77e0337a808768f1db217fefb9182fe22b358761bbeeaa279a774ba507805ea2e266334e61bff4ba83538a8d4af252311e975411a1205

data/.cursor/prompts/docs.md

@@ -0,0 +1,12 @@
+You are a senior Ruby developer with expert knowledge of CMDx and writing documentation.
+
+Update the active tab using the following guidelines:
+
+- Follow best practices and implementation
+- Use a consistent professional voice
+- Examples should be concise, non-repetitive, and realistic
+- Update any pre-existing documentation to match stated rules
+- Examples should not cross boundaries or focus
+- Docs must cover both typical use cases, including invalid inputs and error conditions
+- Use GitHub flavored markdown, including alerts to emphasize critical information (https://github.com/orgs/community/discussions/16925)
+- Optimize for LLM's including coding and AI agents

data/.cursor/prompts/llms.md

@@ -0,0 +1,20 @@
+Process the following instructions in the order given:
+
+1. Create an `LLM.md` file
+2. Append all files within `docs/**/*.md` into @LLM.md
+  2a. Use order outlined in the table of contents of @README.md
+  2b. Process one file at a time faster performance and improved accuracy
+  2c. Remove the table of contents from the chunk
+  2c. Remove the navigations below `---` from the chunk
+  2d. Wrap the chunk the files GitHub url the top and a spacer at the bottom like so:
+      ```
+
+      ---
+      url: https://github.com/drexed/cmdx/blob/main/docs/callbacks.md
+      ---
+
+      {{ chunk }}
+
+      ---
+
+      ```

data/.cursor/prompts/rspec.md

@@ -0,0 +1,24 @@
+You are a senior Ruby developer with expert knowledge of RSpec.
+
+Add tests for the active tab using the following guidelines:
+
+- Expectations should be concise, non-repetitive, and realistic (how it would be used in the real world)
+- Follow best practices and implementation
+- Update any pre-existing specs to match stated rules
+- New tests should be consistent with current `spec/cmdx` specs
+- Use custom matchers available within `lib/cmdx/rspec`
+- Use task helpers available within `spec/support/helpers`
+- Use stubs to return predefined values for specific methods. Isolate the unit being tested, but avoid over-mocking; test real behavior when possible (mocks should be used only when necessary)
+- Ensure each test is independent; avoid shared state between tests
+- Use let and let! to define test data, ensuring minimal and necessary setup
+- Context block descriptions should start with the following words: `when`, `with`, `without`
+- Organize tests logically using describe for classes/modules and context for different scenarios
+- Use subject to define the object under test when appropriate to avoid repetition
+- Ensure test file paths mirror the structure of the files being tested, but within the spec directory (e.g., lib/cmdx/task.rb → spec/cmdx/task_spec.rb)
+- Use clear and descriptive names for describe, context, and it blocks
+- Prefer the expect syntax for assertions to improve readability
+- Keep test code concise; avoid unnecessary complexity or duplication
+- Tests must cover both typical cases and edge cases, including invalid inputs and error conditions
+- Consider all possible scenarios for each method or behavior and ensure they are tested
+- Do NOT include integration or real world examples
+- Verify all specs are passing

data/.cursor/prompts/yardoc.md

@@ -0,0 +1,14 @@
+You are a senior Ruby developer with expert knowledge of YARDoc.
+
+Add yardoc to the active tab using the following guidelines:
+
+- Follow best practices and implementation
+- New documentation should be consistent with current `lib/cmdx` documentation
+- Examples should be concise, non-repetitive, and realistic
+- Avoid unnecessary complexity or duplication
+- Update any pre-existing documentation to match stated rules
+- Do NOT include `CMDx` module level docs
+- Module level docs description should NOT include `@example`
+- Method level docs should include `@example`, `param`, `@options`, `@return`, and any `@raise`
+- Hash `@params` should expand with possible `@option`
+- Module and method level docs should NOT include `@since`

data/.cursor/rules/cursor-instructions.mdc

@@ -0,0 +1,60 @@
+---
+description:
+globs:
+alwaysApply: true
+---
+
+# Ruby Coding Standards
+
+Follow the official Ruby gem guides for best practices.
+Reference the guides outlined in https://guides.rubygems.org
+
+## Project Context
+CMDx provides a framework for designing and executing complex
+business logic within service/command objects.
+
+## Technology Stack
+- Ruby 3.4+
+- RSpec 3.1+
+
+## Code Style and Structure
+- Write concise, idiomatic Ruby code with accurate examples
+- Follow Ruby conventions and best practices
+- Use object-oriented and functional programming patterns as appropriate
+- Prefer iteration and modularization over code duplication
+- Use descriptive variable and method names (e.g., user_signed_in?, calculate_total)
+- Write comprehensive code documentation using the Yardoc format
+
+## Naming Conventions
+- Use snake_case for file names, method names, and variables
+- Use CamelCase for class and module names
+
+## Syntax and Formatting
+- Follow the Ruby Style Guide (https://rubystyle.guide/)
+- Follow Ruby style conventions (2-space indentation, snake_case methods)
+- Use Ruby's expressive syntax (e.g., unless, ||=, &.)
+- Prefer double quotes for strings
+- Respect my Rubocop options
+
+## Performance Optimization
+- Use memoization for expensive operations
+
+## Testing
+- Follow the RSpec Style Guide (https://rspec.rubystyle.guide/)
+- Write comprehensive tests using RSpec
+- It's ok to put multiple assertions in the same example
+- Include both BDD and TDD based tests
+- Create test objects to share across tests
+- Do NOT make tests for obvious or reflective expectations
+- Prefer real objects over mocks. Use `instance_double` if necessary; never `double`
+- Don't test declarative configuration
+- Use appropriate matchers
+- Update tests and update Yardocs after you write code
+
+## Documentation
+- Utilize the YARDoc format when documenting Ruby code
+- Follow these best practices:
+  - Avoid redundant comments that merely restate the code
+  - Keep comments up-to-date with code changes
+  - Keep documentation consistent
+- Update CHANGELOG.md with any changes

data/.irbrc

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "pp"
+
+# To reload the gem, you must exit and restart the IRB session
+require_relative "lib/cmdx/i18n" unless defined?(CMDx)

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.rubocop.yml

@@ -0,0 +1,37 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 3.1
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/LineLength:
+  Enabled: false
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integrations/**/*'
+RSpec/SpecFilePathFormat:
+  CustomTransform:
+    CMDx: cmdx
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always_true
+  SafeAutoCorrect: true
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.4.5

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [TODO]
+
+## [0.1.0] - 2025-08-21
+
+### Added
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Juan Gomez
+
+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,140 @@
+<p align="center">
+  <img src="./src/cmdx-i18n-logo.png" width="200" alt="CMDx::I18n Logo">
+</p>
+
+<p align="center">
+  <img alt="Version" src="https://img.shields.io/gem/v/cmdx-i18n">
+  <img alt="Build" src="https://github.com/drexed/cmdx-i18n/actions/workflows/ci.yml/badge.svg">
+  <img alt="License" src="https://img.shields.io/github/license/drexed/cmdx-i18n">
+</p>
+
+# CMDx::I18n
+
+Centralization of locale data collection for CMDx.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cmdx-i18n'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmdx-i18n
+
+## Configuration
+
+By default, `cmdx-i18n` locales are automatically loaded and are managed through the `I18n.available_locales` option.
+
+## Locales
+
+- af - Afrikaans
+- ar - Arabic
+- az - Azerbaijani
+- be - Belarusian
+- bg - Bulgarian
+- bn - Bengali
+- bs - Bosnian
+- ca - Catalan
+- cnr - Montenegrin
+- cs - Czech
+- cy - Welsh
+- da - Danish
+- de - German
+- dz - Dzongkha
+- el - Greek
+- en - English
+- eo - Esperanto
+- es - Spanish
+- et - Estonian
+- eu - Basque
+- fa - Persian
+- fi - Finnish
+- fr - French
+- fy - Western Frisian
+- gd - Scottish Gaelic
+- gl - Galician
+- he - Hebrew
+- hi - Hindi
+- hr - Croatian
+- hu - Hungarian
+- hy - Armenian
+- id - Indonesian
+- is - Icelandic
+- it - Italian
+- ja - Japanese
+- ka - Georgian
+- kk - Kazakh
+- km - Khmer
+- kn - Kannada
+- ko - Korean
+- lb - Luxembourgish
+- lo - Lao
+- lt - Lithuanian
+- lv - Latvian
+- mg - Malagasy
+- mk - Macedonian
+- ml - Malayalam
+- mn - Mongolian
+- mr-IN - Marathi (India)
+- ms - Malay
+- nb - Norwegian Bokmål
+- ne - Nepali
+- nl - Dutch
+- nn - Norwegian Nynorsk
+- oc - Occitan
+- or - Odia
+- pa - Punjabi
+- pl - Polish
+- pt - Portuguese
+- rm - Romansh
+- ro - Romanian
+- ru - Russian
+- sc - Sardinian
+- sk - Slovak
+- sl - Slovenian
+- sq - Albanian
+- sr - Serbian
+- st - Southern Sotho
+- sv - Swedish
+- sw - Swahili
+- ta - Tamil
+- te - Telugu
+- th - Thai
+- tl - Tagalog
+- tr - Turkish
+- tt - Tatar
+- ug - Uyghur
+- uk - Ukrainian
+- ur - Urdu
+- uz - Uzbek
+- vi - Vietnamese
+- wo - Wolof
+- zh-CN - Chinese (Simplified)
+- zh-HK - Chinese (Hong Kong)
+- zh-TW - Chinese (Traditional)
+- zh-YUE - Chinese (Yue)
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cmdx-i18n. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/cmdx-i18n/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cmdx::I18n project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cmdx-i18n/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/cmdx/i18n/railtie.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module CMDx
+  module I18n
+    # Rails integration class that automatically configures CMDx::I18n when the Rails
+    # application initializes. Handles locale configuration and I18n setup.
+    class Railtie < Rails::Railtie
+
+      railtie_name :cmdx_i18n
+
+      # Configures CMDx::I18n locales during Rails application initialization.
+      #
+      # Iterates through available locales from the Rails configuration and loads
+      # corresponding CMDx::I18n locale files. Reloads the I18n system to ensure
+      # all locales are properly registered.
+      #
+      # @param app [Rails::Application] the Rails application instance
+      #
+      # @raise [LoadError] if locale files cannot be loaded
+      #
+      # @example
+      #   # This initializer runs automatically when Rails starts
+      #   # It will load locales like en.yml, es.yml, fr.yml if they exist
+      #   # in the CMDx::I18n gem's locales directory
+      initializer("cmdx_i18n.configure_locales") do |app|
+        Array(app.config.i18n.available_locales).each do |locale|
+          path = CMDx::I18n.gem_path.join("lib/locales/#{locale}.yml")
+          next unless File.file?(path)
+
+          ::I18n.load_path << path
+        end
+
+        ::I18n.reload!
+      end
+
+    end
+  end
+end

data/lib/cmdx/i18n/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CMDx
+  module I18n
+
+    VERSION = "0.1.0"
+
+  end
+end

data/lib/cmdx/i18n.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "cmdx"
+require "zeitwerk"
+
+module CMDx
+  module I18n
+
+    extend self
+
+    def gem_path
+      @gem_path ||= Pathname.new(__dir__).parent.parent
+    end
+
+  end
+end
+
+# Set up Zeitwerk loader for the CMDx gem
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect("cmdx" => "CMDx")
+loader.ignore("#{__dir__}/locales")
+loader.setup
+
+# Load the Railtie last after everything else is required so we don't
+# need to load any CMDx::I18n components when we use this Railtie.
+require_relative "cmdx/i18n/railtie" if defined?(Rails::Railtie)

data/lib/locales/af.yml

@@ -0,0 +1,49 @@
+af:
+  cmdx:
+    attributes:
+      required: "moet toeganklik wees via die bron"
+      undefined: "delegeer na ongedefinieerde metode %{method}"
+    coercions:
+      into_a: "kon nie na %{type} omskep word nie"
+      into_an: "kon nie na %{type} omskep word nie"
+      into_any: "kon nie na een van: %{types} omskep word nie"
+      unknown: "onbekende %{type} omskep tipe"
+    faults:
+      unspecified: "geen rede gegee nie"
+    types:
+      array: "skikking"
+      big_decimal: "groot desimale"
+      boolean: "booleaanse"
+      complex: "kompleks"
+      date_time: "datum en tyd"
+      date: "datum"
+      float: "drywende punt"
+      hash: "hash"
+      integer: "heelgetal"
+      rational: "rasionaal"
+      string: "string"
+      symbol: "simbool"
+      time: "tyd"
+    validators:
+      exclusion:
+        of: "moet nie een van wees nie: %{values}"
+        within: "moet nie binne %{min} en %{max} wees nie"
+      format: "is 'n ongeldige formaat"
+      inclusion:
+        of: "moet een van wees: %{values}"
+        within: "moet binne %{min} en %{max} wees"
+      length:
+        is: "lengte moet %{is} wees"
+        is_not: "lengte moet nie %{is_not} wees nie"
+        min: "lengte moet ten minste %{min} wees"
+        max: "lengte kan maksimum %{max} wees"
+        not_within: "lengte moet nie binne %{min} en %{max} wees nie"
+        within: "lengte moet binne %{min} en %{max} wees"
+      numeric:
+        is: "moet %{is} wees"
+        is_not: "moet nie %{is_not} wees nie"
+        min: "moet ten minste %{min} wees"
+        max: "kan maksimum %{max} wees"
+        not_within: "moet nie binne %{min} en %{max} wees nie"
+        within: "moet binne %{min} en %{max} wees"
+      presence: "kan nie leeg wees nie"