i18n_interpolation_spec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c8467ae5c07c2e23012dfa774dea5738ba563d2
+  data.tar.gz: 6645ce1d131d67bbc47ae39ceabc4d3c8406d30b
+SHA512:
+  metadata.gz: 77226457dc91514362ea632ea407447009c06b94f702d60e4d672cbe5cb09fe8c059e9c7edddced953772cfc57b0e8d458fcff511c1879b88554044a6abe9963
+  data.tar.gz: 42c18de0594a5c78ba95f8afc70329df7b268ca3e1dd8c06a2ff101351ab24720da6d3ba2e840bb3f426108c37c69b43b9c42d0127cd35ce9567135b20119cce

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vender/bundle

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 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,46 @@
+i18n_interpolation_spec
+=======================
+
+**i18n_interpolation_spec provides RSpec matchers for testing the completeness of interpolation arguments in locale files.**  
+It's great to use with [tigrish/i18n-spec](https://github.com/tigrish/i18n-spec).
+
+
+Installation
+------------
+
+Add the gem to your Gemfile.
+
+```ruby
+gem 'i18n_interpolation_spec', group: :test
+```
+
+
+Matchers
+--------
+
+```ruby
+describe 'config/locales/fr.yml' do
+  it { is_expected.to be_a_complete_interpolation_of 'config/locales/en.yml' }
+end
+
+describe 'config/locales/it.yml' do
+  it { is_expected.to have_mutual_interpolation_of 'config/locales/en.yml' }
+end
+
+describe 'config/locales/es.yml' do
+  it {
+    is_expected.to be_a_complete_interpolation_of 'config/locales/en.yml',
+      except: [
+        'some.key.to.ignore',
+        /^some\.patt[e3]rn\.to\.ignore/,
+      ]
+  }
+end
+```
+
+
+License
+-------
+
+This project is copyright by [Creasty](http://creasty.com), released under the MIT license.  
+See `LICENSE` file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/i18n_interpolation_spec.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i18n_interpolation_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'i18n_interpolation_spec'
+  spec.version       = I18nInterpolationSpec::VERSION
+  spec.authors       = ['Yuki Iwanaga']
+  spec.email         = ['yuki@creasty.com']
+  spec.summary       = %q{RSpec matchers for testing the completeness of interpolation arguments in locale files}
+  spec.description   = %q{RSpec matchers for testing the completeness of interpolation arguments in locale files}
+  spec.homepage      = 'https://github.com/creasty/i18n_interpolation_spec'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'rspec', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/i18n_interpolation_spec.rb

@@ -0,0 +1,7 @@
+require_relative 'i18n_interpolation_spec/version'
+require_relative 'i18n_interpolation_spec/checker'
+require_relative 'i18n_interpolation_spec/locale_file'
+require_relative 'i18n_interpolation_spec/matchers/have_mutual_interpolation_of'
+require_relative 'i18n_interpolation_spec/matchers/be_a_complete_interpolation_of'
+
+module I18nInterpolationSpec; end

data/lib/i18n_interpolation_spec/checker.rb

@@ -0,0 +1,65 @@
+module I18nInterpolationSpec
+  module Checker
+    class << self
+
+      def except?(patterns, key)
+        patterns.any? { |pattern|  pattern === key }
+      end
+
+      def check(t1, t2, except, &checker)
+        i1, i2 = interpolations(t1), interpolations(t2)
+
+        missing_keys = {}
+
+        (i1.keys & i2.keys).each do |key|
+          a1, a2 = i1[key], i2[key]
+          diff = (a1 - a2) | (a2 - a1)
+          next if except? except, key
+          missing_keys[key] = diff if checker[key, a1, a2, diff]
+        end
+
+        missing_keys
+      end
+
+      def strict_check(t1, t2, except: [])
+        check t1, t2, except do |key, a1, a2, diff|
+          diff.any?
+        end
+      end
+
+      def loose_check(t1, t2, except: [])
+        check t1, t2, except do |key, a1, a2, diff|
+          a1.any? && a2.any? && (diff == a1 | a2)
+        end
+      end
+
+      def interpolations(t)
+        result = {}
+
+        rec = ->(t, scopes) do
+          if t.is_a? Hash
+            t.each do |(k, v)|
+              rec.call v, [*scopes, k]
+            end
+          elsif t.is_a? Array
+            t.each_with_index do |v, i|
+              rec.call v, [*scopes, i]
+            end
+          else
+            args = extract_args t
+            result[scopes.join('.')] = args
+          end
+        end
+
+        rec.call t, []
+
+        result
+      end
+
+      def extract_args(translation)
+        translation.to_s.scan(/(?<!%)%\{([^\}]+)\}/).flatten
+      end
+
+    end
+  end
+end

