glossync 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2450f5576a89f1db3e54a7ddb46b6fb9a77d35e8883272959f666b8cc87cad
-  data.tar.gz: ba10cd3f9a0fe0b2d6aea66cc14e0da08e5f5e925b760b880af44027071bead0
+  metadata.gz: c9f37796efedf9aee1579ceb60b4c88ac241ad40744a00e10a7563103270c950
+  data.tar.gz: b0ac328d38119d563e8f5193679c147423714640613dc5d5bf041dd26533a613
 SHA512:
-  metadata.gz: 3046bb3e3056b9589b4f24091ee37931f3775d6b5cdbc0cf2632a1281aa0852fe7798cf7088fd542d8bd047fcf357ffcf68f90b46284445cf5f2275e083856a0
-  data.tar.gz: d409fadc2172f7139f13d93f9d5303c5b1ea6da3f6b28e238367a5f85535606496a613aa6aee74b6af117db0da64ef5c9bfc8961302d9a9e107f96fa0ecddfc7
+  metadata.gz: ceaf7fbae10d61519576b76f81be6b3bd6c10ef4385a67d0157b239b7fe567366ffca5f2c6458aec1e95cf1bba2340d4d7532a22c73f051703a10d1a060f9a53
+  data.tar.gz: bd725afe42d70c64e61d34021bb960de1956bd53cdb193db5864bc5e542c4637c30b2bc19b1a496d5648e95f288c26e11f8f63b15145a7eb0d0f7e92ebed6587

data/.env.example

@@ -0,0 +1 @@
+export GOOGLE_TRANSLATE_API_KEY=abcdeFGH1JKLMN0p

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+.env
+
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    glossync (0.1.0)
+    glossync (0.2.0)
+      easy_translate (~> 0.5)
       i18n (~> 1.1)
 
 GEM
@@ -9,7 +10,10 @@ GEM
   specs:
     concurrent-ruby (1.1.4)
     diff-lcs (1.3)
