aigu 0.3.1 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b973b5aa391a17f4dc4d001e5a8ab7e0a286b32
-  data.tar.gz: 6d38f76e465218a22923333650a7e30650a27c14
+  metadata.gz: 1891efbb20cc81f439f20f30fb4d74586e09c2c9
+  data.tar.gz: 2715fb01c3d8f203c791ffc55357469b077ad793
 SHA512:
-  metadata.gz: 22e775bce2767935d0a5f260dd1f8e7a7ca4d6eea1dce18a6c2bff6ca4dfde13fe2b4711cd38bb7f828ec4041b62a4f0b361ca4ecf3616cf51d486a580697d63
-  data.tar.gz: 07c4cb7b0708431a4a38f3c399451121ee8f8c8287a16ca980a6ff80ea5f2c0f70f6a307d5d7295fda0d9b2b5fbfaa79cf03dce3355d09495ccab615b711378a
+  metadata.gz: 83421bf2129630b61d54543cfa484963415151301c345fd624febb67d65de937a45634173c54fb3017c5a3c3a3f95f3ab92ce1f814b147c99a560336f675f390
+  data.tar.gz: 3a60ed45b7ee4764a8b809cb297e8a9b9a7bfa395ae683cd335009308b189a8bb56039e39e099abee88c5a637a3e1f9ac635b10bf575b5c40bdfc32b33b562ab

data/.rubocop.yml

@@ -0,0 +1,52 @@
+AllCops:
+  Include:
+    - Rakefile
+  Exclude:
+    - bin/phare
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 20
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+ClassLength:
+  Enabled: false

data/README.md

@@ -1,8 +1,16 @@
 ## Introduction
 
-Aigu processes Rails YAML localization files and generates a single JSON file
-that can be imported into the Accent service. It can also process a JSON file
-generated by Accent and convert it back to multiple YAML files.
+Aigu is a set of utility to process localization files to genarate JSON files
+to push to Accent service. Pulling from Accent to update localization files
+is also supported.
+
+The following localization file formats are supported: Rails YAML, Android
+XML, Java Enum Core, iOS strings and stringsdict.
+
+Merge and unmerge commands allows to merge different source files into a
+single JSON file to send as a single Accent project.
+
+Push and pull can be used to interact directly with Accent.
 
 ## Installation
 
@@ -36,6 +44,13 @@ $ aigu export --locale=fr --input-directory=config/locales --output-file=my-proj
 | `output-file`     | The path to the JSON file that will be written by `aigu`                                                                  |
 | `ignore`          | The patterns `aigu` will use to skip ignored files (eg. `routes.yml`)
 
+| Command			| File format											|
+|-------------------|-------------------------------------------------------|
+| `export`			| Rails YAML											|
+| `andoird_export`  | Android XML											|
+| `core_export`		| Java Enum Core										|
+| `ios_export`		| iOS strings & stringsdict								|
+
 ### Importing the JSON file from Accent
 
 The `import` command takes a generated JSON file from Accent and generates
@@ -53,10 +68,67 @@ $ aigu import --locale=fr --input-file=file-from-accent.json --output-directory=
 | `input-file`       | The path to the Accent-generated JSON file                                                        |
 | `output-directory` | The directory where the localization YAML files will be generated                                 |
 
