i18n_screwdriver 5.1 → 6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36b2576441d68ecd7a79975b76fee091de68f10f
-  data.tar.gz: 704059b0323d79e61f0fd68f2870942c8880f71a
+  metadata.gz: 3fb8ed962112d953a9faf5f4150d3f213710179d
+  data.tar.gz: 6d3e1a2a3f0258d4a5c49796ab800c002fbf60a5
 SHA512:
-  metadata.gz: 675315966e45b946ea2b3a5973cba0974e9d6efd8794deeeacd499e60149a7efdb5a08309af45dfb51573d47499f69713baff0f29d8fc774bc93141e6dc822be
-  data.tar.gz: 081994bb117a431eb84d5bd45e373d985dd80f4124ad08d7e22552a293fce7e162e5ca5f1b988c97052bbbb3b66e0ebed9f5882b0dbc666d4ab8c94957d1b67a
+  metadata.gz: 434aef9acfceefb716e73afe39ce90ab2e78c24a3a56c17ab6aa25756419eec475ef3117d8d9adddb280f405c20cb53daace89337c17312c84f2b8f88d4d05c4
+  data.tar.gz: a417c66dc9ef6213436057c82fb7e639233c2cde4e9e6242e12446359916eac80fd3489ae5457f2cc0fb02bd0f246bdc023e8c61322154fd81c8e528dea864d1

data/Gemfile.lock

@@ -1,79 +1,69 @@
 PATH
   remote: .
   specs:
-    i18n_screwdriver (2.1.1)
+    i18n_screwdriver (6.0)
       rails (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.5)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
+    hike (1.2.3)
+    i18n (0.6.11)
+    json (1.8.1)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.3)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
       rspec-expectations (~> 2.10.0)
@@ -82,16 +72,20 @@ GEM
     rspec-expectations (2.10.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.10.1)
-    sprockets (2.1.3)
+    sprockets (2.12.2)
       hike (~> 1.2)
