c11n 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d6ddb9f33eac9ad392124d3d42bc094e5b0f2c4
+  data.tar.gz: fca0db5616d9ff41a3d8bbbfd873974293831179
+SHA512:
+  metadata.gz: fc1eceaa98d8982ce77098aa0010cb735d1905f5c3fd5fe234914013eaed133bd15ab95cb00a09f2461a8852b345a5753fa428eefc9edf7809d7d79051320e80
+  data.tar.gz: 3bded82ae6a10c8faa53ffef5f56981a168087f568884c73c2cb7905d5cd15d702f8afc89d0b21181e89d9b3f0682e8a277b6eb306b4d45b8931e2d4a61a62c4

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Inbeom Hwang
+
+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,52 @@
+# C11n
+
+C11n enables you to collaborate on i18n for your apps easily using Google
+Drive. It can upload locales in your project to Google Drive Spreadsheet and
+download contents from Google Drive Spreadsheet and modify your source files
+up to date.
+
+Default conventions for Rails/Android/iOS application projects are supported.
+
+## Installation
+
+C11n runs from command line. Install it via Rubygems as:
+
+    $ gem install c11n
+
+You may need to install additional libraries c11n depends on:
+
+    $ gem install nokogiri # for parsing XML files in Android projects
+
+## Usage
+
+You need to make your own configuration file for your projects. Example:
+
+    ---
+    :external:
+      :google_drive:
+        :email: [EMAIL ADDRESS OF YOUR GOOGLE ACCOUNT]
+        :password: [PASSWORD FOR YOUR GOOGLE ACCOUNT]
+        :spreadsheet_key: [KEY OF SPREADSHEET CONTAINS LOCALES FOR YOUR APPLICATION]
+        :worksheet_number: [0-BASED INDEX OF YOUR WORKSHEET]
+    :type: [TYPE OF YOUR PROJECT: android, ios, rails]
+    :root: [ROOT DIRECTORY OF YOUR PROJECT]
+    :default_locale: [DEFAULT LOCALE FOR YOUR PROJECT - ONLY FOR android]
+
+After writing configuration file, you can set up a spreadsheet for your project
+with `setup` task. You may skip this step if you have a spreadsheet already.
+
+    $ c11n -c [PATH TO CONFIG FILE] setup
+
+After setting up the spreadsheet, you can move your i18n dat to/from google
+drive using these commands:
+
+    $ c11n -c [PATH TO CONFIG FILE] push
+    $ c11n -c [PATH TO CONFIG FILE] pull
+
+## 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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/c11n

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'optparse'
+
+require 'c11n'
+require 'c11n/executable/runner'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: c11n [options]'
+
+  opts.on('-c', '--config [CONFIG_FILE]', 'Configuration file') do |config_file_path|
+    options[:config_file_path] = config_file_path
+  end
+end.parse!
+
+options[:task] = ARGV.shift
+
+C11n::Executable::Runner.new(options).run

