weeler 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2174e5387e4473742f03bcb7d8676524c0909bf8ad711bb4a61b722c1d75834
-  data.tar.gz: 3c4250a6a160bf9cb62da039fc29e8d372d968ad05e02400ee1162bad4f61327
+  metadata.gz: 9a5843d8169cc1f00da76876d33c136077878f6f02b516207402652068bfb54b
+  data.tar.gz: 2b1d3e9aa399794f81e91b096b76147cd7529bae9966e1798668551321890c2c
 SHA512:
-  metadata.gz: '05382816c8433c45a716d23bccf68821c1d7872fb464ed353b291e0873e90cd6a5ee2be5a011112ed7674be33c205772de5849b3d72c095e626ebd924ee0b5d3'
-  data.tar.gz: 8ad0ed75b237f4bf39bbc47eaa4189100f9f6db5ee02342cf81fcbe8eafd52f70feeba24cb2ce45026f61f42f939eea66f231a88a72a882b3a18e840017eda82
+  metadata.gz: f8a8056a9690d1dfab75ea1e570e1b332e0c22b245c48908ad46f4994e9dd8c3ae1557b7d089555143d6824a0a0af2756817bf623a62a23a50d1922f3ba56cd5
+  data.tar.gz: 02dc435b1cd9f7f358b2a36b2a2507389071ca0e0a65a8d43136dd442c0b748664d77d2d99f4f5d1473effff97cb0e335c8441993d960071b5ff01822bfd66ab

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/.travis.yml

@@ -8,7 +8,8 @@ before_script:
   - psql -c 'create database travis_ci_test;' -U postgres
 rvm:
   - "2.6.0"
-  - "2.7.0"
+  - "2.7.2"
+  - "3.0.0"
 # uncomment this line if your project needs to run something other than `rake`:
 script:
   - RAILS_ENV=test bundle exec rake db:migrate --trace

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.1
+
+### Features & Enhancements
+
+* Optimized translation import and export (avoiding n+1 queries)
+
 ## 2.0.0
 
 ### Features & Enhancements

data/Gemfile

@@ -3,12 +3,5 @@ source 'https://rubygems.org'
 gem 'globalize', github: 'globalize/globalize'
 gem 'rails-controller-testing'
 
-# platform :jruby do
-#   github 'jruby/activerecord-jdbc-adapter', branch: 'rails-5' do
-#     gem 'activerecord-jdbc-adapter'
-#     gem 'activerecord-jdbcpostgresql-adapter'
-#   end
-# end
-
 # Specify your gem's dependencies in weeler.gemspec
 gemspec

data/app/assets/javascripts/weeler/init.js

@@ -1,8 +1,6 @@
 //= require jquery
-//= require jquery.turbolinks
 //= require jquery-ui
 //= require jquery_ujs
-//= require turbolinks
 //= require ./vendor/moment
 //= require_tree ./vendor
 //= require_tree ./lib

data/app/assets/stylesheets/weeler/style.css.scss

@@ -78,4 +78,10 @@ span.weeler_version{
   vertical-align: super;
   font-size:10px;
   color:#C2C2C2;
-}
+}
+
+.sidebar-nav {
+  .nav > li > a:hover, .nav > li > a:focus, .nav > li > a.active {
+    background-color: #ddd;
+  }
+}

data/app/controllers/weeler/seo_items_controller.rb

@@ -17,8 +17,9 @@ module Weeler
         translation.value = value
         translation.save
       end
-      Settings.i18n_updated_at = Time.now
+      Setting.i18n_updated_at = Time.now
+
       redirect_to({action: :edit, id: params[:id]}, {flash: {success: "Section updated."}})
     end
   end
-end
+end

data/app/controllers/weeler/settings_controller.rb

@@ -1,21 +1,39 @@
 class Weeler::SettingsController < Weeler::ConfigurationController
+  HIDDEN_SETTINGS_KEYS = %w[i18n_updated_at].freeze
+
   def index
