i18n-ai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06e2c7c1e6b90add5766612403fefc33653d55b98e2a49b6ba0920a736545788
+  data.tar.gz: 19c739baa0b768bb12496cbb43dc2e58eb78a6afe629ab2db11e53dcfe5e94b0
+SHA512:
+  metadata.gz: a3abb0c81d6716e37df291fa0ef3b2b3853d97696de0247e0677b453cb781d154751b4dd8c4577596ef2e02ef35630a42956189547df3a046e556c85fc062764
+  data.tar.gz: 971b820565e02c742653a423e5eef1f8f6b4111cb3d9d2e535b0752fceb4c1996fc5e09338d866d7a19c2a9e9bd95299c110e40f8f6d0d17a2ffd26ef1c3154f

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

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 William Estoque
+
+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,54 @@
+# i18n-ai
+
+i18n-ai is a gem that converts your rails locales into different languages automatically. Uses the `en.yml` file as base by default and creates accompanying `es.yml`, `it.yml` and others depending on your configuration.
+
+Currently uses OpenAI (`gpt4o-mini`) to generate the translations but support for other AI models and APIs will be added soon.
+
+## Installation
+
+Simply add to your gemfile:
+
+```
+gem "i18n-ai"
+```
+
+And do `bundle install`.
+
+## Usage
+
+First you need to set the environment variable `ENV["OPENAI_ACCESS_TOKEN"]`.
+
+To configure and enable other locales, create a file `config/initializers/i18n_ai.rb` and add the following:
+
+```
+# config/initializers/i18n_ai.rb
+I18nAi.configure do |config|
+  config.generate_locales = [:es, :it] # add your other supported locales to this array
+end
+```
+
+Every page reload, the gem will check if the `en.yml` file changed and if it did, it will automatically generate the configured locale files.
+
+The gem has been setup to generate a `es.yml` file by default.
+
+To disable locale generation simply set the `generate_locales` to an empty array.
+
+```
+I18nAi.configure do |config|
+  config.generate_locales = []
+end
+```
+
+## 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).
+
+## 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 I18n::Ai project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/i18n-ai/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/i18n-ai/configuration.rb

@@ -0,0 +1,9 @@
+module I18nAi
+  class Configuration
+    attr_accessor :generate_locales
+
+    def initialize
+      @generate_locales = [:es]
+    end
+  end
+end

data/lib/i18n-ai/railtie.rb

@@ -0,0 +1,75 @@
+require "rails/railtie"
+require "openai"
+require "digest"
+
+module I18nAi
+  class Railtie < Rails::Railtie
+    class I18nAiMiddleware
+      def initialize(app)
+        @app = app
+        @client = OpenAI::Client.new(
+          access_token: ENV.fetch("OPENAI_ACCESS_TOKEN"),
+          log_errors: true
+        )
+        @last_checksum = nil
+      end
+
+      def call(env)
+        locales_file = Rails.root.join("config", "locales", "en.yml")
+
+        if File.exist?(locales_file)
+          current_checksum = calculate_checksum(locales_file)
+          puts "==> en.yml checksum: #{current_checksum}"
+          first_load = @last_checksum.nil?
+          file_changed = current_checksum != @last_checksum
+          puts "==> en.yml generate: #{first_load || file_changed}"
+
+          if first_load || file_changed
+            @last_checksum = current_checksum
+            generate_translations(locales_file)
+          end
+        else
+          puts "en.yml file not found"
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def generate_translations(locales_file)
+        locales = YAML.load_file(locales_file)
+        text_to_translate = locales.to_yaml
+        generate_locales = I18nAi.configuration.generate_locales
+
+        generate_locales.each do |locale|
+          # Make a request to OpenAI to translate the locales to the specified locale
+          response = @client.chat(
+            parameters: {
+              model: "gpt-4o-mini",
+              messages: [{ role: "user",
+                           content: "Translate the following YAML content to #{locale.to_s.upcase} and make sure to retain the keys in english except the first key which is the 2 letter language code:\n\n#{text_to_translate}" }],
+              max_tokens: 5000
+            }
+          )
+
+          translated_text = response["choices"][0]["message"]["content"]
+          match_data = translated_text.match(/```yaml(.*?)```/m)
+          str = match_data ? match_data[1].strip : nil
+
+          # Save the response to <locale>.yml
+          locales_file = Rails.root.join("config", "locales", "#{locale}.yml")
+          File.write(locales_file, str)
+        end
+      end
+
+      def calculate_checksum(file_path)
+        Digest::SHA256.file(file_path).hexdigest
+      end
+    end
+
+    initializer "i18n_ai.configure_middleware", before: :build_middleware_stack do |app|
+      app.middleware.use I18nAiMiddleware
+    end
+  end
+end

data/lib/i18n-ai/version.rb

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

data/lib/i18n-ai.rb

@@ -0,0 +1,19 @@
+require_relative "i18n-ai/version"
+require_relative "i18n-ai/railtie"
+require_relative "i18n-ai/configuration"
+
+module I18nAi
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/sig/i18n/ai.rbs

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: i18n-ai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Estoque
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  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'
+description:
+email:
+- william.estoque@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/i18n-ai.rb
+- lib/i18n-ai/configuration.rb
+- lib/i18n-ai/railtie.rb
+- lib/i18n-ai/version.rb
+- sig/i18n/ai.rbs
+homepage: https://github.com/narralabs/i18n-ai
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/narralabs/i18n-ai
+  source_code_uri: https://github.com/narralabs/i18n-ai
+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.13
+signing_key:
+specification_version: 4
+summary: i18n-ai is a gem that converts your locales into different languages automatically
+test_files: []