aigu 0.7 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 616ab0c8f167d1882b848067e0f431300ae11e8b
-  data.tar.gz: eabdfe2a5a75e12e6aab5c86e4da964f09609d56
+  metadata.gz: f139727dc870d7af72ca5a7158f82b862ab845d0
+  data.tar.gz: e08a5d627d246fc8a683e10bca1b0d92c6c3255d
 SHA512:
-  metadata.gz: 1deffeb18fa97f7e6351e106d8271da63aa67c19a65254e69757d7605fa445ba1e4bb501b4f04d67ddb561f96fc964be5db5ff5c964187a933713bfa47a688d0
-  data.tar.gz: 8efe81cf8c5ce9d153d098681117f98eb010d264619c84d0ac7fae9d34aa45e78cf50b5a3ad52cea4eec0d5eda2c23c73c637b76c6b6dac2abd6a9c1072e27c8
+  metadata.gz: 408822e9bbe23a275efa973102e9ee0dbbeface4f27c9483b80632b7f367cef9a9cd1acb249de36c905bd6499fc0e5e6b9b2491d8dbbc3b96efcaf30fdaa9ac3
+  data.tar.gz: 93567c83ec12858ab34e243887f8b711f03d597f596d83531bcc5c8bb17b7f5d5a5e6944ad400552ed2cdcefe2f972649641167cf7a76e041c9e3c9933729cf8

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 
 rvm:
+  - 2.4.0
+  - 2.3.3
   - 2.2
 
 sudo: false

data/README.md

@@ -1,16 +1,8 @@
 ## Introduction
 
-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 and Ember JavaScript.
-
-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.
+Aigu is a set of utility to process localization files to generate JSON files
+to send to Accent as well as taking JSON files from Accent and convert them
+back to localization files.
 
 ## Installation
 
@@ -34,24 +26,25 @@ This file will then be compatible with Accent.
 ```bash
 $ aigu <export-command> --locale=fr --input-directory=config/locales --output-file=my-project.json
 ```
+#### Commands
+
+| Command            | File format               |
+|--------------------|---------------------------|
+| `rails-export`     | Rails YAML                |
+| `android-export`   | Android XML               |
+| `core-export`      | Java Enum Core            |
+| `ios-export`       | iOS strings & stringsdict |
+| `ember-export`     | Ember.js JavaScript       |
+| `ember-pod-export` | Ember.js pods JSON        |
 
 #### Options
 
-| Option            | Description                                                            |
-|-------------------|------------------------------------------------------------------------|
-| `locale`          | The locale used to find localization files.                            |
-| `input-directory` | The directory used to find localization files                          |
-| `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                |
-|--------------------|----------------------------|
-| `rails-export`     | Rails YAML                 |
-| `android-export`   | Android XML                |
-| `core-export`      | Java Enum Core             |
-| `ios-export`       | iOS strings & stringsdict  |
-| `ember-export`     | Ember.js JavaScript        |
-| `ember-pod-export` | Ember.js pods JSON         |
+| Option            | Description                                                           |
+|-------------------|-----------------------------------------------------------------------|
+| `locale`          | The locale used to find localization files.                           |
+| `input-directory` | The directory used to find localization files                         |
+| `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`) |
 
 ### Importing the JSON file from Accent
 
@@ -62,72 +55,24 @@ localization files in the output directory.
 $ aigu <import-command> --locale=fr --input-file=file-from-accent.json --output-directory=config/locales
 ```
 
-#### Options
-
-| Option             | Description                                                                                                               |
-|--------------------|---------------------------------------------------------------------------------------------------|
-| `locale`           | The locale used to generate localization files. Files will be generated as `<file>.<locale>.yml`  |
-| `input-file`       | The path to the Accent-generated JSON file                                                        |
-| `output-directory` | The directory where the localization YAML files will be generated                                 |
-
-| Command            | File format                |
-|--------------------|----------------------------|
-| `rails-import`     | Rails YAML                 |
-| `android-import`   | Android XML                |
-| `core-import`      | Java Enum Core             |
-| `ios-import`       | iOS strings & stringsdict  |
-| `ember-import`     | Ember.js JavaScript        |
-| `ember-pod-import` | Ember.js pods JSON         |
-
-### 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                          |
-
-### Pulling from Accent
+#### Commands
 
