ios_localizer 0.0.1 → 0.0.1.1

data/README.md

@@ -1 +1,105 @@
+iOS Localizer
+=============
 
+A Ruby gem that makes it easy to localize iOS applications. 
+
+This gem uses [Google Translate's REST API] to translate all the Localizable.strings 
+files generated by XCode to the file's respective language.
+
+Created by Daniel Olshansky ([@olshansky]) and Amandeep Grewal ([@amandeep]).
+
+Prerequisites
+-------------
+
+###  1. API Access 
+
+Google's translating services cost $20 per 1M characters so you must get
+a valid key prior to using this gem. 
+
+Go to the [Google APIs Console]. Under *Services*, enable *Translate API* and complete the required 
+forms to enable payments.
+
+### 2. Localizing your strings 
+
+I would also personally recommend that all the strings displayed to the user
+should be removed from any .nib files and added via code to make your 
+project more systematic and easier to manage.
+
+Any string displayed to the User must be formatted in the following way:
+``` 
+NSLocalizedString(@"String to be displayed", @"Comment about the string");
+```
+
+### 3. Localizable.strings files
+
+Create a new Strings file: 
+  - Go to *File > New > File*
+  - On the left hand side go to Resource (iOS or OS X depending on the application)
+    and choose *Strings File*. Call the file *Localizable.strings*.
+
+Select the new Localizable.strings file and make it localizable by clicking the *[Make localized]* button.
+
+### 4. Adding new languages
+
+Adding an additional language is very simple with XCode. [This image] shows you where 
+you can choose to add or remove  languages that application should be localized for depending on who your target 
+demographic. 
+
+Installation
+------------
+```
+gem install ios_localizer
+```
+
+Usage
+-----
+* Navigate into your project's directory in terminal:
+
+   i.e. ```cd ~/Documents/workspace/ExampleProjectName/ ```
+
+* The most common use case of the gem would then be:
+
+   i.e. ```ios_localizer -k YoureKeyHere1234567890 ```
+
+* If the source language is not english, you can specify it as follows:
+
+   i.e. ```ios_localizer -k YoureKeyHere1234567890 -s nl```
+   
+   where `nl` is the ISO 639 representation of the source language
+
+* If you have already run the script but added a new localization 
+   language afterwards, you can avoid retranslating (and wasting your credit) as follows:
+
+   i.e. ```ios_localizer -k YoureKeyHere1234567890 -n la -n lb -n lc```
+   
+   where `la`, `lb` and `lc` are the ISO 639 representations of the languages you 
+   would like to avoid translating to (given that you have added them in 
+   XCode under Localizations).
+
+Contributing
+------------
+Any and all pull requests are welcome!
+
+Copyright and license
+---------------------
+
+Copyright 2012 Daniel Olshansky & Amandeep Grewal
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License in the LICENSE file, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+  [@olshansky]: http://twitter.com/olshansky
+  [@amandeep]: http://twitter.com/amandeep
+  [Google APIs Console]: https://code.google.com/apis/console/
+  [Google Translate's REST API]: https://developers.google.com/translate/v2/using_rest
+  [This image]: https://github.com/Olshansk/ios_localizer/raw/master/images/Add%20Language.png
+  [Make localized]: https://github.com/Olshansk/ios_localizer/raw/master/images/Localize.png

data/ios_localizer.gemspec

@@ -5,6 +5,7 @@ require 'ios_localizer/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "ios_localizer"
+  gem.date          = Date.today
   gem.version       = IosLocalizer::VERSION
   gem.authors       = ["Daniel Olshansky", "Amandeep Grewal"]
   gem.email         = ["olshansky.daniel@gmail.com", "me@amandeep.ca"]
@@ -17,11 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "uri"
-  gem.add_development_dependency "net/https"
-  gem.add_development_dependency "json"
-  gem.add_development_dependency "cgi"
-  gem.add_development_dependency "htmlentities"
-  gem.add_development_dependency "optparse"
+  gem.add_dependency "json"
+  gem.add_dependency "htmlentities"
   
 end

data/lib/ios_localizer/version.rb

@@ -1,3 +1,3 @@
 module IosLocalizer
-  VERSION = "0.0.1"
+  VERSION = "0.0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ios_localizer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,75 +10,31 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-09 00:00:00.000000000 -04:00
+date: 2012-09-10 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: uri
-  requirement: &70338768892080 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70338768892080
-- !ruby/object:Gem::Dependency
-  name: net/https
-  requirement: &70338768891600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70338768891600
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70338768891100 !ruby/object:Gem::Requirement
+  requirement: &70328367060260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *70338768891100
-- !ruby/object:Gem::Dependency
-  name: cgi
-  requirement: &70338768890640 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70338768890640
+  version_requirements: *70328367060260
 - !ruby/object:Gem::Dependency
   name: htmlentities
-  requirement: &70338768890140 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70338768890140
-- !ruby/object:Gem::Dependency
-  name: optparse
-  requirement: &70338768889660 !ruby/object:Gem::Requirement
+  requirement: &70328367059800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *70338768889660
+  version_requirements: *70328367059800
 description: Uses Google Translate's REST API to properly translate the source Localizable.strings
   file to each of the specified languages
 email:
@@ -95,6 +51,8 @@ files:
 - README.md
 - Rakefile
 - bin/ios_localizer
+- images/Add Language.png
+- images/Localize.png
 - ios_localizer.gemspec
 - lib/ios_localizer.rb
 - lib/ios_localizer/version.rb