data/c11n.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'c11n/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'c11n'
+  gem.version       = C11n::VERSION
+  gem.authors       = ['Inbeom Hwang']
+  gem.email         = ['hwanginbeom@gmail.com']
+  gem.description   = %q{Imports/exports i18n translations from/to Google Drive Spreadsheet for easier collaboration.}
+  gem.summary       = %q{Manage i18n for your projects using Google Drive.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'google_drive'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'nokogiri'
+end

data/lib/c11n.rb

@@ -0,0 +1,8 @@
+require 'c11n/version'
+require 'c11n/configuration'
+
+module C11n
+  def self.configure
+    yield C11n::Configuration.instance
+  end
+end

data/lib/c11n/configuration.rb

@@ -0,0 +1,72 @@
+module C11n
+  class Configuration
+    attr_reader :configurations, :externals
+
+    class NotConfigured < StandardError; end
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def initialize
+      @configurations = {}
+      @externals = {}
+    end
+
+    def external(klass)
+      if block_given?
+        yield(@externals[klass] ||= Configuration.new)
+
+        @externals[klass]
+      else
+        @externals[klass] || raise(NotConfigured.new)
+      end
+    end
+
+    def [](key)
+      @configurations[key]
+    end
+
+    def []=(key, value)
+      @configurations[key.to_sym] = value
+    end
+
+    def to_hash
+      @configurations
+    end
+
+    def method_missing(method_name, *args, &block)
+      if method_name =~ /(.+)=$/
+        @configurations[$1.to_sym] = args.first
+      elsif value = @configurations[method_name.to_sym]
+        value
+      else
+        super
+      end
+    end
+
+    def configure_with_hash(configurations)
+      configurations.each do |config_key, config_value|
+        @configurations[config_key.to_sym] = config_value
+      end
+    end
+
+    def load_from_hash(configurations)
+      load_external_configurations(configurations.delete(:external) || {})
+
+      configurations.each do |entry, configuration|
+        self[entry] = configuration
+      end
+    end
+
+    def load_external_configurations(externals)
+      externals.each do |external_entry, nested_configurations|
+        external(external_entry) do |external_config|
+          nested_configurations.each do |entry, configuration|
+            external_config[entry] = configuration
+          end
+        end
+      end
+    end
+  end
+end

data/lib/c11n/conversion/composed_key_deserializer.rb

@@ -0,0 +1,37 @@
+require 'c11n/translations'
+
+module C11n
+  module Conversion
+    # Deserializes translations in tabular form into Hash.
+    class ComposedKeyDeserializer
+      attr_accessor :table
+      attr_reader :translations
+
+      def initialize(table)
+        @table = table
+        @translations = {}
+      end
+
+      def deserialize
+        @table.each do |composed_key, value|
+          path = path_for(composed_key)
+          create_or_get_leaf_node_for(path)[path.last] = value
+        end
+
+        @translations
+      end
+
+      def create_or_get_leaf_node_for(path)
+        path[0..-2].inject(@translations) do |node, path_component|
+          node[path_component] ||= {}
+        end
+      end
+
+      private
+
+      def path_for(key)
+        key.split('.').map(&:to_sym)
+      end
+    end
+  end
+end

data/lib/c11n/conversion/plain_deserializer.rb

@@ -0,0 +1,21 @@
+module C11n
+  module Conversion
+    class PlainDeserializer
+      attr_accessor :table
+      attr_reader :translations
+
+      def initialize(table)
+        @table = table
+        @translations = {}
+      end
+
+      def deserialize
+        @table.each do |key, value|
+          @translations[key] = value
+        end
+
+        @translations
+      end
+    end
+  end
+end

data/lib/c11n/conversion/serializer.rb

@@ -0,0 +1,51 @@
+module C11n
+  module Conversion
+    class Serializer
+
+      class Pair
+        attr_accessor :key, :value
+
+        def initialize(key, value)
+          @key = key
+          @value = value
+        end
+
+        def to_a
+          [@key, @value]
+        end
+
+        def ==(another)
+          another.key == @key && another.value == @value
+        end
+      end
+
+      attr_accessor :translations
+      attr_reader :table
+
+      def initialize(translations)
+        @translations = translations
+        @table = nil
+      end
+
+      def serialize
+        @table ||= Hash[serialized_translations_for('', @translations).map(&:to_a)]
+      end
+
+      private
+
+      def serialized_translations_for(prefix, translations)
+        translations.map do |key, value|
+          if value.is_a?(Hash)
+            serialized_translations_for(child_prefix_for(prefix, key), value)
+          else
+            Pair.new(child_prefix_for(prefix, key), value)
+          end
+        end.flatten
+      end
+
+      def child_prefix_for(prefix, key)
+        prefix.empty? ? key : "#{prefix}.#{key}"
+      end
+    end
+  end
+end

data/lib/c11n/executable/runner.rb

@@ -0,0 +1,43 @@
+require 'c11n/translations'
+require 'c11n/synchronizer'
+
+module C11n
+  module Executable
+    class Runner
+      def initialize(options = {})
+        @options = options
+      end
+
+      def run
+        load_config_file
+
+        case task
+        when 'push'
+          synchronizer.upload
+        when 'pull'
+          synchronizer.download
+        when 'setup'
+          synchronizer.setup
+        end
+      end
+
+      def task
+        @options[:task]
+      end
+
+      def config_hash
+        if @options[:config_file_path]
+          @config_hash ||= YAML.load(File.open(@options[:config_file_path]).read)
+        end
+      end
+
+      def load_config_file
+        C11n::Configuration.instance.load_from_hash(config_hash) if config_hash
+      end
+
+      def synchronizer
+        C11n::Synchronizer.new(configuration: C11n::Configuration.instance)
+      end
+    end
+  end
+end

data/lib/c11n/exporter/android.rb

@@ -0,0 +1,41 @@
+require 'nokogiri'
+require 'c11n/types'
+
+module C11n
+  module Exporter
+    class Android
+      def initialize(options = {})
+        @path = options[:path]
+      end
+
+      def file
+        @file ||= File.new(@path, 'w')
+      end
+
+      def export(translations, locale)
+        builder = Nokogiri::XML::Builder.new(encoding: 'utf-8')
+        types = translations.types
+
+        root_node = builder.resources do |xml|
+          translations.translations_for(locale).each do |key, translation|
+            case types[key]
+            when C11n::Types::ARRAY
+              xml.send(:'string-array') do
+                translation.each do |item|
+                  xml.item item
+                end
+              end
+            when C11n::Types::CDATA
+              xml.string { xml.cdata translation }
+            else
+              xml.string translation
+            end['name'] = key
+          end
+        end
+
+        file.print builder.to_xml
+        file.close
+      end
+    end
+  end
+end