rails_core_extensions 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0a2d1edb6ec0ac6591e211c6d2b7ac83d1a5c84
-  data.tar.gz: 512cae180b1e0e5d33c4c5601d381fd37982f171
+  metadata.gz: 20b022eccf968998d9236870dd9255b5ca5eff46
+  data.tar.gz: a82a4adf1601c57035016df31d53d6a2fbc5e41e
 SHA512:
-  metadata.gz: 0d2730d04532398da8a1257a0b75dbcbaf34db1f15c4ffc4677f9ce615317fd1f3ac63b5304ad39e4d3992ae1ca47412ee80acbe4fbdea5791ffb668ea318a2f
-  data.tar.gz: dba790cfdbaaf05e1d74daa1852398787dbe41a2daaca3a7302c1bed5a6a4e71db7d2b7343c61e32de84aded19973bbefcfa90000db51ad4e160474b34edb4fb
+  metadata.gz: 53bfc4fb4f56485453989c62428fb370748e6cda40bd082ce98e21a544518bc5354b70cc6b3294b59f897664e08b146e21bd6ce385a64880e10a3184649ad0bc
+  data.tar.gz: d1d3a4637dff550333f1eba6fb3ae7ca9d19bfa6aad31f8deb4344ab60a9e99ac519b139e356ee9e203f4aa9a2ec98a707774d4c6b1841780f74000574194c64

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.0
+
+* Extract and test translations
+
 ## 0.1.1
 
 * Fixes issue with sortable controllers

data/lib/rails_core_extensions.rb

@@ -27,11 +27,13 @@ module RailsCoreExtensions
     require 'rails_core_extensions/active_record_cache_all_attributes'
     require 'rails_core_extensions/active_record_extensions'
     require 'rails_core_extensions/active_record_liquid_extensions'
+    require 'rails_core_extensions/translations'
 
     ActiveRecord::Base.send(:include, ActiveRecordCloning)
     ActiveRecord::Base.send(:include, ActiveRecordExtensions)
     ActiveRecord::Base.send(:include, RailsCoreExtensions::ActiveRecordLiquidExtensions)
     ActiveRecord::Base.send(:include, ActiveRecordExtensions::InstanceMethods)
+    ActiveRecord::Base.send(:include, RailsCoreExtensions::Translations)
 
     if ActiveRecord::VERSION::MAJOR >= 3
       require 'rails_core_extensions/active_model_extensions'

data/lib/rails_core_extensions/active_record_extensions.rb

@@ -144,16 +144,6 @@ module ActiveRecordExtensions
       # longer alive.
       ActiveRecord::Base.clear_active_connections!
     end
-
-    def translate(key, options = {})
-      klass = self
-      klass = klass.superclass while klass.superclass != ActiveRecord::Base
-      I18n.translate key, options.merge(:scope => klass.name.tableize.singularize)
-    end
-
-    def t(key, options = {})
-      self.translate(key, options)
-    end
   end
 
   module InstanceMethods
@@ -184,11 +174,5 @@ module ActiveRecordExtensions
     def audit_log
       return (self.methods.include?('audits') ? self.audits : [])
     end
-
-    private
-
-    def t(key, options = {})
-      self.class.translate(key, options)
-    end
   end
 end

data/lib/rails_core_extensions/translations.rb

@@ -0,0 +1,32 @@
+module RailsCoreExtensions
+  module Translations
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def translate(key, options = {})
+        I18n.translate key, options.merge(scope: translation_key)
+      end
+
+      def translation_key
+        @translation_key ||= base_translation_class.name.tableize.singularize.gsub('/', '.')
+      end
+
+      def base_translation_class
+        return base_class if defined?(ActiveRecord) && ancestors.include?(ActiveRecord::Base)
+        self
+      end
+
+      def t(key, options = {})
+        self.translate(key, options)
+      end
+    end
+
+    private
+
+    def t(key, options = {})
+      self.class.translate(key, options)
+    end
+  end
+end

data/lib/rails_core_extensions/version.rb

@@ -1,3 +1,3 @@
 module RailsCoreExtensions
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/en.yml

@@ -0,0 +1,8 @@
+en:
+  translation_model:
+    display_me: 'My name is %{name}'
+  translation:
+    sub_model:
+      display_me: 'My subname is %{name}'
+  party:
+    display_me: 'Party %{name}'

data/spec/schema.rb

@@ -6,6 +6,10 @@ ActiveRecord::Schema.define(:version => 1) do
     t.integer :category_id
   end
 
+  create_table :parties do |t|
+    t.string :name, :type
+  end
+
   create_table :parents do |t|
   end
 

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ require 'action_controller'
 require 'active_record'
 
 require 'rails_core_extensions'
+I18n.load_path << [File.expand_path('../en.yml', __FILE__)]
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!

data/spec/support/coverage_loader.rb

@@ -1,4 +1,4 @@
-MINIMUM_COVERAGE = 79.4
+MINIMUM_COVERAGE = 81.1
 
 unless ENV['COVERAGE'] == 'off'
   require 'simplecov'