+      multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    sprockets-rails (2.1.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -26,6 +26,10 @@ In your views, helpers and controllers use the convenient underscore helper meth
 
   _("your translation")
 
+Starting with version 6.0 you can also use symbols as keys
+
+  _(:my_long_text)
+
 Variable interpolation works as for normal strings
 
   _("Hello %{name}!") % {name: "Liah"}

data/lib/i18n_screwdriver/version.rb

@@ -1,3 +1,3 @@
 module I18nScrewdriver
-  VERSION = "5.1"
+  VERSION = "6.0"
 end

data/lib/i18n_screwdriver.rb

@@ -4,22 +4,27 @@ require "i18n_screwdriver/translation_helper"
 require "i18n_screwdriver/rails"
 
 module I18nScrewdriver
-  def self.filename(locale)
-    "config/locales/application.#{locale}.yml"
+  def self.filename_for_locale(locale)
+    File.join("config", "locales", "application.#{locale}.yml")
   end
 
   def self.for_key(string)
-    Digest::MD5.hexdigest(string.strip)
+    string = string.strip
+    (string =~ /^:[a-z][a-z0-9_]*$/) ? string : Digest::MD5.hexdigest(string)
+  end
+
+  def self.file_with_translations_exists?(locale)
+    File.exists?(filename_for_locale(locale))
   end
 
   def self.load_translations(locale)
-    filename = self.filename(locale)
-    raise "File #{filename} not found!" unless File.exists?(filename)
-    YAML.load_file(filename)[locale]
+    path = filename_for_locale(locale)
+    raise "File #{path} not found!" unless File.exists?(path)
+    sanitize_hash(YAML.load_file(path)[locale])
   end
 
   def self.write_translations(locale, translations)
-    File.open(filename(locale), "w") do |file|
+    File.open(filename_for_locale(locale), "w") do |file|
       file.puts "# use rake task i18n:update to generate this file"
       file.puts
       file.puts({locale => in_utf8(translations)}.to_yaml)
@@ -34,6 +39,10 @@ module I18nScrewdriver
     end
   end
 
+  def self.grab_symbols_to_be_translated(string)
+    string.scan(/_\((:[a-z][a-z0-9_]*)\)/).flatten
+  end
+
   def self.in_utf8(hash)
     {}.tap do |result|
       hash.sort.each do |k, v|
@@ -72,5 +81,52 @@ module I18nScrewdriver
       end
     end
   end
-end
 
+  def self.gather_translations
+    texts = []
+    symbols = []
+    Dir.glob("**/*.{haml,erb,slim,rb}").each do |file|
+      input = File.read(file)
+      texts.concat(grab_texts_to_be_translated(input))
+      symbols.concat(grab_symbols_to_be_translated(input))
+    end
+    translations = Hash[texts.uniq.map{ |text| [for_key(text), text] }]
+    translations.merge(Hash[symbols.uniq.map{ |symbol| [for_key(symbol), ""] }])
+  end
+
+  def self.default_locale
+    @default_locale ||= begin
+      raise "Please set I18.default_locale" unless I18n.default_locale.present?
+      I18n.default_locale.to_s
+    end
+  end
+
+  def self.available_locales
+    @available_locales ||= begin
+      raise "Please set I18.available_locales" unless I18n.available_locales.count > 0
+      I18n.available_locales.map(&:to_s)
+    end
+  end
+
+  def self.dummy_text
+    "TRANSLATION_MISSING"
+  end
+
+  def self.update_translations_file(locale, translations)
+    existing_translations = file_with_translations_exists?(locale) ? load_translations(locale) : {}
+    existing_translations.select!{ |k| translations.has_key?(k) }
+
+    translations.each do |k, v|
+      next if existing_translations[k]
+      existing_translations[k] = (default_locale == locale) ? v : dummy_text
+    end
+
+    write_translations(locale, existing_translations)
+  end
+
+  def self.sanitize_hash(hash)
+    {}.tap do |new_hash|
+      hash.each{ |k, v| new_hash[k.to_s] = v.to_s }
+    end
+  end
+end

data/lib/tasks/i18n.rake

@@ -1,65 +1,10 @@
 namespace :i18n do
-  def default_locale
-    @default_locale ||= begin
-      raise "Please set I18.default_locale" unless I18n.default_locale.present?
-      I18n.default_locale.to_s
-    end
-  end
-
-  def available_locales
-    @available_locales ||= begin
-      raise "Please set I18.available_locales" unless I18n.available_locales.count > 0
-      I18n.available_locales.map(&:to_s)
-    end
-  end
-
-  def dummy_text
-    "TRANSLATION_MISSING"
-  end
-
   desc 'Find all translations in views, helpers and controllers'
   task :update => :environment do
-    # parse all files for texts to be translated
-    texts = []
-    Dir.glob("**/*.{haml,erb,slim,rb}").each do |file|
-      texts.concat(I18nScrewdriver.grab_texts_to_be_translated(File.read(file)))
-    end
-
-    # properly handle character codes in strings (\n, \r, \t, \\)
-    texts.map!{ |text| I18nScrewdriver.unescape_string(text) }
-
-    # remove duplicates
-    texts.uniq!
-
-    # transform translations into a hash, sanitizing the keys
-    translations = {}
-    texts.each{ |text| translations[I18nScrewdriver.for_key(text)] = text }
-
-    # rewrite default language file with updated translations
+    translations = I18nScrewdriver.gather_translations
     puts "Found #{translations.keys.size} unique translations"
-    I18nScrewdriver.write_translations(default_locale, translations)
-  end
-
-  desc 'Write dummy translation files so they can manually be translated'
-  task :update_foreign => :environment do
-    # load translations from default locale
-    translations = I18nScrewdriver.load_translations(default_locale)
-
-    # process each language we'd like to translate
-    (available_locales - [default_locale]).each do |locale|
-      filename = I18nScrewdriver.filename(locale)
-
-      # load existing translations
-      existing_translations = File.exists?(filename) ? I18nScrewdriver.load_translations(locale) : {}
-
-      # delete removed translations from hash
-      existing_translations.reject!{ |k| !translations.has_key?(k) }
-
-      # add new translations
-      translations.each_key{ |k| existing_translations[k] ||= dummy_text }
-
-      # write the file
-      I18nScrewdriver.write_translations(locale, existing_translations)
+    I18nScrewdriver.available_locales.each do |locale|
+      I18nScrewdriver.update_translations_file(locale, translations)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n_screwdriver
 version: !ruby/object:Gem::Version
-  version: '5.1'
+  version: '6.0'
 platform: ruby
 authors:
 - Tobias Miesel
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: make translating with rails i18n fun again
@@ -47,7 +47,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -71,17 +71,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: i18n_screwdriver
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: make translating with rails i18n fun again