i18nline 0.0.2.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9735908d64a162fd6609bad31eeff6eb39c8f4fe
+  data.tar.gz: d220b2d3f964c7b9bb7b3687807f55c6fbf6969a
+SHA512:
+  metadata.gz: 21507271b19bc58d5f1e6ce01ef3b2a87ad466a662d45efa65fdb3253b467ec48c25e917a9d9ce87f5cae424a966f29736ead8b59b2182f1d69cae62348d647e
+  data.tar.gz: 6975c6965347bc646affd6aa9fc578dd479b2c4ec210e143fe178e441d6c7a739759eb4d26127edb184325318839ae4b56f5b1fdf1b53012ba0078948e0eb57a

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'I18nline'
+  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/i18nline/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 jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/i18nline_to_host.js

@@ -0,0 +1,7 @@
+$(document).ready(function() {
+  $('span.translation_missing').contextmenu(function(event) {
+    key = $(this).attr("title").split(":")[1].trim()
+    window.open("/i18nline/find_by_key?key=" + key, "_blank");
+    return false; //prevent context menu to show
+  });
+});

data/app/assets/stylesheets/i18nline/_base.css

@@ -0,0 +1,15 @@
+#edit_key_set .panel-danger{
+  background-color: #EED3D7;
+}
+
+body {
+  font-size: 14px !important;
+}
+.form-control {
+  font-size: 14px !important;
+  height: 36px !important;
+}
+.btn {
+  padding: 6px 10px !important;
+  font-size: 14px !important;
+}

data/app/assets/stylesheets/i18nline/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/i18nline_to_host.css

@@ -0,0 +1,3 @@
+span.translation_missing {
+  border-bottom: 2px solid red;
+}

data/app/controllers/i18nline/application_controller.rb

@@ -0,0 +1,13 @@
+module I18nline
+  class ApplicationController < ActionController::Base
+    before_action :check_authenticated_user
+
+    private
+
+    def check_authenticated_user
+      unless(I18nline.current_user and I18nline.current_user.try(I18nline.can_translate_method))
+        redirect_to I18nline::login_route, error: "You need to login first"
+      end
+    end
+  end
+end

data/app/controllers/i18nline/translations_controller.rb

@@ -0,0 +1,95 @@
+require_dependency "i18nline/application_controller"
+
+module I18nline
+  class TranslationsController < ApplicationController
+    before_action :set_translation, only: [:show, :edit, :update, :destroy]
+
+    def find_by_key
+      tokens = params[:key].split(".")
+      locale_at_inline_key = tokens.delete_at(0)
+      key = tokens.join(".")
+      translations = Translation.where("key = ?", key)
+      if translations.none?
+        redirect_to :root, error: "Something went wrong. No translations found." and return
+      end
+
+      # This is needed to preserve nil values
+      # otherwise 'update action' receives ""
+      # and stores an empty string
+      translations.each do |a_tr|
+        if a_tr.value.nil?
+          a_tr.make_nil = true
+        end
+      end
+
+      require 'ostruct'
+      @tr_set = OpenStruct.new(
+        translations: translations,
+        key: key,
+        locale_at_inline_key: locale_at_inline_key,
+        interpolations: translations.first.interpolations.to_s,
+        is_proc: translations.first.is_proc
+      )
+
+      render "edit_key" and return
+    end
+
+    # GET /translations
+    def index
+      q = Translation.search_key(params[:search_key])
+        .search_value(params[:search_value])
+        .in_locale(params[:search_locale])
+        .not_translated(params[:search_not_translated])
+        .blank_value(params[:search_blank_value])
+      @translations = q.page(params[:page]).per(25)
+    end
+
+    def update_key_set
+      unless params[:tr_set]
+        redirect_to :root, error: "Something went wrong. No translations found." and return
+      end
+      is_proc = params[:tr_set][:is_proc]
+      params[:tr_set][:translation].each do |translation|
+        db_translation = Translation.find(translation.first)
+        if db_translation
+          db_translation.value = translation.last[:value]
+          db_translation.is_proc = is_proc
+          if translation.last[:make_nil].presence == "1"
+            # it is likely that if value was nil and now is not, 'make_nil' has been left marked
+            # as a mistake, so in that case we ignore it and apply the new value:
+            unless db_translation.value_changed? and db_translation.value_was.nil?
+              db_translation.value = nil
+            end
+          end
+          if db_translation.changed?
+            db_translation.save
+          end
+        end
+      end
+      redirect_to :translations, notice: "Update successful."
+    end
+
+    # PATCH/PUT /translations/1
+    def update
+      if translation_params[:make_nil].presence == "1"
+        params[:translation][:value] = nil
+      end
+      if @translation.update(translation_params)
+        redirect_to @translation, notice: 'Translation was successfully updated.'
+      else
+        render action: 'edit'
+      end
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_translation
+        @translation = Translation.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def translation_params
+        params.require(:translation).permit(:value, :is_proc, :make_nil)
+      end
+  end
+end

