releaf-i18n_database 0.2.1

data/lib/releaf/i18n_database/humanize_missing_translations.rb

@@ -0,0 +1,15 @@
+module Releaf::I18nDatabase
+  module HumanizeMissingTranslations
+    def call(exception, locale, key, options)
+      if exception.is_a?(I18n::MissingTranslation)
+        key.to_s.split('.').last.humanize
+      else
+        super
+      end
+    end
+
+    def self.initialize_component
+      I18n.exception_handler.extend(self)
+    end
+  end
+end

data/releaf-i18n_database.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path("../../releaf-core/lib/releaf/version.rb", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "releaf-i18n_database"
+  s.version     = Releaf::VERSION
+
+  s.summary     = "i18n database gem for releaf"
+  s.description = "i18n database backend for releaf"
+  s.authors     = ["CubeSystems"]
+  s.email       = 'info@cubesystems.lv'
+  s.homepage    = 'https://github.com/cubesystems/releaf'
+
+  s.files             = `git ls-files`.split("\n")
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency 'releaf-core', Releaf::VERSION
+  s.add_dependency 'twitter_cldr'
+  s.add_dependency 'axlsx_rails', '>= 0.3.0'
+  s.add_dependency 'roo'
+
+end

data/spec/builders/translations/builder_common_spec.rb

@@ -0,0 +1,39 @@
+require "rails_helper"
+
+describe Releaf::I18nDatabase::Translations::BuildersCommon, type: :class do
+  class I18nBuildersCommonInheriter < Releaf::Builders::IndexBuilder
+    include Releaf::I18nDatabase::Translations::BuildersCommon
+  end
+  class TableBuilderTestHelper < ActionView::Base; end
+  let(:template){ TableBuilderTestHelper.new }
+  let(:subject){ I18nBuildersCommonInheriter.new(template) }
+
+  describe "#action_url" do
+    before do
+      request = ActionDispatch::Request.new("X")
+      allow(request).to receive(:query_parameters).and_return(a: "b", c: "d")
+      allow(subject).to receive(:request).and_return(request)
+    end
+
+    it "returns url for given action with current query params" do
+      allow(subject).to receive(:url_for).with(a: "b", c: "d", action: :edit).and_return("url")
+      expect(subject.action_url(:edit)).to eq("url")
+    end
+
+    context "when extra params given" do
+      it "merges given params to url" do
+        allow(subject).to receive(:url_for).with(a: "b", c: "z", action: :edit, format: "xx").and_return("url")
+        expect(subject.action_url(:edit, format: "xx", c: "z")).to eq("url")
+      end
+    end
+  end
+
+  describe "#export_button" do
+    it "returns export button" do
+      allow(subject).to receive(:t).with("export").and_return("exp")
+      allow(subject).to receive(:action_url).with(:export, format: :xlsx).and_return("_exp_url_")
+      allow(subject).to receive(:button).with("exp", "download", class: "secondary", href: "_exp_url_").and_return("btn")
+      expect(subject.export_button).to eq('btn')
+    end
+  end
+end

data/spec/builders/translations/edit_builder_spec.rb

@@ -0,0 +1,93 @@
+require "rails_helper"
+
+describe Releaf::I18nDatabase::Translations::EditBuilder, type: :class do
+  class TableBuilderTestHelper < ActionView::Base
+    def protect_against_forgery?; end
+  end
+  let(:template){ TableBuilderTestHelper.new }
+  let(:resource_class){ Releaf::I18nDatabase::Translation }
+  let(:subject){ described_class.new(template) }
+
+  describe "#section" do
+    it "returns section blocks wrapped within edit form" do
+      allow(subject).to receive(:action_url).with(:update).and_return("update_url")
+      allow(subject).to receive(:section_blocks).and_return(["a", "b"])
+      result = '<section><form action="update_url" accept-charset="UTF-8" method="post"><input name="utf8" type="hidden" value="&#x2713;" />ab</form></section>'
+      expect(subject.section).to eq(result)
+    end
+  end
+
+  describe "#section_body" do
+    it "returns section body with form fields partial" do
+      allow(subject).to receive(:render).with(partial: "form_fields", locals: {builder: subject}).and_return("xxx")
+      expect(subject.section_body).to eq('<div class="body">xxx</div>')
+    end
+  end
+
+  describe "#import?" do
+    it "returns template `import` value" do
+      allow(subject).to receive(:template_variable).with("import").and_return("x")
+      expect(subject.import?).to eq("x")
+    end
+  end
+
+  describe "#save_button" do
+    it "returns localized value for given resource and column(locale)" do
+      allow(subject).to receive(:save_button_text).and_return("sv_txt")
+      allow(subject).to receive(:button).with("sv_txt", "check", class: "primary", data: { type: 'ok' }, type: "submit").and_return("save_btn")
+      expect(subject.save_button).to eq("save_btn")
+    end
+  end
+
+  describe "#save_button_text" do
+    context "when within import view" do
+      it "returns translated `Import` text" do
+        allow(subject).to receive(:t).with("Import").and_return("_import_")
+        allow(subject).to receive(:import?).and_return(true)
+        expect(subject.save_button_text).to eq("_import_")
+      end
+    end
+
+    context "when not within import view" do
+      it "returns translated `Save` text" do
+        allow(subject).to receive(:t).with("Save").and_return("_save_")
+        allow(subject).to receive(:import?).and_return(false)
+        expect(subject.save_button_text).to eq("_save_")
+      end
+    end
+  end
+
+  describe "#footer_secondary_tools" do
+    before do
+      allow(subject).to receive(:back_to_index_button).and_return("indx_btn")
+      allow(subject).to receive(:export_button).and_return("xprt_btn")
+    end
+
+    it "returns array with back and export links" do
+      allow(subject).to receive(:import?).and_return(false)
+      expect(subject.footer_secondary_tools).to eq(["indx_btn", "xprt_btn"])
+    end
+
+    context "when within import view" do
+      it "does not incliude export button" do
+        allow(subject).to receive(:import?).and_return(true)
+        expect(subject.footer_secondary_tools).to eq(["indx_btn"])
+      end
+    end
+  end
+
+  describe "#back_to_index_button" do
+    it "returns localized value for given resource and column(locale)" do
+      allow(subject).to receive(:t).with("Back to list").and_return("back")
+      allow(subject).to receive(:action_url).with(:index).and_return("index_url")
+      allow(subject).to receive(:button).with("back", "caret-left", class: "secondary", href: "index_url").and_return("index_btn")
+      expect(subject.back_to_index_button).to eq("index_btn")
+    end
+  end
+
+  describe "#section_header" do
+    it "returns nil" do
+      expect(subject.section_header).to be nil
+    end
+  end
+end

data/spec/builders/translations/index_builder_spec.rb

@@ -0,0 +1,96 @@
+require "rails_helper"
+
+describe Releaf::I18nDatabase::Translations::IndexBuilder, type: :class do
+  class IndexBuilderTestHelper < ActionView::Base
+    include Releaf::ApplicationHelper
+    delegate :resource_class, :table_options, to: :controller
+
+    def protect_against_forgery?; end
+
+    def controller
+      @controller ||= begin
+                        c = Releaf::I18nDatabase::TranslationsController.new
+                        c.setup
+                        c
+                      end
+    end
+  end
+  let(:template){ IndexBuilderTestHelper.new }
+  let(:resource_class){ Releaf::I18nDatabase::Translation }
+  let(:subject){ described_class.new(template) }
+
+  describe "#text_search_content" do
+    it "adds blank translation checbox to text search" do
+      allow(subject).to receive(:t).and_return("search")
+      allow(subject).to receive(:params).and_return(search: "xx")
+      allow(subject).to receive(:button).and_return("btn")
+      allow(subject).to receive(:search_only_blank_ui).and_return("_blank_ui_")
+      expect(subject.text_search_content).to start_with("_blank_ui_")
+    end
+  end
+
+  describe "#search_only_blank_ui" do
+    before do
+      allow(subject).to receive(:t).with("Only blank").and_return("trnls")
+    end
+
+    it "returns only blank translation search ui" do
+      allow(subject).to receive(:params).and_return(search: "xx")
+      expect(subject.search_only_blank_ui).to match_html(%Q[
+          <div class="search-field" data-name="only-blank">
+              <input type="checkbox" name="only_blank" id="only_blank" value="true" />
+              <label for="only_blank">trnls</label>
+          </div>
+      ])
+    end
+
+    it "reflects `only_blank` params to checkbox state" do
+      allow(subject).to receive(:params).and_return(only_blank: "1", search: true)
+      expect(subject.search_only_blank_ui).to match_html(%Q[
+          <div class="search-field" data-name="only-blank">
+              <input type="checkbox" name="only_blank" id="only_blank" value="true" checked="checked" />
+              <label for=\"only_blank\">trnls</label>
+          </div>
+      ])
+    end
+  end
+
+  describe "#footer_primary_tools" do
+    it "returns array with edit button" do
+      allow(subject).to receive(:edit_button).and_return("btn")
+      expect(subject.footer_primary_tools).to eq(["btn"])
+    end
+  end
+
+  describe "#footer_secondary_tools" do
+    it "returns array with edit button" do
+      allow(subject).to receive(:export_button).and_return("a")
+      allow(subject).to receive(:import_button).and_return("b")
+      allow(subject).to receive(:import_form).and_return("c")
+      expect(subject.footer_secondary_tools).to eq(["a", "b", "c"])
+    end
+  end
+
+  describe "#import_form" do
+    it "returns import form" do
+      allow(subject).to receive(:url_for).with(action: 'import').and_return("import_url")
+      result = "<form class=\"import\" enctype=\"multipart/form-data\" action=\"import_url\" accept-charset=\"UTF-8\" method=\"post\"><input name=\"utf8\" type=\"hidden\" value=\"&#x2713;\" /><input type=\"file\" name=\"import_file\" id=\"import_file\" /></form>"
+      expect(subject.import_form).to eq(result)
+    end
+  end
+
+  describe "#edit_button" do
+    it "return edit button" do
+      allow(subject).to receive(:t).with("Edit").and_return("edt")
+      allow(subject).to receive(:action_url).with(:edit).and_return("edt_url")
+      allow(subject).to receive(:button).with("edt", "edit", class: "primary", href: "edt_url").and_return("edt_btn")
+      expect(subject.edit_button).to eq("edt_btn")
+    end
+  end
+
+  describe "#text_search_available?" do
+    it "return true" do
+      expect(subject.text_search_available?).to be true
+    end
+  end
+end

data/spec/builders/translations/table_builder_spec.rb

@@ -0,0 +1,68 @@
+require "rails_helper"
+
+describe Releaf::I18nDatabase::Translations::TableBuilder, type: :class do
+  class TableBuilderTestHelper < ActionView::Base; end
+  let(:template){ TableBuilderTestHelper.new }
+  let(:resource_class){ Releaf::I18nDatabase::Translation }
+  let(:subject){ described_class.new([], resource_class, template, {}) }
+
+  before do
+    allow(Releaf.application.config).to receive(:all_locales).and_return(["de", "ze"])
+  end
+
+  describe "#column_names" do
+    it "returns key and Releaf.application.config column names array" do
+      expect(subject.column_names).to eq([:key, "de", "ze"])
+    end
+  end
+
+  describe "#head_cell_content" do
+    context "when locale column given" do
+      it "returns head cell content with translated locale" do
+        allow(subject).to receive(:translate_locale).with("de").and_return("gegxxxeg")
+        expect(subject.head_cell_content("de")).to eq('gegxxxeg')
+      end
+    end
+
+    context "when non locale column given" do
+      it "returns head cell content with translated locale" do
+        expect(subject).to_not receive(:translate_locale)
+        expect(subject.head_cell_content("lv")).to eq('Lv')
+      end
+    end
+  end
+
+  describe "#cell_content" do
+    it "wraps content within span element" do
+      resource = resource_class.new(key: "xx")
+      expect(subject.cell_content(resource, :key, format_method: :format_string_content)).to eq("<span>xx</span>")
+    end
+  end
+
+  describe "#locale_value" do
+    it "returns localized value for given resource and column(locale)" do
+      resource = resource_class.new
+      allow(resource).to receive(:locale_value).with(:en).and_return("en value")
+      expect(subject.locale_value(resource, :en)).to eq("en value")
+    end
+  end
+
+  describe "#cell_format_method" do
+    before do
+      allow(Releaf.application.config).to receive(:all_locales).and_return([:de, :ze])
+    end
+
+    context "when given column name exists within Releaf.application.config.all_locales" do
+      it "returns :locale_value" do
+        expect(subject.cell_format_method(:de)).to eq(:locale_value)
+        expect(subject.cell_format_method(:ze)).to eq(:locale_value)
+      end
+    end
+
+    context "when given column name does not  exists within Releaf.application.config.all_locales" do
+      it "return super" do
+        expect(subject.cell_format_method(:en)).to eq(:format_string_content)
+      end
+    end
+  end
+end

data/spec/controllers/i18n_backend/translations_controller_spec.rb

@@ -0,0 +1,157 @@
+require 'rails_helper'
+
+describe Releaf::I18nDatabase::TranslationsController do
+  def file_attachment
+    test_document = File.expand_path('../../fixtures/translations_import.xlsx', __dir__)
+    Rack::Test::UploadedFile.new(test_document)
+  end
+
+  login_as_user :user
+
+  before do
+    @time_now = Time.parse("1981-02-23 21:00:00 UTC")
+    allow(Time).to receive(:now).and_return(@time_now)
+  end
+
+  before build_translations: true do
+    @t1 = FactoryGirl.create(:translation, key: 'test.key1')
+    @t2 = FactoryGirl.create(:translation, key: 'great.stuff')
+    @t3 = FactoryGirl.create(:translation, key: 'geek.stuff')
+
+    @t1_en = FactoryGirl.create(:translation_data, lang: 'en', localization: 'testa atslēga', translation_id: @t1.id)
+
+    @t2_en = FactoryGirl.create(:translation_data, lang: 'en', localization: 'awesome stuff', translation_id: @t2.id)
+    @t2_lv = FactoryGirl.create(:translation_data, lang: 'lv', localization: 'lieliska manta', translation_id: @t2.id)
+
+    @t3_en = FactoryGirl.create(:translation_data, lang: 'en', localization: 'geek stuff', translation_id: @t3.id)
+    @t3_lv = FactoryGirl.create(:translation_data, lang: 'lv', localization: 'nūģu lieta', translation_id: @t3.id)
+  end
+
+
+  describe "GET #index", build_translations: true do
+    context "when not searching" do
+      it "renders all translations" do
+        get :index
+        expect( assigns(:collection).size ).to eq(3)
+      end
+    end
+
+    context "when searching" do
+      it "searches by translation key" do
+        get :index, search: 'great'
+        expect( assigns(:collection).size ).to eq(1)
+      end
+
+      it "searched by localized values" do
+        get :index, search: 'manta'
+        expect( assigns(:collection).size ).to eq(1)
+      end
+    end
+
+    context "when searching blank translations" do
+      it "returns translations that has blank translation in any localization" do
+        get :index, only_blank: 'true'
+        expect( assigns(:collection).map(&:id) ).to match_array [@t1.id]
+      end
+    end
+  end
+
+  describe "GET #edit", build_translations: true do
+    context "when search scope is not given" do
+      it "renders all translations" do
+        get :edit
+        expect( assigns(:collection).size ).to eq(3)
+      end
+    end
+
+    context "when search scope is given" do
+      it "renders translations matching search pattern" do
+        get :index, search: 'stuff'
+        expect( assigns(:collection).size ).to eq(2)
+      end
+    end
+  end
+
+  describe "#update" do
+    context "when save successful" do
+      it "updates translations updated_at" do
+        expect(Releaf::I18nDatabase::Backend).to receive("translations_updated_at=").with(@time_now)
+        put :update, translations: [{key: 'a.b.c', localizations: {en: 'test', lv: 'xxl'}}]
+      end
+
+      context "when save with import" do
+        before do
+          put :update, translations: [{key: 'a.b.c', localizations: {en: 'test', lv: 'xxl'}}], import: "true"
+        end
+
+        it "redirects to index view" do
+          expect(subject).to redirect_to(action: :index)
+        end
+
+        it "flash success notification with updated count" do
+          expect(flash["success"]).to eq("id" => "resource_status", "message" => "successfuly imported 1 translations")
+        end
+      end
+
+      context "when save without import" do
+        before do
+          put :update, translations: [{key: 'a.b.c', localizations: {en: 'test', lv: 'xxl'}}]
+        end
+
+        it "redirects to edit view" do
+          expect(subject).to redirect_to(action: :edit)
+        end
+
+        it "flash success notification" do
+          expect(flash["success"]).to eq("id" => "resource_status", "message" => "Update succeeded")
+        end
+      end
+    end
+
+    context "when save failed" do
+      it "renders edit view" do
+        put :update, translations: [{key: '', localizations: {en: 'test', lv: 'xxl'}}]
+        expect(response).to render_template(:edit)
+      end
+
+      it "flash error notification" do
+        put :update, translations: [{key: '', localizations: {en: 'test', lv: 'xxl'}}]
+        expect(flash["error"]).to eq("id" => "resource_status", "message" => "Update failed")
+      end
+    end
+  end
+
+  describe "#import" do
+    context "when file uploaded" do
+      before do
+        file = fixture_file_upload(File.expand_path('../../fixtures/translations_import.xlsx', __dir__), 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+        class << file
+          # The reader method is present in a real invocation,
+          # but missing from the fixture object for some reason (Rails 3.1.1)
+          attr_reader :tempfile
+        end
+
+        post :import, import_file: file
+      end
+
+      it "parses uploaded file and assigns content to collection" do
+        expect( assigns(:collection).size ).to eq(4)
+      end
+
+      it "assigns @import to true" do
+        expect( assigns(:import) ).to be true
+      end
+
+      it "appends breadcrumb with 'import' part" do
+        expect( assigns(:breadcrumbs).last ).to eq({name: "Import"})
+      end
+    end
+
+    context "when no file uploaded" do
+      it "redirects to index" do
+        post :import
+        expect(subject).to redirect_to(action: :index)
+      end
+    end
+  end
+end