-    # to get all items for render list
-    @settings = Settings.unscoped
+    @settings = Setting.all.order(:id).where.not(var: HIDDEN_SETTINGS_KEYS)
+  end
+
+  def create
+    @setting = Setting.new(create_setting_params)
+
+    if @setting.save
+      redirect_to weeler_settings_path, flash: { success: 'Setting created.' }
+    else
+      flash.now[:error] = 'Errors on creating.'
+      render :index
+    end
   end
 
   def update
-    @setting = Settings.unscoped.find(params[:id])
-    if @setting.update(setting_params)
-      redirect_to weeler_settings_path, flash: {success: "Setting updated."}
+    @setting = Setting.find(params[:id])
+
+    if @setting.update(update_setting_params)
+      redirect_to weeler_settings_path, flash: { success: 'Setting updated.' }
     else
-      flash.now[:error] = "Errors in updating."
+      flash.now[:error] = 'Errors on updating.'
       render :index
     end
   end
-protected
-  def setting_params
-    params.require(:settings).permit([:value])
+
+  protected
+
+  def create_setting_params
+    params.require(:setting).permit(:var, :value)
   end
 
+  def update_setting_params
+    params.require(:setting).permit(:value)
+  end
 end

data/app/controllers/weeler/static_sections_controller.rb

@@ -12,8 +12,8 @@ module Weeler
         translation.value = value
         translation.save
       end
-      Settings.i18n_updated_at = Time.now
-      redirect_to({action: :show, id: params[:id]}, {flash: {success: "Section updated."}})
+      Setting.i18n_updated_at = Time.current
+      redirect_to({ action: :show, id: params[:id] }, { flash: { success: "Section updated." } })
     end
   end
 end

data/app/controllers/weeler/translations_controller.rb

@@ -19,7 +19,7 @@ module Weeler
       @translation = I18n::Backend::Weeler::Translation.new(translation_params)
 
       if @translation.save
-        Settings.i18n_updated_at = Time.now
+        Setting.i18n_updated_at = Time.now
         redirect_to ({ action: :edit, id: @translation }), flash: { success: "Translation saved." }
       else
         flash.now[:error] = "Errors in saving."
@@ -31,7 +31,7 @@ module Weeler
       @translation = I18n::Backend::Weeler::Translation.find(params[:id])
 
       if @translation.update(translation_params)
-        Settings.i18n_updated_at = Time.now
+        Setting.i18n_updated_at = Time.now
 
         redirect_to ({ action: :edit, id: @translation }), flash: { success: "Translation updated." }
       else
@@ -44,24 +44,11 @@ module Weeler
       @translation = I18n::Backend::Weeler::Translation.find(params[:id])
       @translation.destroy
 
-      Settings.i18n_updated_at = Time.now
+      Setting.i18n_updated_at = Time.now
 
       redirect_to ({ action: :index }), flash: {success: "Translation succesfully removed."}
     end
 
-    def usage_stats
-      @used_keys = []
-      if Settings.log_key_usage == 'dump'
-        I18n::Backend::Weeler::TranslationStat.all.each do |translation_stat|
-          @used_keys << [translation_stat.key, translation_stat.usage_count]
-        end
-      else
-        Weeler.i18n_cache.instance_variable_get(:@data).keys.each do |key|
-          @used_keys << [key, Weeler.i18n_cache.read(key)] if key.start_with?('usage_stats')
-        end
-      end
-    end
-
     def export
       respond_to do |format|
         format.xlsx do
@@ -76,7 +63,7 @@ module Weeler
       if params[:file].present?
         I18n::Backend::Weeler::Translation.import params[:file]
 
-        Settings.i18n_updated_at = Time.now
+        Setting.i18n_updated_at = Time.now
 
         redirect_to ({ action: :index }), flash: {success: "Translations succesfully imported."}
       else
@@ -108,6 +95,5 @@ module Weeler
       translations = translations.lookup(params[:group]) if params[:group].present?
       translations
     end
-
   end
 end

data/app/models/setting.rb

@@ -0,0 +1,7 @@
+class Setting < RailsSettings::Base
+  field :i18n_updated_at, type: :string
+
+  Weeler.settings_fields.each do |field_options|
+    field field_options[:name], **field_options.except(:name)
+  end
+end

