traco 5.3.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f574ca00b4a00cb29c1b6222d4b1afd7ce8e2a84561cd2eba142c3dc7ad9e3e5
-  data.tar.gz: ff1a6327086f994627df877d57b46a6c16389315e2183406f07ca6215b376aef
+  metadata.gz: 5de70b4e4831449104ded9af0acc78de7225a0cf0ae44e6f6559d913cbf0a2e0
+  data.tar.gz: 2db12568f7e0901facaade861013fd92cef6894f8c536ad1bcef1b9a887af1fe
 SHA512:
-  metadata.gz: 1b54c9864d9d378f5fdbcf9ff8952413dfbee488effedccf5485cdcd3b3c34a12e0798a5d46a6b9e9a0e40dbabc5e089af14ccf4d6c83278d98bb23dd31e63e8
-  data.tar.gz: 4c281b250b2065bf0d62754be45cc4efa873b859f1d666b1bd6741420dda3d29d756d7155869ea347a47e7fb2bc0d73314b8fed0d9585f63b0ed15cc9048e58f
+  metadata.gz: '095d8a4db69e3b98fc74fc2ae3e5c8fc1f3606a671baf96ee597a23de3d514e39090f4baceabc9cc4de824a0e02c1a7a95b2bb892956ca98698068eb35ee2b5c'
+  data.tar.gz: c4d7ae492cab31e788840689306ef572a620872398d071a076d6010a1726da3be32bd7d5e20f9f96d57fc2d3409dc8bb38d4ab2e2242a44cde4be684165153ab

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 6.0.0
+
+* Return e.g. `{}` rather than `nil` for falsey values that are not the empty string.
+
 ## 5.3.3
 
 * Force MFA for privileged Rubygems actions.

data/lib/traco/attributes.rb

