localio 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c21e5dff4337729edd1fc6269aded7e26a016865
-  data.tar.gz: a0159d82208d6738b0afc6d2912133eafc5c86b1
+  metadata.gz: 2ab1bb80d6ff76d09f5a49870da6def8a557327c
+  data.tar.gz: 0d5ac9d5fbeacb0ae31ea0bffcb7ba5ad0e192e8
 SHA512:
-  metadata.gz: c80d19c1d239b3b6bfdb2a1d1d34eda8dab8ea8ff8db87092350633d55686220bf6966e6d0b0dfef12c164d9e61488f4e5a0923bc3516c246cf4aef350ecdf55
-  data.tar.gz: fccb1c83520acd2912dce8a783d0b7d37b7fbbc893067026f152d3c585d43b093c21f8f80d2623f27658f0fb6c11b135578d013c1dbb0cbc41876c4c185e5e5f
+  metadata.gz: cfaeda3f347fef27740843416e499de7e0e634ab3cdece0c0bfd03ada9e789cd32bdbd6736a7469d847a911acc19ec85c33e3db614d0a8c4f7f5913aea055a25
+  data.tar.gz: ed4cc7851740012f89fedfcaeb00083d33cfd61a6f4e49f2fc49fc47328ee9439fa0d85d0126c58a625dbb13ba95c3d6479e15d42e14220a27641611a42d872b

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/README.md

@@ -44,9 +44,11 @@ platform :ios
 output_path 'out/'
 
 source :google_drive,
-    :spreadsheet => '[Localizables] My Project!',
-    :login => 'your_email@gmail.com',
-    :password => 'your_password'
+       :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!".
@@ -55,35 +57,96 @@ The list of possible commands is this.
 
 Option                      | Description                                                      | Default
 ----------------------------|------------------------------------------------------------------|--------
-`platform`                  | (Req.) Target platform for the localizable files.                | ---
-`source`                    | (Req.) Information on where to find the spreadsheet w/ the info  | ---
+`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`
 
-
 #### Supported platforms
 
-* `:android` for Android string.xml files.
-* `:ios` for iOS Localizable.strings files.
-* `:rails` for Rails YAML files.
-* `:json` for an easy JSON format for localizables.
+* `: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.
+* `: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 :)
 
 #### Supported sources
 
-* `:google_drive` will connect to Google Drive.
-* `:xls` will use a local XLS file.
+##### 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
+
+Currently XLSX is not supported though the code is there (not tested, though) and it will be included in a future release.
 
 #### 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_keys").
