voltron-translate 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db4e5fc35eb77c846ae4e2ef94e3744a2914b9b
-  data.tar.gz: b497648aaa3bfd6ca8fbdf8b8b0e4a75316b50da
+  metadata.gz: 1658719544a250f6aae2906d090e405a7614db52
+  data.tar.gz: 1a44aea7a63899dc077fa3871a6334e6e528aa3b
 SHA512:
-  metadata.gz: 3167d32b07bf56cec33c9533c9d569039a2f3abc8d0c154a943032ba9037402582a6c553c24863142d4a8039df683c1a571f58cfe5f91751df5494b115d0f53d
-  data.tar.gz: 02bd0d4fc342882f2fbbeef36086602a81a270d9a7e826ff42f61a7c9f91dade7b20b4c5f09c715b81f731ee981867af65bee3f19cce7fb3e399c3b8cc09707c
+  metadata.gz: 6d48356fb02213c0d4d41e53cf2c6fc23c0bbba719a81252dadbc50e0acdcb89e8fe239d12f98d5bf77c2b44f3cf165c4ae1d6c640ef8334c4c78dc59f47f229
+  data.tar.gz: 5ceea071fb55ec9ccfc5b5fbda61d5c9c3966ff5fc0e95938c32c62085ce53cc31bb266eb6b99bdf50b742d347c3c35ad651ab9aeec1807f8ca074046c72ca4d

data/lib/generators/voltron/translate/install_generator.rb

@@ -3,15 +3,15 @@ module Voltron
     module Generators
       class InstallGenerator < Rails::Generators::Base
 
-        desc "Add Voltron Translate initializer"
+        desc 'Add Voltron Translate initializer'
 
         def inject_initializer
 
-          voltron_initialzer_path = Rails.root.join("config", "initializers", "voltron.rb")
+          voltron_initialzer_path = Rails.root.join('config', 'initializers', 'voltron.rb')
 
           unless File.exist? voltron_initialzer_path
             unless system("cd #{Rails.root.to_s} && rails generate voltron:install")
-              puts "Voltron initializer does not exist. Please ensure you have the 'voltron' gem installed and run `rails g voltron:install` to create it"
+              puts 'Voltron initializer does not exist. Please ensure you have the \'voltron\' gem installed and run `rails g voltron:install` to create it'
               return false
             end
           end

data/lib/voltron/translate/railtie.rb

@@ -1,9 +1,9 @@
-require "voltron"
+require 'voltron'
 
 module Voltron
   module Translate
     class Railtie < Rails::Railtie
-      initializer "voltron.translate.initialize" do
+      initializer 'voltron.translate.initialize' do
         ::ActionController::Base.send :include, ::Voltron::Translate
         ::ActiveRecord::Base.send :include, ::Voltron::Translate
         ::ActiveRecord::Base.send :extend, ::Voltron::Translate

data/lib/voltron/translate/version.rb

@@ -1,5 +1,5 @@
 module Voltron
   module Translate
-    VERSION = "0.1.5".freeze
+    VERSION = '0.1.6'.freeze
   end
 end

data/lib/voltron/translate.rb

@@ -1,9 +1,9 @@
-require "voltron"
-require "voltron/translate/version"
-require "voltron/config/translate"
-require "digest"
-require "csv"
-require "google_hash"
+require 'voltron'
+require 'voltron/translate/version'
+require 'voltron/config/translate'
+require 'digest'
+require 'csv'
+require 'google_hash'
 
 module Voltron
   module Translate
@@ -12,7 +12,7 @@ module Voltron
       return (text % args) unless Voltron.config.translate.enabled?
 
       begin
-        raise "Locale can only contain the characters A-Z, and _" unless locale.to_s =~ /^[A-Z_]+$/i
+        raise 'Locale can only contain the characters A-Z, and _' unless locale.to_s =~ /^[A-Z_]+$/i
 
         # If app is running in one of the environments where translations can be created
         if Voltron.config.translate.buildable?
@@ -23,7 +23,7 @@ module Voltron
         translator(locale).translate text, **args
       rescue => e
         # If any errors occurred, log the error and just return the default interpolated text
-        Voltron.log e.message.to_s + " (Original Translation Text: #{text})", "Translate", :light_red
+        Voltron.log e.message.to_s + " (Original Translation Text: #{text})", 'Translate', :light_red
         text % args
       end
     end
@@ -31,76 +31,116 @@ module Voltron
     def translator(locale = I18n.locale)
       @translators ||= {}
       @translators[locale.to_s] ||= Translation.new(locale)
-      @translators[locale.to_s]
     end
 
     class Translation
 
-      attr_accessor :locale, :list, :last_modified
+      attr_accessor :locale
 
       def initialize(locale)
         @locale = locale.to_s
-        load_list # Load the list of translations into a dense google hash object for retrieval
       end
 
       def translate(text, **args)
         phrase(text, args) % args
       end
 
-      def []=(text, translation)
-        unless list.has_key?(text)
-          CSV.open(path, "a", force_quotes: true) { |f| f.puts [text, translation] }
-          list[text] = translation
-        end
-      end
-
       def destroy
         File.unlink(path) if File.exists?(path)
