phraseapp_android 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1bfba10c4b6cbe4cdcebe6b43238b0f5831aee6
+  data.tar.gz: 04b26134b3a91b71167c0faca54154e1e023caaa
+SHA512:
+  metadata.gz: 57e1cf5c6bebf15704a1814ead25ee5892a07a9d5d95dfe8487c804aebda8f9925ba80b2c9588676aabd849197bb01c7d8d7768f338d94112c128e4929117f3d
+  data.tar.gz: ccc4b1ea8f4eff82714bd367e4dccdaa38ab976e646e41bf4b7885f28af456e34f022d53a28d18c5d8701c6ef6c023d984bf1ecf86b99fa227ef29986c51a0af

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anjlab
+
+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,30 @@
+# PhraseappAndroid
+
+This gem is intended to make managing PhraseApp translations in Android projects much easier.
+
+## Installation
+
+    $ gem install phraseapp_android
+
+## Usage
+
+    $ ./phrase_app_translations COMMAND
+
+Commands:
+
+    list_missing        List missing translations
+    pull                Download translations from PhraseApp
+    push                Upload translations to PhraseApp
+    reformat            Sort translations texts alphabetically in local files
+    check_formatting    Check formatting arguments in local files
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anjlab/phraseapp_android. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'phraseapp_android'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/phrase_app_translations

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'phraseapp_android'
+
+unless ENV['PHRASE_ACCESS_TOKEN']
+  puts 'you have\'nt set PHRASE_ACCESS_TOKEN environment variable! You can create access token at https://phraseapp.com/settings/oauth_access_tokens'.red
+  exit 1
+end
+
+unless ENV['PHRASE_PROJECT_ID']
+  puts 'you have\'nt set PHRASE_PROJECT_ID environment variable! You find your Project Id at https://phraseapp.com/projects'.red
+  exit 1
+end
+
+if ARGV.empty?
+  puts <<END_TEXT
+Usage phrase_app_translations COMMAND
+
+Manage Android project localization data with PhraseApp
+
+Commands:
+  list_missing        List missing translations
+  pull                Download translations from PhraseApp
+  push                Upload translations to PhraseApp
+  reformat            Sort translations texts alphabetically in local files
+  check_formatting    Check formatting arguments in local files
+END_TEXT
+else
+  case ARGV[0].downcase
+    when 'list_missing'
+      PhraseApp::Android::MissingTranslations.new.list
+    when 'pull'
+      PhraseApp::Android::MissingTranslations.new.pull
+    when 'push'
+      PhraseApp::Android::Upload.new.perform ARGV[1] || 'en'
+    when 'reformat'
+      PhraseApp::Android::FileFormatter.new.apply_to_all_files
+    when 'check_formatting'
+      PhraseApp::Android::FormatCheck.new.perform
+    else
+      puts 'Unknown command!'.red
+  end
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/phraseapp_android/file_formatter.rb

@@ -0,0 +1,68 @@
+require_relative './phrase_app_client'
+
+class PhraseApp::Android::FileFormatter < PhraseApp::Android::PhraseAppClient
+
+  def apply(file_name, locale)
+    doc = read_locale_file file_name, locale
+    formatted = apply_to_xml_doc doc
+    File.write locale_file_name(file_name, locale), formatted
+  end
+
+  def apply_to_xml_doc(doc)
+    data = {}
+    ignore_keys = []
+
+    match_elements doc, 'integer-array', data, ignore_keys
+    match_elements doc, 'string-array', data, ignore_keys
+    match_elements doc, 'string', data, ignore_keys
+
+    last_name = nil
+    builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+      xml.resources('xmlns:tools' => 'http://schemas.android.com/tools') do
+        data.keys.sort.each do |k|
+          name = k.split('_').first.to_s
+
+          if last_name != name
+            xml.comment " #{name} * "
+            last_name = name
+          end
+
+          attrs = {name: k}
+          attrs['tools:ignore'] = 'MissingTranslation' if ignore_keys.include? k
+
+          xml.send data[k][:name], attrs do
+            if data[k][:name].end_with?('array')
+              data[k][:value].each do |t|
+                xml.item t
+              end
+            else
+              xml.text data[k][:value]
+            end
+          end
+        end
+      end
+    end
+
+    builder.to_xml indent: 4
+  end
+
+  def apply_to_all_files
+    count = 0
+    ([nil] + locales).each do |locale|
+      apply 'strings', locale
+      apply 'arrays', locale
+      count += 2
+    end
+    puts "#{count} files were reformatted.".green
+  end
+
+  private
+
+  def match_elements(doc, node_name, data, ignore_keys)
+    doc.at('//resources').search(node_name).each do |string|
+      data[string.attr('name')] = {name: string.name, value: node_name.end_with?('array') ? string.search('item').map(&:text) : string.text}
+      ignore_keys << string.attr('name') if string.attr('tools:ignore')
+    end
+  end
+
+end

