traco 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 978a4848f6b31ac00301a8e43b89b7937a446a261031c699c3edc6cd8207d7f8
-  data.tar.gz: 53b5f78c80d4e5bc9a8f16aadba823e2dd258dfec8e754650c63b8e12c5ac318
+  metadata.gz: c8d3d3ad540b0b54d9a5ce5adb2128e2edb4f3a1639cc943005bf8f0ffc59046
+  data.tar.gz: 28ac1c659ba7e3b6160e5d7da6bd995a2a0a12c08b0e070d461b45b85cc751ae
 SHA512:
-  metadata.gz: a30e150540760c82a82ed68553c298dcade15f9695fbc7af1afb7f2c443e4804233c536c2f1652c7fb3338626bfa610df339f35ea00679b43e14742647fdcc8c
-  data.tar.gz: 49a329d6a6b2cc7c2a6d68a21f5f9e2a2dd76327f162f8a1115c04c254ef6aaf3b287b2790e6d96b0f811873f5c46555e8d2c74143fb9bcaf678a51dc66863a4
+  metadata.gz: d2bd0a863da9ad824af47836f419f0b89ffd366aebf45a05772c2d109249effde7f5f18904480da34fd7d4deaf338125cfc5e8a74926c24ea6eecac8a16419dd
+  data.tar.gz: 6604dbef3ea352ecb532aa77b826e15664cb407bf168240d254f194b0be9340ced3791eda23d45199d14860c8a0f3364bb78c3d0ef257a0a9d565f3d8bb90a29

data/lib/traco/attributes.rb

@@ -21,10 +21,11 @@ module Traco
     private
 
     def define_reader(attribute)
+      default_fallback = @options.fetch(:fallback, LocaleFallbacks::DEFAULT_FALLBACK)
+
       class_eval <<-EOM, __FILE__, __LINE__ + 1
