traco 5.0.0 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 995b6c0b60252d02350da1d58e7ea0268a80a80b
-  data.tar.gz: 65c1db0ac8b1036daf10595d5c8745ccf2412aac
+SHA256:
+  metadata.gz: 8578dcbe5ffad338b2a486d18610d2c018d2a7f1cbf1e051037a0780eee98f30
+  data.tar.gz: c8df336aeedb3649d5629a88076bb11f89ff4e19d465bc8471110df24ea49098
 SHA512:
-  metadata.gz: 7f8fe7b9b21d2ea1ac651bf85d0eaa642e276533973347e8feb7248616632c764a1368a5670f8ee64d2afb519160cdbdec68a53ccb2c730e23c81330db3f657f
-  data.tar.gz: 448dff9dd08c1e8fb9c3d4dcfa57bf3fd4e66311ec84c66410fbaea44fac667fe7c8c1add591bb11b6a665648582dd6de59ce35aef604fe14d2a7e3d0444690b
+  metadata.gz: 4b2a96991498a6ca004cc5e804a489c856e8e769e3b12d7a1c9194134ca261beed7dd9de383fa46b48a2dfdabdac20bffa4d00667e33c2d7ddc14502c94fcdac
+  data.tar.gz: b0b95f3fc8904fb754554a7af9f468ca26089ae241cc140829c37c3c233fc7982a2d525f473adb8b604901e2467b729717ec17fc8382d473143b2bfedd0396c6

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 5.3.2
+
+* This version is only to actually include this CHANGELOG in the gem, so you can see the below if you compare gem diffs 😅
+
+## 5.3.1
+
+* This version is only to clarify a backwards incompatibility if relying on undocumented behaviour:
+
+  Readers like `post.title` no longer accept (and ignore) arbitrary keyword arguments.
+
+  So if you would e.g. override a reader like this before:
+
+      def my_title(my_arg:)
+        super || "my fallback #{my_arg}"
+      end
+
+  You will instead need to do:
+
+      def my_title(my_arg:)
+        super() || "my fallback #{my_arg}"
+      end
+
+## 5.3.0
+
+* Feature: You can pass a desired locale to readers and query methods, e.g. `post.title(locale: :de)` to get the German-locale title, and `post.title?(locale: :de)` to check if one exists. This ignores fallback settings – use `I18n.with_locale(:de) { post.title }` if you want fallbacks.
+
+## 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.

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/class_methods.rb

@@ -5,6 +5,8 @@ module Traco
     end
 
     def locale_columns(*attributes)
+      attributes = attributes.presence || translatable_attributes
+
       attributes.flat_map { |attribute|
         _locale_columns_for_attribute(attribute, fallback: LocaleFallbacks::ANY_FALLBACK)
       }

data/lib/traco/locale_fallbacks.rb

@@ -7,6 +7,7 @@ module Traco
       ANY_FALLBACK = :any,
       NO_FALLBACK = false,
       DEFAULT_FIRST_FALLBACK = :default_first,
+      I18N_FALLBACK = :i18n,
     ]
 
     attr_reader :fallback_option
@@ -26,6 +27,7 @@ module Traco
       when ANY_FALLBACK           then [ current_locale, @default_locale, *@available_locales ].uniq
       when NO_FALLBACK            then [ current_locale ]
       when DEFAULT_FIRST_FALLBACK then [ @default_locale, *@available_locales ].uniq
+      when I18N_FALLBACK          then I18n.fallbacks[current_locale]
       when Array                  then [ current_locale, *fallback_option ]
       else                        raise "Unknown fallback."  # Should never get here.
       end

data/lib/traco/version.rb

@@ -1,3 +1,3 @@
 module Traco
-  VERSION = "5.0.0"
+  VERSION = "5.3.2"
 end

data/spec/locale_fallbacks_spec.rb

@@ -1,7 +1,6 @@
-require "spec_helper"
 require "traco/locale_fallbacks"
 
-describe Traco::LocaleFallbacks do
+RSpec.describe Traco::LocaleFallbacks do
   describe ".new" do
     it "raises ArgumentError if an unknown argument passed in" do
       expect { Traco::LocaleFallbacks.new(:foo) }.to raise_error(ArgumentError)
@@ -51,5 +50,20 @@ describe Traco::LocaleFallbacks do
         expect(subject[:sv]).to eq [ :uk, :de, :en, :sv ]
       end
     end
+
+    context "with the ':i18n' option" do
+      it "returns what is configured as a I18n fallback" do
+        I18n.fallbacks = I18n::Locale::Fallbacks.new(
+          en: [ :en, :uk, :de, :sv ],
+          uk: [ :uk, :en, :de, :sv ],
+          de: [ :de, :uk, :en, :sv ],
+          sv: [ :sv, :en, :uk, :de ],
+        )
+
+        subject = Traco::LocaleFallbacks.new(:i18n)
+        expect(subject[:sv]).to eq [ :sv, :en, :uk, :de ]
+        expect(subject[:de]).to eq [ :de, :uk, :en, :sv ]
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,9 @@ require "i18n"
 RSpec.configure do |config|
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
 end
 
 I18n.enforce_available_locales = false