data/app/views/weeler/base/_footer.html.haml

@@ -1,2 +1,2 @@
 %footer
-  %p © Weby 2014
+  %p © Weby 2021

data/app/views/weeler/settings/_form.html.haml

@@ -0,0 +1,16 @@
+= form_for [:weeler, item], html: {class: "form-vertical", role: "form"} do |f|
+  - if item.new_record?
+    = f.hidden_field :var
+
+  .form-group
+    %label.col-lg-4.col-md-4.control-label
+      = "#{item.var.humanize.capitalize}:"
+    .col-lg-6.col-md-6
+      - type = item.class.get_field(item.var)[:type]
+      - if type == :boolean
+        = f.check_box :value, class: "form-check-input"
+      - else
+        = f.text_field :value, class: "form-control"
+
+  .col-lg-2.col-md-2
+    = f.submit "Save", class: "btn btn-primary"

data/app/views/weeler/settings/index.html.haml

@@ -9,11 +9,8 @@
   %div{class: "col-lg-8 col-md-8"}
     - @settings.each do |item|
       %div{style: "min-height: 50px;"}
-        = form_for [:weeler, item], html: {class: "form-vertical", role: "form"} do |f|
-          .form-group
-            %label.col-lg-4.col-md-4.control-label
-              = "#{item.var.humanize.capitalize}:"
-            .col-lg-6.col-md-6
-              = f.text_field :value, value: item.value, class: "form-control"
-          .col-lg-2.col-md-2
-            = f.submit "Save", class: "btn btn-primary"
+        = render 'form', item: item
+    - Setting.keys.each do |key|
+      - if !Setting.all.map(&:var).include?(key)
+        %div{style: "min-height: 50px;"}
+          = render 'form', item: Setting.new(var: key)

data/app/views/weeler/static_sections/show.html.haml

@@ -17,8 +17,12 @@
           .form-group
             = label_tag key, key.to_s.split('.').last.humanize, class: "col-lg-2 col-md-2 control-label"
             %div{class: "col-lg-10 col-md-10"}
+              
               - if translation.html?
-                = text_area_tag "translations[#{translation.id}]", translation.value, class: 'form-control redactor'
+                - if ::Weeler.use_rails_rich_text_editor
+                  = rich_text_area_tag "translations[#{translation.id}]", translation.value
+                - else
+                  = text_area_tag "translations[#{translation.id}]", translation.value, class: 'form-control html'
               - else
                 = text_area_tag "translations[#{translation.id}]", translation.value, class: 'form-control'
 

data/app/views/weeler/translations/_form.html.haml

@@ -10,8 +10,11 @@
 .form-group
   %label.col-lg-2.col-md-2.control-label Value
   .col-lg-10.col-md-10
-    %textarea.form-control{class: "#{'redactor' if translation.html?}", name: 'i18n_backend_weeler_translation[value]', id: 'i18n_backend_weeler_translation_value'}
-      = translation.value
+    - if ::Weeler.use_rails_rich_text_editor && translation.html?
+      = rich_text_area_tag 'i18n_backend_weeler_translation[value]', translation.value
+    - else
+      %textarea.form-control{class: "#{'html' if translation.html?}", name: 'i18n_backend_weeler_translation[value]', id: 'i18n_backend_weeler_translation_value'}
+        = translation.value
 %h4 Info
 .form-group
   %label.col-lg-2.col-md-2.control-label Variables

data/app/views/weeler/translations/index.html.haml

@@ -10,15 +10,6 @@
           = link_to 'Show translations', weeler_translations_path(show_translation_keys: false)
         - else
           = link_to 'Show translation keys', weeler_translations_path(show_translation_keys: true)
-      %h1 Stats
-      %p.lead.text-muted
-        - if Settings.log_key_usage == 'true'
-          = 'Translation usage stat gathering is ON'
-        - else
-          = 'Translation usage stat gathering is OFF'
-      %p.lead.text-muted
-        = link_to 'Go to Stats', {action: :usage_stats}
-
 .row
   .col-xs-12
     %nav.navbar.navbar-default{ role: "navigation" }