data/lib/i18n_interpolation_spec/locale_file.rb

@@ -0,0 +1,29 @@
+require 'yaml'
+
+module I18nInterpolationSpec
+  class LocaleFile
+
+    attr_accessor :filepath
+
+    def initialize(filepath)
+      @filepath = filepath
+    end
+
+    def content
+      @content ||= File.read @filepath
+    end
+
+    def content_yaml
+      @content_yaml ||= YAML.load(content).freeze
+    end
+
+    def locale
+      @locale ||= content_yaml.keys.first
+    end
+
+    def translations
+      content_yaml[locale]
+    end
+
+  end
+end

data/lib/i18n_interpolation_spec/matchers/be_a_complete_interpolation_of.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :be_a_complete_interpolation_of do |subject_filepath, except: []|
+
+  match do |object_filepath|
+    object_locale  = I18nInterpolationSpec::LocaleFile.new object_filepath
+    subject_locale = I18nInterpolationSpec::LocaleFile.new subject_filepath
+
+    t1, t2 = subject_locale.translations, object_locale.translations
+
+    @missing_args = I18nInterpolationSpec::Checker.strict_check t1, t2, except: except
+    @missing_args.empty?
+  end
+
+  failure_message do |filepath|
+    listed = @missing_args.map do |(scope, args)|
+      args = args.map { |arg| '%%{%s}' % arg }.join ', '
+      "\n - %s should have %s" % [scope, args]
+    end
+
+    "expected #{filepath} to contain the following interpolation arguments:#{listed.join}"
+  end
+
+end

data/lib/i18n_interpolation_spec/matchers/have_mutual_interpolation_of.rb

@@ -0,0 +1,22 @@
+RSpec::Matchers.define :have_mutual_interpolation_of do |subject_filepath, except: []|
+
+  match do |object_filepath|
+    object_locale  = I18nInterpolationSpec::LocaleFile.new object_filepath
+    subject_locale = I18nInterpolationSpec::LocaleFile.new subject_filepath
+
+    t1, t2 = subject_locale.translations, object_locale.translations
+
+    @missing_args = I18nInterpolationSpec::Checker.loose_check t1, t2, except: except
+    @missing_args.empty?
+  end
+
+  failure_message do |filepath|
+    listed = @missing_args.map do |(scope, args)|
+      args = args.map { |arg| '%%{%s}' % arg }.join ', '
+      "\n - %s should have %s" % [scope, args]
+    end
+
+    "expected #{filepath} to contain the following interpolation arguments:#{listed.join}"
+  end
+
+end

data/lib/i18n_interpolation_spec/version.rb

@@ -0,0 +1,9 @@
+module I18nInterpolationSpec
+
+  MAJOR    = 1
+  MINOR    = 0
+  REVISION = 0
+
+  VERSION = [MAJOR, MINOR, REVISION].compact.join '.'
+
+end

data/spec/fixtures/base.yml

@@ -0,0 +1,5 @@
+interpolation:
+  foo:
+    text_1: '%{key_a} %{key_b}'
+    text_2: '%{key_a} %{key_b}'
+    text_3: '%%{key_a}'

data/spec/fixtures/complete.yml

@@ -0,0 +1,5 @@
+interpolation:
+  foo:
+    text_1: '%{key_a} %{key_b}'
+    text_2: '%{key_b} %{key_a}'
+    text_3: ''

data/spec/fixtures/incomplete.yml

@@ -0,0 +1,5 @@
+interpolation:
+  foo:
+    text_1: '%{k3y_a} %{key_b}'
+    text_2: '%{key_a}'
+    text_3: ''

