i18n-ai 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4b8bb0bd9755345297a83d3c236a95fa9d68c1b432743f08cb48b9bc38fa03b
-  data.tar.gz: 62f2a9fc7281367224041c3222191e345c15848757ee6e6cfc4905de2dc4156f
+  metadata.gz: f98f84d08a1cbe5960d00ca2b76c1d1ce7adc930431247971694b4a93e497367
+  data.tar.gz: b42bc703a7bc1880a3503a1470b9f51923ce925ace01458f590e836313f80478
 SHA512:
-  metadata.gz: 2a72a92c4f61419e2a76e9ad7df7086168128d24c5d6eafe9be395be4db948e6e6d06937d2db8d11356a85f295c53cf46952fb09eb1c7171eacfe4aa4e009d89
-  data.tar.gz: 45997aa4a669cc795ee91841a6de94974ba782387ad1e55384700d3a407749b097079abe77aec6c2f505a42bf31adfdb01a145e8cc24dab52b3a7089b860044c
+  metadata.gz: 2500f28ee2e4185e89b433a1265b863647a7fbbdd35c1288ecd33e939261cec5ff328875b96ddb531506462914c77bd7cd8d3db6145ebc324fbc80efa321f1a9
+  data.tar.gz: e5f6d3da9c17b2fd58d578aa3bd2037e213d9cf8a175df15f9d791bd24ae96e0be5eeb7432e1401d08fa94863dd6be2c94077e133e04375fd33a92fddb6b9ac6

data/.rubocop.yml

@@ -6,3 +6,26 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Layout/LineLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/i18n-ai.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'i18n-ai.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/lib/i18n-ai.rb

@@ -1,21 +1,3 @@
 # frozen_string_literal: true
 
-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
+require_relative "i18n_ai"

data/lib/{i18n-ai → i18n_ai}/clients/anthropic_client.rb

@@ -5,39 +5,34 @@ require_relative "base_client"
 
 module I18nAi
   module Clients
+    # The AnthropicClient class is responsible for interacting with the Anthropic API
     class AnthropicClient < BaseClient
       def initialize
         super
         @client = Anthropic::Client.new(
-          access_token: @config[:access_token]
+          access_token: config[:access_token]
         )
       end
 
       def chat(locale, text)
         response = @client.messages(
           parameters: {
-            model: @config[:model],
-            messages: [
-              { role: "user", content: content(locale, text) }
-            ]
+            model: config[:model],
+            messages: [{ role: "user", content: chat_prompt(locale, text) }],
+            max_tokens: 4096
           }
         )
-
         parse_response(response)
-      rescue StandardError => e
-        handle_error(e)
       end
 
       private
 
       def parse_response(response)
         response.dig("content", 0, "text")
-      rescue TypeError, NoMethodError => e
-        handle_error(e)
       end
 
-      def handle_error(error)
-        puts "Error: #{error.message}"
+      def extract_translated_content(chat_content)
+        chat_content
       end
     end
   end

data/lib/i18n_ai/clients/base_client.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module I18nAi
+  module Clients
+    # The BaseClient class serves as a base class for all AI client implementations
+    class BaseClient
+      attr_reader :config
+
+      def initialize
+        @config = I18nAi.configuration.ai_settings
+      end
+
+      def translate_content(locale, content)
+        chat_content = chat(locale, content)
+        extract_translated_content(chat_content)
+      end
+
+      private
+
+      def chat_prompt(locale, text_to_translate)
+        <<~PROMPT
+          Translate the following YAML content to the language of the country using the ISO 639 language code
+          of #{locale}. Make sure to retain the keys in english except the first key which is the 2 letter language code:
+
+          """"
+          #{text_to_translate}"
+          """"
+
+          Return only the YAML content without explanation.
+
+          Example Return YAML:
+
+          """
+          {{ISO_639 language code}}:
+            key_1: "value1"
+          """
+        PROMPT
+      end
+
+      def chat(locale, text)
+        raise NotImplementedError, "Subclasses must implement this method"
+      end
+
+      def parse_response(response)
+        raise NotImplementedError, "Subclasses must implement this method"
+      end
+
+      def extract_translated_content(chat_content)
+        raise NotImplementedError, "Subclasses must implement this method"
+      end
+    end
+  end
+end

data/lib/{i18n-ai → i18n_ai}/clients/open_ai_client.rb

@@ -9,7 +9,7 @@ module I18nAi
       def initialize
         super
         @client = OpenAI::Client.new(
-          access_token: @config[:access_token],
+          access_token: config[:access_token],
           log_errors: true
         )
       end
@@ -18,14 +18,11 @@ module I18nAi
         response = @client.chat(
           parameters: {
             model: @config[:model],
-            messages: [{ role: "user", content: content(locale, text) }],
-            max_tokens: 5000
+            messages: [{ role: "user", content: chat_prompt(locale, text) }],
+            max_tokens: 4096
           }
         )
-
         parse_response(response)
-      rescue StandardError => e
-        handle_error(e)
       end
 
       private
@@ -39,6 +36,11 @@ module I18nAi
       def handle_error(error)
         puts "Error: #{error.message}"
       end
+
+      def extract_translated_content(chat_content)
+        match_data = chat_content.match(/```yaml(.*?)```/m)
+        match_data ? match_data[1].strip : nil
+      end
     end
   end
 end

