phrase 0.2.3 → 0.2.4

data/Gemfile.lock

@@ -16,7 +16,7 @@ GEM
     crack (0.3.1)
     diff-lcs (1.1.3)
     i18n (0.6.0)
-    json (1.7.4)
+    json (1.7.5)
     multi_json (1.3.6)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
@@ -26,6 +26,7 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    timecop (0.4.5)
     vcr (2.2.1)
     webmock (1.8.7)
       addressable (>= 2.2.7)
@@ -38,5 +39,6 @@ DEPENDENCIES
   i18n
   phrase!
   rspec
+  timecop
   vcr
   webmock

data/lib/phrase/api/client.rb

@@ -23,7 +23,7 @@ class Phrase::Api::Client
   def fetch_locales
     result = perform_api_request("/locales", :get)
     locales = []
-    JSON.parse(result).map do |locale| 
+    parsed(result).map do |locale| 
       locales << locale['name']
     end
     locales
@@ -32,7 +32,7 @@ class Phrase::Api::Client
   def fetch_blacklisted_keys
     result = perform_api_request("/blacklisted_keys", :get)
     blacklisted_keys = []
-    JSON.parse(result).map do |blacklisted_key| 
+    parsed(result).map do |blacklisted_key| 
       blacklisted_keys << blacklisted_key['name']
     end
     blacklisted_keys
@@ -40,15 +40,14 @@ class Phrase::Api::Client
   
   def translate(key)
     raise "You must specify a key" if key.nil? or key.blank?
-    keys = {}    
-    result = JSON.parse(perform_api_request("/translation_keys/translate", :get, {:key => key}))
+    keys = {}
+    result = parsed(perform_api_request("/translation_keys/translate", :get, {:key => key}))
     keys = extract_structured_object(result["translate"]) if result["translate"]
     keys
   end
   
   def find_keys_by_name(key_names=[])
-    result = JSON.parse(perform_api_request("/translation_keys", :get, {:key_names => key_names}))
-    result
+    parsed(perform_api_request("/translation_keys", :get, {:key_names => key_names}))
   end
   
   def create_locale(name)
@@ -128,11 +127,11 @@ private
   def api_error_message(response)
     message = ""
     begin
-      error = JSON.parse(response.body)["error"]
+      error = parsed(response.body)["error"]
       if error.class == String
         message = error
       else
-        message = JSON.parse(response.body)["message"]
+        message = parsed(response.body)["message"]
       end
     rescue JSON::ParserError
     end
@@ -212,4 +211,8 @@ private
     end.join(separator)
     request.content_type = 'application/x-www-form-urlencoded'
   end
+  
+  def parsed(raw_data)
+    JSON.parse(raw_data)
+  end
 end

data/lib/phrase/cache.rb

@@ -0,0 +1,34 @@
+# -*- encoding : utf-8 -*-
+
+require 'phrase'
+
+class Phrase::Cache
+  
+  attr_accessor :lifetime
+  
+  def initialize(args={})
+    @store = {}
+    @lifetime = args.fetch(:lifetime, Phrase.cache_lifetime)
+  end
+  
+  def cached?(cache_key)
+    @store.has_key?(cache_key) && !expired?(cache_key)
+  end
+  
+  def get(cache_key)
+    begin
+      @store.fetch(cache_key)[:payload]
+    rescue
+      nil
+    end
+  end
+  
+  def set(cache_key, value)
+    @store[cache_key] = {timestamp: Time.now, payload: value}
+  end
+  
+private
+  def expired?(cache_key)
+    @store.fetch(cache_key)[:timestamp] < (Time.now - @lifetime)
+  end
+end

data/lib/phrase/config.rb

@@ -67,4 +67,20 @@ class Phrase::Config
   def js_use_ssl=(js_use_ssl)
     @@js_use_ssl = js_use_ssl
   end
-end
+  
+  def cache_key_segments_initial
+    @@cache_key_segments_initial ||= ["simple_form"]
+  end
+  
+  def cache_key_segments_initial=(cache_key_segments_initial=[])
+    @@cache_key_segments_initial = cache_key_segments_initial
+  end
+  
+  def cache_lifetime
+    @@cache_lifetime ||= 300
+  end
+  
+  def cache_lifetime=(cache_lifetime)
+    @@cache_lifetime = cache_lifetime
+  end
+end

data/lib/phrase/delegate.rb

@@ -1,6 +1,9 @@
 # -*- encoding : utf-8 -*-
 
 require 'phrase/api'
+require 'phrase/cache'
+require 'phrase/hash_flattener'
+require 'set'
 
 class Phrase::Delegate < String
   attr_accessor :key, :display_key, :options, :api_client, :fallback_keys
@@ -8,6 +11,7 @@ class Phrase::Delegate < String
   def initialize(key, options={})
     @display_key = @key = key
     @options = options
+    
     @fallback_keys = []
     
     extract_fallback_keys
@@ -38,7 +42,7 @@ class Phrase::Delegate < String
 private
   def identify_key_to_display
     key_names = [@key] | @fallback_keys