data/spec/lib/i18n_interpolation_spec/checker_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe I18nInterpolationSpec::Checker do
+
+  describe '::extract_args' do
+
+    it 'should extract interpolation arguments' do
+      text = 'non_arg %{arg_1} {non_arg} %{arg_2}'
+      args = %w[arg_1 arg_2]
+
+      expect(I18nInterpolationSpec::Checker.extract_args(text)).to eq args
+    end
+
+    it 'should not extract arguments of interpolation-like syntax with escaped %' do
+      text = '%{arg} %%{non_arg}'
+      non_arg = 'non_arg'
+
+      expect(I18nInterpolationSpec::Checker.extract_args(text)).not_to include non_arg
+    end
+
+  end
+
+  describe '::interpolations' do
+
+    it 'should return pairs of scope and interpolation arguments' do
+      translations = {
+        a: { aa: '%{a_aa}', ab: '%{a_ab}' },
+        b: { ba: '%{b_ba}' },
+        c: [{ ca: '%{c_0_ca}' }],
+      }
+
+      args = {
+        'a.aa'   => %w[a_aa],
+        'a.ab'   => %w[a_ab],
+        'b.ba'   => %w[b_ba],
+        'c.0.ca' => %w[c_0_ca],
+      }
+
+      expect(I18nInterpolationSpec::Checker.interpolations(translations)).to eq args
+    end
+
+    it 'should include empty array for translations without interpolations' do
+      translations = {
+        a: { aa: '%{a_aa}' },
+        b: { ba: 'no interpolations here' },
+      }
+
+      args = {
+        'a.aa'   => %w[a_aa],
+        'b.ba'   => %w[],
+      }
+
+      expect(I18nInterpolationSpec::Checker.interpolations(translations)).to eq args
+    end
+
+  end
+
+  let(:t1) do
+    {
+      a: { aa: '%{a_aa}', ab: '%{a_ab}' },
+      b: { ba: '%{b_ba}' },
+      c: [{ ca: '%{c_0_ca}' }],
+    }
+  end
+
+  let(:t2) do
+    {
+      a: { aa: '%{a_aa}', ab: '%{a_ab}' },
+      b: { ba: '%{b_ba}' },
+      c: [{ ca: '%{c_0_ca}' }],
+    }
+  end
+
+  describe '::strict_check' do
+
+    it 'should return an empty hash if interpolation arguments are fully contained in both arg lists' do
+      expect(I18nInterpolationSpec::Checker.strict_check(t1, t2)).to eq({})
+    end
+
+    it 'should ignore translations that only exists in either hash' do
+      t1[:d] = { only_1: '%{only_1}' }
+      t2[:d] = { only_2: '%{only_2}' }
+
+      expect(I18nInterpolationSpec::Checker.strict_check(t1, t2)).to eq({})
+    end
+
+    it 'should return a hash of missing translations arguments if interpolation arguments are not fully contained in both arg lists' do
+      t1[:c][0][:ca] = ''
+      t2[:a][:ab]    = '%{A_AB}'
+      t2[:b][:ba]    = ''
+
+      args = {
+        'a.ab'   => %w[a_ab A_AB],
+        'b.ba'   => %w[b_ba],
+        "c.0.ca" => %w[c_0_ca],
+      }
+
+      expect(I18nInterpolationSpec::Checker.strict_check(t1, t2)).to eq args
+    end
+
+  end
+
+  describe '::loose_check' do
+
+    it 'should return an empty hash if interpolation arguments are fully contained in both arg lists' do
+      expect(I18nInterpolationSpec::Checker.loose_check(t1, t2)).to eq({})
+    end
+
+    it 'should ignore translations that only exists in either hash' do
+      t1[:d] = { only_1: '%{only_1}' }
+      t2[:d] = { only_2: '%{only_2}' }
+
+      expect(I18nInterpolationSpec::Checker.loose_check(t1, t2)).to eq({})
+    end
+
+    it 'should return a hash of missing translations arguments if interpolation arguments are not fully contained in both arg lists' do
+      t1[:a][:aa]    = '%{a_aa} %{only}'
+      t1[:c][0][:ca] = ''
+      t2[:a][:ab]    = '%{A_AB}'
+      t2[:b][:ba]    = '%{B_BA} %{only}'
+
+      args = {
+        'a.ab' => %w[a_ab A_AB],
+        'b.ba' => %w[b_ba B_BA only],
+      }
+
+      expect(I18nInterpolationSpec::Checker.loose_check(t1, t2)).to eq args
+    end
+
+  end
+
+end

