rails_i18n_extended 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a792c6b59b81e49afa55da44408822b8aed8cdcd2e70670ee737b782bd6384e
+  data.tar.gz: cf10a1e92e4adebefaec5f89e2deb9b5355dac1bd2d3fb4b687cec7804b916fd
+SHA512:
+  metadata.gz: 9b9b867b963058cb11e710f5372ea75f53baa19bb05715379b9c842d6eb2cc5fd63d189dad7f8103fad969c3aa7b93e85aecc8a7dde487325c9aadab27ee0419
+  data.tar.gz: 3f1da885ede191017ae6f25e0300510761df7216b0b0d35c9c6ae59c1b4f6fee1c59aa31e2e4b945909e033b877626d2f26533d35640b4c5a785537187fa74d5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_i18n_extended.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    rails_i18n_extended (0.1.0)
+      activerecord
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3)
+      activesupport (= 6.0.3)
+    activerecord (6.0.3)
+      activemodel (= 6.0.3)
+      activesupport (= 6.0.3)
+    activesupport (6.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails_i18n_extended!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Johan VAN RYSEGHEM
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# RailsI18nExtended
+
+The gem adds a bunch of helpers to ease the use of I18n in your rails project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_i18n_extended'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_i18n_extended
+
+## Usage
+
+The following helpers are available:
+- `Model.t` will get the model name
+- `Model.ts` will get the model name (pluralized)
+- `Model.t_action(action_name)` will get localized action
+- `Model.t_panel(panel_name)` will get localized panel name
+- `Model.t_attr(attr)` will get name of the attribute
+- `model.t_attr(attr)` (on an instance) will get name of the attribute
+- `model.t_enum(attr)` (on an instance) will get value of an enum attribue, localized
+
+You can also call the method `t` on booleans, or on a string to get its translation as a key.
+You can call `l` on all time-related classes to get their localized representation.
+
+We also added a "default fallback" behaviour: when looking for the key `a.b.c.key`, before failing, I18n will look for `a.b.default.key`,  `a.default.key` and  `default.key`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/honestica/rails_i18n_extended.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_i18n_extended"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_i18n_extended/version.rb

@@ -0,0 +1,3 @@
+module RailsI18nExtended
+  VERSION = "0.1.0"
+end

data/lib/rails_i18n_extended.rb

@@ -0,0 +1,194 @@
+require "i18n"
+require "rails_i18n_extended/version"
+require 'active_record'
+
+module I18n
+
+  class << self
+
+    def translate_with_default key, options={}, original=nil
+      begin
+        self.translate_without_default(key, **{raise: true}.update(options))
+      rescue => e
+        split = key.to_s.split('.')
+        if split.size <= 2
+          translate_without_default original || key, **options
+        else
+          v = split.pop
+          v2 = split.pop
+          split.pop if v2 == 'defaults'
+          split << 'defaults' << v
+          new_key = split.join('.')
+          translate_with_default new_key, options, original || key
+        end
+      end
+    end
+    alias_method :translate_without_default, :translate
+    alias_method :translate, :translate_with_default
+    alias_method :t, :translate
+
+    def translate_with_fallback(key = nil, **options)
+      locale = options[:locale] || I18n.locale
+      intended_to_raise = options[:raise]
+      translate_without_fallback(key, options.dup.update(raise: true))
+    rescue I18n::MissingTranslationData => e
+      raise if locale == I18n.default_locale && intended_to_raise
+
+      begin
+        return translate_without_fallback(key, options.dup.update(locale: I18n.default_locale, raise: true))
+      rescue I18n::MissingTranslationData
+        raise e if intended_to_raise
+      end
+
+      translate_without_fallback(key, options)
+    end
+
+    alias_method :translate_without_fallback, :translate
+    alias_method :translate, :translate_with_fallback
+    alias_method :t, :translate
+
+    def model_key(obj)
+      obj.model_name.to_s.underscore.gsub('/', '_')
+    end
+
+    def attribute_key(obj, attr)
+      "activerecord.attributes.#{model_key(obj)}.#{attr}"
+    end
+
+    def custom_attribute_key(obj, attr)
+      "activerecord.custom_display_attributes.#{model_key(obj)}.#{attr}"
+    end
+
+    def flash(key, params={})
+      scope = [:flash] + params[:scope].to_a
+
+      t(key, params.update(scope: scope))
+    end
+
+    def notice(key, params={})
+      scope = [:notice] + params[:scope].to_a
+
+      flash(key, params.update(scope: scope))
+    end
+
+    def alert(key, params={})
+      scope = [:alert] + params[:scope].to_a
+
+      flash(key, params.update(scope: scope))
+    end
+
+    def error(key, params={})
+      scope = [:error] + params[:scope].to_a
+
+      flash(key, params.update(scope: scope))
+    end
+  end
+end
+
+class String
+  def t(params={})
+    I18n.t(self, **params)
+  end
+end
+
+class Time
+  def l(params={})
+    I18n.l(self, **params)
+  end
+end
+
+class DateTime
+  def l(params={})
+    I18n.l(self, **params)
+  end
+end
+
+class Date
+  def l(params={})
+    I18n.l(self, **params)
+  end
+end
+
+class Date
+  def l(params={})
+    I18n.l(self, **params)
+  end
+end
+
+class TrueClass
+  def t(params={})
+    I18n.t(self.to_s, **params)
+  end
+end
+
+class FalseClass
+  def t(params={})
+    I18n.t(self.to_s, **params)
+  end
+end
+
+module RailsI18nExtended
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def t(params={})
+      "activerecord.models.#{model_name.to_s.underscore.gsub('/', '_')}".t({count: 1}.update(params))
+    end
+
+    def tp(params={})
+      t(count: 2)
+    end
+
+    def t_scope(scope, params={})
+      I18n.t("activerecord.scopes.#{I18n.model_key(self)}.#{scope}", **params)
+    end
+
+    def t_panel(panel, params={})
+      I18n.t("panels.#{I18n.model_key(self)}.#{panel}", **params)
+    end
+
+    def t_action(panel, params={})
+      I18n.t("actions.#{I18n.model_key(self)}.#{panel}", **params)
+    end
+
+    def t_confirm(panel, params={})
+      I18n.t("confirm.#{I18n.model_key(self)}.#{panel}", **params)
+    end
+
+    def t_message(panel, params={})
+      I18n.t("message.#{I18n.model_key(self)}.#{panel}", **params)
+    end
+
+    def t_attr(attr, params={})
+      I18n.t(I18n.attribute_key(self, attr), **params)
+    end
+
+    def t_custom_attr(attr, params={})
+      I18n.t(I18n.custom_attribute_key(self, attr), **params)
+    end
+
+    def t_enum(attr, value, params={})
+      return unless value.present?
+
+      I18n.t([I18n.attribute_key(self, attr.to_s.pluralize), value].join('.'), **params)
+    end
+  end
+
+  def t_attr(attr, params={})
+    self.class.t_attr(attr, params)
+  end
+
+  def t_custom_attr(attr, params={})
+    self.class.t_custom_attr(attr, params)
+  end
+
+  def t_enum(attr, params={})
+    return unless send(attr).present?
+
+    self.class.t_enum(attr, send(attr))
+  end
+end
+
+class ActiveRecord::Base
+  include RailsI18nExtended
+end

data/rails_i18n_extended.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/rails_i18n_extended/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_i18n_extended"
+  spec.version       = RailsI18nExtended::VERSION
+  spec.authors       = ["Johan VAN RYSEGHEM"]
+  spec.email         = ["johan@about-blank.fr"]
+
+  spec.summary       = 'Add a few helpers for I18n in RoR'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/honestica/rails_i18n_extended"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/honestica/rails_i18n_extended"
+  spec.metadata["changelog_uri"] = "https://github.com/honestica/rails_i18n_extended"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "rails"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rails_i18n_extended
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johan VAN RYSEGHEM
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- johan@about-blank.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_i18n_extended.rb
+- lib/rails_i18n_extended/version.rb
+- rails_i18n_extended.gemspec
+homepage: https://github.com/honestica/rails_i18n_extended
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/honestica/rails_i18n_extended
+  source_code_uri: https://github.com/honestica/rails_i18n_extended
+  changelog_uri: https://github.com/honestica/rails_i18n_extended
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Add a few helpers for I18n in RoR
+test_files: []