weeler 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04354c614713ac3f01bbd9ef74db3d3adfbf6e5e
-  data.tar.gz: b7cb66aa043d0f4474d030fc8a3098c2f110eeb4
+  metadata.gz: 21fd389096c8af80e13c46bf777233d15188fa71
+  data.tar.gz: 783c33428045e4d05b7e76fc10a991cafc3f9b2e
 SHA512:
-  metadata.gz: 3995b5e005fae4e1d03fa0bcbee009fd7cfa0ace18d0be818250c690b6afec317ed9ee0b31f213a19c112308463aa039e1be74ea53dd420162833e6ff7e7cc8f
-  data.tar.gz: aca2e0510b49b00a85d99a8329eec36874b10105ead3cd20b13da590a68f38b0c43056ea6424265a3033c85c575b731b944044a02917e2124380416a02f31c84
+  metadata.gz: 39c2ceb91177c876eadeb18b9e03b86fc8367c33a48cc81f4b2e627741290816c5d8ecd8c20188c87e1f776e3e6df7f1f16e19f154007464e4200d9b25123ee1
+  data.tar.gz: e9602c77a0ea9738ae4eb0c8dd91c98bdfb228a594e9ead83d41b0bcbf4bb0a799f19fabeb8c2c479c0e07b0be4b148b0da8b19388d4e8bd47edfb8954f187e4

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
+before_install:
+  - rvm get head
+services:
+  - postgresql
+sudo: false
+before_script:
+  - psql -c 'create database travis_ci_test;' -U postgres
 rvm:
   - "2.0.0"
   - "2.1.0"
@@ -11,7 +18,10 @@ rvm:
   - "2.2.0"
   - "2.2.1"
   - "2.2.2"
-  - "jruby"
-  - "rbx-2.4.1"
+  - "2.2.3"
+  - "2.2.4"
+  - "2.3.0"
 # uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rspec spec
+script:
+  - RAILS_ENV=test bundle exec rake db:migrate --trace
+  - bundle exec rspec spec

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.5.1
+
+* Fixed version number
+
+### Contributors
+
+* Artis Raugulis
+
+## 1.4.0
+
+* Added translation usage stats
+* Fixed a transliteration bug
+
+### Contributors
+
+* Artis Raugulis
+
+## 1.5.0
+
+* Added Lock
+* Added translation usage stats export
+* Dropped jruby support
+* Dropped rbx suport
+
 ## 1.4.0
 
 * Added translation usage stats

data/Rakefile

@@ -1 +1,5 @@
+Bundler::GemHelper.install_tasks
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
 require "bundler/gem_tasks"

data/app/controllers/weeler/translations_controller.rb

@@ -20,7 +20,7 @@ module Weeler
 
       if @translation.save
         Settings.i18n_updated_at = Time.now
-        redirect_to edit_weeler_translation_path(@translation), flash: {success: "Translation saved."}
+        redirect_to ({ action: :edit, id: @translation }), flash: { success: "Translation saved." }
       else
         flash.now[:error] = "Errors in saving."
         render :edit
@@ -33,7 +33,7 @@ module Weeler
       if @translation.update_attributes(translation_params)
         Settings.i18n_updated_at = Time.now
 
-        redirect_to edit_weeler_translation_path(@translation), flash: {success: "Translation updated."}
+        redirect_to ({ action: :edit, id: @translation }), flash: { success: "Translation updated." }
       else
         flash.now[:error] = "Errors in updating."
         render :edit
@@ -46,13 +46,19 @@ module Weeler
 
       Settings.i18n_updated_at = Time.now
 
-      redirect_to weeler_translations_path, flash: {success: "Translation succesfully removed."}
+      redirect_to ({ action: :index }), flash: {success: "Translation succesfully removed."}
     end
 
     def usage_stats
       @used_keys = []
-      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')
+      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
 
@@ -72,9 +78,9 @@ module Weeler
 
         Settings.i18n_updated_at = Time.now
 
-        redirect_to weeler_translations_path, flash: {success: "Translations succesfully imported."}
+        redirect_to ({ action: :index }), flash: {success: "Translations succesfully imported."}
       else
-        redirect_to weeler_translations_path, flash: {success: "No file choosen"}
+        redirect_to ({ action: :index }), flash: {success: "No file choosen"}
       end
     end
 

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

@@ -8,5 +8,5 @@
   %td= translation.interpolations
   %td.text-center= translation.created_at.strftime("%d/%m/%Y")
   %td
-    = link_to 'Edit', edit_weeler_translation_path(translation.id), class: 'btn btn-default'
-    = link_to 'Remove', weeler_translation_path(translation), data: { confirm: 'Are you sure you want to remove?' }, method: :delete, class: 'btn btn-danger'
+    = link_to 'Edit', { action: :edit, id: translation.id }, class: 'btn btn-default'
+    = link_to 'Remove', { action: :destroy, id: translation }, data: { confirm: 'Are you sure you want to remove?' }, method: :delete, class: 'btn btn-danger'

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