-The `pull` command GET the Accent generated JSON file
+| Command            | File format               |
+|--------------------|---------------------------|
+| `rails-import`     | Rails YAML                |
+| `android-import`   | Android XML               |
+| `core-import`      | Java Enum Core            |
+| `ios-import`       | iOS strings & stringsdict |
+| `ember-import`     | Ember.js JavaScript       |
+| `ember-pod-import` | Ember.js pods JSON        |
 
 #### 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                          |
+| Option             | Description                                                                                      |
+|--------------------|--------------------------------------------------------------------------------------------------|
+| `locale`           | The locale used to generate localization files. Files will be generated as `<file>.<locale>.yml` |
+| `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`
 

data/aigu.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Aigu::VERSION
   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.description   = 'Aigu is a set of utility to process localization files to generate JSON files to send to Accent as well as taking JSON files from Accent and convert them back to localization files.'
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/mirego/aigu'
   spec.license       = 'BSD 3-Clause'

data/lib/aigu.rb

@@ -27,10 +27,5 @@ require 'aigu/ember_importer'
 require 'aigu/ember_pod_exporter'
 require 'aigu/ember_pod_importer'
 
-require 'aigu/unmerger'
-require 'aigu/merger'
-require 'aigu/puller'
-require 'aigu/pusher'
-
 module Aigu
 end

data/lib/aigu/cli.rb

@@ -12,11 +12,7 @@ module Aigu
       'ember-import' => 'EmberImporter',
       'ember-export' => 'EmberExporter',
       'ember-pod-import' => 'EmberPodImporter',
-      'ember-pod-export' => 'EmberPodExporter',
-      'merge' => 'Merger',
-      'unmerge' => 'Unmerger',
-      'pull' => 'Puller',
-      'push' => 'Pusher'
+      'ember-pod-export' => 'EmberPodExporter'
     }.freeze
 
     def initialize(env, argv)
@@ -69,23 +65,23 @@ Commands:
 Options:
 DOC
 
-        opts.on('--input-directory=', 'The directory in which the Rails YAML localization files are stored.') do |directory|
+        opts.on('--input-directory=', 'The directory in which the Rails YAML localization files are stored') do |directory|
           options[:'input-directory'] = directory
         end
 
-        opts.on('--output-directory=', 'The directory in which the Rails YAML localization files will be generated.') do |directory|
+        opts.on('--output-directory=', 'The directory in which the Rails YAML localization files will be generated') do |directory|
           options[:'output-directory'] = directory
         end
 
-        opts.on('--input-file=', 'The JSON file generated by Accent.') do |file|
+        opts.on('--input-file=', 'The JSON file generated by Accent') do |file|
           options[:'input-file'] = file
         end
 
-        opts.on('--output-file=', 'The JSON file that will be generated for Accent.') do |file|
+        opts.on('--output-file=', 'The JSON file that will be generated for Accent') do |file|
           options[:'output-file'] = file
         end
 
-        opts.on('--locale=', 'The locale to use. Files will be processed/generated using the "<file>.<locale>.yml" pattern.') do |locale|
+        opts.on('--locale=', 'The locale to use. Importers and exporters may need it to process files') do |locale|
           options[:locale] = locale
         end
 
@@ -93,12 +89,9 @@ DOC
           options[:ignore] = ignore.split(',')
         end
 
-        opts.on('--accent-api-key=', 'Accent API key') do |key|
-          options[:'accent-api-key'] = key
-        end
-
-        opts.on('--accent-url=', 'Accent URL (ex: http://accent.mirego.com)') do |url|
-          options[:'accent-url'] = url
+        opts.on_tail('-v', '--version', 'Output Aigu’s version') do
+          puts "aigu-v#{Aigu::VERSION}"
+          exit
         end
 
         opts.on_tail('-h', '--help', 'Show this message') do

data/lib/aigu/version.rb

@@ -1,3 +1,3 @@
 module Aigu
-  VERSION = '0.7'
+  VERSION = '1.0'
 end

data/spec/spec_helper.rb

@@ -3,7 +3,15 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'rspec'
 require 'aigu'
 
