i18n_flow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4537799b78a2246ecd36a0cf9be738dc928e2422
+  data.tar.gz: 1fc6adc2ef94f46a13714829dfbc677cb42778f9
+SHA512:
+  metadata.gz: 923ce8ee56eb52fbe275a1c07657c163b8a319c7dc67aec80e9b0f45f6991e44ff43b4c4c04bcce70909c26eac6959fb5f22555a347feb3aaca09223f4eae92a
+  data.tar.gz: 9d84ac662df036e5c2bbd56e3f4d9dda06ceb8e57e60b1b8670f8f01b2c37e6cfb0ce51001970a274722a3507fc4fd6a7ec243a06dcb4401e191d9ce7abf1f12

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm: 2.4.2
+
+branches:
+  only:
+    - master # Affects only branch builds; pull requests will still be built on any branch
+
+install:
+  - bundle install
+
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in i18n_flow.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    i18n_flow (0.1.0)
+      psych (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    fakefs (0.13.1)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fakefs
+  i18n_flow!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018- Yuki Iwanaga
+
+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,103 @@
+![](https://user-images.githubusercontent.com/1695538/36350808-d0cf8afe-14e1-11e8-8afb-34a316f98f80.png)
+
+i18n_flow (beta)
+================
+
+[![Build Status](https://travis-ci.org/creasty/i18n_flow.svg?branch=master)](https://travis-ci.org/creasty/i18n_flow)
+[![License](https://img.shields.io/github/license/creasty/i18n_flow.svg)](./LICENSE)
+
+**Manage translation status in YAML file.**  
+With an official [tag](http://www.yaml.org/spec/1.2/spec.html#id2784064) feature, `i18n_flow` enables you to annotate status information directly in YAML file.
+
+![](https://user-images.githubusercontent.com/1695538/36359417-6a976054-155e-11e8-914b-d6a10a8287fc.png)
+
+- [Lint rules](./doc/rules.md)
+- [Tags](./doc/tags.md)
+
+
+Setup
+-----
+
+### Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'i18n_flow', github: 'creasty/i18n_flow'
+```
+
+### Configuration
+
+Create a configuration file at your project's root directory.
+
+```sh-session
+$ cat > i18n_flow.yml
+base_path: config/locales
+glob_patterns:
+  - '**/*.yml'
+valid_locales:
+  - en
+  - ja
+locale_pairs:
+  - ['en', 'ja']
+^D
+```
+
+
+CLI
+---
+
+```sh-session
+$ i18n_flow
+Manage translation status in yaml file
+
+Usage:
+    i18n_flow COMMAND [args...]
+    i18n_flow [options]
+
+Options:
+    -v, --version    Show version
+    -h               Show help
+
+Commands:
+    lint       Validate files
+    search     Search contents and keys
+    copy       Copy translations and mark as todo
+    split      Split a file into proper-sized files
+    version    Show version
+    help       Show help
+```
+
+
+Configuration file
+------------------
+
+```yaml
+# Base directory
+# Default: pwd
+base_path: config/locales
+
+# Patterns for locale YAML files
+# Default: ['*.en.yml']
+glob_patterns:
+  - '**/*.yml'
+
+# List of all supporting locales
+# May want to sync with `I18n.available_locales`
+# Default: ['en']
+valid_locales:
+  - en
+  - ja
+
+# List of master-foreign pairs
+# Used by the linter to check symmetry
+# Default: []
+locale_pairs:
+  - ['en', 'ja']
+
+# Enabled linters
+# Default
+linters:
+  - file_scope
+  - symmetry
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "i18n_flow"
+
+# 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(__FILE__)

data/bin/setup

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

data/doc/rules.md

@@ -0,0 +1,316 @@
+Lint rules
+==========
+
+File-scope linter
+-----------------
+
+File-scope linter checks consistency between file content and a file path of each file, without comparing with others.
+
+'File-scope' is a sort of namespace that derives from a file path.
+For example a file-scope of `models/user.en.yml` is `en.models.user`.
+
+
+### A file must start with scopes that derive from its file path
+
+<table><thead><tr>
+  <th></th>
+  <th>models/user.en.yml</th>
+</tr></thead><tbody><tr><th>✅</th><td>
+
+```yaml
+en:
+  models:
+    user:
+      ...
+```
+
+</td></tr><tr><td colspan=2>
+
+Starts with `en.models.user`
+
+</td></tr></tbody></table>
+
+<table><thead><tr>
+  <th></th>
+  <th>models/user.en.yml</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+ja:
+  models:
+    user:
+      ...
+```
+
+</td></tr><tr><td colspan=2>
+
+Starts with `ja`
+
+</td></tr></tbody></table>
+
+<table><thead><tr>
+  <th></th>
+  <th>controllers/admin/accounts_controller.en.yml</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  controllers:
+    nimda:
+      accounts_controller:
+        ...
+```
+
+</td></tr><tr><td colspan=2>
+
+Starts with `en.controllers.nimda`
+
+</td></tr></tbody></table>
+
+
+### Having extra key at anywhere upper-or-equal level than a file-scope
+
+<table><thead><tr>
+  <th></th>
+  <th>models/user.en.yml</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  models:
+    user:
+      ...
+
+  foo: ...
+```
+
+</td></tr><tr><td colspan=2>
+
+`en.foo` and `en.models` coexist
+
+</td></tr></tbody></table>
+
+
+### A file-scope itself must not have a scalar value
+
+<table><thead><tr>
+  <th></th>
+  <th>models/user.en.yml</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  models:
+    user: 'User'
+```
+
+</td></tr><tr><td colspan=2>
+
+`user` must be either a mapping or a sequence
+
+</td></tr></tbody></table>
+
+
+Symmetry linter
+---------------
+
+Symmetry linter compares a pair of files and checks their symmetry.
+As a pair, one is 'master' and another is 'foreign'.
+
+If your primary language is English and going to support Japanese as secondary, you may want to lint Japanese (foreign) locale file based on English locale file (master).
+
+### Keys in a foreign file must be exhaustive and exclusive
+
+[→ Justify violations with `!only` or ignore with `!ignore:key`](./tags.md)
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>✅</th><td>
+
+```yaml
+en:
+  title: 'Non zero sum'
+  desc: 'A situation in...'
+```
+
+</td><td>
+
+```yaml
+ja:
+  title: '非ゼロ和'
+  desc: '複数の人が相互...'
+```
+
+</td></tr><tr><td colspan=3>
+
+Every keys exist on both files. No asymmetric keys
+
+</td></tr></tbody></table>
+
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  title: 'Non zero sum'
+  desc: 'A situation in...'
+```
+
+</td><td>
+
+```yaml
+ja:
+  title: '非ゼロ和'
+  
+```
+
+</td></tr><tr><td colspan=3>
+
+Missing `ja.desc`
+
+</td></tr></tbody></table>
+
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  title: 'Non zero sum'
+  
+```
+
+</td><td>
+
+```yaml
+ja:
+  title: '非ゼロ和'
+  desc: '複数の人が相互...'
+```
+
+</td></tr><tr><td colspan=3>
+
+Having the extra `ja.desc`
+
+</td></tr></tbody></table>
+
+
+### Structure must match exactly
+
+[→ Ignore violations with `!ignore:key`](./tags.md)
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  follower_count:
+    one: '1 follower'
+    other: '%{count} followers'
+```
+
+</td><td>
+
+```yaml
+ja:
+  follower_count: '%{count} フォロワ'
+  
+  
+```
+
+</td></tr><tr><td colspan=3>
+
+`en.follower_count` is a mapping, whereas `ja.follower_count` is a scalar
+
+</td></tr></tbody></table>
+
+
+### Interpolation arguments must be exhaustive and exclusive
+
+[→ Ignore violations with `!ignore:args`](./tags.md)
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>✅</th><td>
+
+```yaml
+en:
+  key: '%{alpha} %{beta} %{beta}'
+```
+
+</td><td>
+
+```yaml
+ja:
+  key: '%{beta} %{alpha}'
+```
+
+</td></tr><tr><td colspan=3>
+
+It's insensitive of arguments order and repetition
+
+</td></tr></tbody></table>
+
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  key: '%{alpha}'
+```
+
+</td><td>
+
+```yaml
+ja:
+  key: 'alpha'
+```
+
+</td></tr><tr><td colspan=3>
+
+No arguments exists in `ja.key`
+
+</td></tr></tbody></table>
+
+
+<table><thead><tr>
+  <th></th>
+  <th>master</th>
+  <th>foreign</th>
+</tr></thead><tbody><tr><th>👎</th><td>
+
+```yaml
+en:
+  key: '%{alpha}'
+```
+
+</td><td>
+
+```yaml
+ja:
+  key: '%{gamma}'
+```
+
+</td></tr><tr><td colspan=3>
+
+A set of arguments is different from master
+
+</td></tr></tbody></table>