data/lib/phraseapp_android/format_check.rb

@@ -0,0 +1,51 @@
+require_relative './phrase_app_client'
+
+class PhraseApp::Android::FormatCheck < PhraseApp::Android::PhraseAppClient
+
+  attr_accessor :keys
+
+  def initialize(options = {})
+    super(options)
+
+    self.keys = xml_strings_to_hash 'strings', nil
+  end
+
+  def perform
+    locales.map { |l| perform_for_locale(l) }.reduce(:+)
+  end
+
+  def perform_for_locale(locale)
+    data = xml_strings_to_hash 'strings', locale
+    count = 0
+
+    keys.each do |name, value|
+      formatters = value.scan /(%[\d$a-z]+)/i
+      count += 1 if formatters && !check_formatters(locale, data, name, formatters)
+    end
+
+    count
+  end
+
+  private
+
+  def xml_strings_to_hash(file_name, locale)
+    string_keys = {}
+    read_locale_file(file_name, locale).at('//resources').search('string').each do |string|
+      string_keys[string.attr('name')] = string.text
+    end
+    string_keys
+  end
+
+  def check_formatters(locale, locale_data, name, sample_formatters)
+    localized_key = locale_data[name]
+    if localized_key
+      sw_formatters = localized_key.scan /(%[\d$a-z]+)/i
+      if sample_formatters.sort != sw_formatters.sort
+        puts ('%s: Arguments mismatch for %s' % [locale, name]).red
+        return false
+      end
+    end
+    true
+  end
+
+end

data/lib/phraseapp_android/missing_translations.rb

@@ -0,0 +1,107 @@
+require_relative './phrase_app_client'
+
+class PhraseApp::Android::MissingTranslations < PhraseApp::Android::PhraseAppClient
+
+  def list
+    count = 0
+    locales.each do |locale|
+      missing = find locale
+      if missing.size > 0
+        puts "Missing translations for #{locale.upcase} locale:".red
+        missing.each { |s| puts s.to_s.yellow }
+        count += missing.size
+      end
+    end
+    puts 'No missing translations found.'.green if count == 0
+  end
+
+  def find(locale)
+    list = []
+
+    default_strings, default_arrays = load_locale_files nil
+    localized_strings, localized_arrays = load_locale_files locale
+
+    default_strings.each do |name, el|
+      list << el unless localized_strings.has_key?(name)
+    end
+
+    default_arrays.each do |name, el|
+      list << el if !localized_arrays.has_key?(name) || el.search('item').size != localized_arrays[name].search('item').size
+    end
+
+    list
+  end
+
+  def pull
+    locales.each do |locale|
+      pull_locale locale
+    end
+  end
+
+  def pull_locale(locale)
+    strings_updated = 0
+    arrays_updated = 0
+    missing = find locale
+    if missing.size > 0
+      strings = read_locale_file 'strings', locale
+      arrays = read_locale_file 'arrays', locale
+
+      params = PhraseApp::RequestParams::LocaleDownloadParams.new file_format: 'xml'
+      doc = Nokogiri::XML client.locale_download(project_id, locale, params)
+
+      missing.each do |el|
+        name = el.attr 'name'
+        translated = doc.at('//resources').search("#{el.name}[@name=#{name}]").first
+        if translated
+          if el.name == 'string'
+            str = Nokogiri::XML::Node.new 'string', strings
+            str['name'] = name
+            str.content = translated.text
+            strings.at('//resources').children.last.after str
+            strings_updated += 1
+          elsif el.name == 'string-array'
+            str = Nokogiri::XML::Node.new 'string-array', arrays
+            str['name'] = name
+            translated.element_children.each do |child|
+              item = Nokogiri::XML::Node.new 'item', arrays
+              item.content = child.text
+              str.add_child item
+            end
+            arrays.at('//resources').children.last.after str
+            arrays_updated += 1
+          end
+        end
+      end
+
+      if strings_updated + arrays_updated > 0
+        PhraseApp::Android::FileFormatter.new.apply('strings', locale) if strings_updated > 0
+        PhraseApp::Android::FileFormatter.new.apply('arrays', locale) if arrays_updated > 0
+        puts "#{strings_updated + arrays_updated} translation keys were updated.".green
+      else
+        puts 'no keys were updated.'.yellow
+      end
+    end
+
+    [strings_updated, arrays_updated]
+  end
+
+  private
+
+  def load_locale_files(locale)
+    strings = {}
+    arrays = {}
+
+    %w(strings arrays).each do |file|
+      doc = read_locale_file(file, locale).at('//resources')
+      doc.search('string').each do |str|
+        strings[str.attr('name')] = str unless str.attr('tools:ignore')
+      end
+      doc.search('string-array').each do |array|
+        arrays[array.attr('name')] = array unless array.attr('tools:ignore')
+      end
+    end
+
+    [strings, arrays]
+  end
+
+end

data/lib/phraseapp_android/phrase_app_client.rb