-RSpec.configure do |*|
+RSpec.configure do |config|
+  config.before(:suite) do
+    module Kernel
+      def puts(*)
+        # Silence “puts” calls — we don’t want to write anything to STDOUT when
+        # running the test suite.
+      end
+    end
+  end
 end
 
 class String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aigu
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '1.0'
 platform: ruby
 authors:
 - Rémi Prévost
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,8 +95,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-description: Aigu converts a directory of Rails localization files into a single JSON
-  file to import in Accent.
+description: Aigu is a set of utility to process localization files to generate JSON
+  files to send to Accent as well as taking JSON files from Accent and convert them
+  back to localization files.
 email:
 - rprevost@mirego.com
 - wjobin@mirego.com
@@ -113,7 +114,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- SPEC.md
 - aigu.gemspec
 - bin/aigu
 - bin/phare
@@ -132,12 +132,8 @@ files:
 - lib/aigu/importer.rb
 - lib/aigu/ios_exporter.rb
 - lib/aigu/ios_importer.rb
-- lib/aigu/merger.rb
-- lib/aigu/puller.rb
-- lib/aigu/pusher.rb
 - lib/aigu/rails_exporter.rb
 - lib/aigu/rails_importer.rb
-- lib/aigu/unmerger.rb
 - lib/aigu/version.rb
 - spec/aigu/android_exporter_spec.rb
 - spec/aigu/android_importer_spec.rb
@@ -183,8 +179,9 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Aigu converts a directory of Rails localization files into a single JSON
-  file to import in Accent.
+summary: Aigu is a set of utility to process localization files to generate JSON files
+  to send to Accent as well as taking JSON files from Accent and convert them back
+  to localization files.
 test_files:
 - spec/aigu/android_exporter_spec.rb
 - spec/aigu/android_importer_spec.rb

data/SPEC.md

@@ -1,67 +0,0 @@
-# Specification
-
-## Keys
-
-Keys are generated based on the localization file path and the YAML key.
-
-```json
-{
-  "<path>|<key>": "<value>"
-}
-```
-
-Where:
-
-| Item      | Description                                                           |
-|-----------|-----------------------------------------------------------------------|
-| `<path>`  | The path of the YAML localization file (with `/` used as a separator) |
-| `<key>  ` | The full YAML key with `:` used as a separator between levels         |
-| `<value>` | The localized string                                                  |
-
-## Examples
-
-### Input
-
-```yaml
-# config/locales/app/users.fr.yml
-fr:
-  app:
-    users:
-      index:
-        new: 'Nouvel utilisateur'
-        edit: 'Modifier l’utilisateur %{user}'
-
-# config/locales/app/shared/comments.fr.yml
-fr:
-  app:
-    shared:
-      comments:
-        title: 'Tous les commentaires'
-
-# config/locales/admin/shared.fr.yml
-fr:
-  admin:
-    shared:
-      footer:
-        copyright: 'Copyright © %{year}'
-
-# config/locales/layouts.fr.yml
-fr:
-  layouts:
-    application:
-      title: 'Mon Application'
-```
-
-### Output
-
-With `--locale=fr` option.
-
-```json
-{
-  "app/users|app.users.index.new": "Nouvel utilisateur",
-  "app/users|app.users.index.edit": "Modifier l’utilisateur %{user}",
-  "app/shared/comments|app.shared.comments.title": "Tous les commentaires",
-  "admin/shared|admin.shared.footer.copyright": "Copyright © %{year}",
-  "layouts|layouts.application.title": "Mon Application"
-}
-```

data/lib/aigu/merger.rb

@@ -1,51 +0,0 @@
-module Aigu
-  class Merger
-    def initialize(opts = {})
-      @output_file = opts[:'output-file']
-      @input_directory = opts[:'input-directory']
-    end
-
-    def process!
-      puts "Generating flat Accent JSON file `#{@output_file}` merging json files in `#{@input_directory}` directory"
-
-      puts '---'
-
-      build_output
-      write_json_file
-
-      puts '---'
-      puts 'Done'
-    end
-
-  protected
-
-    def build_output
-      @output = {}
-
-      pattern = File.join(@input_directory, '*.json')
-      Dir[pattern].each do |filepath|
-        puts "Processing #{filepath}"
-
-        file_name =  filepath.rpartition(File::SEPARATOR).last.split('.', 2).first
-        prefix = file_name == 'default' ? '' : "@#{file_name.upcase}@__"
-
-        json = JSON.parse(File.read(filepath))
-        json.each_pair do |key, value|
-          @output[prefix + key] = value
-        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
-  end
-end

data/lib/aigu/puller.rb