@@ -6,9 +6,9 @@
 .edit_user.container
   .row
     .col-lg-12.col-md-12
-      = form_for @translation, {url: weeler_translation_path(@translation), html: {class: "form-horizontal", role: "form"}} do |f|
+      = form_for @translation, {url: { action: :update, id: @translation }, html: {class: "form-horizontal", role: "form"}} do |f|
         = render partial: "form", locals: {translation: @translation, f: f}
         %p.text-center
           %button.btn.btn-primary{type: "submit"} Save
-          %a.btn.btn-link{href: weeler_translations_path} Cancel
-          = link_to 'Remove', weeler_translation_path(@translation), :confirm => "Are you sure you want remove?", :method => :delete, :class => "btn btn-danger"
+          = link_to 'Cancel', { action: :index }, class: 'btn btn-link'
+          = link_to 'Remove', { action: :destroy, id: @translation}, :confirm => "Are you sure you want remove?", :method => :delete, :class => "btn btn-danger"

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

@@ -6,8 +6,8 @@
 .edit_user.container
   .row
     .col-lg-12.col-md-12
-      = form_for @translation, {url: weeler_translations_path, html: {class: "form-horizontal", role: "form"}} do |f|
+      = form_for @translation, {url: { action: :create }, html: {class: "form-horizontal", role: "form"}} do |f|
         = render partial: "form", locals: {translation: @translation, f: f}
         %p.text-center
           %button.btn.btn-primary{type: "submit"} Save
-          %a.btn.btn-link{href: weeler_translations_path} Cancel
+          = link_to 'Cancel', { action: :index }, class: 'btn btn-link'

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

@@ -22,7 +22,13 @@
             %th text
         %tbody
           - @used_keys.each do |key, usage|
-            %tr
-              %td= usage
-              %td= key.to_s.gsub('usage_stats/en/', '')
-              %td= t(key.to_s.gsub('usage_stats/en/', ''))
+            - begin
+              %tr
+                %td= usage
+                %td= key.to_s.gsub('usage_stats/en/', '')
+                %td= CGI::unescapeHTML(CGI::escapeHTML(t(key.to_s.gsub('usage_stats/en/', ''))))
+            - rescue => e
+              %tr
+                %td= "err #{usage}"
+                %td= key
+                %td= e.message

data/lib/generators/weeler/templates/migrations/create_weeler_locks.rb

@@ -0,0 +1,14 @@
+class CreateWeelerLocks < ActiveRecord::Migration
+  def self.up
+    create_table :weeler_locks do |t|
+      t.string :name, :limit => 40
+      t.timestamps
+    end
+    add_index :weeler_locks, :name, :unique => true
+  end
+
+  def self.down
+    remove_index :weeler_locks, :column => :name
+    drop_table :weeler_locks
+  end
+end

data/lib/generators/weeler/templates/migrations/create_weeler_translation_stats.rb

@@ -0,0 +1,11 @@
+class CreateWeelerTranslationStats < ActiveRecord::Migration
+  def change
+    create_table :weeler_translation_stats do |t|
+      t.string :key
+      t.integer :usage_count, default: 0
+
+      t.timestamps
+    end
+    add_index :weeler_translation_stats, :key
+  end
+end

data/lib/i18n/backend/weeler.rb

@@ -5,6 +5,8 @@ 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
   module Backend
@@ -24,12 +26,14 @@ module I18n
 
       PLURAL_KEYS = ["zero", "one", "other"]
 
-      autoload :HtmlChecker, 'i18n/backend/weeler/html_checker'
-      autoload :Translation, 'i18n/backend/weeler/dedupe'
-      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 :HtmlChecker,     'i18n/backend/weeler/html_checker'
+      autoload :Translation,     'i18n/backend/weeler/dedupe'
+      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
         include Base, Flatten
@@ -72,9 +76,14 @@ module I18n
 
           # 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
+
           return nil if i18n_cache.read([:missing, [locale, key]])
 
           keys = expand_keys key

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

@@ -0,0 +1,78 @@
+require 'active_record'
+
+module I18n
+  module Backend
+    # Weeler model used to store locks
+    #
+    # This model expects a table like the following to be already set up in
+    # your the database:
+    #
+    # def self.up
+    #   create_table :weeler_locks do |t|
+    #     t.string :name, :limit => 40
+    #     t.timestamps
+    #   end
+    #   add_index :weeler_locks, :name, :unique => true
+    # end
+    #
+    # def self.down
+    #   remove_index :weeler_locks, :column => :name
+    #   drop_table :weeler_locks
+    # end
+    #
+    class Weeler
+      class Lock < ActiveRecord::Base
+
+        self.table_name = 'weeler_locks'
+
+        def self.acquire(name)
+          already_acquired = definitely_acquired?(name)
+
+          if already_acquired
+            yield
+          else
+            begin
+              create(:name => name) unless find_by(name: name)
+            rescue ActiveRecord::StatementInvalid
+              # concurrent create is okay
+            end
+
+            begin
+              result = nil
+              transaction do
+                self.lock(true).find_by(name: name) # this is the call that will block
+                acquired_lock(name)
+                result = yield
+              end
+
+              result
+            ensure
+              maybe_released_lock(name)
+            end
+          end
+        end
+
+        # if true, the lock is acquired
+        # if false, the lock might still be acquired, because we were in another db transaction
+        def self.definitely_acquired?(name)
+          !!Thread.current[:definitely_acquired_locks] and Thread.current[:definitely_acquired_locks].has_key?(name)
+        end
+
+        def self.acquired_lock(name)
+          logger.debug("Acquired lock '#{name}'")
+          Thread.current[:definitely_acquired_locks] ||= {}
+          Thread.current[:definitely_acquired_locks][name] = true
+        end
+
+        def self.maybe_released_lock(name)
+          logger.debug("Released lock '#{name}' (if we are not in a bigger transaction)")
+          Thread.current[:definitely_acquired_locks] ||= {}
+          Thread.current[:definitely_acquired_locks].delete(name)
+        end
+
+        private_class_method :acquired_lock, :maybe_released_lock
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'active_record'
+
+module I18n
+  module Backend
+    # Weeler model used to store translation key usage statistics
+    #
+    # This model expects a table like the following to be already set up in
+    # your the database:
+    #
+    #   create_table :weeler_translation_stats do |t|
+    #     t.string :key
+    #     t.integer :usage_count, default: 0
+    #   end
+    #
+    class Weeler
+      class TranslationStat < ::ActiveRecord::Base
+
+        self.table_name = 'weeler_translation_stats'
+
+        validates :key, uniqueness: true
+        validates :key, :usage_count, presence: true
+      end
+    end
+  end
+end

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

@@ -11,7 +11,23 @@ module I18n
           value = existing.present? ? (existing.to_i + 1) : 1
           i18n_cache.write [:usage_stats, [locale, key]], value
         end
-        
+
+        def dump_key_usage
+          already_dumped = i18n_cache.read([:dump_usage_stats, Process.pid]).present?
+          unless already_dumped
+            Weeler::Lock.acquire('usage_stats_dump') do
+              i18n_cache.instance_variable_get(:@data).keys.each do |key|
+                if key.start_with?('usage_stats')
+                  translation_stat = TranslationStat.find_or_create_by(key: key.gsub('usage_stats/en/', ''))
+                  translation_stat.usage_count += i18n_cache.read(key).to_i
+                  translation_stat.save!
+                end
+              end
+              i18n_cache.write [:dump_usage_stats, Process.pid], Process.pid
+            end
+          end
+        end
+
         Weeler.send(:include, UsageLogger)
       end
     end

data/lib/weeler/action_controller/acts/restful.rb

@@ -118,7 +118,7 @@ module Weeler
               permited_params.call(params)
             elsif permited_params.blank?
               warning_suggestion = params[parameterized_name.to_sym].is_a?(Hash) ? params[parameterized_name.to_sym].keys.map{ |k| k.to_sym } : "permit_params:"
-              warn "[UNPERMITED PARAMS] To permiting #{params[parameterized_name.to_sym].inspect} params, add 'permit_params: #{warning_suggestion}' option to 'acts_as_restful'"
+              warn "[UNPERMITED PARAMS] To permit #{params[parameterized_name.to_sym].inspect} params, add 'permit_params: #{warning_suggestion}' option to 'acts_as_restful'"
             else
               params.require(parameterized_name.to_sym).permit(permited_params)
             end

data/lib/weeler/engine.rb

@@ -10,7 +10,7 @@ module Weeler
     config.weeler = Weeler
 
     config.i18n.available_locales = [:en] unless config.i18n.available_locales.present?
-
+    config.active_record.raise_in_transactional_callbacks = true
     config.assets.precompile += ["weeler/init.js", "weeler/init.css"]
 
     # Load extend Rails classes

data/lib/weeler/version.rb

@@ -1,8 +1,8 @@
 module Weeler
   module VERSION
     MAJOR = 1
-    MINOR = 4
-    TINY  = 0
+    MINOR = 5
+    TINY  = 1
     PRE   = nil
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/spec/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.coveralls.yml
+.DS_Store
+spec/dummy/log/test.log
+rspec.html

data/spec/dummy/config/database.yml

@@ -1,25 +1,3 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 5
-  timeout: 5000
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
 test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
-
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000
+  adapter: postgresql
+  database: travis_ci_test