@@ -0,0 +1,59 @@
+require 'phraseapp-ruby'
+require 'nokogiri'
+require 'colorize'
+
+module PhraseApp
+
+  module Android
+
+    class PhraseAppClient
+
+      attr_accessor :client, :project_id, :locale_files, :locales, :sub_path
+
+      def initialize(options = {})
+        credentials = PhraseApp::Auth::Credentials.new token: (options[:token] || ENV['PHRASE_ACCESS_TOKEN'])
+        self.client = PhraseApp::Client.new credentials
+        self.project_id = options[:project_id] || ENV['PHRASE_PROJECT_ID']
+        self.sub_path = options[:path]
+        find_locales
+      end
+
+      def read_xml_file(file_name)
+        if file_name
+          f = File.open file_name
+          doc = Nokogiri::XML f
+          f.close
+          doc
+        end
+      end
+
+      def read_locale_file(file_name, locale)
+        read_xml_file locale_file_name(file_name, locale)
+      end
+
+      def locale_file_name(file_name, locale)
+        locale = '-' + locale unless locale.nil?
+        locale_files.find { |f| f.end_with?("values#{locale}/#{file_name}.xml") }
+      end
+
+      protected
+
+      def find_locales
+        self.locale_files = Dir.glob("#{sub_path}**/main/res/values*/{strings,arrays}.xml")
+        self.locales = locale_files
+                           .map { |file| file.match(/res\/values[-]*([a-z]+)?\//i)[1] }
+                           .compact
+                           .uniq
+      end
+
+      def write_xml_to_file(path, doc)
+        File.open path, 'w' do |f|
+          f.write doc.to_xml(ident: 4)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/phraseapp_android/upload.rb

@@ -0,0 +1,39 @@
+require_relative './phrase_app_client'
+require 'tempfile'
+
+class PhraseApp::Android::Upload < PhraseApp::Android::PhraseAppClient
+
+  def perform(locale = 'en')
+    file = build_upload_file
+
+    params = PhraseApp::RequestParams::UploadParams.new file: file.path, file_format: 'xml', locale_id: locale
+    upload = client.upload_create project_id, params
+
+    puts 'Successfully uploaded.'.green
+    file.unlink
+
+    upload
+  end
+
+  def build_upload_file
+    tmp = Tempfile.new %w(translations .xml)
+
+    doc = Nokogiri::XML::Document.new
+    doc.encoding = 'utf-8'
+    res = doc.create_element 'resources', 'xmlns:tools' => 'http://schemas.android.com/tools'
+    doc.add_child res
+
+    locales.each do |locale|
+      %w(strings arrays).each do |file|
+        read_locale_file(file, locale).at('//resources').element_children.each do |el|
+          res.add_child(el) if el.attr('tools:ignore').nil?
+        end
+      end
+    end
+
+    tmp.write doc.to_xml(indent: 4)
+    tmp.close
+    tmp
+  end
+
+end

data/lib/phraseapp_android/version.rb

@@ -0,0 +1,3 @@
+module PhraseappAndroid
+  VERSION = '0.1.0'
+end

data/lib/phraseapp_android.rb

@@ -0,0 +1,10 @@
+require 'phraseapp_android/version'
+require 'phraseapp_android/format_check'
+require 'phraseapp_android/upload'
+require 'phraseapp_android/missing_translations'
+require 'phraseapp_android/file_formatter'
+require 'phraseapp_android/phrase_app_client'
+
+module PhraseappAndroid
+  # Your code goes here...
+end

data/phraseapp_android.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phraseapp_android/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'phraseapp_android'
+  spec.version       = PhraseappAndroid::VERSION
+  spec.authors       = ['Sergey Glukhov (serggl)']
+  spec.email         = ['sergey.glukhov@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Manage Android localization data with PhraseApp'
+  spec.description   = 'This gem is intended to make managing PhraseApp translations in Android projects much easier.'
+  spec.homepage      = "https://github.com/anjlab/phraseapp_android"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   << 'phrase_app_translations'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'phraseapp-ruby', '~> 1.2'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+  spec.add_runtime_dependency 'colorize', '~> 0.7'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: phraseapp_android
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Glukhov (serggl)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: phraseapp-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: This gem is intended to make managing PhraseApp translations in Android
+  projects much easier.
+email:
+- sergey.glukhov@gmail.com
+executables:
+- phrase_app_translations
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/phrase_app_translations
+- bin/setup
+- lib/phraseapp_android.rb
+- lib/phraseapp_android/file_formatter.rb
+- lib/phraseapp_android/format_check.rb
+- lib/phraseapp_android/missing_translations.rb
+- lib/phraseapp_android/phrase_app_client.rb
+- lib/phraseapp_android/upload.rb
+- lib/phraseapp_android/version.rb
+- phraseapp_android.gemspec
+homepage: https://github.com/anjlab/phraseapp_android
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Manage Android localization data with PhraseApp
+test_files: []