motion-i18n 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8c6cb8331129a88b35944dd40da95f9848724d0
-  data.tar.gz: 70c4366f974d526c1b5cc7546ae24bf554a92071
+  metadata.gz: d676471d45904385e6697965801e24e5e2d9735b
+  data.tar.gz: f9fb82da081092ea176ea5dea420e53ae371c5d7
 SHA512:
-  metadata.gz: a16fba8ba021cd852e56809f104a0f0bef4f3811715fdf45bce28779e2b3cada3d8a7191bd15e1fa6064b9dc8ee6b87b0084539fb782405defd4115058615223
-  data.tar.gz: 4fc2185cfae832da2a1d8123bc05cfe1145ba4bfe5ccf0fbf28114c2967b7b642df654057fd2eacfe6b0c7862a8d77d1ff9755998c6fc70f2a5f48dbeee9b45e
+  metadata.gz: 0febb52ac33d19e9df01ec8ac9b54610a92921c8e227161e0a1ab18720b63a621f9c06f6a947f3c1835166f092eed315da1a738f5f039c1e7d42c9d4a32eba36
+  data.tar.gz: b4a62246aabf6aefb5fd533a85e873f6a4d7bdf94ed4565ee359a05ec39b642a766dc14718450ecaba1b5e83930b108c82b0ed379526e372140afe09f84d8962

data/.gitignore