-    available_key_names = find_keys_from_service(key_names).map { |key| key["name"] }
+    available_key_names = find_keys_within_phrase(key_names)
     @display_key = @key
     key_names.each do |item|
       if available_key_names.include?(item)
@@ -48,8 +52,41 @@ private
     end
   end
   
-  def find_keys_from_service(key_names)
-    api_client.find_keys_by_name(key_names)
+  def find_keys_within_phrase(key_names)
+    key_names_to_check_against_api = key_names - pre_fetched(key_names)
+    pre_cached(key_names) | key_names_returned_from_api_for(key_names_to_check_against_api)
+  end
+  
+  def pre_cached(key_names)
+    warm_translation_key_names_cache unless cache.cached?(:translation_key_names)
+    pre_cached_key_names = key_names.select { |key_name| key_name_precached?(key_name) }
+    pre_cached_key_names
+  end
+  
+  def pre_fetched(key_names)
+    key_names.select { |key_name| covered_by_initial_caching?(key_name) }
+  end
+  
+  def key_name_precached?(key_name)
+    covered = covered_by_initial_caching?(key_name)
+    in_cache = key_name_is_in_cache?(key_name)    
+    covered && in_cache 
+  end
+  
+  def key_names_returned_from_api_for(key_names)
+    if key_names.size > 0
+      api_client.find_keys_by_name(key_names).map { |key| key["name"] }
+    else
+      []
+    end
+  end
+  
+  def key_name_is_in_cache?(key_name)
+    cache.get(:translation_key_names).include?(key_name)
+  end
+  
+  def covered_by_initial_caching?(key_name)
+    key_name.start_with?(*Phrase.cache_key_segments_initial)
   end
   
   def extract_fallback_keys
@@ -61,16 +98,22 @@ private
         fallback_items << @options[:default]
       end
     end
+    
     fallback_items.each do |item|
       process_fallback_item(item)
     end
   end
   
+  def scoped(item)
+    @options.has_key?(:scope) ? "#{@options[:scope]}.#{item}" : item
+  end
+  
   def process_fallback_item(item)
     if item.kind_of?(Symbol)
-      @fallback_keys << item.to_s
-      if @key == "helpers.label.#{item.to_s}" # http://apidock.com/rails/v3.1.0/ActionView/Helpers/FormHelper/label
-        @fallback_keys << "activerecord.attributes.#{item.to_s}"
+      entry = scoped(item.to_s)
+      @fallback_keys << entry
+      if @key == "helpers.label.#{entry}" # http://apidock.com/rails/v3.1.0/ActionView/Helpers/FormHelper/label
+        @fallback_keys << "activerecord.attributes.#{entry}"
       end
     end
   end
@@ -99,4 +142,34 @@ private
       $stderr.puts message
     end
   end
-end
+  
+  def cache
+    Thread.current[:phrase_cache] ||= build_cache
+  end
+  
+  def build_cache
+    cache = Phrase::Cache.new
+  end
+  
+  def warm_translation_key_names_cache
+    cache.set(:translation_key_names, prefetched_key_names)
+  end
+  
+  def prefetched_key_names
+    prefetched = Set.new
+    Phrase.cache_key_segments_initial.each do |segment|      
+      result = api_client.translate(segment)
+      prefetched.add(segment) if result.is_a?(String)
+      prefetched = prefetched.merge(key_names_from_nested(segment, result))
+    end
+    prefetched
+  end
+  
+  def key_names_from_nested(segment, data)
+    key_names = Set.new
+    Phrase::HashFlattener.flatten(data, nil) do |key, value|
+      key_names.add("#{segment}.#{key}") unless value.is_a?(Hash)
+    end unless (data.is_a?(String) || data.nil?)
+    key_names
+  end
+end

data/lib/phrase/hash_flattener.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+
+module Phrase::HashFlattener
+  
+  FLATTEN_SEPARATOR = "."
+  SEPARATOR_ESCAPE_CHAR = "\001"
+
+  def self.escape_default_separator(key)
+    key.to_s.tr(FLATTEN_SEPARATOR, SEPARATOR_ESCAPE_CHAR)
+  end
+
+  def self.flatten(hash, escape, previous_key=nil, &block)
+    hash.each_pair do |key, value|
+      key = escape_default_separator(key) if escape
+      current_key = [previous_key, key].compact.join(FLATTEN_SEPARATOR).to_sym
+      yield current_key, value
+      flatten(value, escape, current_key, &block) if value.is_a?(Hash)
+    end
+  end
+end

data/lib/phrase/tool/options.rb

@@ -20,7 +20,8 @@ class Phrase::Tool::Options
         recursive: false
       },
       pull: {
-        format: "yml"
+        format: "yml",
+        target: "./phrase/locales/"
       }
     }
     options.parse!(args)
@@ -61,6 +62,10 @@ private
           opts.on("--format=yml", String, "Allowed formats: #{Phrase::Tool::ALLOWED_DOWNLOAD_FORMATS.join(", ")}") do |format|
             @data[command_name][:format] = format
           end
+          
+          opts.on("--target=./phrase/locales", String, "Target folder to store locale files") do |target|
+            @data[command_name][:target] = target
+          end
         end
       else
         OptionParser.new do |opts|

