remote_translation_loader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43ec77c81cc8eca7e36cd14bae7817a4b6052d21e4207565d05a3d1afb0e2abb
+  data.tar.gz: 10ccc1a5f9e6121ccb4bc2f0402fa482aa10e166cd007b3f1ba84c33c8838934
+SHA512:
+  metadata.gz: 213ea0ccdf50df544041da873bba2d458c7ecf8ea66bc87947aedd42d73a0fcc4d96ec30fe311dcecc67a1d3fbe67d8d5e716291e7f12acc12ea800afa850b46
+  data.tar.gz: d6a6ff5ddea8e87c6709a6eaf453b9880a05d06dc97a0fcdf163200ef465630bb31f74809a712205cd282c4326b932ebfa18387e9fa0734290fd545bd58e2484

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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) 2024 Gokul
+
+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,136 @@
+# Remote Translation Loader
+
+`remote_translation_loader` is a Ruby gem for fetching YAML translation files from remote sources and dynamically loading them into your Ruby on Rails application’s I18n translations. This gem is useful for applications that need to integrate external translations without writing them to local files.
+
+## Features
+
+- Fetch translation files from remote URLs
+- Merge remote translations with local translations
+- Directly load translations into Rails I18n without writing to files
+- Handles YAML parsing errors and HTTP request failures
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remote_translation_loader'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install remote_translation_loader
+```
+
+## Usage
+
+### Basic Setup
+
+1. **Initialize the Loader**
+
+   Create an instance of the `RemoteTranslationLoader::Loader` class with a list of remote YAML URLs:
+
+   ```ruby
+   loader = RemoteTranslationLoader::Loader.new([
+     'https://example.com/translations/en.yml',
+     'https://example.com/translations/fr.yml'
+   ])
+   ```
+
+2. **Fetch and Load Translations**
+
+   Call the `fetch_and_load` method to fetch and load the translations:
+
+   ```ruby
+   loader.fetch_and_load
+   ```
+
+   This will:
+    - Fetch the YAML files from the specified URLs
+    - Parse the YAML content
+    - Merge the remote translations with your existing local translations
+    - Load the merged translations into Rails I18n
+
+### Example
+
+```ruby
+require 'remote_translation_loader'
+
+# Initialize the loader with remote YAML URLs
+loader = RemoteTranslationLoader::Loader.new([
+  'https://example.com/translations/en.yml',
+  'https://example.com/translations/fr.yml'
+])
+
+# Fetch and load translations
+loader.fetch_and_load
+
+# Now you can use the loaded translations in your application
+puts I18n.t('greetings.hello') # Output will depend on the remote translation files
+```
+
+### Handling Errors
+
+The gem will raise errors in case of:
+- **Invalid YAML Content**: If the remote YAML file is invalid, a `RuntimeError` will be raised with a message indicating a YAML parsing error.
+- **HTTP Request Failures**: If fetching the remote YAML file fails, a `RuntimeError` will be raised with a message indicating the failure.
+
+### Customizing Error Handling
+
+You can customize the error handling by rescuing from `RuntimeError` or any other specific exceptions as needed:
+
+```ruby
+begin
+  loader.fetch_and_load
+rescue RuntimeError => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+## Development
+
+To contribute to the development of `remote_translation_loader`, follow these steps:
+
+1. **Clone the Repository**
+
+   ```bash
+   git clone https://github.com/gklsan/remote_translation_loader.git
+   cd remote_translation_loader
+   ```
+
+2. **Install Dependencies**
+
+   ```bash
+   bundle install
+   ```
+
+3. **Run Tests**
+
+   Run the test suite to ensure everything is working correctly:
+
+   ```bash
+   bundle exec rspec
+   ```
+
+4. **Make Your Changes**
+
+   Implement your changes or features and ensure they are covered by tests.
+
+5. **Submit a Pull Request**
+
+   Push your changes to your forked repository and submit a pull request with a clear description of the changes.
+
+## License
+
+`remote_translation_loader` is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
+
+For questions or support, please open an issue on [GitHub](https://github.com/gklsan/remote_translation_loader/issues).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/remote_translation_loader/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RemoteTranslationLoader
+  VERSION = "1.0.0"
+end

data/lib/remote_translation_loader.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "remote_translation_loader/version"
+
+require 'http'
+require 'yaml'
+require 'i18n'
+
+module RemoteTranslationLoader
+  class Loader
+    def initialize(urls)
+      @urls = urls
+    end
+
+    def fetch_and_load
+      @urls.each do |url|
+        yml_content = fetch_yaml(url)
+        merge_into_i18n(yml_content)
+      end
+    end
+
+    private
+
+    def fetch_yaml(url)
+      response = HTTP.get(url)
+      raise "Failed to fetch YAML from #{url}" unless response.status.success?
+
+      begin
+        YAML.safe_load(response.body.to_s)
+      rescue Psych::SyntaxError => e
+        raise "Failed to parse YAML from #{url}: #{e.message}"
+      end
+    end
+
+    def merge_into_i18n(yml_content)
+      yml_content.each do |locale, remote_translations|
+        if remote_translations.is_a?(Hash)
+          existing_translations = I18n.backend.send(:translations)[locale.to_sym] || {}
+          merged_translations = deep_merge(existing_translations, remote_translations)
+
+          I18n.backend.store_translations(locale.to_sym, merged_translations)
+        else
+          raise "Invalid data format for locale #{locale}"
+        end
+      end
+    end
+
+    def deep_merge(existing, incoming)
+      existing.merge(incoming) do |key, oldval, newval|
+        oldval.is_a?(Hash) && newval.is_a?(Hash) ? deep_merge(oldval, newval) : newval
+      end
+    end
+  end
+end

data/sig/remote_translation_loader.rbs

@@ -0,0 +1,4 @@
+module RemoteTranslationLoader
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: remote_translation_loader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gokul (gklsan)
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The remote_translation_loader gem allows you to fetch YAML translation
+  files from remote sources and dynamically load them into your Rails application’s
+  I18n translations without writing them to local files.
+email:
+- pgokulmca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/remote_translation_loader.rb
+- lib/remote_translation_loader/version.rb
+- sig/remote_translation_loader.rbs
+homepage: https://github.com/gklsan/remote_translation_loader
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Fetches and loads remote YAML translation files into Rails I18n
+test_files: []