@@ -39,7 +30,6 @@
                   %li
                     %a{href: weeler_translations_path(group: params[:group], filtered_locale: locale)}= locale.capitalize
 
-
         / key group lookup
         %ul.nav.navbar-nav.navbar-left
           %li.dropdown

data/lib/generators/weeler/templates/assets/javascripts/weeler/app/index.js

@@ -1,2 +1,4 @@
 // Here you can implement your JS code
-// For example //= require redactor-rails
+// //= require activestorage
+// //= require trix/dist/trix
+// //= require @rails/actiontext/app/javascript/actiontext/index

data/lib/generators/weeler/templates/assets/stylesheets/weeler/app/index.css

@@ -1,4 +1,4 @@
 /*
   Here you can implement your css code
-  // For example *= require redactor-rails
+  @import "trix/dist/trix"; // For example 
 */

data/lib/i18n/backend/weeler/exporter.rb

@@ -25,7 +25,6 @@ module I18n
         extend ActiveSupport::Concern
 
         module ClassMethods
-
           # Prepare xlsx package from current scope
           # Stores all translations in translations worksheet.
           def as_xlsx_package
@@ -42,33 +41,52 @@ module I18n
 
             included_keys = []
 
-            self.current_scope.each do |translation|
-              unless included_keys.include? translation.key
-                sheet.add_row(Translation.translation_row_by_key_and_locales(translation.key, locales), types: types)
-                included_keys << translation.key
-              end
+            tranlsations_by_locales = Translation.where(locale: locales).group_by(&:locale)
+
+            current_scope.each do |translation|
+              next if included_keys.include?(translation.key)
+
+              row = Translation.translation_row_by_key_and_locales(tranlsations_by_locales, translation.key, locales)
+              sheet.add_row(row, types: types)
+              included_keys << translation.key
             end
-            return package
+
+            package
           end
 
-          def title_row locales
+          def title_row(locales)
             row = [ 'Key' ]
             locales.each do |locale|
               row.push(locale.capitalize)
             end
+
+            row.push('Created at')
+            row.push('Updated at')
+
             row
           end
 
-          def translation_row_by_key_and_locales key, locales
-            row = [ key ]
+          def translation_row_by_key_and_locales(tranlsations_by_locales, key, locales)
+            row = [key]
+            created_ats = []
+            updated_ats = []
+
             locales.each do |locale|
-              result = Translation.locale(locale).lookup(key).load
-              if result.first.present?
-                row.push(result.first.value)
+              translation = tranlsations_by_locales[locale.to_s]&.find { |t| t.key == key }
+
+              if translation.present?
+                created_ats.push(translation.created_at)
+                updated_ats.push(translation.updated_at)
+
+                row.push(translation.value)
               else
-                row.push("")
+                row.push('')
               end
             end
+
+            row.push(created_ats.min)
+            row.push(updated_ats.max)
+
             row
           end
         end

data/lib/i18n/backend/weeler/importer.rb

@@ -5,7 +5,7 @@
 #
 #   if params[:file].present?
 #     I18n::Backend::Weeler::Translation.import params[:file]
-#     Settings.i18n_updated_at = Time.now
+#     Setting.i18n_updated_at = Time.now
 #   end
 
 begin
@@ -17,82 +17,85 @@ end
 module I18n
   module Backend
     class Weeler
-
       module Importer
         extend ActiveSupport::Concern
 
         module ClassMethods
-
           # Loads file and iterates each sheet and row.
-          def import file
-            xls = open_spreadsheet file
-            xls.each_with_pagename do |name, sheet|
+          def import(file)
+            xls = open_spreadsheet(file)
 
+            xls.each_with_pagename do |_, sheet|
               # Lookup locales
               locales = locales_from_xlsx_sheet_row(sheet.row(1))
+              tranlsations_by_locales = Translation.where(locale: locales).group_by(&:locale)
 
               # Lookup values
               (2..sheet.last_row).each do |row_no|