@@ -18,8 +18,9 @@ unless ENV['COVERAGE'] == 'off'
   SimpleCov.at_exit do
     SimpleCov.result.format!
     percent = SimpleCov.result.covered_percent
+    puts "Coverage is #{"%.2f" % percent}%"
     unless percent >= MINIMUM_COVERAGE
-      puts "Coverage must be above #{MINIMUM_COVERAGE}%. It is #{"%.2f" % percent}%"
+      puts "Coverage must be above #{MINIMUM_COVERAGE}%"
       Kernel.exit(1)
     end
   end

data/spec/translation_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+require 'i18n'
+
+describe 'translations' do
+  let(:model_class) {
+    Class.new do
+      include RailsCoreExtensions::Translations
+
+      def initialize(name)
+        @name = name
+      end
+
+      def to_s
+        t('display_me', name: @name)
+      end
+    end
+  }
+
+  before do
+    stub_const 'TranslationModel', model_class
+  end
+
+  let(:class_translation) { TranslationModel.t('display_me', name: 'Class') }
+  subject { TranslationModel.new('Ruby') }
+
+  specify { expect(TranslationModel.translation_key).to eq 'translation_model' }
+  specify { expect(subject.to_s).to eq 'My name is Ruby' }
+  specify { expect(class_translation).to eq 'My name is Class' }
+
+  context 'performance' do
+    before do
+      allow(TranslationModel).to receive(:base_translation_class).and_call_original
+      5.times { subject.to_s }
+    end
+
+    specify {
+      expect(TranslationModel).to have_received(:base_translation_class).once
+    }
+  end
+
+  context 'non AR subclass' do
+    let(:model_subclass) {
+      Class.new(model_class)
+    }
+
+    before do
+      stub_const 'Translation::SubModel', model_subclass
+    end
+
+    let(:class_translation) { Translation::SubModel.t('display_me', name: 'Class') }
+    subject { Translation::SubModel.new('Ruby') }
+
+    specify { expect(Translation::SubModel.translation_key).to eq 'translation.sub_model' }
+    specify { expect(subject.to_s).to eq 'My subname is Ruby' }
+    specify { expect(class_translation).to eq 'My subname is Class' }
+  end
+
+  context 'AR base class' do
+    let(:ar_model_class) {
+      Class.new(ActiveRecord::Base) do
+        self.table_name = 'parties'
+
+        include RailsCoreExtensions::Translations
+
+        def to_s
+          t('display_me', name: name)
+        end
+      end
+    }
+    let(:ar_model_subclass) {
+      Class.new(Party) do
+        self.table_name = 'parties'
+
+        include RailsCoreExtensions::Translations
+
+        def to_s
+          t('display_me', name: name)
+        end
+      end
+    }
+
+    before do
+      connect_to_sqlite
+      stub_const 'Party', ar_model_class
+      stub_const 'Person', ar_model_subclass
+    end
+
+    let(:class_translation) { Party.t('display_me', name: 'Class') }
+    subject { Party.new(name: 'Ruby') }
+
+    specify { expect(Party.translation_key).to eq 'party' }
+    specify { expect(subject.to_s).to eq 'Party Ruby' }
+    specify { expect(class_translation).to eq 'Party Class' }
+
+    context 'AR sub class' do
+      let(:class_translation) { Person.t('display_me', name: 'Class') }
+      subject { Person.new(name: 'Ruby') }
+
+      specify { expect(Person.translation_key).to eq 'party' }
+      specify { expect(subject.to_s).to eq 'Party Ruby' }
+      specify { expect(class_translation).to eq 'Party Class' }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_core_extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Noack
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -234,6 +234,7 @@ files:
 - lib/rails_core_extensions/tasks/position_initializer.rake
 - lib/rails_core_extensions/time_with_zone.rb
 - lib/rails_core_extensions/transfer_records.rb
+- lib/rails_core_extensions/translations.rb
 - lib/rails_core_extensions/version.rb
 - rails_core_extensions.gemspec
 - spec/action_controller_sortable_spec.rb
@@ -243,12 +244,14 @@ files:
 - spec/active_record_extensions_spec.rb
 - spec/breadcrumb_spec.rb
 - spec/concurrency_spec.rb
+- spec/en.yml
 - spec/position_initializer_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/spec_helper_model_base.rb
 - spec/support/coverage_loader.rb
 - spec/transfer_records_spec.rb
+- spec/translation_spec.rb
 homepage: http://github.com/sealink/rails_core_extensions
 licenses:
 - MIT
@@ -269,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Set of extensions to core rails libraries.
@@ -281,9 +284,11 @@ test_files:
 - spec/active_record_extensions_spec.rb
 - spec/breadcrumb_spec.rb
 - spec/concurrency_spec.rb
+- spec/en.yml
 - spec/position_initializer_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/spec_helper_model_base.rb
 - spec/support/coverage_loader.rb
 - spec/transfer_records_spec.rb
+- spec/translation_spec.rb