i18n-spec 0.0.10 → 0.1.0

data/README.md

@@ -43,3 +43,13 @@ If you need to test that all translations have been completed :
     describe "config/locales/fr.yml" do
       it { should be_a_complete_translation_of 'config/locales/en.yml' }
     end
+
+## Rake tasks
+
+You can check a locale file with the following task :
+
+    rake i18n:check FILEPATH
+
+or check a whole directory :
+
+    rake i18n:check DIRECTORY

data/Rakefile

@@ -38,7 +38,7 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
@@ -47,3 +47,5 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require './lib/i18n-spec/tasks/checker'

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.1.0

data/i18n-spec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{i18n-spec}
-  s.version = "0.0.10"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Christopher Dell}]
-  s.date = %q{2011-12-25}
+  s.date = %q{2011-12-31}
   s.description = %q{Includes a number of rspec matchers to make specing your locale files easy peasy.}
   s.email = %q{chris@tigrish.com}
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "lib/i18n-spec/matchers/have_valid_pluralization_keys_matcher.rb",
     "lib/i18n-spec/models/locale_file.rb",
     "lib/i18n-spec/shared_examples/valid_locale_file.rb",
+    "lib/i18n-spec/tasks/checker.rb",
     "spec/fixtures/en.yml",
     "spec/fixtures/es.yml",
     "spec/fixtures/fr.yml",

data/lib/i18n-spec/matchers/be_parseable_matcher.rb

@@ -1,6 +1,10 @@
 RSpec::Matchers.define :be_parseable do |expected|
   match do |actual|
-    locale_file = I18nSpec::LocaleFile.new(actual)
-    locale_file.is_parseable?
+    @locale_file = I18nSpec::LocaleFile.new(actual)
+    @locale_file.is_parseable?
+  end
+
+  failure_message_for_should do |filepath|
+    "expected #{filepath} to be parseable but got :\n- #{@locale_file.errors[:unparseable]}"
   end
 end

data/lib/i18n-spec/matchers/have_valid_pluralization_keys_matcher.rb

@@ -1,11 +1,10 @@
 RSpec::Matchers.define :have_valid_pluralization_keys do |expected|
   match do |actual|
-    locale_file = I18nSpec::LocaleFile.new(actual)
-    @invalid_keys = locale_file.invalid_pluralization_keys
-    @invalid_keys.empty?
+    @locale_file = I18nSpec::LocaleFile.new(actual)
+    @locale_file.invalid_pluralization_keys.empty?
   end
 
   failure_message_for_should do |filepath|
-    "expected #{filepath} to not include invalid pluralization keys :\n- " << @invalid_keys.join("\n- ")
+    "expected #{filepath} to not include invalid pluralization keys :\n- " << @locale_file.errors[:invalid_pluralization_keys].join("\n- ")
   end
 end

data/lib/i18n-spec/models/locale_file.rb

@@ -3,9 +3,11 @@ module I18nSpec
     PLURALIZATION_KEYS = %w{zero one two few many other}
 
     attr_accessor :filepath
+    attr_reader :errors
 
     def initialize(filepath)
       @filepath = filepath
+      @errors = {}
     end
 
     def content
@@ -33,14 +35,16 @@ module I18nSpec
           invalid << [parent, key].join('.') unless PLURALIZATION_KEYS.include?(key)
         end
       end
+      @errors[:invalid_pluralization_keys] = invalid unless invalid.empty?
       invalid
     end
 
     def is_parseable?
       begin
-        Psych.load_file(@filepath)
+        Psych.load(content)
         true
       rescue Psych::SyntaxError => e
+        @errors[:unparseable] = e.to_s
         false
       end
     end

data/lib/i18n-spec/tasks/checker.rb

@@ -0,0 +1,55 @@
+require 'i18n-spec'
+
+I18nSpec::LOG_DETAIL_PREDICATE = " | - "
+
+namespace :i18n do
+  desc "Checks the validity of a locale file"
+  task :check do
+    
+
+    if ARGV[1].nil?
+      puts "You must specifiy a file path or a folder path"
+      return
+    elsif File.directory?(ARGV[1])
+      filepaths = Dir.glob("#{ARGV[1]}/*.yml")
+    else
+      filepaths = [ARGV[1]]
+    end
+
+    filepaths.each do |filepath|
+      puts "-"*80
+      puts filepath
+
+      fatals, errors, warnings = [0, 0, 0]
+      locale_file = I18nSpec::LocaleFile.new(filepath)
+
+      unless locale_file.is_parseable?
+        log :fatal, 'could not be parsed', format_str(locale_file.errors[:unparseable])
+        fatals += 1
+        break
+      end
+
+      unless locale_file.invalid_pluralization_keys.empty?
+        log :error, 'invalid pluralization keys', format_array(locale_file.errors[:invalid_pluralization_keys])
+        errors += 1
+      end
+
+      puts '[OK]' if fatals + errors + warnings == 0
+    end
+
+    puts "="*80
+  end
+
+  def log(level, msg, detail=nil)
+    puts " - [" << level.to_s.upcase << '] ' << msg 
+    puts detail if detail
+  end
+
+  def format_array(array)
+    [I18nSpec::LOG_DETAIL_PREDICATE, array.join(I18nSpec::LOG_DETAIL_PREDICATE)].join
+  end
+
+  def format_str(str)
+    [I18nSpec::LOG_DETAIL_PREDICATE, str].join
+  end
+end

