idioma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4297d3391e67e66042c2a6572edf9e8928bdd39a
+  data.tar.gz: 3d9c1f1a8c2efb1b012a008a7ee12fb145543af5
+SHA512:
+  metadata.gz: 3c071cda64b47acf5fbb7653edb39c5bebe920a823dee0b28847120a5c1c584fc525ea2f1323d09349b888de58317d5b09bfa8a9a2a5547547b634b1942a3413
+  data.tar.gz: 449f8cd93ddc4c1fac4a435d0b189ed9afe3f496c73d18b93957326f47bcc6cf6dbab74ef37fecb3bfb4542c33269b311589b98601a7064bbd5e575f1a8fa175

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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,91 @@
+# Idioma
+
+Idioma is a Ruby Engine to help manage the flow and editing of translations.
+
+### Current Features
+* Imports translations into database from the config yaml files.
+* Interface for managing translations.
+* Duplicate translations from one locale to other locales.
+* DB changes will be persisted to Redis I18n backend store if supplied.
+* Exports translations from DB into CSV and YAML formats.
+
+### Pending Features
+* Import translations from CSV into DB.
+* Stats on each locale, giving percentage of translated/missing.
+* Test persisting to Redis using https://github.com/guilleiguaran/fakeredis
+* Improve interface by converting into SPA with Angular.
+
+### Starting
+Add it to your gemfile.
+```ruby
+gem 'idioma'
+```
+
+Mount it in your config/routes.rb.
+```ruby
+# config/routes.rb
+MyApp::Application.routes.draw do
+  mount Idioma::Engine => "/idioma"
+end
+```
+
+### Security
+You can secure access to the Idioma interface by using [route constraints](http://guides.rubyonrails.org/routing.html#request-based-constraints).
+
+Example 1 by IP address.
+```ruby
+# config/routes.rb
+idioma_constraint = lambda { |request| request.remote_ip == '127.0.0.1' }
+constraints idioma_constraint do
+  mount Idioma::Engine => "/idioma"
+end
+```
+
+Example 2 by using Devise or another warden based authentication system.
+```ruby
+# config/routes.rb
+idioma_constraint = lambda do |request|
+  current_user = request.env['warden'].user
+  current_user.present? && current_user.respond_to?(:is_admin?) && current_user.is_admin?
+end
+
+constraints idioma_constraint do
+  mount Idioma::Engine => "/idioma"
+end
+```
+
+### Configuration
+Setting | Default | Description
+------- | ------- | -----------
+default_locale | :en | Used for showing the default translation (for translators to translate from) for a given phrase
+locales | [:en] | Idioma will only import translations of locales in this list... ignoring the rest
+ignore_keys | ["ransack", "simple_form"] | Gems sometimes bring their own phrases that you don't actually need translated
+redis_backend | nil | Should be an I18n backend of a Redis store.
+
+### Setup
+Import the migrations into your application
+```
+rake idioma:install:migrations
+```
+
+To populate the idioma_phrases table with translations from your locales/yaml files.
+```
+rake idioma:import_from_extraction
+```
+
+To duplicate all translations from a locale to a new locale (as untranslated).
+```
+rake idioma:duplicate_for_locales base_locale=en new_locale=es
+```
+
+### Example
+```ruby
+$redis = Redis.new(:host => 'localhost', :port => 6379)
+I18n.backend = I18n::Backend::KeyValue.new($redis)
+
+Idioma.configure do |configure|
+  configure.default_locale = :en
+  configure.locales = [:en, :es, :fr]
+  configure.redis_backend = I18n.backend
+end
+```

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Idioma'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

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

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .
+//= require jquery
+//= require bootstrap-sprockets

data/app/assets/javascripts/idioma/phrases.js.coffee

@@ -0,0 +1,35 @@
+window.InlinePhraseUpdater = class InlinePhraseUpdater
+  constructor: () ->
+    # attributes
+    @phraseInputs = $(".i18n_value")
+
+    # events
+    @phraseInputs.on "focus", (e) => @setOriginalValue(e)
+    @phraseInputs.on "blur", (e) => @updateIfChanged(e)
+
+    # init
+
+  setOriginalValue: (e) =>
+    phraseInput = $(e.target)
+    phraseInput.data("original", phraseInput.val())
+
+  updateIfChanged: (e) =>
+    phraseInput = $(e.target)
+    if phraseInput.data("original") != phraseInput.val()
+      @updateStatus(phraseInput, "status-working")
+      $.ajax(
+        type: "PUT"
+        url: phraseInput.data("url")
+        dataType: "json"
+        data:
+          phrase:
+            i18n_value: phraseInput.val()
+      ).done((data) =>
+        @updateStatus(phraseInput, "status-success")
+      ).fail((data) =>
+        @updateStatus(phraseInput, "status-error")
+      )
+
+  updateStatus: (input, status) ->
+    input.removeClass("status-success").removeClass("status-error").removeClass("status-working")
+    input.addClass(status)

data/app/assets/stylesheets/idioma/application.css.scss

@@ -0,0 +1,26 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+@import "bootstrap-sprockets";
+@import "bootstrap";
+
+body {
+  padding-top: 50px;
+}
+
+.highlight {
+  padding: 10px;
+  background-color: #f8f8f8;
+}

data/app/assets/stylesheets/idioma/forms.css.scss

@@ -0,0 +1,19 @@
+.search {
+  .form-group {
+    padding-right: 10px;
+  }
+
+  label {
+    margin-right: 10px;
+  }
+}
+
+.status-working {
+  border-color: yellow !important;
+}
+.status-success {
+  border-color: green !important;
+}
+.status-error {
+  border-color: red !important;
+}

data/app/assets/stylesheets/idioma/phrases.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/idioma/application_controller.rb

@@ -0,0 +1,4 @@
+module Idioma
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/idioma/phrases_controller.rb

@@ -0,0 +1,96 @@
+#require_dependency "idioma/application_controller"
+
+module Idioma
+  class PhrasesController < ApplicationController
+    before_action :set_phrase, only: [:edit, :update, :show]
+
+    # GET /phrases
+    def index
+      params[:locale] ||= I18n.default_locale
+      scope = Phrase.where(locale: params[:locale])
+
+      if params[:q].present?
+        scope = scope.where("i18n_key ilike ? OR i18n_value ilike ?", "%#{params[:q]}%", "%#{params[:q]}%")
+      end
+
+      respond_to do |format|
+        format.html {
+          @phrases = scope.paginate(:page => params[:page])
+        }
+        format.csv {
+          render text: PhraseExporter.to_csv(scope)
+        }
+        format.yaml {
+          render text: PhraseExporter.to_yaml(scope)
+        }
+        format.json {
+          @phrases = scope.paginate(:page => params[:page])
+          render json: {
+            meta: {
+              pagination: {
+                current_page: @phrases.current_page,
+                per_page: @phrases.per_page,
+                total_entries: @phrases.total_entries
+              }
+            },
+            phrases: @phrases
+          }
+        }
+      end
+
+    end
+
+    # GET /phrases/1
+    def show
+      respond_to do |format|
+        format.json {
+          render json: @phrase
+        }
+      end
+    end
+
+    # PATCH/PUT /phrases/1
+    def update
+      result = @phrase.update_and_update_backend(phrase_params)
+      respond_to do |format|
+        format.html {
+          if result
+            redirect_to [:edit, @phrase], flash: {success: t('idioma.record_updated')}
+          else
+            render :edit
+          end
+        }
+        format.json {
+          if result
+            render json: @phrase
+          else
+            render json: {
+              errors: @phrase.errors.messages
+            }.merge(@phrase.attributes),
+            status: :bad_request
+          end
+        }
+      end
+
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_phrase
+        @phrase = Phrase.find(params[:id])
+      rescue ActiveRecord::RecordNotFound
+        respond_to do |format|
+          format.json { render json: {}.to_json, status: :not_found }
+          format.html {
+            flash[:error] = t('idioma.record_not_found')
+            redirect_to phrases_path
+          }
+        end
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def phrase_params
+        params.require(:phrase).permit(:locale, :i18n_key, :i18n_value, :flagged_at, :notes)
+      end
+  end
+end

data/app/helpers/idioma/application_helper.rb

@@ -0,0 +1,4 @@
+module Idioma
+  module ApplicationHelper
+  end
+end

data/app/helpers/idioma/phrases_helper.rb

@@ -0,0 +1,4 @@
+module Idioma
+  module PhrasesHelper
+  end
+end

data/app/models/idioma/phrase.rb

@@ -0,0 +1,115 @@
+module Idioma
+  class Phrase < ActiveRecord::Base
+
+    # == Constants ============================================================
+
+    # == Attributes ===========================================================
+
+    # == Extensions ===========================================================
+
+    # == Relationships ========================================================
+
+    # == Validations ==========================================================
+
+    validates :locale, :i18n_key, presence: true
+    validates :i18n_key, uniqueness: { scope: :locale }
+
+    # == Scopes ===============================================================
+
+    scope :translated,   lambda { where("translated_at is not null") }
+    scope :untranslated, lambda { where("translated_at is null") }
+    scope :missing,      lambda { where("i18n_value is null") }
+
+    # == Callbacks ============================================================
+
+    before_validation :strip_values
+
+    # == Class Methods ========================================================
+
+    # Given a base locale, duplicate all phrases to a set of other locales
+    #
+    # @param [Symbol] The base locale
+    # @param [Array] An array of other locales
+    def self.duplicate_for_locales(base_locale, locales)
+      locales = [locales] unless locales.class == Array
+      where(locale: base_locale).find_each do |base_phrase|
+        locales.each do |locale|
+          unless where(locale: locale, i18n_key: base_phrase.i18n_key).exists?
+            phrase = Phrase.create!({
+              locale: locale,
+              i18n_key: base_phrase.i18n_key
+            })
+          end
+        end
+      end
+    end
+
+    # Take what's in the database and prime the i18n backend store (Redis)
+    def self.prime_backend
+      find_each do |phrase|
+        phrase.update_backend
+      end
+    end
+
+    # == Instance Methods =====================================================
+
+    # Update the record and then push those changes to the i18n backend
+    #
+    # @param [Hash] The Phrase attributes to update
+    # @return [Boolean] Whether the update was successful
+    def update_and_update_backend(params = {})
+      self.translated_at = Time.zone.now if self.untranslated?
+
+      result = self.update(params)
+      if result
+        self.update_backend
+      end
+      result
+    end
+
+    # Save and push the changes to the i18n backend
+    #
+    # @param [Hash] The Phrase attributes to save
+    # @return [Boolean] Whether the save was successful
+    def save_and_update_backend(params = {})
+      result = self.save(params)
+      if result
+        self.update_backend
+      end
+      result
+    end
+
+    # Will update the i18n backend if it has been configured
+    def update_backend
+      if Idioma.configuration.redis_backend
+        if i18n_value.present?
+          Idioma::RedisBackend.update_phrase(self)
+        else
+          Idioma::RedisBackend.delete_phrase(self)
+        end
+      end
+    end
+
+    # Is this phrase translated?
+    # @return [Boolean]
+    def translated?
+      translated_at.present?
+    end
+
+    # Is this phrase untranslated?
+    # @return [Boolean]
+    def untranslated?
+      !translated?
+    end
+
+    private
+
+    # Strip the values before validating the model
+    def strip_values
+      [:i18n_value].each do |field|
+        self.send("#{field}=", self.send(field).to_s.strip)
+      end
+    end
+
+  end
+end

data/app/models/idioma/phrase_exporter.rb

@@ -0,0 +1,69 @@
+module Idioma
+  class PhraseExporter
+
+    # Produce a CSV string of Phrases based on a scope
+    # @param [ActiveRecord::Relation] From the Phrase model
+    # @return [String] in CSV format
+    def self.to_csv(scope)
+      require 'csv'
+      CSV.generate do |csv_object|
+        csv_object << [
+          I18n.t("idioma.locale"),
+          I18n.t("idioma.key"),
+          I18n.t("idioma.value"),
+          I18n.t("idioma.translated")
+        ]
+        scope.find_each do |phrase|
+          csv_object << [
+            phrase.locale,
+            phrase.i18n_key,
+            phrase.i18n_value,
+            phrase.translated_at.present? ? I18n.t('idioma.ans_yes') : I18n.t('idioma.ans_no')
+          ]
+        end
+      end
+    end
+
+    # Produce a YAML string of Phrases based on a scope
+    # @param [ActiveRecord::Relation] From the Phrase model
+    # @return [String] in YAML format
+    def self.to_yaml(scope)
+      phrases = scope.order(:locale, :i18n_key).pluck(:locale, :i18n_key, :i18n_value)
+
+      phrase_hash = phrases.each_with_object({}) do |phrase, hsh|
+        hsh["#{phrase[0]}.#{phrase[1]}"] = phrase[2]
+      end
+
+      to_nested_hash(phrase_hash).to_yaml
+    end
+
+    private
+
+    # Will take a flat hash with dot notation (en.errors.invalid) keys and
+    #   convert it to a nested hash.
+    #
+    # Example: {"en.hello" => "Hi"} becomes {"en" => {"hello" => "Hi"}}
+    #
+    # @param [Hash] Flat hash with dot notation keys
+    # @return [Hash] Nested hash
+    def self.to_nested_hash(input_hash)
+      input_hash.each_with_object({}) do |(key, value), hsh|
+        hsh.deep_merge!(dot_keys_to_hash(key.split("."), value))
+      end
+    end
+
+    # Will take an array of keys and a value, and convert this into a nested
+    #   hash.
+    # @param [Array] Of keys
+    # @param [Object] Any value
+    # @return [Hash] Nested hash using the keys and value
+    def self.dot_keys_to_hash(keys, value)
+      if keys.length == 1
+        {keys.first => value}
+      else
+        {keys.shift => dot_keys_to_hash(keys, value)}
+      end
+    end
+
+  end
+end

data/app/models/idioma/phrase_extractor.rb

@@ -0,0 +1,49 @@
+module Idioma
+  class PhraseExtractor
+
+    # Find all of the translations that are in the locale yaml files
+    #   and convert them into a hash of dotted hash notation key/values
+    #   for each locale that is found
+    # @return [Hash] Dotted hash notation key/value pairs
+    def self.extract
+      phrase_hashes = self.get_translations
+
+      phrase_dotted_hashes = {}
+      # convert each locales translations to dotted hash
+      phrase_hashes.each do |locale, phrase_hash|
+        phrase_dotted_hashes[locale] = self.to_dotted_hash(phrase_hash)
+      end
+
+      phrase_dotted_hashes
+    end
+
+    # Get translations from the i18n backend
+    # @param [I18n::Backend, nil] A custom I18n backend
+    # @return [Hash] of translations separated by locale
+    def self.get_translations(backend = nil)
+      backend = I18n::Backend::Simple.new if backend.nil?
+      backend.send(:init_translations)
+      backend.send(:translations)
+    end
+
+    # Convert a nested Hash ({date: {format: {long: "YYYY-MM-DD"}}})
+    #   to a dotted hash {"date.format.long" => "YYYY-MM-DD"}
+    # @param [Hash] Nested hash input
+    # @param [Hash, {}] An accumulator to store the result
+    # @param [String, nil] An accumulator for the key that gets built up
+    # @return [Hash] The end result after the conversion
+    def self.to_dotted_hash(source, accumulator = {}, namespace = nil)
+      prefix = "#{namespace}." if namespace
+      case source
+      when Hash
+        source.each do |key, value|
+          to_dotted_hash(value, accumulator, "#{prefix}#{key}")
+        end
+      else
+        accumulator[namespace] = source
+      end
+      accumulator
+    end
+
+  end
+end

data/app/models/idioma/phrase_importer.rb

@@ -0,0 +1,50 @@
+module Idioma
+  class PhraseImporter
+
+    # Import all of the locales and phrases from the extraction
+    # The extraction comes from Idioma::PhraseExtractor.extract
+    def self.import_from_extraction
+      phrases = Idioma::PhraseExtractor.extract
+      phrases.each do |locale, locale_phrases|
+        next unless Idioma.configuration.locales.include?(locale.to_sym)
+        self.import(locale, locale_phrases)
+      end
+    end
+
+    # For a given locale, impot its phrases
+    #
+    # @param [Symbol] the locale, eg. :en
+    # @param [Hash] a hash of phrases which are already in dot-notation
+    def self.import(locale, locale_phrases)
+      locale_phrases.each do |key, value|
+        next if self.ignore_key?(key)
+
+        phrase = Idioma::Phrase.find_by(locale: locale, i18n_key: key)
+        if !phrase
+          phrase = Idioma::Phrase.new({
+            locale: locale,
+            i18n_key: key,
+            i18n_value: value,
+            translated_at: Time.zone.now
+          })
+        elsif phrase.untranslated?
+          phrase.i18n_value = value
+          phrase.translated_at = Time.zone.now if value.present?
+        end
+        phrase.save_and_update_backend
+      end
+    end
+
+    # Checks to see if a given key should be ignored based on the ignore_keys array
+    #
+    # @param [String] The key to check against
+    # @return [Boolean] Whether to ignore this key or not
+    def self.ignore_key?(key)
+      Idioma.configuration.ignore_keys.each do |ignore_key|
+        return true if key.to_s.include?(ignore_key)
+      end
+      false
+    end
+
+  end
+end

data/app/models/idioma/redis_backend.rb

@@ -0,0 +1,22 @@
+module Idioma
+
+  # Class for dealing with deleting and updating phrases in the i18n backend.
+  #   This is specifically when the backend is Redis
+  class RedisBackend
+
+    # Delete a given Phrase from Redis
+    # @param [Phrase] The Phrase to delete
+    # @return [Boolean] Result of the del command in Redis
+    def self.delete_phrase(phrase)
+      Idioma.configuration.redis_backend.store.del("#{phrase.locale}.#{phrase.i18n_key}")
+    end
+
+    # Update (or create) a Phrase in Redis
+    # @param [Phrase] The Phrase to update or create
+    # @return [Boolean] Result of the store_translations command from the Redis backend (I18n::Backend)
+    def self.update_phrase(phrase)
+      Idioma.configuration.redis_backend.
+        store_translations(phrase.locale, {phrase.i18n_key => phrase.i18n_value}, :escape => false)
+    end
+  end
+end