data/spec/lib/i18n_interpolation_spec/locale_file_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module LocaleFileHelper
+
+  def locale_file_with_content(content)
+    locale_file = I18nInterpolationSpec::LocaleFile.new 'test.yml'
+    expect(locale_file).to receive(:content).and_return(content)
+    locale_file
+  end
+
+end
+
+
+describe I18nInterpolationSpec::LocaleFile do
+  include LocaleFileHelper
+
+  describe '#content' do
+
+    it 'should return the content of the file' do
+      content = <<-YAML
+        en:
+          hello: world
+      YAML
+
+      locale_file = locale_file_with_content content
+
+      expect(locale_file.content).to eq(content)
+    end
+
+  end
+
+  describe '#content_yaml' do
+
+    it 'should return a hash object of translations' do
+      locale_file = locale_file_with_content <<-YAML
+        en:
+          hello: world
+      YAML
+
+      hash = {
+        'en' => {
+          'hello' => 'world'
+        }
+      }
+
+      expect(locale_file.content_yaml).to eq(hash)
+    end
+
+  end
+
+  describe '#locale' do
+
+    it 'should return the locale code of the file' do
+      locale_file = locale_file_with_content <<-YAML
+        en:
+          hello: world
+      YAML
+
+      expect(locale_file.locale).to eq('en')
+    end
+
+  end
+
+  describe '#translations' do
+
+    it 'should return a hash object of translations' do
+      locale_file = locale_file_with_content <<-YAML
+        en:
+          hello: world
+      YAML
+
+      hash = {
+        'hello' => 'world'
+      }
+
+      expect(locale_file.translations).to eq(hash)
+    end
+
+  end
+
+end

data/spec/lib/i18n_interpolation_spec/matchers/be_a_complete_interpolation_of_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'be_a_complete_interpolation_of' do
+
+  describe 'spec/fixtures/complete.yml' do
+    it { is_expected.to be_a_complete_interpolation_of 'spec/fixtures/base.yml' }
+  end
+
+  describe 'spec/fixtures/incomplete.yml' do
+    it { is_expected.not_to be_a_complete_interpolation_of 'spec/fixtures/base.yml' }
+  end
+
+  context 'With exceptions' do
+
+    describe 'spec/fixtures/incomplete.yml' do
+      it do
+        is_expected.to be_a_complete_interpolation_of 'spec/fixtures/base.yml',
+          except: [
+            'foo.text_1',
+            'foo.text_2',
+          ]
+      end
+    end
+
+  end
+
+end

data/spec/lib/i18n_interpolation_spec/matchers/have_mutual_interpolation_of_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'have_mutual_interpolation_of' do
+
+  describe 'spec/fixtures/complete.yml' do
+    it { is_expected.to have_mutual_interpolation_of 'spec/fixtures/base.yml' }
+  end
+
+  describe 'spec/fixtures/incomplete.yml' do
+    it { is_expected.to have_mutual_interpolation_of 'spec/fixtures/base.yml' }
+  end
+
+  describe 'spec/fixtures/complete.yml' do
+    it { is_expected.not_to be_a_complete_interpolation_of 'spec/fixtures/incomplete.yml' }
+  end
+
+  context 'With exceptions' do
+
+    describe 'spec/fixtures/complete.yml' do
+      it do
+        is_expected.to be_a_complete_interpolation_of 'spec/fixtures/incomplete.yml',
+          except: [
+            'foo.text_1',
+            'foo.text_2',
+          ]
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'rspec'
+require 'i18n_interpolation_spec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: i18n_interpolation_spec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuki Iwanaga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: RSpec matchers for testing the completeness of interpolation arguments
+  in locale files
+email:
+- yuki@creasty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- i18n_interpolation_spec.gemspec
+- lib/i18n_interpolation_spec.rb
+- lib/i18n_interpolation_spec/checker.rb
+- lib/i18n_interpolation_spec/locale_file.rb
+- lib/i18n_interpolation_spec/matchers/be_a_complete_interpolation_of.rb
+- lib/i18n_interpolation_spec/matchers/have_mutual_interpolation_of.rb
+- lib/i18n_interpolation_spec/version.rb
+- spec/fixtures/base.yml
+- spec/fixtures/complete.yml
+- spec/fixtures/incomplete.yml
+- spec/lib/i18n_interpolation_spec/checker_spec.rb
+- spec/lib/i18n_interpolation_spec/locale_file_spec.rb
+- spec/lib/i18n_interpolation_spec/matchers/be_a_complete_interpolation_of_spec.rb
+- spec/lib/i18n_interpolation_spec/matchers/have_mutual_interpolation_of_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/creasty/i18n_interpolation_spec
+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.5
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for testing the completeness of interpolation arguments in
+  locale files
+test_files:
+- spec/fixtures/base.yml
+- spec/fixtures/complete.yml
+- spec/fixtures/incomplete.yml
+- spec/lib/i18n_interpolation_spec/checker_spec.rb
+- spec/lib/i18n_interpolation_spec/locale_file_spec.rb
+- spec/lib/i18n_interpolation_spec/matchers/be_a_complete_interpolation_of_spec.rb
+- spec/lib/i18n_interpolation_spec/matchers/have_mutual_interpolation_of_spec.rb
+- spec/spec_helper.rb