-                store_translations_from_xlsx_row(sheet.row(row_no), locales)
-              end # rows
-
-            end # sheets
-
-          end # import
+                store_translations_from_xlsx_row(tranlsations_by_locales, sheet.row(row_no), locales)
+              end
+            end
+          end
 
           private
 
-            # Open csv, xls, xlsx or ods file and read content
-            def open_spreadsheet(file)
-              case File.extname(file.original_filename)
-              when ".csv"  then Roo::Csv.new(file.path, file_warning: :ignore)
-              when ".xls"  then Roo::Excel.new(file.path, file_warning: :ignore)
-              when ".xlsx" then Roo::Excelx.new(file.path, file_warning: :ignore)
-              when ".ods"  then Roo::OpenOffice.new(file.path, file_warning: :ignore)
-              else raise "Unknown file type: #{file.original_filename}"
-              end
+          # Open csv, xls, xlsx or ods file and read content
+          def open_spreadsheet(file)
+            case File.extname(file.original_filename)
+            when ".csv"  then Roo::Csv.new(file.path, file_warning: :ignore)
+            when ".xls"  then Roo::Excel.new(file.path, file_warning: :ignore)
+            when ".xlsx" then Roo::Excelx.new(file.path, file_warning: :ignore)
+            when ".ods"  then Roo::OpenOffice.new(file.path, file_warning: :ignore)
+            else raise "Unknown file type: #{file.original_filename}"
             end
+          end
 
-            # Lookup locales and sequence for loading
-            def locales_from_xlsx_sheet_row row
-              locales = []
-              row.each_with_index do |cell, i|
-                if i > 0
-                  locales.push(cell.downcase)
-                end
-              end
-              locales
-            end
+          # Lookup locales and sequence for loading
+          def locales_from_xlsx_sheet_row(row)
+            locales = []
+            row.each_with_index do |cell, i|
+              next unless i.positive?
 
-            # Iterate each cell in row and store translation by locale
-            def store_translations_from_xlsx_row row, locales
-              locale = nil
-              key = nil
-              value = nil
-
-              row.each_with_index do |cell, i|
-                if i == 0
-                  key = cell
-                else
-                  locale = locales[ i - 1 ]
-                  store_translation_from_xlsx_cell locale, key, cell
-                end
-              end
+              locale = cell.downcase
+
+              # check if legal local
+              next if locale.size != 2
+
+              locales.push(cell.downcase)
             end
+            locales
+          end
+
+          # Iterate each cell in row and store translation by locale
+          def store_translations_from_xlsx_row(tranlsations_by_locales, row, locales)
+            locale = nil
+            key = nil
 
-            # Store locale if locale and key present
-            def store_translation_from_xlsx_cell locale, key, cell
-              value = cell.nil? ? '' : cell
+            row.each_with_index do |cell, i|
+              if i.zero?
+                key = cell
+              else
+                locale = locales[i - 1]
 
-              if locale.present? && key.present?
-                translation = Translation.find_or_initialize_by locale: locale, key: key
-                if translation.value != value
-                  translation.value = value
-                  translation.save
-                end
+                store_translation_from_xlsx_cell(tranlsations_by_locales[locale.to_s], locale, key, cell) if locale.present?
               end
             end
+          end
+
+          # Store locale if locale and key present
+          def store_translation_from_xlsx_cell(locale_translations, locale, key, cell)
+            value = cell.nil? ? '' : cell
+
+            return if locale.blank? || key.blank?
+
+            translation = locale_translations&.find { |t| t.key == key }
+
+            return if translation.present? && translation.value == value
 
+            translation ||= Translation.new(locale: locale, key: key)
+            translation.value = value
+            translation.save
+          end
         end
       end
 

data/lib/i18n/backend/weeler.rb

@@ -4,8 +4,6 @@ require 'i18n/backend/weeler/dedupe'
 require 'i18n/backend/weeler/html_checker'
 require 'i18n/backend/weeler/exporter'
 require 'i18n/backend/weeler/importer'
-require 'i18n/backend/weeler/usage_logger'
-require 'i18n/backend/weeler/translation_stat'
 require 'i18n/backend/weeler/lock'
 
 module I18n
