missing_i18n 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmIwNDA0MmM3ODk5YTY2NDk2YmFiMDEyY2I5YzQyYjY5ZWM3ZDE3Yw==
+  data.tar.gz: !binary |-
+    MjU4YjNjMGY0ZTBkYTM5MGE5YjExZjU3ZjJiMTgxMDJjM2MxZGVhYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGY3MDM0MjAzZWQwNzUyMGQxYjEyNjY1ZDhmYWViMTAzYmYwMmIzZTFmYmFh
+    MGI1NWU3Y2NjYTRiODQ5M2YwYWY1Njc0YTg1MWMyY2FlMzIyYjNkODg3ZTg5
+    MDY0YjNkNmJhZmJhNDlkNmYwMjlhNDFhODBkYTM5YTE1MDBkNzA=
+  data.tar.gz: !binary |-
+    YTE3M2Q2OWFkMTJhMjIxYmU3N2I3Mzg0ZmNmZTAyMGE1YzY3OThkMmY1Yzg2
+    NjgxODU2MmQyMWU1NDUxZjY3MTE5OTVjNGY3ZWYzMmJhZWMwOTY2NjFiOTQ2
+    N2Y4YjE5N2VkNDkwOWU5OGNmY2RmODc2ZWIwNDFiZGNjYmIyODM=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,68 @@
+# missing_i18n
+
+This is a [rails 3 mountable engine](http://railscasts.com/episodes/277-mountable-engines).
+
+It allows you to see which locales have missing entries. You probably want to use it in your development/staging environment.
+
+## Installation
+
+On your Gemfile:
+
+    gem 'missing_i18n'
+
+On your `config/routes.rb`:
+
+    unless Rails.env.production? # optional, but recommended
+      mount MissingI18n::Engine, :path => '/missing_i18n'
+    end
+
+## Customization & scope filtering
+
+You can override MissingI18n' only view by creating any of the following files:
+
+* `app/views/missing_i18n/locales/index.html.erb`
+* `app/views/missing_i18n/locales/show.html.erb`
+
+You can similarly override MissingI18n controller by defining `app/views/missing_i18n/locales_controller.rb`.
+
+Finally, you will probably want to add "ignored paths" to `missing_i18n`, for example for avoiding certain groups of prefixes.
+
+To ignore (for example) the entries inserted by the [Faker](http://faker.rubyforge.org/), create an initializer file with this text:
+
+    # config/initializers/missing_i18n.rb
+
+    if defined? MissingI18n
+      MissingI18n.ignored_scopes += ['faker']
+    end
+
+You can add more than one scope on that array. Also, you can add dot-separated scopes (`'foo.bar.baz'`) to filter more precisely.
+
+Notice that `missing_i18n` [ignores some scopes by default](https://github.com/kikito/missing_i18n/blob/master/lib/missing_i18n.rb). These are scopes missing in some
+locales of [rails-i18n](https://github.com/svenfuchs/rails-i18n), and in general it is safe to ignore those. If you need to include them in the list, you can; just
+set `MissingI18n.ignored_scopes` to whatever you want; just use `=` instead of `+=`:
+
+    # config/initializers/missing_i18n.rb
+
+    if defined? MissingI18n
+      MissingI18n.ignored_scopes = ['my.scopes', 'which.dont.include', 'the.default.ones']
+    end
+
+Everything will work as long as `MissingI18n.ignored_scopes` is an array of strings.
+
+## Tests
+
+This engine has no tests. I'm basically using non-public methods from the i18n gem, so it's extremely brittle and coupled with the implementation details of i18n.
+
+However, you can try the dummy app by executing:
+
+    cd test/dummy
+    rails s
+
+If you then go to http://localhost:3000, you should see some differences between the es and en locales. Try modifying the files inside `test/dummy/config/locales` and
+refreshing the page.
+
+Feel free to send me pull requests with tests if you want!
+
+
+
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MissingI18n'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/missing_i18n/application.js

@@ -0,0 +1,11 @@
+//= require jquery-1.8.3.min
+//= require_tree .
+
+jQuery(function($) {
+  $('.locales').on('click', 'li', function() {
+    var $li = $(this);
+    $('iframe').attr('src', $li.find('a').attr('href'));
+    $li.parent().find('.active').removeClass('active');
+    $li.addClass('active');
+  });
+});

data/app/assets/stylesheets/missing_i18n/application.css.erb

@@ -0,0 +1,36 @@
+/*
+ *= require bootstrap.min
+ *= require_self
+ *= require_tree .
+ */
+
+body {
+  height: 100%;
+}
+
+iframe {
+  min-height: 95%;
+  width: 100%;
+  border:     none;
+}
+
+.locales li {
+  list-style-type: none;
+}
+
+.locales .active,
+.locales .active:hover {
+  background: #ccc;
+}
+
+.locales li {
+  cursor: pointer;
+}
+
+[class^="icon-"], [class*=" icon-"] {
+  background-image: url(<%=asset_path "glyphicons-halflings.png"%>);
+}
+
+.icon-white {
+  background-image: url(<%=asset_path "glyphicons-halflings-white.png"%>);
+}

data/app/controllers/missing_i18n/application_controller.rb

@@ -0,0 +1,7 @@
+module MissingI18n
+  class ApplicationController < ActionController::Base
+    def index
+      @locales = Locale.all
+    end
+  end
+end

data/app/controllers/missing_i18n/locales_controller.rb

@@ -0,0 +1,17 @@
+module MissingI18n
+  class LocalesController < ApplicationController
+    def index
+      @locales = Locale.all
+    end
+
+    def show
+      @locale = Locale.new(params[:id])
+      respond_to do |format|
+        format.html
+        format.yaml {
+          render :text => @locale.to_yaml, :content_type => 'text/yaml'
+        }
+      end
+    end
+  end
+end

data/app/models/missing_i18n/locale.rb

@@ -0,0 +1,90 @@
+module MissingI18n
+  class Locale #plain old ruby object
+
+    @@merged_translations = nil
+    @@i18n_translations = nil
+    @@all = nil
+
+    attr_accessor :id
+
+    def initialize(id)
+      self.id = id.to_s
+    end
+
+    def to_yaml(ignored_scopes = MissingI18n.ignored_scopes)
+      {self.id => missing_i18n(ignored_scopes)}.to_yaml
+    end
+
+    def translations
+      self.class.i18n_translations[self.id]
+    end
+
+    def missing_i18n(ignored_scopes = MissingI18n.ignored_scopes)
+      diff = hash_deep_diff(self.class.merged_translations, self.translations)
+      return hash_filter(diff, [], ignored_scopes)
+    end
+
+    def self.all
+      @@all ||= I18n.available_locales.collect{ |id| new(id) }.sort_by(&:id)
+    end
+
+    def self.merged_translations
+      unless @@merged_translations
+        @@merged_translations = {}
+        i18n_translations.each do |locale, translations|
+          @@merged_translations = translations.deep_merge(@@merged_translations)
+        end
+      end
+      @@merged_translations
+    end
+
+    def self.i18n_translations
+      unless @@i18n_translations
+        I18n.backend.send :init_translations
+        @@i18n_translations = hash_deep_stringify_keys(I18n.backend.send(:translations))
+      end
+      @@i18n_translations
+    end
+
+    private
+
+
+    def hash_filter(hash, scope, ignored_scopes)
+      return hash unless hash.is_a? Hash
+      result = {}
+      hash.each do |key, value|
+        new_scope = scope.dup << key
+        unless new_scope.join('.').in?(ignored_scopes)
+          new_value = hash_filter(value, new_scope, ignored_scopes)
+          result[key] = new_value unless new_value.blank?
+        end
+      end
+      result
+    end
+
+    # assumption big contains small completely
+    def hash_deep_diff(big, small)
+      return big unless small.is_a? Hash
+      result = {}
+      big.each do |key, value|
+        if small[key].present?
+          if value.is_a?(Hash)
+            diff = hash_deep_diff(value, small[key])
+            result[key] = diff unless diff.empty?
+          end
+        else
+          result[key] = value
+        end
+      end
+      result
+    end
+
+    def self.hash_deep_stringify_keys(hash)
+      return hash unless hash.is_a? Hash
+      hash.each_with_object({}) do |(key,value), result|
+        result[key.to_s] = hash_deep_stringify_keys(value)
+      end
+    end
+
+  end
+end

data/app/views/layouts/missing_i18n/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>missing_i18n</title>
+    <%= stylesheet_link_tag    "missing_i18n/application", :media => "all" %>
+    <%= javascript_include_tag "missing_i18n/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+
+    <%= yield %>
+
+  </body>
+</html>

data/app/views/missing_i18n/locales/_locale.html.erb

@@ -0,0 +1,5 @@
+<h2><%= link_to locale.name, self.send("missing_i18n_#{locale.name}_path") %>
+<small>(<%= link_to 'yaml', self.send("missing_i18n_#{locale.name}_path", :format => :yaml) %>)</small></h2>
+<pre>
+  <%= locale.to_yaml %>
+</pre>

data/app/views/missing_i18n/locales/index.html.erb

@@ -0,0 +1,19 @@
+<div class="container">
+  <h1>missing_i18n
+    <%= link_to locales_path, class: 'btn btn-primary refresh' do %>
+      <i class="icon-refresh icon-white"></i>
+      Refresh
+    <% end %>
+  </h1>
+
+  <ul class="locales inline">
+    <% @locales.each_with_index do |locale, index| %>
+      <li class="<%= 'active' if index == 0 %>">
+        <%= link_to(locale.id, locale_path(locale.id), target: 'locale') %>
+      </li>
+    <% end %>
+  </ul>
+
+  <iframe name="locale" id="locale" src="<%= @locales[0].present? ? locale_path(@locales[0].id) : 'about:blank' %>"></iframe>
+</div>
+

data/app/views/missing_i18n/locales/show.html.erb

@@ -0,0 +1,15 @@
+<h2><%= @locale.id %></h2>
+
+<pre>
+  <%= @locale.to_yaml %>
+</pre>
+
+<p class="pull-right">
+  <%= link_to locale_path(@locale.id, :format => :yaml),
+        :class => 'btn btn-inverse btn-small',
+        :target => '_blank' do %>
+    <i class="icon-download icon-white"></i>
+    yaml
+  <% end %>
+</p>
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+MissingI18n::Engine.routes.draw do
+  get '/'   => 'locales#index', :as => :locales
+  get ':id' => 'locales#show',  :as => :locale
+end

data/lib/missing_i18n/engine.rb

@@ -0,0 +1,5 @@
+module MissingI18n
+  class Engine < ::Rails::Engine
+    isolate_namespace MissingI18n
+  end
+end

data/lib/missing_i18n/version.rb

@@ -0,0 +1,3 @@
+module MissingI18n
+  VERSION = "0.0.1"
+end

data/lib/missing_i18n.rb

@@ -0,0 +1,29 @@
+require "missing_i18n/engine"
+
+module MissingI18n
+  DEFAULT_IGNORED_SCOPES = %w{
+    activemodel.errors.messages
+    activemodel.errors.template.header
+    activerecord.errors.messages
+    activerecord.errors.template.header
+    datetime.distance_in_words
+    datetime.prompts
+    errors.messages
+    errors.template.header
+    helpers.button
+    helpers.select
+    helpers.submit
+    i18n
+    number
+    support.array
+    time
+  }
+
+  def self.ignored_scopes=(new_ignored_scopes)
+    @@ignored_scopes = new_ignored_scopes
+  end
+
+  def self.ignored_scopes
+    @@ignored_scopes ||= DEFAULT_IGNORED_SCOPES.clone
+  end
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/missing_i18n/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'