data/app/helpers/i18nline/application_helper.rb

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

data/app/helpers/i18nline/translations_helper.rb

@@ -0,0 +1,4 @@
+module I18nline
+  module TranslationsHelper
+  end
+end

data/app/models/i18nline/translation.rb

@@ -0,0 +1,55 @@
+module I18nline
+  class Translation < ActiveRecord::Base
+    after_save :update_caches
+    attr_accessor :make_nil
+    serialize :value
+    serialize :interpolations, Array
+
+    default_scope { order("created_at desc") }
+
+    def self.not_translated(apply_this = "1")
+      if apply_this.present?
+        where("value is null")
+      else
+        scoped
+      end
+    end
+
+    def self.blank_value(apply_this = "1")
+      if apply_this.present?
+        #value is serialized so searching for empty is complicated:
+        where("value like ?", "".to_yaml)
+      else
+        scoped
+      end
+    end
+
+    def self.in_locale(locale)
+      if locale.present?
+        where("locale = ?", locale)
+      else
+        scoped
+      end
+    end
+
+    def self.search_key(to_search)
+      if to_search.present?
+        where("key like ?", "%#{to_search}%")
+      else
+        scoped
+      end
+    end
+
+    def self.search_value(to_search)
+      if to_search.present?
+        where("value like ?", "%#{to_search}%")
+      else
+        scoped
+      end
+    end
+
+    def update_caches
+      TRANSLATION_STORE.reload!
+    end
+  end
+end

data/app/views/i18nline/translations/_search_form.html.erb

@@ -0,0 +1,26 @@
+<%= form_tag translations_path, :method => 'get', class: "form-inline", role: "form" do %>
+  <div class="form-group">
+    <label class="sr-only" for="search_key"> key:</label>
+    <%= text_field_tag :search_key, params[:search_key], class: "form-control", placeholder: "Search key" %>
+  </div>
+  <div class="form-group">
+    <label class="sr-only" for="search_value"> value:</label>
+    <%= text_field_tag :search_value, params[:search_value], class: "form-control", placeholder: "Search value" %>
+  </div>
+  <div class="form-group">
+    <%= select_tag :search_locale, options_for_select(I18nline::enabled_locales, params[:search_locale]), class: "form-control", prompt: "all locales" %>
+  </div>
+  <div class="checkbox">
+    <label>
+      <%= check_box_tag :search_not_translated, "1", params[:search_not_translated] == "1" %>
+      Not translated
+    </label>
+  </div>
+  <div class="checkbox">
+    <label>
+      <%= check_box_tag :search_blank_value, "1", params[:search_blank_value] == "1" %>
+      Has blank value
+    </label>
+  </div>
+  <%= submit_tag "Search", :name => nil, class: "btn btn-default" %>
+<% end %>

data/app/views/i18nline/translations/edit_key.html.erb