@@ -31,8 +29,6 @@ module I18n
       autoload :Translation,     'i18n/backend/weeler/translation'
       autoload :Exporter,        'i18n/backend/weeler/exporter'
       autoload :Importer,        'i18n/backend/weeler/importer'
-      autoload :UsageLogger,     'i18n/backend/weeler/usage_logger'
-      autoload :TranslationStat, 'i18n/backend/weeler/translation_stat'
       autoload :Lock,            'i18n/backend/weeler/lock'
 
       module Implementation
@@ -52,12 +48,16 @@ module I18n
           Translation.all.each do |translation|
             # Load in cache unless value is nil or it is blank and empty
             # translation acts like missing
-            if !(translation.value.nil? || (::Weeler.empty_translation_acts_like_missing && translation.value.blank?))
-              i18n_cache.write [translation.locale, translation.key], translation
-            end
+            next if translation.value.nil? || (::Weeler.empty_translation_acts_like_missing && translation.value.blank?)
+
+            i18n_cache.write [translation.locale, translation.key], translation
           end
 
-          i18n_cache.write('UPDATED_AT', Settings.i18n_updated_at) if ActiveRecord::Base.connection.data_source_exists?('settings')
+          i18n_cache.write('UPDATED_AT', Setting.i18n_updated_at) if ActiveRecord::Base.connection.data_source_exists?('settings')
+        end
+
+        def available_locales
+          I18n::Backend::Weeler::Translation.distinct.pluck(:locale).compact.map(&:to_sym)
         end
 
         protected
@@ -70,26 +70,15 @@ module I18n
 
         private
 
-        def lookup_in_cache locale, key, scope = [], options = {}
+        def lookup_in_cache(locale, key, scope = [], options = {})
           # reload cache if cache timestamp differs from last translations update
-          reload_cache if ((!ActiveRecord::Base.connection.data_source_exists?('settings')) || i18n_cache.read('UPDATED_AT') != Settings.i18n_updated_at)
-
-          # log locale/key usage for statistics
-          if Settings.log_key_usage == 'true'
-            i18n_cache.delete([:dump_usage_stats, Process.pid])
-            log_key_usage(locale, key)
-          end
-
-          if Settings.log_key_usage == 'dump'
-            dump_key_usage
-          end
+          reload_cache if ((!ActiveRecord::Base.connection.data_source_exists?('settings')) || i18n_cache.read('UPDATED_AT') != Setting.i18n_updated_at)
 
           return nil if i18n_cache.read([:missing, [locale, key]])
 
           keys = expand_keys key
 
           keys.reverse.each do |check_key|
-
             result = i18n_cache.read([locale, check_key])
 
             return result.value unless result.blank?
@@ -145,10 +134,12 @@ module I18n
 
           keys = options[:count] ? PLURAL_KEYS.map { |k| [singular_key, k].join(FLATTEN_SEPARATOR) } : [singular_key]
 
-
           keys.each do |key|
-            translation = Weeler::Translation.find_or_initialize_by locale: locale.to_s, key: key
+            translation = Weeler::Translation.find_or_initialize_by(locale: locale.to_s, key: key)
             translation.interpolations = interpolations
+
+            
+
             fallback_value = fallback_backend_translation locale, key
             if fallback_value.present?
               translation.value = fallback_value
@@ -162,7 +153,6 @@ module I18n
           return_value
         end
 
-
         def fallback_backend_translation locale, key
           if I18n.backend.backends.size > 1
             alternative_backend = I18n.backend.backends[1]
@@ -171,7 +161,6 @@ module I18n
             nil
           end
         end
-
       end
 
       include Implementation

data/lib/weeler/action_dispatch/routing/mapper.rb

@@ -54,11 +54,10 @@ module Weeler
             collection do
               get :export
               post :import
-              get :usage_stats
             end
           end
           resources :seo_items
-          resources :settings, :only => [:index, :edit, :update]
+          resources :settings, :only => [:index, :update, :create]
         end
 
         # Ordable route concern for dynamic sorting and removing image