-        load_list
+        reload
       end
 
       def path
-        @path ||= Rails.root.join("config", "locales", "#{locale}.csv")
+        @path ||= Rails.root.join('config', 'locales', "#{locale}.csv")
       end
 
       def write(text)
-        unless list.has_key?(text)
-          CSV.open(path, "a", force_quotes: true) { |f| f.puts [text, text] }
-          list[text] = text
-          Voltron.log "Added translation for text '#{text}' (Locale: #{locale})", "Translate", :light_blue
+        # If the full list of translations does not contain the given text content, add it
+        unless full_list.has_key?(text)
+          CSV.open(path, 'a', force_quotes: true) { |f| f.puts [text, text] }
+          Voltron.log "Added translation for text '#{text}' (Locale: #{locale})", 'Translate', :light_blue
+        end
+      end
+
+      # Almost the same as full_list, but does not include translations whose from/to are identical,
+      # since that would just be unnecessarily inflating the size of the hash
+      def list
+        reload if has_been_modified?
+        @@list ||= begin
+          hsh = ::GoogleHashDenseRubyToRuby.new
+          data.each { |k,v| hsh[k] = v unless k == v }
+          hsh
         end
       end
 
+      # A google hash object representing the translation file, where the key is the original text,
+      # and the value is the translated text
+      def full_list
+        reload if has_been_modified?
+        @@full_list ||= begin
+          hsh = ::GoogleHashDenseRubyToRuby.new
+          data.each { |k,v| hsh[k] = v }
+          hsh
+        end
+      end
+
+      # The last time (in microseconds) the translation file was updated
+      def last_modified
+        Rails.cache.fetch("translations/data/modified/#{locale}") { modified }
+      end
+
       private
 
-        def load_list
-          @list = ::GoogleHashDenseRubyToRuby.new
-          @last_modified = modified
-          Rails.cache.delete_matched("translations/phrase") if Rails.cache.respond_to?(:delete_matched)
-          CSV.foreach(path, force_quotes: true) { |row| list[row.first] = row.last unless list.has_key?(row.first) } if File.exists?(path)
+        # The hash representation of the csv contents. Cannot be a google hash since google hash
+        # objects cannot be stored in the cache. This data is reloaded anytime the csv file is modified
+        def data
+          Rails.cache.fetch("translations/data/#{locale}/#{modified}") do
+            hsh = {}
+            if File.exists?(path)
+              CSV.foreach(path, force_quotes: true) do |row|
+                hsh[row[0]] = row[1]
+              end
+            end
+            hsh
+          end
         end
 
         def phrase(text, args)
-          load_list if modified > last_modified
-          write(text) if Voltron.config.translate.buildable?
           key = phrase_key(text, args)
-          Rails.cache.fetch(key) { list[text] } || text
+          Rails.cache.fetch(key) { list[text] || text }
         end
 
         def modified
           if File.exists? path
-            File.mtime(path).to_i
+            File.mtime(path).strftime('%s%6N')
           else
-            Time.now.to_i
+            Time.now.strftime('%s%6N')
           end
         end
 
+        # Reset the list and full list objects, so they are forced to load the new data
+        def reload
+          @@list = nil
+          @@full_list = nil
+        end
+
+        def has_been_modified?
+          is_modified = last_modified != modified
+
+          if is_modified
+            # Update last modified timestamp
+            Rails.cache.write("translations/data/modified/#{locale}", modified)
+          end
+
+          is_modified
+        end
+
         def phrase_key(text, args)
-          key = Digest::SHA256.hexdigest [text, locale, modified].map(&:to_s).join + args.map { |k,v| "#{k}#{v}" }.join
-          "translations/phrase/#{key}"
+          key = Digest::SHA256.hexdigest text + args.map { |k,v| "#{k}#{v}" }.join
+          "translations/phrase/#{key}/#{locale}/#{modified}"
         end
     end
   end
 end
 
-require "voltron/translate/railtie" if defined?(Rails)
+require 'voltron/translate/railtie' if defined?(Rails)

data/voltron-translate.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 4.2"
-  spec.add_dependency "voltron", ">= 0.2.0"
-  spec.add_dependency "google_hash", ">= 0.9.0"
+  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_dependency 'voltron', '>= 0.2.0'
+  spec.add_dependency 'google_hash', '>= 0.9.0'
 
-  spec.add_development_dependency "bundler", ">= 1.12"
-  spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "rspec", ">= 3.0"
-  spec.add_development_dependency "rspec-rails", ">= 3.4"
-  spec.add_development_dependency "sqlite3", ">= 1.2"
-  spec.add_development_dependency "simplecov", "0.11.0"
+  spec.add_development_dependency 'bundler', '>= 1.12'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rspec-rails', '>= 3.4'
+  spec.add_development_dependency 'sqlite3', '>= 1.2'
+  spec.add_development_dependency 'simplecov', '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voltron-translate
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Eric Hainer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -179,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Implements double underscore method for translating and interpolating phrases