@@ -0,0 +1,56 @@
+<h1>Editing translation</h1>
+
+<div id="edit_key_set" class="panel panel-default">
+  <div class="panel-heading">
+    <h3 class="panel-title">Key: <%= @tr_set.key %></h3>
+  </div>
+  <div class="panel-body">
+    <%= form_for(@tr_set, as: :tr_set, url: update_key_set_path, method: :put, html: { class: 'form-horizontal', role: 'form' }) do |f| %>
+      <div class="form-group">
+        <label class="col-sm-2 control-label">Interpolations</label>
+        <div class="col-sm-10">
+          <%= f.text_field :interpolations, class: "form-control", disabled: :disabled %>
+        </div>
+      </div>
+      <div class="form-group">
+        <div class="col-sm-offset-2 col-sm-10">
+          <div class="checkbox">
+            <label>
+              <%= f.check_box :is_proc %>
+              Is a proc?
+            </label>
+          </div>
+        </div>
+      </div>
+      <% @tr_set.translations.each do |translation| %>
+        <% panel_color = translation.value.nil? ? "panel-danger" : "panel-info" %>
+        <div class="panel panel-default <%= panel_color %>">
+          <div class="panel-body">
+            <%= f.fields_for "translation[]", translation do |tl_form| %>
+              <div class="input-group col-sm-offset-2">
+                <span class="input-group-addon"><%= translation.locale %></span>
+                <% rows = (translation.value.to_s.length / 100) + 1 %>
+                <%= tl_form.text_area :value, class: "form-control", rows: "#{rows}" %>
+              </div>
+              <div class="form-group">
+                <div class="col-sm-offset-2 col-sm-10">
+                  <div class="checkbox">
+                    <label>
+                      <%= tl_form.check_box :make_nil %>
+                      Make nil to cause missing_translation?
+                    </label>
+                  </div>
+                </div>
+              </div>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
+      <div class="actions">
+        <%= f.submit "Save changes", class: "btn btn-primary" %>
+        <%= link_to 'Cancel', translations_path, class: "btn btn-default" %>
+      </div>
+    <% end %>
+  </div>
+</div>
+

data/app/views/i18nline/translations/index.html.erb

@@ -0,0 +1,31 @@
+<h1>Listing translations</h1>
+
+<%= render "search_form" %>
+
+<table class="table table-hover">
+  <thead>
+    <tr>
+      <th>Locale</th>
+      <th>Key</th>
+      <th>Value</th>
+      <th>Modified at</th>
+      <th>Action</th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @translations.each do |translation| %>
+      <% tr_color = translation.value.nil? ? "danger" : "" %>
+      <tr class="<%= tr_color %>">
+        <td><%= translation.locale %></td>
+        <td><%= translation.key %></td>
+        <td><%= translation.value.to_s.truncate(50) %></td>
+        <td class="date"><%= translation.updated_at.strftime("%T, %d %b %Y") %></td>
+        <td><%= link_to 'Edit', find_by_key_path(key: "#{translation.locale}.#{translation.key}") %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= paginate @translations %>
+

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

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>I18nline</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <%= stylesheet_link_tag    "i18nline/application", media: "all" %>
+    <%= javascript_include_tag "i18nline/application" %>
+    <%= stylesheet_link_tag    "//netdna.bootstrapcdn.com/bootswatch/3.0.1/readable/bootstrap.min.css", media: "all" %>
+    <%= javascript_include_tag "//netdna.bootstrapcdn.com/bootstrap/3.0.2/css/bootstrap.min.css" %>
+    <%= javascript_include_tag "//netdna.bootstrapcdn.com/bootstrap/3.0.2/js/bootstrap.min.js" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <div class="container">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/config/initializers/kaminari_config.rb

@@ -0,0 +1,10 @@
+Kaminari.configure do |config|
+  # config.default_per_page = 25
+  # config.max_per_page = nil
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+  # config.page_method_name = :page
+  # config.param_name = :page
+end

data/config/initializers/locale.rb

@@ -0,0 +1,25 @@
+require 'i18n/backend/active_record'
+module I18nline
+  class MyBackend < I18n::Backend::ActiveRecord
+    Translation.table_name = "i18nline_translations"
+    include I18n::Backend::ActiveRecord::Missing
+    include I18n::Backend::Memoize
+
+    def available_locales
+      I18nline::enabled_locales
+    end
+  end
+end
+TRANSLATION_STORE = I18nline::MyBackend.new
+I18n.backend = I18n::Backend::Chain.new(TRANSLATION_STORE, I18n::Backend::Simple.new)
+module I18n
+  class JustRaiseExceptionHandler < ExceptionHandler
+    def call(exception, locale, key, options)
+      if exception.is_a?(MissingTranslation)
+        TRANSLATION_STORE.store_default_translations(locale, key, options)
+      end
+      super
+    end
+  end
+end
+I18n.exception_handler = I18n::JustRaiseExceptionHandler.new

data/config/routes.rb