-* `:camel_case` for camel case formatting (ie "thisKindOfKeys").
+* `: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)     | _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.
+
 ## 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
+Please read the [contributing guide](https://github.com/mrmans0n/localio/blob/master/CONTRIBUTING.md).

data/bin/localize

@@ -2,4 +2,9 @@
 
 require 'localio'
 
-Localio.from_cmdline(ARGV)
+begin
+  Localio.from_cmdline(ARGV)
+rescue => e
+  abort e.message
+end
+

data/lib/localio.rb

@@ -10,7 +10,7 @@ module Localio
       if File.exist? 'Locfile'
         process_locfile('Locfile')
       else
-        abort 'Locfile not found in current directory, and no compatible file supplied in arguments.'
+        raise ArgumentError, 'Locfile not found in current directory, and no compatible file supplied in arguments.'
       end
     else
       process_locfile(ARGV.shift)

data/lib/localio/formatter.rb

@@ -14,7 +14,7 @@ module Formatter
       when :snake_case
         key.space_to_underscore.strip_tag.downcase
       else
-        abort 'Unknown formatting used. Must use :smart, :none, :camel_case or :snake_case'
+        raise ArgumentError, 'Unknown formatting used. Must use :smart, :none, :camel_case or :snake_case'
     end
   end
 end

data/lib/localio/localizable_writer.rb

@@ -15,7 +15,7 @@ module LocalizableWriter
       when :rails
         RailsWriter.write languages, terms, path, formatter, options
       else
-        abort 'Platform not supported! Current possibilities are :android, :ios, :json, :rails'
+        raise ArgumentError, 'Platform not supported! Current possibilities are :android, :ios, :json, :rails'
     end
   end
 end

data/lib/localio/processor.rb

@@ -1,6 +1,6 @@
 require 'localio/processors/google_drive_processor'
 require 'localio/processors/xls_processor'
-require 'localio/processors/xlsx_processor'
+# require 'localio/processors/xlsx_processor'
 
 module Processor
   def self.load_localizables(service, options)
@@ -13,7 +13,7 @@ module Processor
         raise 'Temporarily disabled due to rubyzip problems. Sorry!'
         # XlsxProcessor.load_localizables options
       else
-        abort 'Unsupported service! Try with :google_drive, :xlsx or :xls in the source argument'
+        raise ArgumentError, 'Unsupported service! Try with :google_drive, :xlsx or :xls in the source argument'
     end
   end
 end

data/lib/localio/processors/google_drive_processor.rb

@@ -7,18 +7,18 @@ class GoogleDriveProcessor
 
     # Parameter validations
     spreadsheet = options[:spreadsheet]
-    abort ':spreadsheet required for Google Drive source!' if spreadsheet.nil?
+    raise ArgumentError, ':spreadsheet required for Google Drive source!' if spreadsheet.nil?
     login = options[:login]
-    abort ':login required for Google Drive source!' if login.nil?
+    raise ArgumentError, ':login required for Google Drive source!' if login.nil?
     password = options[:password]
-    abort ':password required for Google Drive source!' if password.nil?
+    raise ArgumentError, ':password required for Google Drive source!' if password.nil?
 
     # Log in and get spreadsheet
     puts 'Logging in to Google Drive...'
     begin
       session = GoogleDrive.login(login, password)
     rescue
-      abort 'Couldn\'t access Google Drive. Check your credentials in :login and :password'
+      raise 'Couldn\'t access Google Drive. Check your credentials in :login and :password'
     end
     puts 'Logged in!'
 
@@ -39,7 +39,7 @@ class GoogleDriveProcessor
 
     # TODO we could pass a :page_index in the options hash and get that worksheet instead, defaulting to zero?
     worksheet = matching_spreadsheets[0].worksheets[0]
-    abort 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
+    raise 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
 
     # At this point we have the worksheet, so we want to store all the key / values
     first_valid_row_index = nil
@@ -50,9 +50,9 @@ class GoogleDriveProcessor
       last_valid_row_index = row if worksheet[row, 1].downcase == '[end]'
     end
 
-    abort 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
-    abort 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
-    abort 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
+    raise IndexError, 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
 
     languages = Hash.new('languages')
     default_language = nil

data/lib/localio/processors/xls_processor.rb

@@ -7,7 +7,7 @@ class XlsProcessor
 
     # Parameter validations
     path = options[:path]
-    abort ':path attribute is missing from the source, and it is required for xls spreadsheets' if path.nil?
+    raise ArgumentError, ':path attribute is missing from the source, and it is required for xls spreadsheets' if path.nil?
 
     Spreadsheet.client_encoding = 'UTF-8'
 
@@ -15,7 +15,7 @@ class XlsProcessor
 
     # TODO we could pass a :page_index in the options hash and get that worksheet instead, defaulting to zero?
     worksheet = book.worksheet 0
-    abort 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
+    raise 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
 
     # At this point we have the worksheet, so we want to store all the key / values
     first_valid_row_index = nil
@@ -26,9 +26,9 @@ class XlsProcessor
       last_valid_row_index = row if worksheet[row, 0].to_s.downcase == '[end]'
     end
 
-    abort 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
-    abort 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
-    abort 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
+    raise IndexError, 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
 
     languages = Hash.new('languages')
     default_language = nil
@@ -41,7 +41,7 @@ class XlsProcessor
       end
     end
 
-    abort 'There are no language columns in the worksheet' if languages.count == 0
+    raise 'There are no language columns in the worksheet' if languages.count == 0
 
     default_language = languages[0] if default_language.to_s == ''
 

data/lib/localio/processors/xlsx_processor.rb

@@ -7,13 +7,13 @@ class XlsxProcessor
 
     # Parameter validations
     path = options[:path]
-    abort ':path attribute is missing from the source, and it is required for xlsx spreadsheets' if path.nil?
+    raise ArgumentError, ':path attribute is missing from the source, and it is required for xlsx spreadsheets' if path.nil?
 
     book = SimpleXlsxReader.open path
 
     # TODO we could pass a :page_index in the options hash and get that worksheet instead, defaulting to zero?
     worksheet = book.sheets.first
-    abort 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
+    raise 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
 
     # At this point we have the worksheet, so we want to store all the key / values
     first_valid_row_index = nil
@@ -24,9 +24,9 @@ class XlsxProcessor
       last_valid_row_index = row if worksheet[row, 0].to_s.downcase == '[end]'
     end
 
-    abort 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
-    abort 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
-    abort 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
+    raise IndexError, 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
 
     languages = Hash.new('languages')
     default_language = nil
@@ -39,7 +39,7 @@ class XlsxProcessor
       end
     end
 
-    abort 'There are no language columns in the worksheet' if languages.count == 0
+    raise 'There are no language columns in the worksheet' if languages.count == 0
 
     default_language = languages[0] if default_language.to_s == ''
 

data/lib/localio/version.rb

@@ -1,3 +1,3 @@
 module Localio
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/localio.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "micro-optparse", "~> 1.1.5"
   spec.add_dependency "google_drive", "~> 0.3.6"
   spec.add_dependency "spreadsheet", "~> 0.8.9"
-  spec.add_dependency "simple_xlsx_reader", "~> 0.9.7"
+  # spec.add_dependency "simple_xlsx_reader", "~> 0.9.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: localio
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nacho Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,20 +94,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.9
-- !ruby/object:Gem::Dependency
-  name: simple_xlsx_reader
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.7
 description: Automatic Localizable file generation for multiple platforms (Rails,
   Android, iOS, JSON)
 email:
@@ -118,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md