i18n-spec 0.1.0 → 0.1.1

data/README.md

@@ -46,10 +46,27 @@ If you need to test that all translations have been completed :
 
 ## Rake tasks
 
+Include the tasks in your Rakefile with :
+
+    require 'i18n-spec/tasks'
+
+### Validating locale files
+
 You can check a locale file with the following task :
 
-    rake i18n:check FILEPATH
+    rake i18n-spec:validate FILEPATH
 
 or check a whole directory :
 
-    rake i18n:check DIRECTORY
+    rake i18n-spec:validate DIRECTORY
+
+### Checking for translation completeness
+
+
+You can check a locale file with the following taks :
+
+	rake i18n-spec:completeness SOURCE_FILEPATH TRANSLATED_FILEPATH
+
+or again, check a whole directory :
+
+	rake i18n-spec:completeness SOURCE_FILEPATH DIRECTORY

data/Rakefile

@@ -48,4 +48,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require './lib/i18n-spec/tasks/checker'
+require 'i18n-spec/tasks'

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/i18n-spec.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{i18n-spec}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   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-31}
+  s.date = %q{2012-01-14}
   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,7 +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",
+    "lib/i18n-spec/tasks.rb",
     "spec/fixtures/en.yml",
     "spec/fixtures/es.yml",
     "spec/fixtures/fr.yml",

data/lib/i18n-spec/tasks.rb

@@ -0,0 +1,76 @@
+require 'i18n-spec'
+
+I18nSpec::LOG_DETAIL_PREDICATE = "  - "
+
+namespace :'i18n-spec' do
+  desc "Checks the validity of a locale file"
+  task :validate 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|
+      heading 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
+
+      log :ok if fatals + errors + warnings == 0
+    end
+  end
+
+  desc "Checks for missing translations between the default and the translated locale file"
+  task :completeness do
+    if ARGV[1].nil? || ARGV[2].nil?
+      puts "You must specify a default locale file and translated file or a folder of translated files"
+    elsif File.directory?(ARGV[2])
+      translated_filepaths = Dir.glob("#{ARGV[2]}/*.yml")
+    else
+      translated_filepaths = [ARGV[2]]
+    end
+    default_locale = I18nSpec::LocaleFile.new(ARGV[1])
+    translated_filepaths.each do |translated_filepath|
+      heading translated_filepath
+      locale_file = I18nSpec::LocaleFile.new(translated_filepath)
+      misses = default_locale.flattened_translations.keys.reject do |key|
+        locale_file.flattened_translations.keys.include?(key)
+      end
+      if misses.empty?
+        log :complete
+      else
+        misses.each { |miss| log :missing, miss }
+      end
+    end
+  end
+
+  def log(level, msg='', detail=nil)
+    puts "- *" << level.to_s.upcase << '* ' << msg 
+    puts detail if detail
+  end
+
+  def heading(str='')
+    puts "\n### " << str << "\n\n"
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-31 00:00:00.000000000Z
+date: 2012-01-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70320506471860 !ruby/object:Gem::Requirement
+  requirement: &70301793011300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70320506471860
+  version_requirements: *70301793011300
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70320506470580 !ruby/object:Gem::Requirement
+  requirement: &70301793010720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *70320506470580
+  version_requirements: *70301793010720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70320506469500 !ruby/object:Gem::Requirement
+  requirement: &70301793010200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70320506469500
+  version_requirements: *70301793010200
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70320506468020 !ruby/object:Gem::Requirement
+  requirement: &70301793009660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70320506468020
+  version_requirements: *70301793009660
 description: Includes a number of rspec matchers to make specing your locale files
   easy peasy.
 email: chris@tigrish.com
@@ -85,7 +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
+- lib/i18n-spec/tasks.rb
 - spec/fixtures/en.yml
 - spec/fixtures/es.yml
 - spec/fixtures/fr.yml
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3595436614852658303
+      hash: 3454305248462324191
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

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

@@ -1,55 +0,0 @@
-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