rosetta-rails 0.1.1

data/config/initializers/pagy.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+# Pagy initializer file (9.0.9)
+# Customize only what you really need and notice that the core Pagy works also without any of the following lines.
+# Should you just cherry pick part of this file, please maintain the require-order of the extras
+
+
+# Pagy Variables
+# See https://ddnexus.github.io/pagy/docs/api/pagy#variables
+# You can set any pagy variable as a Pagy::DEFAULT. They can also be overridden per instance by just passing them to
+# Pagy.new|Pagy::Countless.new|Pagy::Calendar::*.new or any of the #pagy* controller methods
+# Here are the few that make more sense as DEFAULTs:
+# Pagy::DEFAULT[:limit]       = 20                    # default
+# Pagy::DEFAULT[:size]        = 7                     # default
+# Pagy::DEFAULT[:ends]        = true                  # default
+# Pagy::DEFAULT[:page_param]  = :page                 # default
+# Pagy::DEFAULT[:count_args]  = []                    # example for non AR ORMs
+# Pagy::DEFAULT[:max_pages]   = 3000                  # example
+
+
+# Extras
+# See https://ddnexus.github.io/pagy/categories/extra
+
+
+# Legacy Compatibility Extras
+
+# Size extra: Enable the Array type for the `:size` variable (e.g. `size: [1,4,4,1]`)
+# See https://ddnexus.github.io/pagy/docs/extras/size
+# require 'pagy/extras/size'   # must be required before the other extras
+
+
+# Backend Extras
+
+# Arel extra: For better performance utilizing grouped ActiveRecord collections:
+# See: https://ddnexus.github.io/pagy/docs/extras/arel
+# require 'pagy/extras/arel'
+
+# Array extra: Paginate arrays efficiently, avoiding expensive array-wrapping and without overriding
+# See https://ddnexus.github.io/pagy/docs/extras/array
+# require 'pagy/extras/array'
+
+# Calendar extra: Add pagination filtering by calendar time unit (year, quarter, month, week, day)
+# See https://ddnexus.github.io/pagy/docs/extras/calendar
+# require 'pagy/extras/calendar'
+# Default for each calendar unit class in IRB:
+# >> Pagy::Calendar::Year::DEFAULT
+# >> Pagy::Calendar::Quarter::DEFAULT
+# >> Pagy::Calendar::Month::DEFAULT
+# >> Pagy::Calendar::Week::DEFAULT
+# >> Pagy::Calendar::Day::DEFAULT
+#
+# Uncomment the following lines, if you need calendar localization without using the I18n extra
+# module LocalizePagyCalendar
+#   def localize(time, opts)
+#     ::I18n.l(time, **opts)
+#   end
+# end
+# Pagy::Calendar.prepend LocalizePagyCalendar
+
+# Countless extra: Paginate without any count, saving one query per rendering
+# See https://ddnexus.github.io/pagy/docs/extras/countless
+# require 'pagy/extras/countless'
+# Pagy::DEFAULT[:countless_minimal] = false   # default (eager loading)
+
+# Elasticsearch Rails extra: Paginate `ElasticsearchRails::Results` objects
+# See https://ddnexus.github.io/pagy/docs/extras/elasticsearch_rails
+# Default :pagy_search method: change only if you use also
+# the searchkick or meilisearch extra that defines the same
+# Pagy::DEFAULT[:elasticsearch_rails_pagy_search] = :pagy_search
+# Default original :search method called internally to do the actual search
+# Pagy::DEFAULT[:elasticsearch_rails_search] = :search
+# require 'pagy/extras/elasticsearch_rails'
+
+# Headers extra: http response headers (and other helpers) useful for API pagination
+# See http://ddnexus.github.io/pagy/extras/headers
+# require 'pagy/extras/headers'
+# Pagy::DEFAULT[:headers] = { page: 'Current-Page',
+#                            limit: 'Page-Items',
+#                            count: 'Total-Count',
+#                            pages: 'Total-Pages' }     # default
+
+# Keyset extra: Paginate with the Pagy keyset pagination technique
+# See http://ddnexus.github.io/pagy/extras/keyset
+# require 'pagy/extras/keyset'
+
+# Meilisearch extra: Paginate `Meilisearch` result objects
+# See https://ddnexus.github.io/pagy/docs/extras/meilisearch
+# Default :pagy_search method: change only if you use also
+# the elasticsearch_rails or searchkick extra that define the same method
+# Pagy::DEFAULT[:meilisearch_pagy_search] = :pagy_search
+# Default original :search method called internally to do the actual search
+# Pagy::DEFAULT[:meilisearch_search] = :ms_search
+# require 'pagy/extras/meilisearch'
+
+# Metadata extra: Provides the pagination metadata to Javascript frameworks like Vue.js, react.js, etc.
+# See https://ddnexus.github.io/pagy/docs/extras/metadata
+# you must require the JS Tools internal extra (BEFORE the metadata extra) ONLY if you need also the :sequels
+# require 'pagy/extras/js_tools'
+# require 'pagy/extras/metadata'
+# For performance reasons, you should explicitly set ONLY the metadata you use in the frontend
+# Pagy::DEFAULT[:metadata] = %i[scaffold_url page prev next last]   # example
+
+# Searchkick extra: Paginate `Searchkick::Results` objects
+# See https://ddnexus.github.io/pagy/docs/extras/searchkick
+# Default :pagy_search method: change only if you use also
+# the elasticsearch_rails or meilisearch extra that defines the same
+# Pagy::DEFAULT[:searchkick_pagy_search] = :pagy_search
+# Default original :search method called internally to do the actual search
+# Pagy::DEFAULT[:searchkick_search] = :search
+# require 'pagy/extras/searchkick'
+# uncomment if you are going to use Searchkick.pagy_search
+# Searchkick.extend Pagy::Searchkick
+
+
+# Frontend Extras
+
+# Bootstrap extra: Add nav, nav_js and combo_nav_js helpers and templates for Bootstrap pagination
+# See https://ddnexus.github.io/pagy/docs/extras/bootstrap
+# require 'pagy/extras/bootstrap'
+
+# Bulma extra: Add nav, nav_js and combo_nav_js helpers and templates for Bulma pagination
+# See https://ddnexus.github.io/pagy/docs/extras/bulma
+# require 'pagy/extras/bulma'
+
+# Pagy extra: Add the pagy styled versions of the javascript-powered navs
+# and a few other components to the Pagy::Frontend module.
+# See https://ddnexus.github.io/pagy/docs/extras/pagy
+# require 'pagy/extras/pagy'
+
+# Multi size var used by the *_nav_js helpers
+# See https://ddnexus.github.io/pagy/docs/extras/pagy#steps
+# Pagy::DEFAULT[:steps] = { 0 => 5, 540 => 7, 720 => 9 }   # example
+
+
+# Feature Extras
+
+# Gearbox extra: Automatically change the limit per page depending on the page number
+# See https://ddnexus.github.io/pagy/docs/extras/gearbox
+# require 'pagy/extras/gearbox'
+# set to false only if you want to make :gearbox_extra an opt-in variable
+# Pagy::DEFAULT[:gearbox_extra] = false               # default true
+# Pagy::DEFAULT[:gearbox_limit] = [15, 30, 60, 100]   # default
+
+# Limit extra: Allow the client to request a custom limit per page with an optional selector UI
+# See https://ddnexus.github.io/pagy/docs/extras/limit
+# require 'pagy/extras/limit'
+# set to false only if you want to make :limit_extra an opt-in variable
+# Pagy::DEFAULT[:limit_extra] = false    # default true
+# Pagy::DEFAULT[:limit_param] = :limit   # default
+# Pagy::DEFAULT[:limit_max]   = 100      # default
+
+# Overflow extra: Allow for easy handling of overflowing pages
+# See https://ddnexus.github.io/pagy/docs/extras/overflow
+# require 'pagy/extras/overflow'
+# Pagy::DEFAULT[:overflow] = :empty_page    # default  (other options: :last_page and :exception)
+
+# Trim extra: Remove the page=1 param from links
+# See https://ddnexus.github.io/pagy/docs/extras/trim
+# require 'pagy/extras/trim'
+# set to false only if you want to make :trim_extra an opt-in variable
+# Pagy::DEFAULT[:trim_extra] = false # default true
+
+# Standalone extra: Use pagy in non Rack environment/gem
+# See https://ddnexus.github.io/pagy/docs/extras/standalone
+# require 'pagy/extras/standalone'
+# Pagy::DEFAULT[:url] = 'http://www.example.com/subdir'  # optional default
+
+# Jsonapi extra: Implements JSON:API specifications
+# See https://ddnexus.github.io/pagy/docs/extras/jsonapi
+# require 'pagy/extras/jsonapi'   # must be required after the other extras
+# set to false only if you want to make :jsonapi an opt-in variable
+# Pagy::DEFAULT[:jsonapi] = false  # default true
+
+# Rails
+# Enable the .js file required by the helpers that use javascript
+# (pagy*_nav_js, pagy*_combo_nav_js, and pagy_limit_selector_js)
+# See https://ddnexus.github.io/pagy/docs/api/javascript
+
+# With the asset pipeline
+# Sprockets need to look into the pagy javascripts dir, so add it to the assets paths
+# Rails.application.config.assets.paths << Pagy.root.join('javascripts')
+
+# I18n
+
+# Pagy internal I18n: ~18x faster using ~10x less memory than the i18n gem
+# See https://ddnexus.github.io/pagy/docs/api/i18n
+# Notice: No need to configure anything in this section if your app uses only "en"
+# or if you use the i18n extra below
+#
+# Examples:
+# load the "de" built-in locale:
+# Pagy::I18n.load(locale: 'de')
+#
+# load the "de" locale defined in the custom file at :filepath:
+# Pagy::I18n.load(locale: 'de', filepath: 'path/to/pagy-de.yml')
+#
+# load the "de", "en" and "es" built-in locales:
+# (the first passed :locale will be used also as the default_locale)
+# Pagy::I18n.load({ locale: 'de' },
+#                 { locale: 'en' },
+#                 { locale: 'es' })
+#
+# load the "en" built-in locale, a custom "es" locale,
+# and a totally custom locale complete with a custom :pluralize proc:
+# (the first passed :locale will be used also as the default_locale)
+# Pagy::I18n.load({ locale: 'en' },
+#                 { locale: 'es', filepath: 'path/to/pagy-es.yml' },
+#                 { locale: 'xyz',  # not built-in
+#                   filepath: 'path/to/pagy-xyz.yml',
+#                   pluralize: lambda{ |count| ... } )
+
+
+# I18n extra: uses the standard i18n gem which is ~18x slower using ~10x more memory
+# than the default pagy internal i18n (see above)
+# See https://ddnexus.github.io/pagy/docs/extras/i18n
+# require 'pagy/extras/i18n'
+
+
+# When you are done setting your own default freeze it, so it will not get changed accidentally
+Pagy::DEFAULT.freeze