@@ -0,0 +1,11 @@
+.repl_history
+build
+resources/*.nib
+resources/*.momd
+resources/*.storyboardc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.dat*
+.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "motion-require"
+
+# Specify your gem's dependencies in motion-support.gemspec
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+# MotionI18n
+
+Rails-style translations for RubyMotion apps.
+
+This gem allows you to specify your RubyMotion translations as `.yml` files. The translations are automatically converted to Cocoa's native format for translations.
+
+# Installation
+
+```
+gem install motion-i18n
+```
+
+and in your `Rakefile`:
+
+```ruby
+require 'motion-i18n'
+```
+
+or using bundler:
+
+```ruby
+gem "motion-i18n"
+```
+
+# Usage
+
+Put your translations in YAML files in `config/locales/`. For each locale there should be a file named as the locale with the extension `.yml`, e.g. `en.yml`, `de.yml` etc.
+
+## Translations
+
+For a guide on how the translation files should look like, see <http://guides.rubyonrails.org/i18n.html#adding-translations>
+
+To translate a string, use `I18n.translate` or the shortcut `I18n.t` like this:
+
+```ruby
+I18n.t("main_screen.title")
+```
+
+To substitute variables in the string, specify the substitutions in second a hash argument
+
+```ruby
+I18n.t("maps.directions", :from => origin, :to => destination)
+```
+
+## Locale
+
+You can get the current locale by calling
+
+```ruby
+I18n.locale
+```
+
+## Workflow
+
+This gem works perfectly together with the `i18n_tools` gem:
+
+```
+gem install i18n_tools
+```
+
+or in `Gemfile`;
+
+```ruby
+gem "i18n_tools", :require => "i18n_tools/tasks"
+```
+
+The gem will give you the tasks `rake translations:missing` which shows untranslated strings as well as `rake translations:unused` which shows strings which are translated but not used in the code. For more information, see [i18n_tools](https://github.com/tkadauke/i18n_tools).
+
+# Warning
+
+For each locale `loc`, this gem overwrites the file `resources/loc.lproj/Localizable.strings` before building. Make sure you don't edit this file. Also, you should add these files to `.gitignore`:
+
+```
+Localizable.strings
+```
+
+# Forking
+
+Feel free to fork and submit pull requests!

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+$:.unshift("/Library/RubyMotion/lib")
+
+if ENV['android']
+  require 'motion/project/template/android'
+elsif ENV['osx']
+  require 'motion/project/template/osx'
+else
+  require 'motion/project/template/ios'
+end
+
+require './lib/motion-i18n'
+
+begin
+  require 'bundler'
+  require 'motion/project/template/gem/gem_tasks'
+  Bundler.require
+rescue LoadError
+end
+
+Motion::Project::App.setup do |app|
+  # Use `rake config' to see complete project settings.
+  app.name = 'MotionI18n'
+end

data/app/app_delegate.rb

@@ -0,0 +1,7 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    @window = UIWindow.alloc.initWithFrame(UIScreen.mainScreen.bounds)
+    @window.rootViewController = UIViewController.alloc.init
+    true
+  end
+end

data/lib/motion-i18n-android/i18n.rb

@@ -0,0 +1,19 @@
+module I18n
+  class << self
+    def translate(key, substitutions = {})
+      pkg_name = RMQ.app.context.getPackageName # please use RMQ for now.
+      id = RMQ.app.resources.getIdentifier(key.gsub(" ", "_"), "string", pkg_name)
+      str = RMQ.app.resources.getString(id)
+      str.tap do |result|
+        substitutions.each do |key, value|
+          result.gsub!("%{#{key}}", value.to_s)
+        end
+      end
+    end
+    alias_method :t, :translate
+
+    def locale
+      Java::Util::Locale.getDefault
+    end
+  end
+end

data/lib/motion-i18n-android/translate.rb

@@ -0,0 +1,48 @@
+def droid_convert(file, namespace, value)
+  if value.is_a?(Hash)
+    value.each do |key, value|
+      droid_convert(file, "#{namespace}.#{key}", value)
+    end
+  else
+    encoded_val = value.to_s.gsub("'", "'").gsub('"', """).encode(:xml => :text)
+    encoded_name = namespace.to_s.gsub(" ", "_")
+    file.puts %{<string name="#{encoded_name}">#{encoded_val}</string>}
+  end
+end
+
+def droid_translate
+  require 'i18n'
+
+  files = Dir.glob("config/locales/*.yml")
+
+  I18n.load_path.clear
+  I18n.load_path << files
+
+  files.each do |locale_file|
+    locale = File.basename(locale_file).sub(".yml", "")
+
+    all_translations = I18n.backend.send(:lookup, locale.to_sym, "")
+    FileUtils.mkdir_p("resources/values-#{locale}")
+    File.open("resources/values-#{locale}/strings.xml", 'w') do |file|
+      file.puts '<?xml version ="1.0" encoding ="utf-8"?>'
+      file.puts '<resources>'
+      all_translations.each do |key, value|
+        droid_convert(file, key, value)
+      end
+      file.puts '</resources>'
+    end
+  end
+  # get rid of annoying warnings
+  FileUtils.mkdir_p("resources/values-en")
+  FileUtils.cp("resources/values-en/strings.xml", "resources/values/strings.xml")
+end
+
+desc "Translate (android)"
+task :translate do
+  droid_translate
+end
+
+namespace :build do
+  task :simulator => :translate
+  task :device => :translate
+end

data/lib/motion-i18n-ios/i18n.rb

@@ -0,0 +1,16 @@
+module I18n
+  class << self
+    def translate(key, substitutions = {})
+      String.new((NSBundle.mainBundle.localizedStringForKey(key, value:"", table:nil))).tap do |result|
+        substitutions.each do |key, value|
+          result.gsub!("%{#{key}}", value.to_s)
+        end
+      end
+    end
+    alias t translate
+
+    def locale
+      NSLocale.preferredLanguages.first
+    end
+  end
+end

data/lib/motion-i18n-ios/translate.rb

@@ -0,0 +1,40 @@
+def convert(file, namespace, value)
+  if value.is_a?(Hash)
+    value.each do |key, value|
+      convert(file, "#{namespace}.#{key}", value)
+    end
+  else
+    file.puts %{"#{namespace}" = "#{value.to_s}";}
+  end
+end
+
+def ios_translate
+  require 'i18n'
+
+  files = Dir.glob("config/locales/*.yml")
+
+  I18n.load_path.clear
+  I18n.load_path << files
+
+  files.each do |locale_file|
+    locale = File.basename(locale_file).sub(".yml", "")
+
+    all_translations = I18n.backend.send(:lookup, locale.to_sym, "")
+    FileUtils.mkdir_p("resources/#{locale}.lproj")
+    File.open("resources/#{locale}.lproj/Localizable.strings", 'w') do |file|
+      all_translations.each do |key, value|
+        convert(file, key, value)
+      end
+    end
+  end
+end
+
+desc "Translate (ios)"
+task :translate do
+  ios_translate
+end
+
+namespace :build do
+  task :simulator => :translate
+  task :device => :translate
+end

data/lib/motion-i18n.rb

@@ -0,0 +1,27 @@
+require 'motion-require'
+
+platform = Motion::Project::App.respond_to?(:template) ? Motion::Project::App.template : :ios
+if platform.to_s.start_with?('ios') or platform.to_s.start_with?('osx')
+  platform_name = 'ios'
+elsif platform.to_s.start_with?('android')
+  platform_name = 'android'
+end
+
+require "motion-i18n-#{platform_name}/translate"
+
+Motion::Project::App.setup do |app|
+  platform_lib = File.join(File.dirname(__FILE__), "motion-i18n-#{platform_name}")
+  unless File.exists? platform_lib
+    raise "Sorry, the platform #{platform.inspect} (aka #{platform_name}) is not supported by motion-i18n"
+  end
+
+  # scans app.files until it finds app/ (the default)
+  # if found, it inserts just before those files, otherwise it will insert to
+  # the end of the list
+  insert_point = app.files.find_index { |file| file =~ /^(?:\.\/)?app\// } || 0
+
+  Dir.glob(File.join(platform_lib, 'i18n.rb')).reverse.each do |file|
+    app.files.insert(insert_point, file)
+  end
+
+end

data/motion-i18n.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name        = "motion-i18n"
+  s.version     = "0.0.6"
+  s.authors     = ["Thomas Kadauke"]
+  s.email       = ["thomas.kadauke@googlemail.com"]
+  s.homepage    = "https://github.com/tkadauke/motion-i18n"
+  s.summary     = "Wrapper for translations in RubyMotion"
+  s.description = "Wrapper for translations in RubyMotion"
+
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'motion-require'
+  s.add_dependency 'i18n'
+  s.add_development_dependency 'rake'
+end

data/resources/en.lproj/Localizable.strings

@@ -0,0 +1,3 @@
+"test.string" = "Test string";
+"test.substitutions" = "%{count} substitutions";
+"test.multiple_substitutions" = "%{count} substitutions %{count}";

data/spec/motion-i18n/i18n_spec.rb

@@ -0,0 +1,29 @@
+describe "I18n" do
+  describe "translate" do
+    it "should translate string" do
+      I18n.translate("test.string").should == "Test string"
+    end
+
+    it "should return key for untranslated string" do
+      I18n.translate("foo.bar").should == "foo.bar"
+    end
+
+    it "should plug in substitutions" do
+      I18n.translate("test.substitutions", :count => 5).should == "5 substitutions"
+    end
+
+    it "substitutes multiple instances" do
+      I18n.translate("test.multiple_substitutions", :count => 5).should == "5 substitutions 5"
+    end
+
+    it "should have shortcut" do
+      I18n.t("test.string").should == I18n.translate("test.string")
+    end
+  end
+
+  describe "locale" do
+    it "should return the current locale" do
+      I18n.locale.should == "en-US"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-i18n
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Thomas Kadauke
@@ -58,7 +58,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- lib/motion-i18n-android/i18n.rb
+- lib/motion-i18n-android/translate.rb
+- lib/motion-i18n-ios/i18n.rb
+- lib/motion-i18n-ios/translate.rb
+- lib/motion-i18n.rb
+- motion-i18n.gemspec
+- resources/en.lproj/Localizable.strings
+- spec/motion-i18n/i18n_spec.rb
 homepage: https://github.com/tkadauke/motion-i18n
 licenses: []
 metadata: {}
@@ -82,4 +95,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Wrapper for translations in RubyMotion
-test_files: []
+test_files:
+- spec/motion-i18n/i18n_spec.rb