@@ -0,0 +1,6 @@
+I18nline::Engine.routes.draw do
+  resources :translations
+  get "find_by_key", to: "translations#find_by_key"
+  put "update_key_set", to: "translations#update_key_set"
+  root to: "translations#index"
+end

data/db/migrate/20131112155848_create_i18nline_translations.rb

@@ -0,0 +1,18 @@
+class CreateI18nlineTranslations < ActiveRecord::Migration
+  def self.up
+    create_table :i18nline_translations do |t|
+      t.string :locale
+      t.string :key
+      t.text   :value
+      t.text   :interpolations
+      t.boolean :is_proc, :default => false
+
+      t.timestamps
+    end
+    add_index :i18nline_translations, [:locale, :key], unique: true
+  end
+
+  def self.down
+    drop_table :i18nline_translations
+  end
+end

data/lib/generators/i18nline/install_generator.rb

@@ -0,0 +1,12 @@
+module I18nline
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy i18nline default files"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template "config/initializers/i18nline.rb"
+      end
+    end
+  end
+end

data/lib/generators/i18nline/templates/config/initializers/i18nline.rb

@@ -0,0 +1,21 @@
+# Use this setup block to configure all options available in i18nline.
+I18nline.setup do |config|
+
+  # A helper method available in your views so we can ask if there is a current user.
+  #config.current_user_method = "current_user"
+
+  # A method your current_user has to respond to affirmatively to be able to
+  # interact with i18nline administration features, like inline markers and
+  # translation management views.
+  # This method will be tried in the instance returned by the 'current_user' helper
+  # specified above: current_user.can_translate?
+  #config.can_translate_method = "can_translate?"
+
+  # A route available in your application to redirect the user to login
+  # when he tries to access to protected views. This route should be
+  # available on your 'rake routes'.
+  #config.login_route = "\login_url"
+
+  # Missing translations will be generated for this locales.
+  #config.enabled_locales = %w(en es it)
+end

data/lib/i18nline/action_view_extension.rb

@@ -0,0 +1,40 @@
+module I18nline
+  module ActionViewExtension
+    extend ActiveSupport::Concern
+
+    included do
+      def current_user_can_translate?
+        current_user = send I18nline.current_user_method
+        if current_user
+          if current_user.try I18nline.can_translate_method
+            I18nline.current_user = current_user
+            return true
+          end
+        end
+        false
+      end
+    end
+
+    def i18nline_assets_inclusion_tag
+      if current_user_can_translate?
+        assets = ""
+        assets << i18nline_host_styles << "\n"
+        assets << i18nline_host_javascripts << "\n"
+        assets.html_safe
+      end
+    end
+
+    private
+
+      # Javascripts that will be loaded on host application:
+      def i18nline_host_javascripts
+        javascript_include_tag("i18nline_to_host.js")
+      end
+
+      # Css that will be loaded on host application:
+      def i18nline_host_styles
+        stylesheet_link_tag("i18nline_to_host.css")
+      end
+
+  end
+end

data/lib/i18nline/engine.rb

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

data/lib/i18nline/railtie.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), 'action_view_extension')
+module I18nline
+  class Railtie < Rails::Railtie
+    initializer "i18nline.configure_rails_initialization" do
+      ActiveSupport.on_load(:action_view) do
+        ::ActionView::Base.send :include, I18nline::ActionViewExtension
+      end
+    end
+  end
+end

data/lib/i18nline/version.rb

@@ -0,0 +1,3 @@
+module I18nline
+  VERSION = "0.0.2.alpha"
+end

data/lib/i18nline.rb

@@ -0,0 +1,28 @@
+require "i18nline/engine"
+require 'i18nline/railtie' if defined?(Rails)
+
+module I18nline
+
+  ## CONFIGURATION OPTIONS:
+
+  mattr_accessor :current_user_method
+  @@current_user_method = "current_user"
+
+  mattr_accessor :can_translate_method
+  @@can_translate_method = "can_translate?"
+
+  mattr_accessor :login_route
+  @@login_route = "/login"
+
+  mattr_accessor :enabled_locales
+  @@enabled_locales = %w(en es it)
+
+  def self.setup
+    yield self
+  end
+
+  private
+  mattr_accessor :current_user
+  @@current_user ||= nil
+
+end

data/lib/tasks/i18nline_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :i18nline do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks