babelish 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmY3NGRmN2Q0MjljZmE1MDFiMjI2MjRkYmY1Y2UyMDZiYjI2NGIyNg==
+  data.tar.gz: !binary |-
+    ZmZkYjAxZDhmNjk0NWNjYjcyYmJlMTczMzVlYjJhMWQ4MGY5NGIxOA==
+SHA512:
+  metadata.gz: !binary |-
+    ZTAzZjgyMDA2NmNhMjEyMGZlNTYyYTFhMThhMTUxNzA4MmU1Y2M1Y2E0NDg5
+    MDk5ODhiMjMwNTdkYjgyNDk5ODgxMWU4YmY4N2VhNzM4Zjc4MjY0MmM2NDdh
+    NTcwNzkwNDM4YWU1ZDdmZjI4OTlhY2Q0NDYyZTc3MzQ3MzRlZGI=
+  data.tar.gz: !binary |-
+    ZDJmMmM3ZThkMmJlZTU0ZWQzNjBjMGNkYjk1NTI0OTIxNWU3NDVlNGEwZGI1
+    ODMyMzVkZTdlMmRkNzgzOWZiNGZlNjU1Yjg0M2NiODdhYTkwY2Q1MGFmZjFi
+    ZjY2MmU3MDY1ZTQzODZmYzQyOTI2OWQ5Mjc2ZWVmMGFmY2QyMTQ=

data/.babelish.sample

@@ -0,0 +1,26 @@
+# This is a sample configuration file
+
+# Base2CSV
+
+## required, location of strings files (FILENAMES)
+filenames: ["test/data/test_en.strings", "test/data/test_fr.strings"]
+
+## optional
+# headers: ["Constants", "English", "French"] # override headers of columns, default is name of input files and 'Variables' for reference
+# csv_filename: "testconfig.csv"              # location of output file
+# dryrun: true                                # prints out content of hash without writing file
+
+# CSV2Base
+
+## required
+filename: test/data/test_data.csv  # CSV file (CSV_FILENAME) to convert from or name of file in Google Drive
+langs:                             # Languages to convert. i.e. English:en
+  English: "en"
+
+## optional
+# fetch: true                        # set to true to get file(filename) from google drive
+# excluded-states: ["Images", "Xib"] # Exclude rows with given state
+# state-column: 3                    # Position of column for state if any
+# keys-column: 0                     # Position of column for keys
+# default-lang: "English"            # Default language to use for empty values if any
+# default-path: "resources/"          # Path of output files

data/.gitignore

@@ -0,0 +1,30 @@
+# Generated files
+*.csv
+*.strings
+*.lproj
+*.gem
+*~
+*#
+#*#
+
+# Config file
+.babelish
+
+# SimpleCov
+coverage
+
+# ignore Gemfile.lock as http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+# this should solve the fastercsv issue
+Gemfile.lock
+
+# Ruby package manager files
+.ruby-version
+.rbenv-version
+.rvmrc
+
+# Sublime Text
+*.sublime-workspace
+*.sublime-project
+
+doc
+.yardoc

data/.hound.yml

@@ -0,0 +1,4 @@
+HashSyntax:
+  Enabled: false
+LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Xjq+v+jEU6wK4BtyfnV1elegNcxK6Ah/O99Sn9c2IlkCmJ1wxLBouqzEiSorSJ4IOMa5H2y3gwo5GXOr6Y7d8huyGrPuBeCSGqAmH77wNCIv7G+jnLiYb1sRZbtKcPW2QaN6JF81qDIelwyspMfo6/ug1qN1x323UaxZl7f7nUE=
+  gem: babelish
+  on:
+    tags: true
+    repo: netbe/Babelish

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in teachmehowtomakearubygem.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false, :platforms => [:ruby_19, :ruby_20]
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 François Benaiteau
+
+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,43 @@
+[![Build Status](https://secure.travis-ci.org/netbe/CSV-to-iOS-Localizable.strings-converter.png?branch=master)](http://travis-ci.org/netbe/CSV-to-iOS-Localizable.strings-converter)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/netbe/CSV-to-iOS-Localizable.strings-converter)
+[![Coverage Status](https://coveralls.io/repos/netbe/CSV-to-iOS-Localizable.strings-converter/badge.png)](https://coveralls.io/r/netbe/CSV-to-iOS-Localizable.strings-converter)
+[![Gem Version](https://badge.fury.io/rb/csv2strings.png)](http://badge.fury.io/rb/csv2strings)
+# Introduction
+This script converts a csv file of translations into the below file formats and vice-versa:
+* .strings (iOS)
+* .xml (Android)
+* .json
+* .php
+
+# Requirements
+
+* Ruby 1.9.2 or above
+
+# Setup
+
+`gem install babelish`
+
+# Usage
+
+` babelish help`
+
+* Use configuration file
+
+You can use a configuration file to hold all your commandline arguments into a file.
+Place a `.babelish` file in your repo where you will run the command.
+See `.babelish.sample` as the possible values.
+
+# Contributing
+
+If you feel like it, just create a pull request with a branch like `feature/<nameofbranch>` to `develop` branch
+
+
+## Development
+
+Edge version can be found on `develop` branch.
+
+Run `bundle install` to install all the dependencies. Tests are done with `Test::Unit` so run `rake test` to run all the test suite.
+
+# Todo & Known issues
+
+See GitHub issues

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/babelish/**/test_*.rb']
+  # t.warning = true
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  # t.options = ['--any', '--extra', '--opts']
+end
+
+task :default => :test

data/babelish.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'babelish/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'babelish'
+  s.version     = Babelish::VERSION
+  s.date        = '2014-04-10'
+  s.summary     = "CSV converter for localization files"
+  s.description = "This set of commands converts a CSV file to the following formats:
+                  - .strings (iOS)
+                  - .xml (Android)
+                  - .json
+                  - .php"
+  s.authors     = ["François Benaiteau", "Markus Paeschke"]
+  s.email       = ['francois.benaiteau@gmail.com', 'markus.paeschke@gmail.com']
+  s.homepage    = 'https://github.com/netbe/CSV-to-iOS-Localizable.strings-converter'
+  s.license = 'MIT'
+
+  s.add_dependency "thor"
+
+  s.add_dependency "google_drive"
+  # google_drive dependency to ask for mail and password
+  s.add_dependency "highline"
+
+  # android support
+  s.add_dependency "xml-simple"
+  # json support
+  s.add_dependency "json"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "yard"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path  = 'lib'
+end

data/bin/android2csv

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/babelish

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+Commandline.start(ARGV)

data/bin/csv2android

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/csv2json

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/csv2php

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/csv2strings

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/json2csv

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/php2csv

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/bin/strings2csv

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../../lib", __FILE__)
+require 'babelish'
+require 'babelish/commandline'
+
+puts "DEPRECATED: use babelish command"
+args = [File.basename(__FILE__)]
+if ARGV.first == "help"
+  args.insert(0, ARGV.first)
+  ARGV.delete(ARGV.first)
+end
+args += ARGV
+Commandline.start(args)

data/lib/babelish/android2csv.rb

@@ -0,0 +1,25 @@
+module Babelish
+  require 'xmlsimple'
+  class Android2CSV < Base2Csv
+
+    def initialize(args = {:filenames => []})
+      super(args)
+    end
+
+    def load_strings(strings_filename)
+      strings = {}
+      raise Errno::ENOENT unless File.exist?(strings_filename)
+
+      xmlfile = XmlSimple.xml_in(strings_filename)
+      xmlfile['string'].each do |element|
+        if !element.nil? && !element['name'].nil?
+          content = element['content'].nil? ? '' : element['content']
+          strings.merge!({element['name'] => content})
+        end
+      end
+
+      strings
+    end
+
+  end
+end

data/lib/babelish/base2csv.rb

@@ -0,0 +1,98 @@
+module Babelish
+  class Base2Csv
+    attr_accessor :csv_filename, :headers, :filenames, :default_lang
+
+    def initialize(args = {:filenames => []})
+      raise ArgumentError.new("No filenames given") unless args[:filenames]
+      if args[:headers]
+        raise ArgumentError.new("number of headers and files don't match, don't forget the constant column") unless args[:headers].size == (args[:filenames].size + 1)
+      end
+
+      @filenames = args[:filenames]
+
+      @csv_filename = args[:csv_filename] || "translations.csv"
+      @default_lang = args[:default_lang]
+      @headers = args[:headers] || default_headers
+    end
+
+    public
+
+    # Process files and create csv
+    #
+    # @param [Boolean] write_to_file create or not the csv file
+    # @return [Hash] the translations formatted if write_to_file
+    def convert(write_to_file = true)
+      strings = {}
+      keys = nil
+
+      @filenames.each do |fname|
+        header = fname
+        strings[header] = load_strings(fname)
+        keys ||= strings[header].keys
+      end
+
+      if write_to_file
+        # Create csv file
+        puts "Creating #{@csv_filename}"
+        create_csv_file(keys, strings)
+      else
+        return keys, strings
+      end
+    end
+
+    protected
+
+    # Load all strings of a given file
+    #
+    # @param [String, #read] strings_filename filename of file containing translations
+    # for a given language
+    # @return [Hash] the translations for a given language
+    def load_strings(strings_filename)
+      return {}
+    end
+
+    # Give the default headers of csv file
+    #
+    # @return [Array] headers of csv
+    def default_headers
+      headers = ["Variables"]
+      @filenames.each do |fname|
+        headers << fname
+      end
+      headers
+    end
+
+    # Basename of given file
+    #
+    # @param [String, #read] file_path
+    # @return [String] basename
+    def basename(file_path)
+      filename = File.basename(file_path)
+      return filename.split('.')[0].to_sym if file_path
+    end
+
+    private
+
+    # Create the resulting file
+    #
+    # @param [Array] keys references of all translations
+    # @param [Array] strings translations of all languages
+    def create_csv_file(keys, strings)
+      raise "csv_filename must not be nil" unless @csv_filename
+      CSV.open(@csv_filename, "wb") do |csv|
+        csv << @headers
+        keys.each do |key|
+          line = [key]
+          default_val = strings[@default_lang][key] if strings[@default_lang]
+          @filenames.each do |fname|
+            lang = fname
+            current_val = (lang != default_lang && strings[lang][key] == default_val) ? '' : strings[lang][key]
+            line << current_val
+          end
+          csv << line
+        end
+        puts "Done"
+      end
+    end
+  end
+end

data/lib/babelish/commandline.rb

@@ -0,0 +1,114 @@
+require 'thor'
+class Commandline < Thor
+  include Thor::Actions
+  class_option :verbose, :type => :boolean
+  map "-v" => :version
+
+  CSVCLASSES = [
+    {:name => "CSV2Strings", :ext => ".strings"},
+    {:name => "CSV2Android", :ext => ".xml"},
+    {:name => "CSV2JSON", :ext => ".json"},
+    {:name => "CSV2Php", :ext => ".php"},
+  ]
+
+  CSVCLASSES.each do |klass|
+    desc "#{klass[:name].downcase}", "Convert CSV file to #{klass[:ext]}"
+    method_option :filename, :type => :string, :desc => "CSV file to convert from or name of file in Google Drive", :required => true
+    method_option :langs, :type => :hash, :aliases => "-L", :desc => "Languages to convert. i.e. English:en", :required => true
+
+    # optional options
+    method_option :excluded_states, :type => :array, :aliases => "-x", :desc => "Exclude rows with given state"
+    method_option :state_column, :type => :numeric, :aliases => "-s", :desc => "Position of column for state if any"
+    method_option :keys_column,  :type => :numeric, :aliases => "-k", :desc => "Position of column for keys"
+    method_option :default_lang, :type => :string, :aliases => "-l", :desc => "Default language to use for empty values if any"
+    method_option :default_path, :type => :string, :aliases => "-p", :desc => "Path of output files"
+    method_option :fetch, :type => :boolean, :desc => "Download file from Google Drive"
+    define_method("#{klass[:name].downcase}") do
+      csv2base(klass[:name])
+    end
+  end
+
+  BASECLASSES = [
+    {:name => "Strings2CSV", :ext => ".strings"},
+    {:name => "Android2CSV", :ext => ".xml"},
+    {:name => "JSON2CSV", :ext => ".json"},
+    {:name => "Php2CSV", :ext => ".php"},
+  ]
+
+  BASECLASSES.each do |klass|
+    desc "#{klass[:name].downcase}", "Convert #{klass[:ext]} files to CSV file"
+    method_option :filenames, :type => :array, :aliases => "-i", :desc => "location of strings files (FILENAMES)", :required => true
+
+    # optional options
+    method_option :csv_filename, :type => :string, :aliases => "-o", :desc => "location of output file"
+    method_option :headers, :type => :array, :aliases => "-h", :desc => "override headers of columns, default is name of input files and 'Variables' for reference"
+    method_option :dryrun, :type => :boolean, :aliases => "-n", :desc => "prints out content of hash without writing file"
+    define_method("#{klass[:name].downcase}") do
+      base2csv(klass[:name])
+    end
+  end
+
+  desc "csv_download", "Download Google Spreadsheet containing translations"
+  method_option :gd_filename, :type => :string, :required => :true, :desc => "File to download from Google Drive"
+  method_option :output_filename, :type => :string, :desc => "Filepath of downloaded file"
+  def csv_download
+    download(options['gd_filename'], options['output_filename'])
+  end
+
+  desc "version", "Display current version"
+  def version
+    require "babelish/version"
+    say "Babelish #{Babelish::VERSION}"
+  end
+
+  no_tasks do
+    def download(filename, output_filename = nil)
+      gd = Babelish::GoogleDoc.new
+      if output_filename
+        file_path = gd.download filename.to_s, output_filename
+      else
+        file_path = gd.download filename.to_s
+      end
+      if file_path
+        say "File '#{filename}' downloaded to '#{file_path}'"
+      else
+        say "Could not download the requested file: #{filename}"
+      end
+      file_path
+    end
+
+    def csv2base(classname)
+      args = options.dup
+      if options[:fetch]
+        say "Fetching csv file #{options[:filename]} from Google Drive"
+        filename = download(options[:filename])
+        abort unless filename # no file downloaded
+        args.delete(:fetch)
+      else
+        filename = options[:filename]
+      end
+      args.delete(:langs)
+      args.delete(:filename)
+
+      class_object = eval "Babelish::#{classname}"
+      converter = class_object.new(filename, options[:langs], args)
+      say converter.convert
+    end
+
+    def base2csv(classname)
+      class_object = eval "Babelish::#{classname}"
+      converter = class_object.new(options)
+
+      debug_values = converter.convert(!options[:dryrun])
+      say debug_values.inspect if options[:dryrun]
+    end
+  end
+
+  private
+  def options
+    original_options = super
+    return original_options unless File.exists?(".babelish")
+    defaults = ::YAML.load_file(".babelish") || {}
+    Thor::CoreExt::HashWithIndifferentAccess.new(defaults.merge(original_options))
+  end
+end

data/lib/babelish/csv2android.rb

@@ -0,0 +1,36 @@
+module Babelish
+  class CSV2Android < Csv2Base
+    require 'xmlsimple'
+
+    attr_accessor :file_path
+
+    def initialize(filename, langs, args = {})
+      super(filename, langs, args)
+
+      @file_path = args[:default_path].to_s
+    end
+
+    def language_filepaths(language)
+      require 'pathname'
+      filepath = Pathname.new(@file_path) + "values-#{language.code}" + "strings.xml"
+      return filepath ? [filepath] : []
+    end
+
+    def get_row_format(row_key, row_value)
+      return "\t<string name=\"#{row_key}\">#{row_value}</string>\n"
+    end
+
+    def hash_to_output(content = {})
+      output = ''
+      if content && content.size > 0
+        output += "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+        output += "<resources>\n"
+        content.each do |key, value|
+          output += get_row_format(key, value)
+        end
+        output += "</resources>"
+      end
+      return output
+    end
+  end
+end