phrase 0.3.1 → 0.3.2

data/.gitignore

@@ -19,4 +19,7 @@ tmp
 .rvmrc
 .DS_Store
 /phrase
-.rspec
+.rspec
+/locales
+/ru.lproj
+/res

data/Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/README.md

@@ -4,4 +4,4 @@ Powerful in-place translation management for your web applications.
 
 ## More Information
 
-https://phraseapp.com
+https://phraseapp.com

data/lib/phrase.rb

@@ -42,19 +42,18 @@ module Phrase
     end
   end
   
+  def self.configure
+    yield(self.config)
+  end
+  
   autoload :ViewHelpers, 'phrase/view_helpers'
   
+  require 'phrase/api'
   require 'phrase/version'
   require 'phrase/engine'
   require 'phrase/backend'
+  require 'phrase/delegate'
 end
 
-module I18n
-  class << self
-    def translate_with_phrase(*args)
-      Phrase.backend.translate(*args)
-    end
-    alias_method_chain :translate, :phrase
-    alias_method :t, :translate
-  end
-end
+require 'phrase/adapters/i18n'
+require 'phrase/adapters/fast_gettext'

data/lib/phrase/adapters/fast_gettext.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+
+require 'phrase/delegate/fast_gettext'
+
+module FastGettext
+  module Translation
+    def __with_phrase(*args)
+      Phrase::Delegate::FastGettext.new(:_, *args)
+    end
+    alias_method_chain :_, :phrase
+    
+    def n__with_phrase(*args)
+      Phrase::Delegate::FastGettext.new(:n_, *args)
+    end
+    alias_method_chain :n_, :phrase
+    
+    def s__with_phrase(*args)
+      Phrase::Delegate::FastGettext.new(:s_, *args)
+    end
+    alias_method_chain :s_, :phrase
+  end
+end if defined? FastGettext::Translation

data/lib/phrase/adapters/i18n.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+
+module I18n
+  class << self
+    def translate_with_phrase(*args)
+      Phrase.backend.translate(*args)
+    end
+    alias_method_chain :translate, :phrase
+    alias_method :t, :translate
+  end
+end if defined?(I18n)

data/lib/phrase/api/client.rb

@@ -218,4 +218,4 @@ private
   def escaped(value) 
     CGI::escape(value)
   end
-end
+end

data/lib/phrase/backend/phrase_service.rb

@@ -1,6 +1,6 @@
 # -*- encoding : utf-8 -*-
 
-require 'phrase/delegate'
+require 'phrase/delegate/i18n'
 
 class Phrase::Backend::PhraseService
   
@@ -55,7 +55,7 @@ protected
     key = given_key_from_args(args)
     return nil unless present?(key)
     options = args[1].nil? ? {} : args[1]
-    Phrase::Delegate.new(key, options)
+    Phrase::Delegate::I18n.new(key, options)
   end
 
   def extract_normalized_key_from_args(args)

data/lib/phrase/delegate.rb

@@ -1,175 +1,23 @@
 # -*- 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
-  
-  def initialize(key, options={})
-    @display_key = @key = key
-    @options = options
-    
-    @fallback_keys = []
-    
-    extract_fallback_keys
-    identify_key_to_display if @fallback_keys.any?
-    super(decorated_key_name)
-  end
-  
-  def to_s
-    "#{decorated_key_name}"
-  end
-  
-  def method_missing(*args, &block)
-    if @key.respond_to?(args.first) 
-      to_s.send(*args)
-    else
-      data = translation_or_subkeys
-      if data.is_a?(String)
-        to_s
-      elsif data.respond_to?(args.first)
-        data.send(*args, &block)
-      else
-        log "You are trying to execute the method ##{args.first} on a translation key which is not supported. Please make sure you treat your translations as strings only."
-        nil
-      end
-    end
-  end
-  
-private
-  def identify_key_to_display
-    key_names = [@key] | @fallback_keys
-    available_key_names = find_keys_within_phrase(key_names)
-    @display_key = @key
-    key_names.each do |item|
-      if available_key_names.include?(item)
-        @display_key = item
-        break
-      end
+module Phrase::Delegate
+  class Base < String
+    def to_s
+      "#{decorated_key_name}"
     end