-    i18n (1.3.0)
+    easy_translate (0.5.1)
+      thread
+      thread_safe
+    i18n (1.5.1)
       concurrent-ruby (~> 1.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -25,15 +29,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    thread (0.2.2)
+    thread_safe (0.3.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  glossync!
   rake (~> 10.0)
   rspec (~> 3.0)
-  glossync!
 
 BUNDLED WITH
    1.17.1

data/glossync.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
+  spec.add_dependency 'easy_translate', '~> 0.5'
   spec.add_dependency 'i18n', '~> 1.1'
 end

data/lib/glossync/config.rb

@@ -0,0 +1,34 @@
+module Glossync
+  DEFAULT_CONFIG = {
+    reload_backend:              false,
+    write_fallback_result:       false,
+    missing_translation_handler: MissingTranslationHandler::Default.new,
+    base_locale:                 :en,
+  }.freeze
+
+  DEFAULT_CONFIG.each do |k, v|
+    (case v
+    when true, false
+      [
+        [:"dont_#{k}", -> { @options[k] = false }],
+        [:"#{k}!",     -> { @options[k] = true } ],
+        [:"#{k}?",     -> { @options[k] }        ],
+      ]
+    else
+      []
+    end + [
+      [:"#{k}=", ->(v) { @options[k] = v }],
+      [:"#{k}",  ->    { @options[k]}     ]
+    ]).each { |meth, body| Glossync.define_singleton_method(meth, &body) }
+  end
+
+  class << self
+    attr_reader :options
+
+    def config(&block)
+      @options ||= {}
+      block.call(Glossync)
+    end
+  end
+end
+

data/lib/glossync/exceptions.rb

@@ -0,0 +1,7 @@
+module Glossync
+  class NoTranslationStore < StandardError
+    def initialize(*)
+      super('please set Glossync.tl_store')
+    end
+  end
+end

data/lib/glossync/missing_translation_handler.rb

@@ -0,0 +1,39 @@
+module Glossync
+  module MissingTranslationHandler
+    class Default
+      def handle(error, _who, _field, _locale)
+        error.message
+      end
+    end
+
+    class Raiser
+      def handle(error, _, _, _)
+        raise error
+      end
+    end
+
+    class GoogleTranslate
+      def initialize(key)
+        @api_key = key
+        @cache = {}
+      end
+
+      def translate(text, to)
+        EasyTranslate.translate(
+          text,
+          from: Glossync.options[:base_locale],
+          to: to,
+          key: @api_key
+        )
+      end
+
+      def handle(_, who, field, locale)
+        key = who.tl_key(field)
+
+        @cache[key] = translate(who[field], locale) unless @cache.key?(key)
+
+        @cache[key]
+      end
+    end
+  end
+end

data/lib/glossync/version.rb

@@ -1,3 +1,3 @@
 module Glossync
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/glossync.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
 require 'i18n'
-require 'glossync/version'
-require 'glossync/tl_adapter'
+require 'easy_translate'
+require 'glossync/exceptions'
+require 'glossync/missing_translation_handler'
 require 'glossync/railtie' if defined?(Rails)
+require 'glossync/version'
+
+require 'glossync/config'
 
 # Include into ActiveRecords to obtain some nice I18n features
 module Glossync
   # methods that match this pattern will be responded to in method_missing()
   METHOD_PATTERN = /_translated$/.freeze
 
+  #default configuration
   class << self
     attr_writer :tl_store
 
@@ -18,18 +23,7 @@ module Glossync
 
       Translation
     rescue NameError
-      raise 'No Translation store'
-    end
-
-    # Should we call I18n.backend.reload! on each call to tl_update that
-    # modifies data?
-    def reload_backend_on_tl_update?
-      @reload_backend_on_tl_update ||= true
-    end
-
-    # :nodoc:
-    def reload_backend_on_tl_update=(bool)
-      @reload_backend_on_tl_update = !!bool
+      raise(Glossync::NoTranslationStore)
     end
 
     # called when a module is included, add methods to the base class
@@ -118,7 +112,20 @@ module Glossync
   # @param field the field to translate
   # @return [String] the translated string
   def tl(field)
-    I18n.translate(tl_key(field))
+    tl = catch(:exception) do
+      I18n.translate(tl_key(field), throw: true)
+    end
+
+    if tl.is_a?(I18n::MissingTranslation)
+      tlr = Glossync.missing_translation_handler
+                    .handle(tl, self, field, I18n.locale)
+
+      tl_update(field, tlr) if Glossync.options[:write_fallback_result]
+
+      tlr
+    else
+      tl
+    end
   end
 
   # Update the translation associated with a field and locale
@@ -146,7 +153,7 @@ module Glossync
       tls.create(h.merge(value: value))
     end
 
-    I18n.backend.reload! if Glossync.reload_backend_on_tl_update?
+    I18n.backend.reload! if Glossync.options[:reload_backend]
 
     true
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glossync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Stone Tickle
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: easy_translate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -85,8 +100,10 @@ files:
 - bin/setup
 - glossync.gemspec
 - lib/glossync.rb
+- lib/glossync/config.rb
+- lib/glossync/exceptions.rb
+- lib/glossync/missing_translation_handler.rb
 - lib/glossync/railtie.rb
-- lib/glossync/tl_adapter.rb
 - lib/glossync/version.rb
 - lib/tasks/setup_model_translations.rake
 homepage: 

data/lib/glossync/tl_adapter.rb

@@ -1,36 +0,0 @@
-module Glossync
-  class TlAdapter
-    include I18n::Backend::Base
-
-    TlElem = Struct.new(:value) do
-      def update(value:)
-        self.value = value
-      end
-    end
-
-    def initialize
-      super
-
-      @db = {}
-    end
-
-    def exists?(locale:, key:)
-      @db.key?(key) && @db[key].key?(locale)
-    end
-
-    def find_by(locale:, key:)
-      return nil unless exists?(locale: locale, key: key)
-
-      @db[key][locale]
-    end
-
-    def create(locale:, key:, value:)
-      @db[key] ||= {}
-      @db[key][locale] = TlElem.new(value)
-    end
-
-    def lookup(locale, key, *)
-      find_by(locale: locale, key: key).value
-    end
-  end
-end