data/lib/{i18n-ai → i18n_ai}/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module I18nAi
+  # Configuration class for I18nAi
   class Configuration
     attr_accessor :ai_settings, :generate_locales
 

data/lib/i18n_ai/railtie.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "digest"
+
+require_relative "clients/open_ai_client"
+require_relative "clients/anthropic_client"
+
+module I18nAi
+  # The Railtie class provides a way to integrate I18nAi into an application
+  class Railtie < Rails::Railtie
+    # Initialize the I18nAi middleware
+    class I18nAiMiddleware
+      attr_reader :client
+
+      def initialize(app)
+        @app = app
+        @client = configure_client
+        @last_checksum = nil
+      end
+
+      def call(env)
+        locales_file = locate_locales_file
+
+        if file_exists?(locales_file)
+          process_locales_file(locales_file)
+        else
+          log_file_not_found
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def locate_locales_file
+        Rails.root.join("config", "locales", "en.yml")
+      end
+
+      def file_exists?(file)
+        File.exist?(file)
+      end
+
+      def process_locales_file(file)
+        current_checksum = calculate_checksum(file)
+        log_checksum(current_checksum)
+
+        first_load = @last_checksum.nil?
+        file_changed = current_checksum != @last_checksum
+        log_generate_status(first_load, file_changed)
+
+        return unless first_load || file_changed
+
+        @last_checksum = current_checksum
+        generate_translations(file)
+      end
+
+      def log_checksum(checksum)
+        puts "==> en.yml checksum: #{checksum}"
+      end
+
+      def log_generate_status(first_load, file_changed)
+        puts "==> en.yml generate: #{first_load || file_changed}"
+      end
+
+      def log_file_not_found
+        puts "en.yml file not found"
+      end
+
+      def configure_client
+        config = I18nAi.configuration.ai_settings
+        case config[:provider]
+        when "anthropic"
+          I18nAi::Clients::AnthropicClient.new
+        when "openai"
+          I18nAi::Clients::OpenAiClient.new
+        else
+          raise "Unknown AI provider: #{config[:provider]}"
+        end
+      end
+
+      def generate_translations(locales_file)
+        locales = load_locales(locales_file)
+        text_to_translate = locales.to_yaml
+        generate_locales = I18nAi.configuration.generate_locales
+
+        generate_locales.each do |locale|
+          translated_content = client.translate_content(locale, text_to_translate)
+          save_translated_locales(locale, translated_content) if translated_content
+        end
+      end
+
+      def load_locales(locales_file)
+        YAML.load_file(locales_file)
+      end
+
+      def save_translated_locales(locale, translated_content)
+        locales_file = Rails.root.join("config", "locales", "#{locale}.yml")
+        File.write(locales_file, translated_content)
+      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 → i18n_ai}/version.rb

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

data/lib/i18n_ai.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "i18n_ai/version"
+require_relative "i18n_ai/railtie"
+require_relative "i18n_ai/configuration"
+
+# The I18nAi module provides functionality for integrating AI-based translation services
+module I18nAi
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: i18n-ai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - William Estoque
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: anthropic
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +58,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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:
 email:
 - william.estoque@gmail.com
@@ -52,13 +100,13 @@ files:
 - README.md
 - Rakefile
 - lib/i18n-ai.rb
-- lib/i18n-ai/clients/anthropic_client.rb
-- lib/i18n-ai/clients/base_client.rb
-- lib/i18n-ai/clients/open_ai_client.rb
-- lib/i18n-ai/configuration.rb
-- lib/i18n-ai/railtie.rb
-- lib/i18n-ai/version.rb
-- sig/i18n/ai.rbs
+- lib/i18n_ai.rb
+- lib/i18n_ai/clients/anthropic_client.rb
+- lib/i18n_ai/clients/base_client.rb
+- lib/i18n_ai/clients/open_ai_client.rb
+- lib/i18n_ai/configuration.rb
+- lib/i18n_ai/railtie.rb
+- lib/i18n_ai/version.rb
 homepage: https://github.com/narralabs/i18n-ai
 licenses:
 - MIT

data/lib/i18n-ai/clients/base_client.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module I18nAi
-  module Clients
-    class BaseClient
-      def initialize
-        @config = I18nAi.configuration.ai_settings
-      end
-
-      def content(locale, text_to_translate)
-        "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}"
-      end
-
-      def parse_response(response)
-        raise NotImplementedError, "Subclasses must implement this method"
-      end
-    end
-  end
-end

data/lib/i18n-ai/railtie.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/railtie"
-require "digest"
-
-require_relative "clients/open_ai_client"
-require_relative "clients/anthropic_client"
-
-module I18nAi
-  class Railtie < Rails::Railtie
-    class I18nAiMiddleware
-      def initialize(app)
-        @app = app
-        @client = configure_client
-        @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 configure_client
-        config = I18nAi.configuration.ai_settings
-        case config[:provider]
-        when "anthropic"
-          I18nAi::Clients::AnthropicClient.new
-        when "openai"
-          I18nAi::Clients::OpenAiClient.new
-        else
-          raise "Unknown AI provider: #{config[:provider]}"
-        end
-      end
-
-      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(
-            locale, text_to_translate
-          )
-
-          next unless response
-
-          match_data = response.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/sig/i18n/ai.rbs

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