aigu 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 862c7adb7ffd92e40de8e7f9e53b817c1ffbf1e6
+  data.tar.gz: 057bb56afa2fb168f16f3f33f580f9ae7eff88a2
+SHA512:
+  metadata.gz: f5a9a45689e04f9af76887a8aef2c8fa9747da4e9c2a7aed80db06391aaf3346ca2fa492aed559cede3817b6a4b3deb59310e6f19c2cadc711237d65cbc2dab9
+  data.tar.gz: e9c729ece1be9074b2c4d0f78cfccd86084cd4e35044f74c4cfb2a83fefdbe4f7efaf484208ef523ad1c1b07d3c5e37f7b5627e087d6bbb692c74fceebc32098

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

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2014, Mirego
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the Mirego nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,62 @@
+## 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.
+
+## Installation
+
+Add these lines to your application’s Gemfile as development dependancies:
+
+```ruby
+group :development do
+  gem 'aigu'
+end
+```
+
+## Usage
+
+Aigu provides an executable named `aigu`.
+
+### Exporting the JSON file for Accent
+
+The `export` command looks for YAML localization files and generates a JSON
+file. This file will then be compatible with Accent.
+
+```bash
+$ aigu export --locale=fr --input-directory=config/locales --output-file=my-project.json
+```
+
+### Options
+
+| Option            | Description                                                                                                               |
+|-------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `locale`          | The locale used to find localization files. Files that match `*.<locale>.yml` into the input directory will be processed. |
+| `input-directory` | The directory used to find localization files                                                                             |
+| `output-file`     | The path to the JSON file that will be written by `aigu`                                                                  |
+
+### Importing the JSON file from Accent
+
+The `import` command takes a generated JSON file from Accent and generates
+the original YAML file structure.
+
+```bash
+$ aigu import --input-file=file-from-accent.json --output-directory=config/locales
+```
+
+### Options
+
+| Option             | Description                                                                                                               |
+|--------------------|-------------------------------------------------------------------|
+| `input-file`       | The path to the Accent-generated JSON file                        |
+| `output-directory` | The directory where the localization YAML files will be generated |
+
+## 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.
+
+## About Mirego
+
+[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
+
+We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+desc 'Start an IRB session with the gem'
+task :console do
+  $:.unshift File.expand_path('..', __FILE__)
+  require 'aigu'
+  require 'irb'
+
+  ARGV.clear
+  IRB.start
+end

data/SPEC.md

@@ -0,0 +1,65 @@
+# 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
+
+```json
+{
+  "app/users.fr|fr.app.users.index.new": "Nouvel utilisateur",
+  "app/users.fr|fr.app.users.index.edit": "Modifier l’utilisateur %{user}",
+  "app/shared/comments.fr|fr.app.shared.comments.title": "Tous les commentaires",
+  "admin/shared.fr|fr.admin.shared.footer.copyright": "Copyright © %{year}",
+  "layouts.fr|fr.layouts.application.title": "Mon Application"
+}
+```

data/aigu.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.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'
+end

data/bin/aigu

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'aigu'
+
+Aigu::CLI.new(ENV.dup, ARGV.dup).run

data/lib/aigu.rb

@@ -0,0 +1,85 @@
+require 'aigu/version'
+
+require 'optparse'
+require 'fileutils'
+require 'json'
+require 'yaml'
+
+require 'aigu/extensions/hash'
+require 'aigu/cli'
+
+module Aigu
+  PUBLIC_COMMANDS = %w(import export)
+
+  def self.import(input_file: nil, output_directory: nil)
+    puts "Generating YAML files in `#{output_directory}` based on Accent-generated `#{input_file}` file"
+    puts '---'
+    json = File.read(input_file)
+    object = JSON.parse(json)
+    blob = Hash.recursive
+
+    object.each_pair do |key, value|
+      filename, flat_key = key.split('|')
+
+      parts = flat_key.split('.')
+      hash = blob[filename]
+
+      parts.each_with_index do |part, index|
+        if index + 1 < parts.length
+          hash = hash[part]
+        else
+          hash[part] = value
+        end
+      end
+    end
+
+    blob.each_pair do |file_name, hash|
+      file_path = File.join(output_directory, "#{file_name}.yml")
+      puts "Generating #{file_path}"
+      FileUtils.mkdir_p(File.dirname(file_path))
+
+      File.open(file_path, 'w+') do |file|
+        file << hash.to_yaml(line_width: 100_000_000)
+      end
+    end
+
+    puts '---'
+    puts 'Done'
+  end
+
+  def self.export(output_file: nil, input_directory: nil)
+    puts "Generating Accent JSON file `#{output_file}` based on YAML localization files in `#{input_directory}` directory"
+    puts '---'
+
+    output = {}
+
+    Dir[File.join(input_directory, '**', '*.yml')].each do |file|
+      content = YAML.load_file(file)
+      base_key = file.gsub(input_directory, '').gsub(/^\/*/, '').gsub(/\.yml$/, '|')
+
+      output.merge! flattenize_hash(content, base_key)
+    end
+
+    file_path = output_file
+    puts "Generating #{file_path}"
+    FileUtils.mkdir_p(File.dirname(file_path))
+
+    File.open(file_path, 'w+') do |file|
+      file << output.to_json
+    end
+
+    puts '---'
+    puts 'Done'
+  end
+
+  def self.flattenize_hash(hash, base_key = '')
+    if hash.is_a?(Hash)
+      hash.reduce({}) do |memo, (key, value)|
+        new_base_key = [base_key, key].join('.').sub('|.', '|')
+        memo.merge! flattenize_hash(value, new_base_key)
+      end
+    else
+      { base_key => hash }
+    end
+  end
+end

data/lib/aigu/cli.rb

@@ -0,0 +1,44 @@
+module Aigu
+  class CLI
+    def initialize(env, argv)
+      @env = env
+      @command = Aigu::PUBLIC_COMMANDS.include?(argv.first) ? argv.shift : nil
+      @argv = argv
+      parse_options
+    end
+
+    def run
+      Aigu.send(@command, @options) if @command
+    end
+
+    def parse_options
+      @options = {}
+
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: aigu [options]'
+
+        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|
+          @options[:output_directory] = directory
+        end
+
+        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|
+          @options[:output_file] = file
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+
+      end.parse! @argv
+    end
+  end
+end

data/lib/aigu/extensions/hash.rb

@@ -0,0 +1,7 @@
+class Hash
+  def self.recursive
+    new do |hash, key|
+      hash[key] = recursive
+    end
+  end
+end

data/lib/aigu/version.rb

@@ -0,0 +1,3 @@
+module Aigu
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: aigu
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Rémi Prévost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Aigu converts a directory of Rails localization files into a single JSON
+  file to import in Accent.
+email:
+- rprevost@mirego.com
+executables:
+- aigu
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- SPEC.md
+- aigu.gemspec
+- bin/aigu
+- lib/aigu.rb
+- lib/aigu/cli.rb
+- lib/aigu/extensions/hash.rb
+- lib/aigu/version.rb
+homepage: https://github.com/mirego/aigu
+licenses:
+- BSD 3-Clause
+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.1.0
+signing_key: 
+specification_version: 4
+summary: Aigu converts a directory of Rails localization files into a single JSON
+  file to import in Accent.
+test_files: []