+
+I18n::Backend::Simple.include(I18n::Backend::Fallbacks)

data/spec/spec_helper_models.rb

@@ -1,5 +1,5 @@
 RSpec.configure do |config|
-  config.before(:each) do
+  config.before do
     # Clear class state before each spec.
     Object.send(:remove_const, "Post")
     Object.send(:remove_const, "SubPost")

data/spec/traco_spec.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
 
-require "spec_helper"
 require "spec_helper_models"
 require "traco"
 
-describe Traco, ".split_localized_column" do
+RSpec.describe Traco, ".split_localized_column" do
   subject { described_class }
 
   it "returns attribute and locale" do
@@ -24,7 +23,7 @@ describe Traco, ".split_localized_column" do
   end
 end
 
-describe ActiveRecord::Base, ".translates" do
+RSpec.describe ActiveRecord::Base, ".translates" do
   it "is available" do
     expect(Post).to respond_to :translates
   end
@@ -57,7 +56,7 @@ describe ActiveRecord::Base, ".translates" do
   end
 end
 
-describe Post, ".translatable_attributes" do
+RSpec.describe Post, ".translatable_attributes" do
   before do
     Post.translates :title
   end
@@ -77,7 +76,7 @@ describe Post, ".translatable_attributes" do
   end
 end
 
-describe Post, ".locales_for_attribute" do
+RSpec.describe Post, ".locales_for_attribute" do
   before do
     Post.translates :title
     I18n.default_locale = :"pt-BR"
@@ -95,7 +94,7 @@ describe Post, ".locales_for_attribute" do
   end
 end
 
-describe Post, ".locale_columns" do
+RSpec.describe Post, ".locale_columns" do
   before do
     Post.translates :title
     I18n.default_locale = :"pt-BR"
@@ -114,17 +113,23 @@ describe Post, ".locale_columns" do
     expect(Post.locale_columns(:title)).not_to include(:title_ru)
   end
 
-it "supports multiple attributes" do
-  Post.translates :body
+  it "supports multiple attributes" do
+    Post.translates :body
 
     expect(Post.locale_columns(:body, :title)).to eq [
       :body_en, :body_pt_br, :body_de, :body_sv,
       :title_en, :title_pt_br, :title_de, :title_sv,
     ]
   end
+
+  it "returns the columns of all translated attributes if no params are supplied" do
+    expect(Post.locale_columns).to eq [
+      :title_en, :title_pt_br, :title_de, :title_sv
+    ]
+  end
 end
 
-describe Post, ".current_locale_column" do
+RSpec.describe Post, ".current_locale_column" do
   before do
     Post.translates :title
   end
@@ -140,7 +145,7 @@ describe Post, ".current_locale_column" do
   end
 end
 
-describe Post, "#title" do
+RSpec.describe Post, "#title" do
   let(:post) {
     Post.new(title_sv: "Hej", title_en: "Halloa", title_pt_br: "Olá")
   }
@@ -225,6 +230,19 @@ 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")
@@ -271,7 +289,7 @@ describe Post, "#title" do
   end
 end
 
-describe Post, "#title=" do
+RSpec.describe Post, "#title=" do
   before do
     Post.translates :title
   end
@@ -298,14 +316,14 @@ describe Post, "#title=" do
   end
 end
 
-describe Post, "#title?" do
+RSpec.describe Post, "#title?" do
   before do
     Post.translates :title
     I18n.locale = :sv
     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
 
@@ -313,9 +331,22 @@ 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
 
-describe Post, ".human_attribute_name" do
+RSpec.describe Post, ".human_attribute_name" do
   before do
     Post.translates :title
     I18n.locale = :sv

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traco
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.3.2
 platform: ruby
 authors:
 - Henrik Nyh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -66,21 +66,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - henrik@barsoom.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- benchmarks/overhead.rb
 - lib/traco.rb
 - lib/traco/attributes.rb
 - lib/traco/class_methods.rb
@@ -93,12 +101,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
@@ -113,15 +120,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Translatable columns for Rails 3 or better, stored in the model table itself.
+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,5 +0,0 @@
-.bundle/
-Gemfile.lock
-pkg/
-tmp
-*.gem

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 2.5.1
-  - 2.4.4
-  - 2.3.0
-
-# Avoid some errors, and speed things up:
-# https://github.com/bundler/bundler/issues/3558#issuecomment-171347979
-# https://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false

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,176 +0,0 @@
-# Traco
-
-[![Build Status](https://secure.travis-ci.org/barsoom/traco.png)](http://travis-ci.org/barsoom/traco)
-
-Translatable attributes for Ruby on Rails, 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 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/traco.gemspec

@@ -1,27 +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 3 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", ">= 3.0"
-
-  s.add_development_dependency "sqlite3"
-
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-end