-        def #{attribute}(options = {})
-          default_fallback = #{@options.fetch(:fallback, LocaleFallbacks::DEFAULT_FALLBACK).inspect}
-          fallback = options.fetch(:fallback, default_fallback)
+        def #{attribute}(locale: nil, fallback: #{default_fallback.inspect})
+          return send(Traco.column(:#{attribute}, locale)) if locale
 
           columns_to_try = self.class._locale_columns_for_attribute(:#{attribute}, fallback: fallback)
           columns_to_try.each do |column|
@@ -48,8 +49,8 @@ module Traco
 
     def define_query(attribute)
       class_eval <<-EOM, __FILE__, __LINE__ + 1
-        def #{attribute}?
-          #{attribute}.present?
+        def #{attribute}?(locale: nil)
+          send(:#{attribute}, locale: locale).present?
         end
       EOM
     end

data/lib/traco/version.rb

@@ -1,3 +1,3 @@
 module Traco
-  VERSION = "5.2.0"
+  VERSION = "5.3.0"
 end

data/spec/traco_spec.rb

@@ -230,6 +230,19 @@ RSpec.describe Post, "#title" do
     expect(post.title).to eq "Hej"
   end
 
+  context "when given a 'locale' argument" do
+    it "gives the title in that locale, without fallback" do
+      post = Post.new(title_sv: "Hej", title_en: "Halloa")
+      I18n.default_locale = :en
+      I18n.locale = :en
+
+      expect(post.title(locale: :sv)).to eq "Hej"
+
+      post.title_sv = nil
+      expect(post.title(locale: :sv)).to eq nil
+    end
+  end
+
   context "when the translation was defined with fallback: false" do
     let(:post) {
       Post.new(title_sv: "Hej", title_en: "Halloa")
@@ -310,7 +323,7 @@ RSpec.describe Post, "#title?" do
     I18n.default_locale = :en
   end
 
-  it "is true if the title is present" do
+  it "is true if the title is present, with fallback" do
     post = Post.new(title_sv: "", title_en: " ", title_pt_br: nil)
     expect(post.title?).to be false
 
@@ -318,6 +331,19 @@ RSpec.describe Post, "#title?" do
 
     expect(post.title?).to be true
   end
+
+  context "when given a 'locale' argument" do
+    it "is true if the title if present in that locale, with no fallback" do
+      post = Post.new(title_sv: "Hej", title_en: "Halloa")
+      I18n.default_locale = :en
+      I18n.locale = :en
+
+      expect(post.title?(locale: :sv)).to be true
+
+      post.title_sv = nil
+      expect(post.title?(locale: :sv)).to be false
+    end
+  end
 end
 
 RSpec.describe Post, ".human_attribute_name" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traco
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Henrik Nyh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,29 +80,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - henrik@barsoom.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Appraisals
-- CHANGELOG.md
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- benchmarks/overhead.rb
-- gemfiles/rails_4.2.gemfile
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.gemfile
-- gemfiles/rails_6.1.gemfile
 - lib/traco.rb
 - lib/traco/attributes.rb
 - lib/traco/class_methods.rb
@@ -115,12 +100,11 @@ files:
 - spec/spec_helper.rb
 - spec/spec_helper_models.rb
 - spec/traco_spec.rb
-- traco.gemspec
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,13 +120,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Translatable columns for Rails 4.2 or better, stored in the model table itself.
 test_files:
-- spec/app/post.rb
-- spec/app/sv.yml
-- spec/locale_fallbacks_spec.rb
 - spec/spec_helper.rb
-- spec/spec_helper_models.rb
+- spec/app/sv.yml
+- spec/app/post.rb
 - spec/traco_spec.rb
+- spec/spec_helper_models.rb
+- spec/locale_fallbacks_spec.rb

data/.gitignore

@@ -1,7 +0,0 @@
-.bundle/
-Gemfile.lock
-pkg/
-tmp
-*.gem
-# Appraisal generated lockfiles
-*.gemfile.lock

data/.rspec

@@ -1 +0,0 @@
--r spec_helper

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - 2.3.8
-gemfile:
-  - gemfiles/rails_4.2.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-  - gemfiles/rails_6.1.gemfile
-matrix:
-  exclude:
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.3.8
-      gemfile: gemfiles/rails_6.1.gemfile
-    - rvm: 2.4.6
-      gemfile: gemfiles/rails_6.0.gemfile
-    - rvm: 2.4.6
-      gemfile: gemfiles/rails_6.1.gemfile

data/Appraisals

@@ -1,26 +0,0 @@
-appraise "rails-4.2" do
-  gem "activerecord", "~> 4.2.0"
-  gem "sqlite3", "~> 1.3.13"
-end
-
-appraise "rails-5.0" do
-  gem "activerecord", "~> 5.0.0"
-  gem "sqlite3", "~> 1.3.13"
-end
-
-appraise "rails-5.1" do
-  gem "activerecord", "~> 5.1.0"
-  gem "sqlite3", "~> 1.3.13"
-end
-
-appraise "rails-5.2" do
-  gem "activerecord", "~> 5.2.0"
-end
-
-appraise "rails-6.0" do
-  gem "activerecord", "~> 6.0.3.1"
-end
-
-appraise "rails-6.1" do
-  gem "activerecord", "~> 6.1.0"
-end

data/CHANGELOG.md

@@ -1,83 +0,0 @@
-# Changelog
-
-## 5.2.0
-
-* Feature: `locale_columns` without a passed column name returns all locale columns. Thanks to [manuelmeurer](https://github.com/manuelmeurer)!
-
-## 5.1.0
-
-* Feature: Add `fallback: :i18n` to use the fallbacks from `I18n.fallbacks`. Thanks to [sunny](https://github.com/sunny)!
-
-## 5.0.0
-
-* Change `locale_columns` and `locales_for_attribute` to sort current locale first, then default locale (previously, it was default locale first). This makes more sense for our own apps, and hopefully other apps as well.
-
-## 4.0.0
-
-* Drop support for end-of-lifed Ruby 2.1 and 2.2.
-
-## 3.3.0
-
-* Traco now automatically adds query methods, e.g. `Item#title?` when `title` is translated.
-
-## 3.2.2
-
-* Internal cleanup.
-
-## 3.2.1
-
-* Bugfix: with `fallback: [:sv]`, always look at current locale before any fallbacks.
-
-## 3.2.0
-
-* Introduce e.g. `fallback: [:sv]` to explicitly specify fallbacks.
-
-## 3.1.6
-
-Make [license (MIT)](LICENSE.txt) easier to autodetect.
-
-## 3.1.5
-
-* Bugfix: don't raise error loading models before the DB is created. Thanks to PikachuEXE and Andrii Malyshko.
-
-## 3.1.4
-
-* Bugfix: restore sorting of `locale_columns` and `locales_for_attribute` to put default locale first, not current locale. Thanks to PikachuEXE.
-
-## 3.1.3
-
- * ~20 time speedup thanks to optimizations by Andrii Malyshko.
-
-   Reading a Traco translated attribute used to be ~250x slower than an untranslated attribute; now it's down to ~10x slower.
-
-## 3.1.2
-
-* Bugfix: `.current_locale_column` handles dashed locales like "pt-BR" correctly. Thanks to PikachuEXE.
-
-## 3.1.1
-
-* Bugfix around fallbacks and memoization. Thanks to PikachuEXE.
-
-## 3.1.0
-
-* Introduce `.current_locale_column`, e.g. `Post.current_locale_column(:title)  # => :title_sv`.
-
-## 3.0.0
-
-* Backwards incompatible: `fallback: true` is now `fallback: :default`. Since this was the implicit default value, you shouldn't have a problem unless you explicitly declared this value.
-
-## 2.2.0
-
-* `fallback: :any` to fall back to any other locale if the text is blank in the current and default locales.
-
-## 2.1.0
-
-* Attribute readers can override the attribute's `fallback` setting, e.g. `item.title(fallback: false)`.
-
-## 2.0.0
-
-* Backwards incompatible: for dashed locales like "pt-BR", the column names are now expected to end in e.g. `_pt_br`, not `_pt-BR`.
-
-## 1.3.0
-
-Whatever we had before introducing this changelog.

data/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in the .gemspec.
-gemspec
-
-group :benchmark do
-  gem "benchmark-ips"
-end

data/README.md

@@ -1,178 +0,0 @@
-# Traco
-
-[![Build Status](https://secure.travis-ci.org/barsoom/traco.svg)](http://travis-ci.org/barsoom/traco)
-
-Translatable attributes for Ruby on Rails 4.2+, stored in the model table itself.
-
-Inspired by Iain Hecker's [translatable_columns](https://github.com/iain/translatable_columns/).
-
-To store translations outside the model, see Sven Fuchs' [Globalize](https://github.com/globalize/globalize).
-
-
-## Usage
-
-Say you want `Post#title` and `Post#body` to support both English and Swedish values.
-
-Write a migration to get database columns with locale suffixes, e.g. `title_sv` and `title_en`, like:
-
-```ruby
-class CreatePosts < ActiveRecord::Migration
-  def change
-    create_table :posts do |t|
-      t.string :title_sv, :title_en
-      t.text :body_sv, :body_en
-
-      t.timestamps
-    end
-  end
-end
-```
-
-Don't create a database column named `title` without a suffix, since Traco will define a method with that name.
-
-If you use a locale format like `pt-BR`, the column name would be `title_pt_br`.
-
-Declare the attributes in the model:
-
-```ruby
-class Post < ActiveRecord::Base
-  translates :title, :body
-end
-```
-
-You can still use your accessors like `title_sv` and `title_sv=` in forms, validations and other code, but you also get:
-
-`#title`: Shows the title in the current locale. If blank, falls back to default locale. Otherwise nil.
-
-`#title=`: Assigns the title to the column for the current locale, if present. Raises if the column doesn't exist.
-
-`#title?`: Is the title present? Respects the Traco [fallback](#fallbacks) setting.
-
-`.human_attribute_name(:title_sv)`: Extends this standard method to return "Title (Swedish)" if you have a translation key `i18n.languages.sv = "Swedish"` and "Title (SV)" otherwise. Rails uses this method to build validation error messages and form labels.
-
-`.translatable_attributes`: Returns an array like `[:title, :body]`.
-
-`.locale_columns(:title)`: Returns an array like `[:title_sv, :title_en]` sorted with current locale first, then default locale, and then alphabetically. Suitable for looping in forms:
-
-```erb
-<% Post.locale_columns(:title).each do |column| %>
-  <p>
-    <%= form.label column %>
-    <%= form.text_field column %>
-  </p>
-<% end %>
-```
-
-Or perhaps for things like:
-
-```ruby
-attr_accessible *locale_columns(:title)
-
-validates *locale_columns(:title), :uniqueness => true
-```
-
-You can also pass multiple attributes if you like:
-
-```ruby
-attr_accessible *locale_columns(:title, :body)
-```
-
-The return value will be sorted like `[:title_sv, :title_en, :body_sv, :body_en]`.
-
-`.current_locale_column(:title)`: Returns `:title_sv` if `:sv` is the current locale. Suitable for some SQL queries, such as sorting.
-
-`.locales_for_attribute(:title)`: Returns an array like `[:sv, :en]` sorted with current locale first, then default locale, and then alphabetically.
-
-And the equivalent methods for `body`, of course.
-
-Please note that your `translates :title, :body` declaration must be called before you call `locale_columns`. Otherwise you will get an error like "NoMethodError: undefined method `locale\_columns' for #\<Class:0x00000003f69188\>".
-
-
-### Fallbacks
-
-By default, Traco will fall back to the default locale if there is no translation in the current locale.
-
-You can specify e.g. `translates :title, fallback: false` to never fall back and instead return `nil`.
-
-You can specify e.g. `translates :title, fallback: :any` to fall back first to the default locale, then to any other locale.
-
-You can specify e.g. `translates :title, fallback: [:sv]` to explicitly declare fallbacks as an array of any length.
-
-You can specify e.g. `translates :title, fallback: :i18n` to use the fallbacks from `I18n.fallbacks`.
-
-You can override the default fallback strategy with a parameter passed to the reader: `post.title(fallback: :any)`.
-
-If you need to declare the default locale fallback, do `post.title(fallback: :default)`.
-
-
-### Overriding methods
-
-Methods are defined in an included module, so you can just override them and call Traco's implementation with `super`:
-
-```ruby
-class Post < ActiveRecord::Base
-  translates :title
-
-  def title
-    super.reverse
-  end
-end
-```
-
-## Installation
-
-Add this to your `Gemfile`:
-
-```ruby
-gem "traco"
-```
-
-Then run
-
-    bundle
-
-to install it.
-
-
-## Running the tests
-
-    bundle
-    rake
-
-
-## Benchmark
-
-    ruby benchmarks/overhead.rb
-
-
-<!-- Keeping this a hidden brain dump for now.
-
-## TODO
-
-We've intentionally kept this simple with no features we do not need.
-We'd be happy to merge additional features that others contribute.
-
-Possible improvements to make:
-
-  * Validation that checks that at least one translation for a column exists.
-  * Validation that checks that every translation for a column exists.
-  * Scopes like `translated`, `translated_to(locale)`.
-  * Support for region locales, like `en-US` and `en-GB`.
-
--->
-
-## Contributors
-
-* [Henrik Nyh](http://henrik.nyh.se)
-* Andrii Malyshko
-* Tobias Bohwalli
-* Mario Alberto Chavez
-* Philip Arndt
-* [PikachuEXE](https://github.com/PikachuEXE)
-* Fernando Morgenstern
-* Tomáš Horáček
-* Joakim Kolsjö
-
-## License
-
-[MIT](LICENSE.txt)

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/benchmarks/overhead.rb

@@ -1,41 +0,0 @@
-# This benchmark tests how fast a Traco-wrapped attribute is
-# compared to the plain Active Record attribute.
-
-require "bundler/setup"
-require "benchmark/ips"
-require "active_record"
-require "traco"
-
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-
-I18n.enforce_available_locales = false
-I18n.available_locales = [ :en, :de, :sv ]
-I18n.default_locale = :en
-I18n.locale = :sv
-
-COLUMNS = %w(title body long_title seo_title)
-
-silence_stream(STDOUT) do
-  ActiveRecord::Schema.define(version: 0) do
-    create_table :posts, force: true do |t|
-      I18n.available_locales.each do |locale|
-        COLUMNS.each do |column|
-          t.string "#{column}_#{locale}"
-        end
-      end
-    end
-  end
-end
-
-class Post < ActiveRecord::Base
-  translates *COLUMNS
-end
-
-post = Post.new(title_en: "hello", title_sv: "Hej")
-
-Benchmark.ips do |x|
-  x.report("activerecord") { post.title_sv }
-  x.report("traco") { post.title }
-
-  x.compare!
-end

data/gemfiles/rails_4.2.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 4.2.0"
-gem "sqlite3", "~> 1.3.13"
-
-group :benchmark do
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.0.0"
-gem "sqlite3", "~> 1.3.13"
-
-group :benchmark do
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.1.0"
-gem "sqlite3", "~> 1.3.13"
-
-group :benchmark do
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 5.2.0"
-
-group :benchmark do
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 6.0.3.1"
-
-group :benchmark do
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -1,11 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord", "~> 6.1.0"
-
-group :benchmark do
-  gem "benchmark-ips"
-end
-
-gemspec path: "../"

data/traco.gemspec

@@ -1,28 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "traco/version"
-
-Gem::Specification.new do |s|
-  s.name        = "traco"
-  s.version     = Traco::VERSION
-  s.authors     = ["Henrik Nyh"]
-  s.email       = ["henrik@barsoom.se"]
-  s.homepage    = ""
-  s.summary     = "Translatable columns for Rails 4.2 or better, stored in the model table itself."
-  s.license     = "MIT"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.required_ruby_version = ">= 2.3.0"
-
-  s.add_dependency "activerecord", ">= 4.2"
-
-  s.add_development_dependency "sqlite3"
-
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "appraisal"
-end