data/lib/phrase/tool.rb

@@ -12,6 +12,7 @@ class Phrase::Tool
   ALLOWED_FILE_TYPES = %w(yml pot po)
   ALLOWED_DOWNLOAD_FORMATS = %w(yml po)
   DEFAULT_DOWNLOAD_FORMAT = "yml"
+  DEFAULT_TARGET_FOLDER = "phrase/locales/"
   
   attr_accessor :config, :options
   
@@ -90,6 +91,8 @@ protected
     end
     
     format = @options.get(:format) || DEFAULT_DOWNLOAD_FORMAT
+    target = @options.get(:target) || DEFAULT_TARGET_FOLDER
+    
     unless ALLOWED_DOWNLOAD_FORMATS.include?(format)
       print_error "Invalid format: #{format}"
       exit(43)
@@ -97,7 +100,7 @@ protected
     
     locales.each do |locale_name|
       print "Downloading phrase.#{locale_name}.#{format}..."
-      fetch_translations_for_locale(locale_name, format)
+      fetch_translations_for_locale(locale_name, format, target)
     end
   end
   
@@ -110,7 +113,7 @@ usage: phrase <command> [<args>]
   phrase push FILE [--tags=<tags>]
   phrase push DIRECTORY [--tags=<tags>]
   
-  phrase pull [LOCALE]
+  phrase pull [LOCALE] [--target=<target-folder>]
   
   phrase --version
 USAGE
@@ -181,20 +184,28 @@ private
     end
   end
 
-  def fetch_translations_for_locale(name, format=DEFAULT_DOWNLOAD_FORMAT)
+  def fetch_translations_for_locale(name, format=DEFAULT_DOWNLOAD_FORMAT, target=DEFAULT_TARGET_FOLDER)
     begin
       content = api_client.download_translations_for_locale(name, format)
       print_message "OK"
-      store_translations_file(name, content, format)
+      store_translations_file(name, content, format, target)
     rescue Exception => e
       print_error "Failed"
       print_server_error(e.message)
     end
   end
   
-  def store_translations_file(name, content, format=DEFAULT_DOWNLOAD_FORMAT)
-    File.open("phrase/locales/phrase.#{name}.#{format}", "w") do |file|
-      file.write(content)
+  def store_translations_file(name, content, format=DEFAULT_DOWNLOAD_FORMAT, target=DEFAULT_TARGET_FOLDER)
+    directory = target 
+    directory << "/" unless directory.end_with?("/") 
+    
+    if File.directory?(directory)
+      File.open("#{directory}phrase.#{name}.#{format}", "w") do |file|
+        file.write(content)
+      end
+    else
+      print_error("Cannot write file to target folder (#{directory})")
+      exit(101)
     end
   end
   

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/phrase.rb

@@ -18,7 +18,7 @@ module Phrase
       Thread.current[:phrase_config] = value
     end
     
-    %w(enabled backend prefix suffix auth_token client_version js_host js_use_ssl).each do |method|
+    %w(enabled backend prefix suffix auth_token client_version js_host js_use_ssl cache_key_segments_initial cache_lifetime).each do |method|
       module_eval <<-DELEGATORS, __FILE__, __LINE__ + 1
         def #{method}
           config.#{method}

data/phrase.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('i18n')
   s.add_development_dependency('webmock')
   s.add_development_dependency('vcr')
+  s.add_development_dependency('timecop')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phrase
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70265216292960 !ruby/object:Gem::Requirement
+  requirement: &70298691089780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70265216292960
+  version_requirements: *70298691089780
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70265216292500 !ruby/object:Gem::Requirement
+  requirement: &70298691089320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.8
   type: :runtime
   prerelease: false
-  version_requirements: *70265216292500
+  version_requirements: *70298691089320
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70265216292120 !ruby/object:Gem::Requirement
+  requirement: &70298691088940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70265216292120
+  version_requirements: *70298691088940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70265216291660 !ruby/object:Gem::Requirement
+  requirement: &70298691088480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265216291660
+  version_requirements: *70298691088480
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70265216291240 !ruby/object:Gem::Requirement
+  requirement: &70298691088060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265216291240
+  version_requirements: *70298691088060
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70265216290820 !ruby/object:Gem::Requirement
+  requirement: &70298691087640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265216290820
+  version_requirements: *70298691087640
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70265216290400 !ruby/object:Gem::Requirement
+  requirement: &70298691087220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265216290400
+  version_requirements: *70298691087220
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70298691086800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70298691086800
 description: phrase allows you to edit translations in-place on the page itself. More
   information at phraseapp.com
 email:
@@ -113,9 +124,11 @@ files:
 - lib/phrase/backend.rb
 - lib/phrase/backend/base.rb
 - lib/phrase/backend/phrase_service.rb
+- lib/phrase/cache.rb
 - lib/phrase/config.rb
 - lib/phrase/delegate.rb
 - lib/phrase/engine.rb
+- lib/phrase/hash_flattener.rb
 - lib/phrase/tool.rb
 - lib/phrase/tool/config.rb
 - lib/phrase/tool/options.rb