voltron-translate 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 979979611ec2a7d4eac3353ae47a0caa509bbef5
-  data.tar.gz: 65497650f47fa5723f1725b7562ff38e99e13db2
+  metadata.gz: d63716690236d33ce9d8497b2e4e84c7ee9355a3
+  data.tar.gz: 6d4fef31cd140a923b02ca508169b5470aab9612
 SHA512:
-  metadata.gz: 18db3717e361b952ada8f4a11fa03b9fb54432810e9adb613959c50028b69e802a1dd57b7eabee78b1125fdc3edce2dfc335a4f079906e9ac31efa1d547f9652
-  data.tar.gz: 46759ab9a35119a2957b965d38984711d15f233d9fa37181bcf7532f750132a7fd1696df2ee12ae579d2a1d4cec7031f520c2ca23d66b644ce7de001451b6375
+  metadata.gz: 6e357d22054599503b00a94deaf3a9e065e21f574f26e3fe2dabf8c585339ed235647816c4981d066815c41ddd02f50bed672555faf429f8e31601ab57dd8726
+  data.tar.gz: 3a8b8c93887fba7de22eed4b4e70e11989b7cd689f861767bc3a25783bd71eb12c913d71ef4c08909fe6cea58e04ed9f08f1c74e828a0674e0c196c2a180ebc0

data/Gemfile

@@ -1,9 +1,10 @@
 source 'https://rubygems.org'
-source 'http://gem.minow.io'
+source 'https://gem.minow.io'
 
 # Specify your gem's dependencies in voltron-translate.gemspec
 gemspec
 
 group :test do
   gem 'coveralls', require: false
+  gem 'faker'
 end

data/README.md

@@ -11,7 +11,7 @@ Voltron Translate is a different, in my mind more logical way of dealing with in
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'voltron-translate', '~> 0.2.1'
+gem 'voltron-translate', '~> 0.2.2'
 ```
 
 And then execute:
@@ -201,6 +201,10 @@ Should go without saying, but to set the translation text on the frontend, you'd
 
 Add the appropriate attributes to your strong params, so on, so on...
 
+## Caching
+
+This gem relies on being able to cache translations for quicker lookup. While not a requirement, some sort of cache mechanism is highly recommended as you will notice a difference in page load time. Using [redis-rails](https://github.com/redis-store/redis-rails) or something similar is the most preferred method of caching, but even [FileStore](http://guides.rubyonrails.org/caching_with_rails.html#activesupport-cache-filestore) is better than nothing.
+
 ## Note
 
 Setting `Voltron.config.translate.enabled` to `false` will never break any `__()` call, it simply causes it to ignore the locale argument (if specified) and return the interpolated string using the latter arguments (again, if any)

data/lib/voltron/translatable.rb

@@ -5,7 +5,7 @@ module Voltron
       include InstanceMethods
 
       options = (attributes.extract_options!).with_indifferent_access
-      locales = Array.wrap(options[:locales] || Voltron.config.translate.locales).map(&:to_s).map(&:underscore)
+      locales = Array.wrap(options[:locales] || Voltron.config.translate.locales).map { |l| l.to_s.underscore }
 
       attributes.each do |attrib|
 
@@ -20,7 +20,7 @@ module Voltron
         # locale specified for the attribute, and ultimately the current locale translation
         # If still nil, returns the value from super
         define_method :"#{attrib}" do |locale=nil|
-          # +action_view/helpers/targs+ exist when this method is called from within
+          # +action_view/helpers/tags+ exist when this method is called from within
           # ActionView::Helpers. In other words, form helper tags. In that
           # case we want the actual value of the attribute, not whatever the locale is
           return super() if caller.any? { |l| /action_view\/helpers\/tags/.match(l) } || !Voltron.config.translate.enabled?

data/lib/voltron/translate.rb

@@ -5,10 +5,13 @@ require 'voltron/translatable'
 require 'digest'
 require 'csv'
 require 'google_hash'
+require 'xxhash'
 
 module Voltron
   module Translate
 
+    LOG_COLOR = :light_blue
+
     class InvalidColumnTypeError < StandardError; end
 
     def __(text, locale = I18n.locale, **args)
@@ -19,14 +22,14 @@ module Voltron
 
         # If app is running in one of the environments where translations can be created
         if Voltron.config.translate.buildable?
-          Voltron.config.translate.locales.each { |locale| translator(locale).write text }
+          Array.wrap(Voltron.config.translate.locales).compact.each { |locale| translator(locale).write text }
         end
 
         # Translate the text and return it
         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', ::Voltron::Translate::LOG_COLOR
         text % args
       end
     end
@@ -61,7 +64,7 @@ module Voltron
         # 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
+          Voltron.log "Added translation for text '#{text}' (Locale: #{locale})", 'Translate', ::Voltron::Translate::LOG_COLOR
         end
       end
 
@@ -139,7 +142,7 @@ module Voltron
         end
 
         def phrase_key(text, args)
-          key = Digest::SHA256.hexdigest text + args.map { |k,v| "#{k}#{v}" }.join
+          key = XXhash.xxh32(text + args.map { |k,v| "#{k}#{v}" }.join)
           "translations/phrase/#{key}/#{locale}/#{modified}"
         end
     end

data/lib/voltron/translate/version.rb

@@ -1,5 +1,5 @@
 module Voltron
   module Translate
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.2'.freeze
   end
 end

data/voltron-translate.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rails', '>= 4.2'
   spec.add_dependency 'voltron', '~> 0.2.4'
   spec.add_dependency 'google_hash', '>= 0.9.0'
+  spec.add_dependency 'xxhash', '~> 0.4.0'
 
   spec.add_development_dependency 'bundler', '>= 1.12'
   spec.add_development_dependency 'rake', '>= 10.0'
@@ -29,5 +30,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3', '>= 1.2'
   spec.add_development_dependency 'simplecov', '0.11.0'
   spec.add_development_dependency 'factory_girl_rails', '>= 4.7'
-  spec.add_development_dependency 'byebug'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voltron-translate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Eric Hainer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: xxhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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:
 - eric@commercekitchen.com