@@ -28,12 +28,14 @@ module Traco
           return send(Traco.column(:#{attribute}, locale)) if locale
 
           columns_to_try = self.class._locale_columns_for_attribute(:#{attribute}, fallback: fallback)
+          value = nil
           columns_to_try.each do |column|
             value = send(column)
             return value if value.present?
           end
 
-          nil
+          # With no present value in any locale, return nil for strings, or the last seen blank value (e.g. {} for JSON columns with that default).
+          value.is_a?(String) ? nil : value
         end
       EOM
     end

data/lib/traco/version.rb

@@ -1,3 +1,3 @@
 module Traco
-  VERSION = "5.3.3"
+  VERSION = "6.0.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: traco
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 6.0.0
 platform: ruby
 authors:
 - Henrik Nyh
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,63 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
-- !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: []
@@ -95,18 +37,11 @@ files:
 - lib/traco/locale_fallbacks.rb
 - lib/traco/translates.rb
 - lib/traco/version.rb
-- spec/app/post.rb
-- spec/app/sv.yml
-- spec/locale_fallbacks_spec.rb
-- spec/spec_helper.rb
-- spec/spec_helper_models.rb
-- spec/traco_spec.rb
 homepage: ''
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -121,14 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
-signing_key: 
+rubygems_version: 3.6.9
 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/traco_spec.rb
+test_files: []

data/spec/app/post.rb

@@ -1,5 +0,0 @@
-class Post < ActiveRecord::Base
-end
-
-class SubPost < Post
-end

data/spec/app/sv.yml

@@ -1,7 +0,0 @@
-sv:
-  attributes:
-    title_sv: "Svensk titel"
-    title: "Titel"
-  i18n:
-    languages:
-      en: "engelska"

data/spec/locale_fallbacks_spec.rb

@@ -1,69 +0,0 @@
-require "traco/locale_fallbacks"
-
-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)
-      expect { Traco::LocaleFallbacks.new(nil) }.to raise_error(ArgumentError)
-    end
-  end
-
-  describe "#[]" do
-    context "with the ':default' option" do
-      it "returns given locale, then default locale" do
-        I18n.default_locale = :en
-        subject = Traco::LocaleFallbacks.new(:default)
-        expect(subject[:sv]).to eq [ :sv, :en ]
-      end
-    end
-
-    context "with the ':any' option" do
-      it "returns given locale, then default locale, then remaining available locales alphabetically" do
-        I18n.default_locale = :en
-        I18n.available_locales = [ :en, :sv, :uk, :de ]
-
-        subject = Traco::LocaleFallbacks.new(:any)
-        expect(subject[:sv]).to eq [ :sv, :en, :de, :uk ]
-      end
-    end
-
-    context "with the 'false' option" do
-      it "returns only given locale" do
-        subject = Traco::LocaleFallbacks.new(false)
-        expect(subject[:sv]).to eq [ :sv ]
-      end
-    end
-
-    context "with an explicit list of locales" do
-      it "returns only those locales, after the current one" do
-        subject = Traco::LocaleFallbacks.new([ :en ])
-        expect(subject[:sv]).to eq [ :sv, :en ]
-      end
-    end
-
-    context "with the ':default_first' option" do
-      it "returns default locale, then remaining available locales alphabetically" do
-        I18n.default_locale = :uk
-        I18n.available_locales = [ :en, :sv, :uk, :de ]
-
-        subject = Traco::LocaleFallbacks.new(:default_first)
-        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

@@ -1,11 +0,0 @@
-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,29 +0,0 @@
-RSpec.configure do |config|
-  config.before do
-    # Clear class state before each spec.
-    Object.send(:remove_const, "Post")
-    Object.send(:remove_const, "SubPost")
-    load "app/post.rb"
-
-    # Known state.
-    I18n.default_locale = :sv
-  end
-end
-
-# Test against real ActiveRecord models.
-# Very much based on the test setup in
-# https://github.com/iain/translatable_columns/
-
-require "active_record"
-require "app/post.rb"
-
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-
-ActiveRecord::Schema.define(version: 0) do
-  create_table :posts, force: true do |t|
-    t.string :title_sv, :title_en, :title_pt_br, :title_de
-    t.string :body_sv, :body_en, :body_pt_br, :body_de
-  end
-end
-
-I18n.load_path << "spec/app/sv.yml"

data/spec/traco_spec.rb

@@ -1,384 +0,0 @@
-# encoding: utf-8
-
-require "spec_helper_models"
-require "traco"
-
-RSpec.describe Traco, ".split_localized_column" do
-  subject { described_class }
-
-  it "returns attribute and locale" do
-    expect(subject.split_localized_column("title_sv")).to eq [ :title, :sv ]
-  end
-
-  it "handles normalized locales" do
-    expect(subject.split_localized_column("title_pt_br")).to eq [ :title, :"pt-BR" ]
-  end
-
-  it "returns nil if column is not localized" do
-    expect(subject.split_localized_column("title")).to be_nil
-  end
-
-  it "returns nil if column is not localized but with undercores" do
-    expect(subject.split_localized_column("long_title")).to be_nil
-  end
-end
-
-RSpec.describe ActiveRecord::Base, ".translates" do
-  it "is available" do
-    expect(Post).to respond_to :translates
-  end
-
-  it "adds functionality" do
-    expect(Post.new).not_to respond_to :title
-    Post.translates :title
-    expect(Post.new).to respond_to :title
-  end
-
-  it "can be run more than once" do
-    expect(Post.new).not_to respond_to :title, :body
-    Post.translates :title
-    Post.translates :body
-    expect(Post.new).to respond_to :title, :body
-  end
-
-  it "allows to define several attributes at once" do
-    expect(Post.new).not_to respond_to :title, :body
-    Post.translates :title, :body
-    expect(Post.new).to respond_to :title, :body
-  end
-
-  it "inherits columns from the superclass" do
-    Post.translates :title
-    SubPost.translates :body
-    expect(SubPost.new).to respond_to :title, :body
-    expect(Post.new).to respond_to :title
-    expect(Post.new).not_to respond_to :body
-  end
-end
-
-RSpec.describe Post, ".translatable_attributes" do
-  before do
-    Post.translates :title
-  end
-
-  it "lists the translatable attributes" do
-    expect(Post.translatable_attributes).to eq [ :title ]
-  end
-
-  it "inherits attributes from superclass to a subclass" do
-    SubPost.translates :body
-    expect(SubPost.translatable_attributes).to eq [ :title, :body ]
-  end
-
-  it "doesn't inherit attributes from a subclass to superclass" do
-    SubPost.translates :body
-    expect(Post.translatable_attributes).to eq [ :title ]
-  end
-end
-
-RSpec.describe Post, ".locales_for_attribute" do
-  before do
-    Post.translates :title
-    I18n.default_locale = :"pt-BR"
-    I18n.locale = :en
-  end
-
-  it "lists the locales for that attribute, current locale first, then default locale, and then alphabetically" do
-    expect(Post.locales_for_attribute(:title)).to eq [ :en, :"pt-BR", :de, :sv ]
-  end
-
-  it "doesn't include a locale if there's no corresponding column for it" do
-    I18n.available_locales += [ :ru ]
-
-    expect(Post.locales_for_attribute(:title)).not_to include(:ru)
-  end
-end
-
-RSpec.describe Post, ".locale_columns" do
-  before do
-    Post.translates :title
-    I18n.default_locale = :"pt-BR"
-    I18n.locale = :en
-  end
-
-  it "lists the columns-with-locale for that attribute, current locale first, then default locale, and then alphabetically" do
-    expect(Post.locale_columns(:title)).to eq [
-      :title_en, :title_pt_br, :title_de, :title_sv,
-    ]
-  end
-
-  it "doesn't include a column-with-locale if it doesn't exist" do
-    I18n.available_locales += [ :ru ]
-
-    expect(Post.locale_columns(:title)).not_to include(:title_ru)
-  end
-
-  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
-
-RSpec.describe Post, ".current_locale_column" do
-  before do
-    Post.translates :title
-  end
-
-  it "returns the column name for the current locale" do
-    I18n.locale = :sv
-    expect(Post.current_locale_column(:title)).to eq :title_sv
-  end
-
-  it "returns the column name with right format for the current locale with region identifier" do
-    I18n.locale = :"pt-BR"
-    expect(Post.current_locale_column(:title)).to eq :title_pt_br
-  end
-end
-
-RSpec.describe Post, "#title" do
-  let(:post) {
-    Post.new(title_sv: "Hej", title_en: "Halloa", title_pt_br: "Olá")
-  }
-
-  before do
-    Post.translates :title
-    I18n.locale = :sv
-    I18n.default_locale = :en
-  end
-
-  it "gives the title in the current locale" do
-    expect(post.title).to eq "Hej"
-  end
-
-  it "handles dashed locales" do
-    I18n.locale = :"pt-BR"
-    expect(post.title_pt_br).to eq "Olá"
-    expect(post.title).to eq "Olá"
-  end
-
-  it "falls back to the default locale if locale has no column" do
-    I18n.locale = :ru
-    expect(post.title).to eq "Halloa"
-  end
-
-  it "falls back to the default locale if blank" do
-    post.title_sv = " "
-    expect(post.title).to eq "Halloa"
-  end
-
-  it "does not fall back to any other locale if default locale is blank" do
-    post.title_sv = " "
-    post.title_en = ""
-    expect(post.title).to be_nil
-  end
-
-  it "does not fall back if called with fallback: false" do
-    I18n.locale = :sv
-    post.title_sv = ""
-    expect(post.title(fallback: false)).to be_nil
-  end
-
-  # Had a bug: https://github.com/barsoom/traco/issues/25
-  it "does not incorrectly memoize fallback state" do
-    I18n.locale = :sv
-    post.title_sv = ""
-    expect(post.title(fallback: :any)).not_to be_nil
-    expect(post.title(fallback: false)).to be_nil
-  end
-
-  it "returns nil if all are blank" do
-    post.title_sv = " "
-    post.title_en = ""
-    post.title_pt_br = nil
-    expect(post.title).to be_nil
-  end
-
-  it "is overridable" do
-    class Post
-      def title
-        super.reverse
-      end
-    end
-
-    expect(post.title).to eq "jeH"
-  end
-
-  # Had a regression.
-  it "handles multiple columns" do
-    Post.translates :title, :body
-    post.title_sv = "title"
-    post.body_sv = "body"
-    expect(post.title).to eq "title"
-    expect(post.body).to eq "body"
-  end
-
-  it "reflects locale change" do
-    expect(post.title).to eq "Hej"
-    I18n.locale = :en
-    expect(post.title).to eq "Halloa"
-    I18n.locale = :sv
-    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")
-    }
-
-    before do
-      Post.translates :title, fallback: false
-      I18n.default_locale = :en
-    end
-
-    it "does not fall back to the default locale if locale has no column" do
-      I18n.locale = :ru
-      expect(post.title).to be_nil
-    end
-
-    it "does not fall back to the default locale if blank" do
-      I18n.locale = :sv
-      post.title_sv = " "
-      expect(post.title).to be_nil
-    end
-
-    it "still falls back if called with fallback: :default" do
-      I18n.locale = :ru
-      expect(post.title(fallback: :default)).to eq "Halloa"
-    end
-  end
-
-  context "when the translation was defined with fallback: :any" do
-    before do
-      Post.translates :title, fallback: :any
-      I18n.default_locale = :en
-      I18n.locale = :"pt-BR"
-    end
-
-    it "falls back to any locale, not just the default" do
-      post = Post.new(title_en: "", title_pt_br: "", title_sv: "Hej")
-      expect(post.title).to eq "Hej"
-    end
-
-    it "prefers the default locale" do
-      post = Post.new(title_en: "Hello", title_pt_br: "", title_sv: "Hej")
-      expect(post.title).to eq "Hello"
-    end
-  end
-end
-
-RSpec.describe Post, "#title=" do
-  before do
-    Post.translates :title
-  end
-
-  let(:post) { Post.new }
-
-  it "assigns in the current locale" do
-    I18n.locale = :sv
-    post.title = "Hej"
-    expect(post.title_sv).to eq "Hej"
-  end
-
-  it "handles dashed locales" do
-    I18n.locale = :"pt-BR"
-    post.title = "Olá"
-    expect(post.title_pt_br).to eq "Olá"
-  end
-
-  it "raises if locale has no column" do
-    I18n.locale = :ru
-    expect {
-      post.title = "Privet"
-    }.to raise_error(NoMethodError, /title_ru/)
-  end
-end
-
-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, with fallback" do
-    post = Post.new(title_sv: "", title_en: " ", title_pt_br: nil)
-    expect(post.title?).to be false
-
-    post.title_en = "Hello"
-
-    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
-  before do
-    Post.translates :title
-    I18n.locale = :sv
-  end
-
-  it "uses explicit translations if present" do
-    expect(Post.human_attribute_name(:title_sv)).to eq "Svensk titel"
-  end
-
-  it "appends translated language name if present" do
-    expect(Post.human_attribute_name(:title_en)).to eq "Titel (engelska)"
-  end
-
-  it "appends an abbreviation when language name is not translated" do
-    expect(Post.human_attribute_name(:title_pt_br)).to eq "Titel (PT-BR)"
-  end
-
-  it "passes through the default behavior for untranslated attributes" do
-    expect(Post.human_attribute_name(:title)).to eq "Titel"
-  end
-
-  it "passes through untranslated attributes even if the name suggests it's translated" do
-    expect(Post.human_attribute_name(:body_sv)).to eq "Body sv"
-  end
-
-  # ActiveModel::Errors#full_messages passes in an ugly default.
-
-  it "does not honor passed-in defaults for locale columns" do
-    expect(Post.human_attribute_name(:title_en, default: "Title en")).to eq "Titel (engelska)"
-  end
-
-  it "passes through defaults" do
-    expect(Post.human_attribute_name(:body_sv, default: "Boday")).to eq "Boday"
-  end
-end