data/config/routes.rb

@@ -0,0 +1,18 @@
+Rosetta::Engine.routes.draw do
+  root to: "locales#index"
+
+  resources :locales do
+    scope module: :locales do
+      resources :translations, only: :index
+      resources :deploys, only: :create
+
+      namespace :translations do
+        resources :missing, only: :index
+      end
+    end
+  end
+
+  resources :translation_keys do
+    resource :translation, only: %i[edit update]
+  end
+end

data/db/migrate/20240830123523_create_rosetta_tables.rb

@@ -0,0 +1,33 @@
+class CreateRosettaTables < ActiveRecord::Migration[6.1]
+  def change
+    create_table :rosetta_locales do |t|
+      t.string :name
+      t.string :code
+      t.boolean :published, default: false
+
+      t.timestamps
+
+      t.index :code, unique: true
+    end
+
+    create_table :rosetta_translation_keys do |t|
+      t.text :value
+
+      t.timestamps
+
+      t.index :value, unique: true
+    end
+
+    create_table :rosetta_translations do |t|
+      t.text :value
+      t.references :locale, null: false
+      t.references :translation_key, null: false
+
+      t.timestamps
+
+      t.index [ :locale_id, :translation_key_id ], unique: true
+      t.foreign_key :rosetta_locales, column: :locale_id
+      t.foreign_key :rosetta_translation_keys, column: :translation_key_id
+    end
+  end
+end

