localio-simonz 0.0.21.pre.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fc78f3e23be709d44107ef9688dce80205afa7d
+  data.tar.gz: f1cd5ac9842b97da9c10208321317718354e0da2
+SHA512:
+  metadata.gz: 0231862b3e735f05157493e5f9f43d6217f94507e9ca8e017c9aac4ee68025bd52505aa3688452ffd4526abc9c450491efe017fc89807e735b0a3dd4a297ab82
+  data.tar.gz: 5933d8278a4ca90c37b949e3e664318f5eca0e7934fabd3ad580913bbb3760442f55a9d04bd2bcf852e0372b588ec98970cf5340072feb8bdecf74e628d84cdc

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+testing/

data/CONTRIBUTING.md

@@ -0,0 +1,8 @@
+Contributing
+============
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in localio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nacho L.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,197 @@
+# Localio
+
+Localio generates automatically localizable files for many platforms like Rails, Android, iOS, Java .properties files and JSON files using a centralized spreadsheet as source. The spreadsheet can be in Google Drive or a simple local Excel file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'localio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install localio
+
+## Usage
+
+You have to create a custom file, Locfile, similar to Rakefile or Gemfile, with some information for this to work. Also you must have some spreadsheet with a particular format, either in Google Drive or in Excel (XLS or XLSX) format.
+
+In your Locfile directory you can then execute
+
+````
+localize
+````
+
+and your localizable files will be created with the parameters specified in the Locfile. 
+
+You can also specify in the first parameter a file with another name, and it will work as well.
+
+### The Spreadsheet
+
+You will need a little spreadsheet with all the localization literals and their intended keys for internal use while coding.
+
+There is a basic example in this Google Drive link: [https://docs.google.com/spreadsheet/ccc?key=0AmX_w4-5HkOgdFFoZ19iSUlRSERnQTJ4NVZiblo2UXc&usp=sharing](https://docs.google.com/spreadsheet/ccc?key=0AmX_w4-5HkOgdFFoZ19iSUlRSERnQTJ4NVZiblo2UXc&usp=sharing). You just have to duplicate and save to your account, or download and save it as XLS file.
+
+**NOTE** Localio will only search for translations on the first worksheet of the spreadsheet. 
+
+### Locfile
+
+A minimal `Locfile` example could be:
+
+````ruby
+platform :ios
+
+output_path 'out/'
+
+source :google_drive,
+       :spreadsheet => '[Localizables] My Project!',
+       :login => 'your_email@gmail.com',
+       :password => 'your_password'
+
+formatting :smart # This is optional, formatting :smart is used by default.
+````
+
+This would connect localio to your Google Drive and process the spreadsheet with title "[Localizables] My Project!".
+
+The list of possible commands is this.
+
+Option                      | Description                                                      | Default
+----------------------------|------------------------------------------------------------------|--------
+`platform`                  | (Req.) Target platform for the localizable files.                | `nil`
+`source`                    | (Req.) Information on where to find the spreadsheet w/ the info  | `nil`
+`output_path`               | (Req.) Target directory for the localizables.                    | `out/`
+`formatting`                | The formatter that will be used for key processing.              | `smart`
+`except`                    | Filter applied to the keys, process all except the matches.      | `nil`
+`only`                      | Filter applied to the keys, only process the matches.            | `nil`
+
+#### Supported platforms
+
+* `:android` for Android string.xml files. The `output_path` needed is the path for the `res` directory.
+* `:ios` for iOS Localizable.strings files. The `output_path` needed is base directory where `en.lproj/` and such would go. Also creates header file with Objective-C macros.
+* `:swift` for iOS Localizable.strings files. The `output_path` needed is base directory where `en.lproj/` and such would go. Also creates source file with Swift constants.
+* `:rails` for Rails YAML files. The `output_path` needed is your `config/locales` directory.
+* `:json` for an easy JSON format for localizables. The `output_path` is yours to decide :)
+* `:java_properties` for .properties files used mainly in Java. Files named language_(lang).properties will be generated in `output_path`'s root directory.
+
+#### Supported sources
+
+##### Google Drive
+
+`source :google_drive` will get the translation strings from Google Drive.
+
+You will have to provide some required parameters too. Here is a list of all the parameters.
+
+Option                      | Description
+----------------------------|-------------------------------------------------------------------------
+`:spreadsheet`              | (Req.) Title of the spreadsheet you want to use. Can be a partial match.
+`:login`                    | (Req.) Your Google login.
+`:password`                 | (Req.) Your Google password.
+
+**NOTE** As it is a very bad practice to put your login and your password in a plain file, specially when you would want to upload your project to some repository, it is **VERY RECOMMENDED** that you use environment variables in here. Ruby syntax is accepted so you can use `ENV['GOOGLE_LOGIN']` and `ENV['GOOGLE_PASSWORD']` in here.
+
+For example, this.
+
+````ruby
+source :google_drive,
+       :spreadsheet => '[Localizables] My Project!',
+       :login => ENV['GOOGLE_LOGIN'],
+       :password => ENV['GOOGLE_PASSWORD']
+````
+
+And in your .bashrc (or .bash_profile, .zshrc or whatever), you could export those environment variables like this:
+
+````ruby
+export GOOGLE_LOGIN="your_login"
+export GOOGLE_PASSWORD="your_password"
+````
+
+##### XLS
+
+`source :xls` will use a local XLS file. In the parameter's hash you should specify a `:path`.
+
+Option                      | Description
+----------------------------|-------------------------------------------------------------------------
+`:path`                     | (Req.) Path for your XLS file.
+
+````ruby
+source :xls,
+       :path => 'YourExcelFileWithTranslations.xls'
+````
+
+##### XLSX
+
+`source :xlsx` will use a local XLSX file. In the parameter's hash you should specify a `:path`.
+
+Option                      | Description
+----------------------------|-------------------------------------------------------------------------
+`:path`                     | (Req.) Path for your XLSX file.
+
+````ruby
+source :xlsx,
+       :path => 'YourExcelFileWithTranslations.xlsx'
+````
+
+#### Key formatters
+
+If you don't specify a formatter for keys, :smart will be used.
+
+* `:none` for no formatting.
+* `:snake_case` for snake case formatting (ie "this_kind_of_key").
+* `:camel_case` for camel case formatting (ie "ThisKindOfKey").
+* `:smart` use a different formatting depending on the platform.
+
+Here you have some examples on how the behavior would be:
+
+Platform             | "App name"   | "ANOTHER_KIND_OF_KEY"
+---------------------|--------------|----------------------
+`:none`              | `App name`   | `ANOTHER_KIND_OF_KEY`
+`:snake_case`        | `app_name`   | `another_kind_of_key`
+`:camel_case`        | `appName`    | `AnotherKindOfKey`
+`:smart` (ios/swift) | `_App_name`  | `_Another_kind_of_key`
+`:smart` (android)   | `app_name`   | `another_kind_of_key`
+`:smart` (ruby)      | `app_name`   | `another_kind_of_key`
+`:smart` (json)      | `app_name`   | `another_kind_of_key`
+
+Example of use:
+
+````ruby
+formatting :camel_case
+````
+
+Normally you would want a smart formatter, because it is adjusted (or tries to) to the usual code conventions of each platform for localizable strings.
+
+### Advanced options
+
+#### Filtering content
+
+We can establish filters to the keys by using regular expressions.
+
+The exclusions are managed with the `except` command. For example, if we don't want to include the translations where the key has the "[a]" string, we could include this in the Locfile.
+
+````ruby
+except :keys => '[\[][a][\]]'
+````
+
+We can filter inversely too, with the command `only`. For example, if we only want the translations that contain the '[a]' token, we should use:
+
+````ruby
+only :keys => '[\[][a][\]]'
+````
+
+#### Overriding default language
+
+This only makes sense with `platform :android` at the moment. If we want to override (for whatever reason) the default language flag in the source spreadsheet, we can use `:override_default => 'language'`.
+
+For example, if we wanted to override the default (english) and use spanish instead, we could do this:
+
+```ruby
+platform :android, :override_default => 'es'
+```
+
+## Contributing
+
+Please read the [contributing guide](https://github.com/mrmans0n/localio/blob/master/CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/localize

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'localio'
+
+begin
+  Localio.from_cmdline(ARGV)
+rescue => e
+  abort e.message
+end
+

data/lib/localio.rb

@@ -0,0 +1,61 @@
+require 'localio/version'
+require 'localio/locfile'
+require 'localio/processor'
+require 'localio/localizable_writer'
+require 'localio/filter'
+
+module Localio
+
+  def self.from_cmdline(args)
+    if args.empty?
+      if File.exist? 'Locfile'
+        process_locfile('Locfile')
+      else
+        raise ArgumentError, 'Locfile not found in current directory, and no compatible file supplied in arguments.'
+      end
+    else
+      process_locfile(args.shift)
+    end
+  end
+
+  def self.from_configuration(configuration)
+    @configuration = configuration
+    generate_localizables
+  end
+
+  private
+
+  def self.process_locfile(path)
+    @configuration = Locfile.load(path)
+    generate_localizables
+  end
+
+  def self.generate_localizables
+    process_to_memory
+    apply_filters
+    build_localizables
+  end
+
+  def self.process_to_memory
+    @localizables = Processor.load_localizables @configuration.platform_options,
+                                                @configuration.source_service,
+                                                @configuration.source_options
+  end
+
+  def self.apply_filters
+    @localizables[:segments] = Filter.apply_filter @localizables[:segments],
+                                                   @configuration.only,
+                                                   @configuration.except
+  end
+
+  def self.build_localizables
+    LocalizableWriter.write @configuration.platform_name,
+                            @localizables[:languages],
+                            @localizables[:segments],
+                            @configuration.output_path,
+                            @configuration.formatting,
+                            :default_language => @localizables[:default_language]
+    puts 'Done!'.green
+  end
+
+end

data/lib/localio/filter.rb

@@ -0,0 +1,43 @@
+class Filter
+  def self.apply_filter(segments, only, except)
+
+    segments = only segments, only[:keys] unless only.nil?
+    segments = except segments, except[:keys] unless except.nil?
+
+    segments
+  end
+
+  private
+
+  def self.only segments, keys_filter
+
+    filtered_segments = []
+    segments.each do |segment|
+      is_okay = true
+      unless keys_filter.nil?
+        result = /#{keys_filter}/ =~ segment.keyword
+        is_okay = false if result.nil?
+      end
+
+      filtered_segments << segment if is_okay
+    end
+
+    filtered_segments
+  end
+
+  def self.except segments, keys_filter
+    filtered_segments = []
+    segments.each do |segment|
+      is_okay = true
+      unless keys_filter.nil?
+        result = /#{keys_filter}/ =~ segment.keyword
+        is_okay = false unless result.nil?
+      end
+
+      filtered_segments << segment if is_okay
+    end
+
+    filtered_segments
+  end
+
+end

data/lib/localio/formatter.rb

@@ -0,0 +1,20 @@
+require 'localio/string_helper'
+
+module Formatter
+  def self.format(key, formatter, callback)
+    case formatter
+      when :smart
+        # Smart formatting is given by the processor.
+        # I don't like this very much but creating more classes seemed overkill.
+        callback.call(key)
+      when :none
+        key
+      when :camel_case
+        key.space_to_underscore.strip_tag.camel_case
+      when :snake_case
+        key.space_to_underscore.strip_tag.downcase
+      else
+        raise ArgumentError, 'Unknown formatting used. Must use :smart, :none, :camel_case or :snake_case'
+    end
+  end
+end

data/lib/localio/localizable_writer.rb

@@ -0,0 +1,28 @@
+require 'localio/writers/android_writer'
+require 'localio/writers/ios_writer'
+require 'localio/writers/swift_writer'
+require 'localio/writers/json_writer'
+require 'localio/writers/rails_writer'
+require 'localio/writers/java_properties_writer'
+
+
+module LocalizableWriter
+  def self.write(platform, languages, terms, path, formatter, options)
+    case platform
+      when :android
+        AndroidWriter.write languages, terms, path, formatter, options
+      when :ios
+        IosWriter.write languages, terms, path, formatter, options
+      when :swift
+        SwiftWriter.write languages, terms, path, formatter, options
+      when :json
+        JsonWriter.write languages, terms, path, formatter, options
+      when :rails
+        RailsWriter.write languages, terms, path, formatter, options
+      when :java_properties
+        JavaPropertiesWriter.write languages, terms, path, formatter, options
+      else
+        raise ArgumentError, 'Platform not supported! Current possibilities are :android, :ios, :json, :rails, :java_properties'
+    end
+  end
+end