@@ -1,49 +0,0 @@
-module Aigu
-  class Puller
-    PULL_PATH = '/public_api/latest_revision?language=%s&render_format=json&render_filename=aigu.json'
-
-    def initialize(opts = {})
-      @output_file = opts[:'output-file']
-      @accent_api_key = opts[:'accent-api-key']
-      @accent_url = opts[:'accent-url']
-      @locale = opts[:'locale']
-    end
-
-    def process!
-      puts "Pulling JSON file `#{@output_file}` from Accent"
-
-      puts '---'
-
-      pull
-
-      puts '---'
-      puts 'Done'
-    end
-
-  protected
-
-    def pull
-      uri = URI(@accent_url + format(PULL_PATH, @locale))
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      uri.scheme == 'https' && http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      request = Net::HTTP::Get.new(uri)
-      request.add_field('Authorization', @accent_api_key)
-
-      response = http.request(request)
-      puts 'Response code: ' + response.code
-
-      if response.code != '200'
-        puts 'Error pulling string revision from Accent'
-        exit 1
-      end
-
-      puts "Generating #{@output_file}"
-
-      File.open(@output_file, 'w+') do |file|
-        file << response.body
-      end
-    end
-  end
-end

data/lib/aigu/pusher.rb

@@ -1,53 +0,0 @@
-module Aigu
-  class Pusher
-    PUSH_PATH = '/public_api/revisions'
-
-    HTTP_ALREADY_UP_TO_DATE = '200'.freeze
-    HTTP_UPDATED = '201'.freeze
-    HTTP_SUCCESS_CODES = [HTTP_ALREADY_UP_TO_DATE, HTTP_UPDATED].freeze
-
-    def initialize(opts = {})
-      @input_file = opts[:'input-file']
-      @accent_api_key = opts[:'accent-api-key']
-      @accent_url = opts[:'accent-url']
-    end
-
-    def process!
-      puts "Sending JSON file `#{@input_file}` to Accent"
-
-      puts '---'
-
-      send
-
-      puts '---'
-      puts 'Done'
-    end
-
-  protected
-
-    def send
-      payload = File.read(@input_file)
-      file_name = @input_file.rpartition(File::SEPARATOR).last
-
-      uri = URI(@accent_url + PUSH_PATH)
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      uri.scheme == 'https' && http.use_ssl = true
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      request = Net::HTTP::Post.new(uri)
-      request.add_field('Authorization', @accent_api_key)
-      request.add_field('Content-Type', 'application/json')
-
-      request.body = JSON.pretty_generate(JSON.parse({ revision: { file: payload, filename: file_name } }.to_json))
-
-      response = http.request(request)
-
-      puts 'Response: ' + response.code
-
-      unless HTTP_SUCCESS_CODES.include? response.code
-        puts 'Error pushing string update to Accent'
-        exit 1
-      end
-    end
-  end
-end

data/lib/aigu/unmerger.rb

@@ -1,55 +0,0 @@
-module Aigu
-  class Unmerger
-    UNMERGE_REGEX = /^@(?<file_name>\w+)@__(?<key>.+)$/
-
-    def initialize(opts = {})
-      @output_directory = opts[:'output-directory']
-      @input_file = opts[:'input-file']
-    end
-
-    def process!
-      puts "Unmerging Accent json file `#{@input_file}` to `#{@output_directory}` directory"
-
-      puts '---'
-
-      parse_json
-      write_json_files
-
-      puts '---'
-      puts 'Done'
-    end
-
-  protected
-
-    def parse_json
-      @object = {}
-
-      json = JSON.parse(File.read(@input_file))
-
-      json.each_pair do |key, value|
-        match_data = key.match(UNMERGE_REGEX)
-        if match_data
-          @object[match_data[:file_name]] ||= {}
-          @object[match_data[:file_name]][match_data[:key]] = value
-        else
-          @object['DEFAULT'] ||= {}
-          @object['DEFAULT'][key] = value
-        end
-      end
-
-      @object
-    end
-
-    def write_json_files
-      @object.each_pair do |file_name, json|
-        file_path = File.join(@output_directory, "#{file_name.downcase}.json")
-        puts "Generating #{file_path}"
-        FileUtils.mkdir_p(File.dirname(file_path))
-
-        File.open(file_path, 'w+') do |file|
-          file << JSON.pretty_generate(JSON.parse(json.to_json))
-        end
-      end
-    end
-  end
-end