data/lib/rosetta/configuration.rb

@@ -0,0 +1,17 @@
+module Rosetta
+  class Configuration
+    attr_reader :default_locale
+    attr_accessor :parent_controller_class
+
+    DefaultLocale = Struct.new(:name, :code)
+
+    def initialize
+      set_default_locale(name: "English", code: "en")
+      @parent_controller_class = "ActionController::Base"
+    end
+
+    def set_default_locale(name:, code:)
+      @default_locale = DefaultLocale.new(name, code)
+    end
+  end
+end

data/lib/rosetta/engine.rb

@@ -0,0 +1,12 @@
+require "turbo-rails"
+require "pagy"
+
+module Rosetta
+  class Engine < ::Rails::Engine
+    isolate_namespace Rosetta
+
+    initializer "rosetta.assets.precompile" do |app|
+      app.config.assets.precompile += %w[rosetta_manifest.js]
+    end
+  end
+end

data/lib/rosetta/locale_session.rb

@@ -0,0 +1,16 @@
+module Rosetta
+  class LocaleSession
+    def locale
+      @locale ||= Locale.default_locale
+    end
+
+    def locale=(value)
+      case value
+      when Locale
+        @locale = value
+      when String, Symbol
+        @locale = Locale.find_by(code: value) || Locale.default_locale
+      end
+    end
+  end
+end