-  end
-  
-  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
-    fallback_items = []
-    if @options.has_key?(:default)
-      if @options[:default].kind_of?(Array)
-        fallback_items = @options[:default]
+    
+    def self.log(message)
+      message = "phrase: #{message}"
+      if defined?(Rails)
+        Rails.logger.warn(message)
       else
-        fallback_items << @options[:default]
+        $stderr.puts message
       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)
-      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
-
-  def decorated_key_name
-    "#{Phrase.prefix}phrase_#{@display_key}#{Phrase.suffix}"
-  end
-  
-  def translation_or_subkeys
-    begin
-      api_client.translate(@key)
-    rescue Exception => e
-      log "Server Error: #{e.message}"
+  protected
+    def decorated_key_name
+      "#{Phrase.prefix}phrase_#{@display_key}#{Phrase.suffix}"
     end
   end
-  
-  def api_client
-    @api_client ||= Phrase::Api::Client.new(Phrase.auth_token)
-  end
-  
-  def log(message)
-    message = "phrase: #{message}"
-    if defined?(Rails)
-      Rails.logger.warn(message)
-    else
-      $stderr.puts message
-    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/delegate/fast_gettext.rb

@@ -0,0 +1,27 @@
+# -*- encoding : utf-8 -*-
+
+require 'phrase/delegate'
+
+class Phrase::Delegate::FastGettext < Phrase::Delegate::Base
+  def initialize(method, *args)
+    @method = method
+    params = params_from_args(args)
+    @display_key = params[:msgid]
+  end
+  
+private
+  def params_from_args(args)
+    params = case @method
+      when :_
+        {msgid: args.first}
+      when :n_
+        {msgid: args.first, msgid_plural: args.second, count: args.last}
+      when :s_
+        {msgid: args.first}
+      else
+        self.class.log("Unsupported FastGettext method #{@method}")
+        {}
+    end
+    params
+  end
+end

data/lib/phrase/delegate/i18n.rb

@@ -0,0 +1,159 @@
+# -*- encoding : utf-8 -*-
+
+require 'phrase/api'
+require 'phrase/cache'
+require 'phrase/hash_flattener'
+require 'phrase/delegate'
+require 'set'
+
+class Phrase::Delegate::I18n < Phrase::Delegate::Base
+  attr_accessor :key, :display_key, :options, :api_client, :fallback_keys
+  
+  def initialize(key, options={})
+    @display_key = @key = key
+    @options = options
+    
+    @fallback_keys = []
+    
+    extract_fallback_keys
+    identify_key_to_display if @fallback_keys.any?
+    super(decorated_key_name)
+  end
+  
+  def method_missing(*args, &block)
+    if @key.respond_to?(args.first) 
+      to_s.send(*args)
+    else
+      data = translation_or_subkeys
+      if data.is_a?(String)
+        to_s
+      elsif data.respond_to?(args.first)
+        data.send(*args, &block)
+      else
+        self.class.log "You are trying to execute the method ##{args.first} on a translation key which is not supported. Please make sure you treat your translations as strings only."
+        nil
+      end
+    end
+  end
+  
+private
+  def identify_key_to_display
+    key_names = [@key] | @fallback_keys
+    available_key_names = find_keys_within_phrase(key_names)
+    @display_key = @key
+    key_names.each do |item|
+      if available_key_names.include?(item)
+        @display_key = item
+        break
+      end
+    end
+  end
+  
+  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
+    fallback_items = []
+    if @options.has_key?(:default)
+      if @options[:default].kind_of?(Array)
+        fallback_items = @options[:default]
+      else
+        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)
+      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
+  
+  def translation_or_subkeys
+    begin
+      api_client.translate(@key)
+    rescue Exception => e
+      self.class.log "Server Error: #{e.message}"
+    end
+  end
+  
+  def api_client
+    @api_client ||= Phrase::Api::Client.new(Phrase.auth_token)
+  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