-### Using `aigu.yml`
+| Command			| File format											|
+|-------------------|-------------------------------------------------------|
+| `import`			| Rails YAML											|
+| `andoird_import`  | Android XML											|
+| `core_import`		| Java Enum Core										|
+| `ios_import`		| iOS strings & stringsdict								|
+
+### Merge
+
+The `merge` command will combine several JSON file into a single one to send into a single Accent project. It will prefix keys with
+a pattern embedding the filename to allow later unmerging. It works from an input directory, mergin all json files in it.
+A file can be named `default.json` to avoid prefixes in the resulting json.
+
+#### Options
+
+| Option             | Description                                                                                       |
+|--------------------|---------------------------------------------------------------------------------------------------|
+| `input-directory`  | The directory containing json files to merge                                                      |
+| `output-file`      | The path to the JSON file that will be written to                                                 |
+
+
+### Unmerge
+
+The `unmerge` will split the Accent JSON file into several json files, for further processing. It will look for the prefix pattern
+of the merge command and will extract the filename or use default.json if pattern is not found.
+
+#### Options
+
+| Option             | Description                                                                                       |
+|--------------------|---------------------------------------------------------------------------------------------------|
+| `input-file`       | The path to the Accent-generated JSON file                                                        |
+| `output-directory` | The directory where the unmerged files will be written			                                 |
+
+### Sending to Accent
+
+The `push` command takes a JSON file exported by Aigu and send it to Accent
+
+#### Options
+
+| Option             | Description                                                                                       |
+|--------------------|---------------------------------------------------------------------------------------------------|
+| `input-file`       | The path to the Aigu-generated JSON file                                                          |
+| `accent-api-key`   | The API key of the Accent project. (See project config in Accent)                                 |
+| `accent-url`       | The URL to the instance of Accent to use (Prod: http://accent.mirego.com, QA: https://mirego-accent-qa.herokuapp.com ) |
+
+### Pulling from Accent
+
+The `pull` command GET the Accent generated JSON file
+
+#### Options
+
+| Option             | Description                                                                                       |
+|--------------------|---------------------------------------------------------------------------------------------------|
+| `output-file`      | The path to write the Accent JSON file to                                                         |
+| `accent-api-key`   | The API key of the Accent project. (See project config in Accent)                                 |
+| `accent-url`       | The URL to the instance of Accent to use (Prod: http://accent.mirego.com, QA: https://mirego-accent-qa.herokuapp.com ) |
+
+### Using `.aigu.yml`
 
 Instead of using command-line arguments when running the `aigu` command, you
-can create a `aigu.yml` file at the root of your project and hard-code options
+can create a `.aigu.yml` file at the root of your project and hard-code options
 in that file.
 
 ```yaml
@@ -67,6 +139,18 @@ output-directory: config/locales
 input-directory: config/locales
 ```
 
+## Contributing
+
+We’re using `phare` to make sure all Ruby code adheres to our coding style
+guide. The best way to use `phare` is as a pre-commit hook:
+
+```bash
+$ ln -s "`pwd`/bin/phare" .git/hooks/pre-commit
+```
+
+That way, whenever `git commit` is ran, `phare` will be executed and will abort
+the commit if there are errors.
+
 ## License
 
 `Aigu` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/aigu/blob/master/LICENSE.md) file.

data/Rakefile

@@ -12,7 +12,7 @@ end
 
 desc 'Start an IRB session with the gem'
 task :console do
-  $:.unshift File.expand_path('..', __FILE__)
+  $LOAD_PATH.unshift File.expand_path('..', __FILE__)
   require 'aigu'
   require 'irb'
 

data/aigu.gemspec

@@ -6,19 +6,22 @@ require 'aigu/version'
 Gem::Specification.new do |spec|
   spec.name          = 'aigu'
   spec.version       = Aigu::VERSION
-  spec.authors       = ['Rémi Prévost']
-  spec.email         = ['rprevost@mirego.com']
+  spec.authors       = ['Rémi Prévost', 'William Jobin']
+  spec.email         = ['rprevost@mirego.com', 'wjobin@mirego.com']
   spec.description   = 'Aigu converts a directory of Rails localization files into a single JSON file to import in Accent.'
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/mirego/aigu'
   spec.license       = 'BSD 3-Clause'
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = 'aigu'
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0.0.beta2'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'phare', '~> 0.6'
+  spec.add_development_dependency 'rubocop', '~> 0.27.0'
+  spec.add_development_dependency 'nokogiri', '~> 1.6.3'
 end

data/bin/aigu

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
 
 require 'aigu'
 

data/bin/phare

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'phare' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('phare', 'phare')

data/lib/aigu.rb

@@ -4,11 +4,22 @@ require 'optparse'
 require 'fileutils'
 require 'json'
 require 'yaml'
+require 'nokogiri'
 
 require 'aigu/extensions/hash'
 require 'aigu/cli'
 require 'aigu/importer'
 require 'aigu/exporter'
+require 'aigu/android_exporter'
+require 'aigu/android_importer'
+require 'aigu/core_exporter'
+require 'aigu/core_importer'
+require 'aigu/ios_exporter'
+require 'aigu/ios_importer'
+require 'aigu/unmergeer'
+require 'aigu/mergeer'
+require 'aigu/puller'
+require 'aigu/pusher'
 
 module Aigu
 end

data/lib/aigu/android_exporter.rb

@@ -0,0 +1,165 @@
+module Aigu
+  class AndroidExporter
+    def initialize(opts = {})
+      @output_file = opts[:'output-file']
+      @input_directory = opts[:'input-directory']
+      @locale = opts[:locale]
+      @ignore = opts[:ignore]
+    end
+
+    def process!
+      puts "Generating Accent JSON file `#{@output_file}` based on Android resources files in `#{@input_directory}` directory"
+
+      if @ignore
+        print 'Ignoring '
+        puts @ignore.join(', ')
+      end
+
+      puts '---'
+
+      build_output
+      write_json_file
+
+      puts '---'
+      puts 'Done'
+    end
+
+  protected
+
+    def build_output
+      @output = {}
+
+      pattern = File.join(@input_directory, '*', 'strings.xml')
+      Dir[pattern].each do |filepath|
+        next unless supported_resource_for_language?(filepath, @locale)
+
+        if ignored_filepath?(filepath)
+          puts "Ignoring #{filepath}"
+        else
+          puts "Processing #{filepath}"
+
+          _, _, qualifiers = get_resource_type(filepath)
+          puts "Qualifiers: #{qualifiers}"
+
+          content = File.open(filepath, 'r:bom|utf-8').read
+          base_key = qualifiers
+
+          content = parse_xml(content, base_key)
+          @output.merge! content
+        end
+      end
+
+      @output
+    end
+
+    def write_json_file
+      file_path = @output_file
+      puts "Generating #{file_path}"
+      FileUtils.mkdir_p(File.dirname(file_path))
+
+      File.open(file_path, 'w+') do |file|
+        file << JSON.pretty_generate(JSON.parse(@output.to_json))
+      end
+    end
+
+    def sanitize_value_to_string(value)
+      case value
+        when true
+          '___TRUE___'
+        when false
+          '___FALSE___'
+        when nil
+          '___NULL___'
+        else
+          value
+      end
+    end
+
+    def parse_xml(xml, base_key = '')
+      xml = cleanup_input_xml(xml)
+      doc = Nokogiri::XML(xml) { |config| config.options = Nokogiri::XML::ParseOptions::RECOVER }
+      resources = doc.root.children
+      string_hash = {}
+
+      resources.each do |node|
+        if node.name == 'string'
+          string_hash.merge!(hash_for_key_value(node['name'], node.content, base_key))
+        elsif node.name == 'string-array'
+          resource_string_prefix = node['name'] + '__ARRAY_ITEM__#'
+
+          item_index = 0
+          node.children.each do |array_item|
+            next unless array_item.name == 'item'
+
+            hash = hash_for_key_value("#{resource_string_prefix}#{item_index}", array_item.content, base_key)
+            string_hash.merge! hash
+
+            item_index += 1
+          end
+        end
+      end
+
+      string_hash
+    end
+
+    def build_key_name(key_name, base_key)
+      base_key.empty? ? key_name : "#{key_name}__@TYPE_#{base_key}"
+    end
+
+    def hash_for_key_value(key, value, base_key)
+      { build_key_name(key, base_key) => value }
+    end
+
+    # Try to fix issue
+    def cleanup_input_xml(xml)
+      replace_html_name(xml, 'quot', '"')
+      replace_html_name(xml, 'amp', '&')
+      replace_html_name(xml, 'apos', "'")
+      replace_html_name(xml, 'lt', '<')
+      replace_html_name(xml, 'gt', '>')
+      xml
+    end
+
+    def replace_html_name(xml, html_name, character)
+      replace_string = "&##{character.ord};"
+      xml.gsub!(/&#{html_name};/, replace_string)
+    end
+
+    # Parse out resource meta from filename
+    # Assumes first qualifer is locale if 2 chars
+    def get_resource_type(filepath)
+      filepath_parts = filepath.split(File::SEPARATOR)
+      filepath = filepath_parts[-2]
+
+      resource_qualifiers = filepath.split('-')
+
+      resource_type, first_qualifier = resource_qualifiers
+
+      first_qualifier_is_locale = !first_qualifier || (first_qualifier.length == 2)
+
+      if first_qualifier_is_locale
+        resource_qualifiers.shift(2)
+        locale = first_qualifier
+      else
+        resource_qualifiers.shift(1)
+        locale = nil
+      end
+
+      [resource_type, locale, resource_qualifiers.join(' ')]
+    end
+
+    def supported_resource_for_language?(filepath, expected_locale)
+      _, locale = get_resource_type(filepath)
+      expected_locale == locale
+    end
+
+    def ignored_filepath?(filepath)
+      @ignore && @ignore.any? do |pattern|
+        File.fnmatch(pattern, filepath, File::FNM_PATHNAME | File::FNM_DOTMATCH)
+      end
+
+      _, locale = get_resource_type(filepath)
+      !(@locale == locale)
+    end
+  end
+end

data/lib/aigu/android_importer.rb

@@ -0,0 +1,130 @@
+module Aigu
+  class AndroidImporter
+    ARRAY_REGEX = /__ARRAY_ITEM__#(?<index>\d+)$/
+    TYPE_REGEX = /__@TYPE_(?<type_key>.+)$/
+
+    def initialize(opts = {})
+      @input_file = opts[:'input-file']
+      @output_directory = opts[:'output-directory']
+      @locale = opts[:locale]
+    end
+
+    def process!
+      puts "Generating Android XML files in `#{@output_directory}` based on Accent-generated `#{@input_file}` file"
+      puts '---'
+
+      parse_json
+      @blob = split_res_types(@object)
+      write_xml_files
+
+      puts '---'
+      puts 'Done'
+    end
+
+  protected
+
+    def parse_json
+      json = File.read(@input_file)
+      @object = JSON.parse(json)
+      @object = expand_content_values(@object)
+    end
+
+    def write_xml_files
+      @blob.each_pair do |type, hash|
+        # TODO: add locale to filename
+        qualifier = type.gsub(/_/, '-')
+        if qualifier != ''
+          qualifier.prepend('-')
+        end
+        if @locale
+          language = '-' + @locale
+        else
+          language = ''
+        end
+
+        file_path = File.join(@output_directory, "values#{language}#{qualifier}", 'strings.xml')
+        puts "Generating #{file_path}"
+        FileUtils.mkdir_p(File.dirname(file_path))
+
+        File.open(file_path, 'w+:bom|utf-8') do |file|
+          file << res_to_xml(hash)
+        end
+      end
+    end
+
+    # TODO: Use XML tooling
+    def res_to_xml(content)
+      xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
+      xml << "<resources>\n"
+
+      content.each_pair do |key, value|
+        if value.is_a?(Array)
+          xml << '    <string-array name=' << key.encode(xml: :attr) << ">\n"
+          value.each do |item|
+            xml << '        <item>' << item.encode(xml: :text) << "</item>\n"
+          end
+          xml << "    </string-array>\n"
+        elsif value.is_a?(String)
+          xml << '    <string name=' << key.encode(xml: :attr) << '>' << value.encode(xml: :text) << "</string>\n"
+        end
+      end
+
+      xml << "</resources>\n"
+      xml
+    end
+
+    def localize_content_keys(content)
+      content.reduce({}) do |memo, (key, value)|
+        localized_key = key.gsub(/^([^|]+)\|/, "\\1.#{@locale}|#{@locale}.")
+        memo.merge localized_key => value
+      end
+    end
+
+    def expand_content_values(content)
+      content.each_with_object({}) do |(key, value), memo|
+        match_data = key.match(ARRAY_REGEX)
+
+        if match_data
+          canonical_key = key.gsub(ARRAY_REGEX, '')
+          value_index = match_data[:index].to_i
+          memo[canonical_key] ||= []
+          memo[canonical_key][value_index] = sanitize_string_to_value(value)
+        else
+          memo[key] = sanitize_string_to_value(value)
+        end
+      end
+    end
+
+    def split_res_types(content)
+      res_types = {}
+
+      content.each_pair do |key, value|
+        match_data = key.match(TYPE_REGEX)
+        if match_data
+          canonical_key = key.gsub(TYPE_REGEX, '')
+          res_type = match_data[:type_key]
+        else
+          canonical_key = key
+          res_type = ''
+        end
+        res_types[res_type] ||= {}
+        res_types[res_type][canonical_key] = value
+      end
+
+      res_types
+    end
+
+    def sanitize_string_to_value(string)
+      case string
+        when '___TRUE___'
+          true
+        when '___FALSE___'
+          false
+        when '___NULL___'
+          nil
+        else
+          string
+      end
+    end
+  end
+end