data/lib/rosetta/store.rb

@@ -0,0 +1,75 @@
+module Rosetta
+  class Store
+    class_attribute :locale_stores, default: Concurrent::Map.new
+
+    attr_reader :locale, :cache_expiration_timestamp
+
+    def self.for_locale(locale)
+      store = locale_stores[locale.code.to_sym] ||= new(locale)
+      store.touch!(locale.updated_at)
+      store
+    end
+
+    def initialize(locale)
+      @locale = locale
+      @cache_expiration_timestamp = @locale.updated_at
+      @autodiscovery_queue = Queue.new
+
+      start_key_autodiscovery!
+    end
+
+    def lookup(key_value)
+      if translations.has_key?(key_value)
+        translations[key_value]
+      else
+        @autodiscovery_queue << key_value
+        # Set the key in the translations store to locate it
+        # once only.
+        translations[key_value] = nil
+      end
+    end
+
+    def reload!
+      @translations = nil
+    end
+
+    def touch!(timestamp)
+      return if @cache_expiration_timestamp == timestamp
+
+      @cache_expiration_timestamp = timestamp
+      reload!
+    end
+
+    def translations
+      @translations ||= load_translations
+    end
+
+    private
+
+    def load_translations
+      loaded_translations = Rosetta.with_locale(@locale) do
+        TranslationKey
+          .includes(:translation_in_current_locale)
+          .map do |translation_key|
+          [ translation_key.value, translation_key.translation_in_current_locale&.value ]
+        end.to_h
+      end
+
+      Concurrent::Hash.new.merge(loaded_translations)
+    end
+
+    def start_key_autodiscovery!
+      Thread.new do
+        Thread.current.name = "Rosetta #{locale.code} store thread"
+
+        loop do
+          key_value = @autodiscovery_queue.pop
+
+          unless TranslationKey.exists?(value: key_value)
+            TranslationKey.create!(value: key_value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rosetta/version.rb

@@ -0,0 +1,3 @@
+module Rosetta
+  VERSION = "0.1.1"
+end

data/lib/rosetta-rails.rb

@@ -0,0 +1,48 @@
+require "rosetta/version"
+require "rosetta/engine"
+
+require "rosetta/locale_session"
+require "rosetta/store"
+require "rosetta/configuration"
+
+module Rosetta
+  module Base
+    def locale
+      locale_session.locale
+    end
+
+    def locale=(code)
+      locale_session.locale = code
+    end
+
+    def with_locale(locale, &block)
+      locale_was = Rosetta.locale
+      self.locale = locale
+
+      begin
+        yield
+      ensure
+        self.locale = locale_was
+      end
+    end
+
+    def locale_session
+      Thread.current[:rosetta_locale_session] ||= LocaleSession.new
+    end
+
+    def translate(key, locale: Rosetta.locale)
+      store = Store.for_locale(locale)
+      store.lookup(key)
+    end
+
+    def config
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      config.tap { |config| yield(config) }
+    end
+  end
+
+  extend Base
+end

data/lib/tasks/rosetta_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rosetta do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rosetta-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vincent Rolea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: Unobstrusive Internationalization solution for Rails applications.
+email:
+- 3525369+virolea@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/builds/rosetta/application.css
+- app/assets/builds/rosetta/application.js
+- app/assets/config/rosetta_manifest.js
+- app/assets/javascripts/rosetta/application.js
+- app/assets/javascripts/rosetta/controllers/application.js
+- app/assets/javascripts/rosetta/controllers/dialog_controller.js
+- app/assets/javascripts/rosetta/controllers/index.js
+- app/assets/stylesheets/rosetta/application.css
+- app/controllers/concerns/rosetta/locale_scoped.rb
+- app/controllers/rosetta/application_controller.rb
+- app/controllers/rosetta/locales/deploys_controller.rb
+- app/controllers/rosetta/locales/translations/missing_controller.rb
+- app/controllers/rosetta/locales/translations_controller.rb
+- app/controllers/rosetta/locales_controller.rb
+- app/controllers/rosetta/translations_controller.rb
+- app/helpers/rosetta/application_helper.rb
+- app/helpers/rosetta/dialog_helper.rb
+- app/helpers/rosetta/navigation_helper.rb
+- app/helpers/rosetta/translation_helper.rb
+- app/jobs/rosetta/application_job.rb
+- app/mailers/rosetta/application_mailer.rb
+- app/models/rosetta/application_record.rb
+- app/models/rosetta/locale.rb
+- app/models/rosetta/translation.rb
+- app/models/rosetta/translation_key.rb
+- app/views/layouts/rosetta/_dialog.html.erb
+- app/views/layouts/rosetta/_flashes.html.erb
+- app/views/layouts/rosetta/_navbar.html.erb
+- app/views/layouts/rosetta/application.html.erb
+- app/views/rosetta/locales/_form.html.erb
+- app/views/rosetta/locales/_locale.html.erb
+- app/views/rosetta/locales/index.html.erb
+- app/views/rosetta/locales/new.html.erb
+- app/views/rosetta/locales/translations/_navigation.html.erb
+- app/views/rosetta/locales/translations/_translation_key.html.erb
+- app/views/rosetta/locales/translations/index.html.erb
+- app/views/rosetta/translations/edit.html.erb
+- config/initializers/pagy.rb
+- config/routes.rb
+- db/migrate/20240830123523_create_rosetta_tables.rb
+- lib/rosetta-rails.rb
+- lib/rosetta/configuration.rb
+- lib/rosetta/engine.rb
+- lib/rosetta/locale_session.rb
+- lib/rosetta/store.rb
+- lib/rosetta/version.rb
+- lib/tasks/rosetta_tasks.rake
+homepage: https://github.com/virolea/rosetta
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Unobstrusive Internationalization solution for Rails applications.
+test_files: []