localise_rails 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e6005d06a4ae06da165393d5b5dbde2f81bafd6fe325340c5c294ee372659b8
+  data.tar.gz: e2c5030c305683536e7ad5e1dc2018d1b8c044b2cfecf7a2ad20e83e29348b02
+SHA512:
+  metadata.gz: 5b3640408e57005c6f9b618eaa1d81d5cf220bd395f78e999e7ba592cb5f180ec13c6bda7b44b23f36bb087fd7cb597c7378633fc77f5be5dd168c44481b4d56
+  data.tar.gz: 606bdcfc749f6e44be94c6b84ceaf158d280e00c2817aef0a30c7b6738fc6ee8b59a4c85917fd853a9149325a56ba25f8942ad3792f9a743915f9e4fbed688bf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in localise_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Osman Baliev
+
+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,60 @@
+# LocaliseRails
+
+Easy localise for your Rails app from localise.biz (I18n)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'localise_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install localise_rails
+
+## Usage
+
+### Configuration
+```ruby
+# config/initializers/localise_rails.rb
+LocaliseRails.configure do |config|
+  config.api_key = "LOCALISE_KEY"
+
+  ### all options https://localise.biz/api/docs/export/exportall
+  config.options = {
+    filter: 'backend',
+    fallback: 'en-US'
+  }
+
+  config.rename_locales = {
+    'en-US' => 'en'
+  }
+  
+  ### all options https://github.com/redis/redis-rb
+  # config.redis_options = {
+  #   host: "127.0.0.1", 
+  #   port: 6379, 
+  #   db: 1,
+  #   url: "redis://:p4ssw0rd@127.0.0.1:6379/1"
+  # }
+end
+```
+### How to update locales
+To crontab
+```ruby
+LocaliseRails.update
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/OnlyReFLeX/localise_rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "localise_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/localise_rails/config.rb

@@ -0,0 +1,12 @@
+module LocaliseRails
+  # Class used to initialize configuration object.
+  class Config
+    attr_accessor :api_key, :options, :redis_options, :redis, :rename_locales
+
+    def initialize
+      @options = {}
+      @rename_locales = {}
+      @redis_options = {}
+    end
+  end
+end

data/lib/localise_rails/fetch_localise_cache.rb

@@ -0,0 +1,28 @@
+module LocaliseRails
+  class FetchLocaliseCache
+    def call
+      CachedTranslations.new(fetch_translations)
+    end
+
+    private
+
+    def fetch_translations
+      LocaliseRails.logger.info('Localise: start getting locales from redis')
+      timestamp = LocaliseRails.config.redis.get(UPDATED_AT_CACHE_KEY)
+      if timestamp.present?
+        data = LocaliseRails.config.redis.get(DATA_CACHE_KEY)
+        {
+          data: JSON.parse(data),
+          timestamp: timestamp
+        }
+      else
+        {}
+      end
+    end
+
+    class CachedTranslations
+      include ActiveModel::Model
+      attr_accessor :data, :timestamp
+    end
+  end
+end

data/lib/localise_rails/logger.rb

@@ -0,0 +1,8 @@
+require 'logger'
+
+module LocaliseRails
+  class << self
+    attr_accessor :logger
+  end
+  self.logger = Logger.new($stdout)
+end

data/lib/localise_rails/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'i18n'
+
+module LocaliseRails
+  class Railtie < ::Rails::Railtie
+    initializer 'localise_rails.setup_logging' do
+      LocaliseRails.logger = Rails.logger
+    end
+
+    config.i18n.backend = I18n::Backend::Chain.new(
+      I18n::Backend::KeyValue.new(LocaliseRails::RequestStoreTranslations.new),
+      I18n.backend
+    )
+  end
+end

data/lib/localise_rails/request_store_translations.rb

@@ -0,0 +1,24 @@
+module LocaliseRails
+  class RequestStoreTranslations
+    def [](key)
+      seed_translations if RequestStore.store[:translations].nil?
+      RequestStore.store.dig(:translations, key)
+    end
+
+    def []=(key, value)
+      RequestStore.store[:translations][key] = value
+    end
+
+    def keys
+      seed_translations if RequestStore.store[:translations].nil?
+      RequestStore.store[:translations].keys
+    end
+
+    private
+
+    def seed_translations
+      RequestStore.store[:translations] = {}
+      LocaliseRails::SeedTranslationsToRequestStore.new.call
+    end
+  end
+end

data/lib/localise_rails/seed_translations_to_request_store.rb

@@ -0,0 +1,54 @@
+module LocaliseRails
+  class SeedTranslationsToRequestStore
+    def call
+      if fresh_data_in_memory?
+        seed_translations_from_memory
+      else
+        seed_translations_from_cache
+      end
+    end
+
+    private
+
+    def seed_translations_from_memory
+      RequestStore.store[:translations] = Thread.current[:translations]
+    end
+
+    def seed_translations_from_cache
+      cached = LocaliseRails::FetchLocaliseCache.new.call
+      return unless cached.data
+
+      prepared_locales = prepare_locales(cached.data)
+      prepared_locales.map { |locale, value| I18n.backend.store_translations(locale, value) }
+      copy_request_store_to_memory(cached.timestamp)
+    end
+
+    def prepare_locales(locales)
+      LocaliseRails.config.rename_locales.each do |old_key, new_key|
+        locales[new_key] = locales.delete old_key if locales[old_key]
+      end
+      locales
+    end
+
+    def copy_request_store_to_memory(timestamp)
+      Thread.current[:translations] = RequestStore.store[:translations]
+      Thread.current[:translations_timestamp] = timestamp
+    end
+
+    def fresh_data_in_memory?
+      Thread.current[:translations].present? && fresh_memory_data?
+    end
+
+    def fresh_memory_data?
+      cached_timestamp.present? && memory_timestamp.present? && cached_timestamp == memory_timestamp
+    end
+
+    def cached_timestamp
+      @cached_timestamp ||= LocaliseRails.config.redis.get(LocaliseRails::UPDATED_AT_CACHE_KEY)
+    end
+
+    def memory_timestamp
+      @memory_timestamp ||= Thread.current[:translations_timestamp]
+    end
+  end
+end

data/lib/localise_rails/update.rb

@@ -0,0 +1,25 @@
+module LocaliseRails
+  class Update
+    class << self
+      def call
+        headers = { Authorization: "Loco #{LocaliseRails.config.api_key}", Accept: 'application/json' }
+        query = LocaliseRails.config.options.map { |k, v| "#{k}=#{v}" }.join('&')
+        uri = "https://localise.biz/api/export/all?#{query}"
+
+        LocaliseRails.logger.info('Localise: start getting locales from localise')
+        response = HTTParty.get(uri, headers: headers)
+
+        if response.success?
+          LocaliseRails.logger.info('Localise: locales got successfully')
+          LocaliseRails.config.redis.set(LocaliseRails::DATA_CACHE_KEY, response.body)
+          LocaliseRails.config.redis.set(LocaliseRails::UPDATED_AT_CACHE_KEY, Time.current.to_i)
+        else
+          LocaliseRails.logger.error "Something went wrong downloading translations: #{response.parsed_response}"
+        end
+      rescue StandardError => e
+        LocaliseRails.logger.error("LocaliseRails: #{e.message}")
+        LocaliseRails.logger.error(e.backtrace.join("\n"))
+      end
+    end
+  end
+end

data/lib/localise_rails/version.rb

@@ -0,0 +1,3 @@
+module LocaliseRails
+  VERSION = '0.1.3'.freeze
+end

data/lib/localise_rails.rb

@@ -0,0 +1,59 @@
+# requires
+require 'localise_rails/version'
+require 'localise_rails/logger'
+require 'localise_rails/config'
+require 'localise_rails/update'
+require 'localise_rails/seed_translations_to_request_store'
+require 'localise_rails/request_store_translations'
+require 'localise_rails/fetch_localise_cache'
+
+# gems
+require 'redis'
+require 'request_store'
+
+module LocaliseRails
+  extend ActiveSupport::Autoload
+
+  DATA_CACHE_KEY = 'localise/data'.freeze
+  UPDATED_AT_CACHE_KEY = 'localise/updated_at'.freeze
+
+  def self.update
+    LocaliseRails::Update.call
+  end
+
+  def self.config
+    @config ||= LocaliseRails::Config.new
+  end
+
+  # Lets you set global configuration options.
+  #
+  # All available options and their defaults are in the example below:
+  # @example Initializer for Rails
+  # LocaliseRails.configure do |config|
+  #   config.api_key = "LOCALISE_KEY"
+  #
+  #   # all options https://localise.biz/api/docs/export/exportall
+  #   config.options = {
+  #     filter: 'backend',
+  #     fallback: 'en-US'
+  #   }
+  #
+  #   config.rename_locales = {
+  #     'en-US' => 'en'
+  #   }
+  #
+  #   # all options https://github.com/redis/redis-rb
+  #   # config.redis_options = {
+  #   #   host: "127.0.0.1",
+  #   #   port: 6379,
+  #   #   db: 1,
+  #   #   url: "redis://:p4ssw0rd@127.0.0.1:6379/1"
+  #   # }
+  # end
+  def self.configure
+    yield(config) if block_given?
+    config.redis = Redis.new(config.redis_options)
+  end
+end
+
+require 'localise_rails/railtie' if defined?(Rails)

data/localise_rails.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'localise_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'localise_rails'
+  spec.version       = LocaliseRails::VERSION
+  spec.authors       = ['Osman Baliev']
+  spec.email         = ['reflexonly@gmail.com']
+
+  spec.summary       = 'localise.biz to I18n'
+  spec.description   = 'Easy localise your Rails app from localise.biz'
+  spec.homepage      = 'https://github.com/OnlyReFLeX/localise_rails'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'i18n', '>= 1.9.0'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'railties'
+  spec.add_dependency 'request_store'
+  spec.add_dependency 'redis'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: localise_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Osman Baliev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: httparty
+  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: railties
+  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: request_store
+  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: redis
+  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: Easy localise your Rails app from localise.biz
+email:
+- reflexonly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/localise_rails.rb
+- lib/localise_rails/config.rb
+- lib/localise_rails/fetch_localise_cache.rb
+- lib/localise_rails/logger.rb
+- lib/localise_rails/railtie.rb
+- lib/localise_rails/request_store_translations.rb
+- lib/localise_rails/seed_translations_to_request_store.rb
+- lib/localise_rails/update.rb
+- lib/localise_rails/version.rb
+- localise_rails.gemspec
+homepage: https://github.com/OnlyReFLeX/localise_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OnlyReFLeX/localise_rails
+  source_code_uri: https://github.com/OnlyReFLeX/localise_rails
+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.0.9
+signing_key:
+specification_version: 4
+summary: localise.biz to I18n
+test_files: []