data/spec/lib/i18n-spec/models/locale_file_spec.rb

@@ -1,49 +1,85 @@
 require 'spec_helper'
 
-describe I18nSpec::LocaleFile, "#pluralizations" do
-  def content
-    "en:
-      cats:
-        one: one
-        two: two
-        three: three
-      dogs:
-        one: one
-        some: some
-      birds:
-        penguins: penguins
-        doves: doves"
-  end
-
-  it "returns the leaf where one of the keys is a pluralization key" do
+module LocaleFileHelper
+  def locale_file_with_content(content)
     locale_file = I18nSpec::LocaleFile.new('test.yml')
     locale_file.should_receive(:content).and_return(content)
-    locale_file.pluralizations.should == {
-      'en.cats' => {'one' => 'one', 'two' => 'two', 'three' => 'three'},
-      'en.dogs' => {'one' => 'one', 'some' => 'some'},
-    }
+    locale_file
   end
 end
 
-describe I18nSpec::LocaleFile, "#invalid_pluralization_keys" do
-  def content
-    "en:
-      cats:
-        one: one
-        two: two
-        tommy: tommy
-        tabby: tabby
-      dogs:
-        one: one
-        some: some
-      birds:
-        zero: zero
-        other: other"
+describe I18nSpec::LocaleFile do
+  include LocaleFileHelper
+
+  describe "#is_parseable?" do
+    context "when YAML is parseable" do
+      let(:locale_file) { locale_file = locale_file_with_content("en:\n  hello: world") }
+
+      it "returns true" do
+        locale_file.is_parseable?.should == true
+      end
+    end
+
+    context "when YAML is NOT parseable" do
+      let(:locale_file) { locale_file_with_content("<This isn't YAML>: foo: bar:") }
+
+      it "returns false" do
+        locale_file.is_parseable?.should == false
+      end
+
+      it "adds an :unparseable error" do
+        locale_file.is_parseable?
+        locale_file.errors[:unparseable].should_not be_nil
+      end
+    end
   end
 
-  it "returns pluralization keys where key is not in PLURALIZATION_KEYS" do
-    locale_file = I18nSpec::LocaleFile.new('test.yml')
-    locale_file.should_receive(:content).and_return(content)
-    locale_file.invalid_pluralization_keys.should == ['en.cats.tommy', 'en.cats.tabby', 'en.dogs.some']
+  describe "#pluralizations" do
+    let(:content) {
+      "en:
+        cats:
+          one: one
+          two: two
+          three: three
+        dogs:
+          one: one
+          some: some
+        birds:
+          penguins: penguins
+          doves: doves"}
+
+    it "returns the leaf where one of the keys is a pluralization key" do
+      locale_file = locale_file_with_content(content)
+      locale_file.pluralizations.should == {
+        'en.cats' => {'one' => 'one', 'two' => 'two', 'three' => 'three'},
+        'en.dogs' => {'one' => 'one', 'some' => 'some'},
+      }
+    end
+  end
+
+  describe "#invalid_pluralization_keys" do
+    let(:content) {
+      "en:
+        cats:
+          one: one
+          two: two
+          tommy: tommy
+          tabby: tabby
+        dogs:
+          one: one
+          some: some
+        birds:
+          zero: zero
+          other: other"}
+      let(:locale_file) { locale_file_with_content(content) }
+
+    it "returns pluralization keys where key is not in PLURALIZATION_KEYS" do
+      locale_file.invalid_pluralization_keys.should == ['en.cats.tommy', 'en.cats.tabby', 'en.dogs.some']
+    end
+
+    it "adds a :invalid_pluralization_keys error with each invalid key" do
+      locale_file.invalid_pluralization_keys
+      locale_file.errors[:invalid_pluralization_keys].should == ['en.cats.tommy', 'en.cats.tabby', 'en.dogs.some']
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-spec
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-25 00:00:00.000000000Z
+date: 2011-12-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70298451985820 !ruby/object:Gem::Requirement
+  requirement: &70320506471860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70298451985820
+  version_requirements: *70320506471860
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70298451985220 !ruby/object:Gem::Requirement
+  requirement: &70320506470580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *70298451985220
+  version_requirements: *70320506470580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70298451984620 !ruby/object:Gem::Requirement
+  requirement: &70320506469500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70298451984620
+  version_requirements: *70320506469500
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70298451984020 !ruby/object:Gem::Requirement
+  requirement: &70320506468020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70298451984020
+  version_requirements: *70320506468020
 description: Includes a number of rspec matchers to make specing your locale files
   easy peasy.
 email: chris@tigrish.com
@@ -85,6 +85,7 @@ files:
 - lib/i18n-spec/matchers/have_valid_pluralization_keys_matcher.rb
 - lib/i18n-spec/models/locale_file.rb
 - lib/i18n-spec/shared_examples/valid_locale_file.rb
+- lib/i18n-spec/tasks/checker.rb
 - spec/fixtures/en.yml
 - spec/fixtures/es.yml
 - spec/fixtures/fr.yml
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1979141701292860623
+      hash: 3595436614852658303
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: