i18n-object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5f747082d7edff8f1dcc331a1de47fa5d3d881a6d64a178d5943839a6edd574
+  data.tar.gz: 0e3174d2bd7597cc5694ea2adcfa1eef225d8751522736c21aee6ab139b5de96
+SHA512:
+  metadata.gz: b6c99af1ead5e26aa02fff24f71bf2ed7b49dfff032ea7376699a6ec5d774deabedd3d1b9454e1cc611d1753512354f89007dca201b7dad08afad40823fbbda2
+  data.tar.gz: 3245f17013fc0b8932b6069d32635cf455d07aa07c440e039cd10e250aa1cb610bb4cb61bc0e2089407e1cbb1202d76a1b53080d78b4253ada94768846885b3c

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/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  onkcop:
+    - "config/rubocop.yml"
+    # uncomment if use rails cops
+    # - "config/rails.yml"
+    # uncomment if use rspec cops
+    # - "config/rspec.yml"
+
+AllCops:
+  TargetRubyVersion: 2.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in i18n-object.gemspec
+gemspec
+
+gem "onkcop", require: false

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    i18n-object (0.1.0)
+      activesupport (>= 5.0)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    onkcop (0.53.0.3)
+      rubocop (>= 0.53.0)
+      rubocop-rspec (>= 1.24.0)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  i18n-object!
+  onkcop
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshiyuki Hirano
+
+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,94 @@
+# I18n::Object
+
+`I18n::Object` provides you can use wrapper classes for easy handling/testing of I18n by just only configuration.
+
+## The Value of I18n::Object
+
+This gem resolves these problems:
+
+- It's not a easy to deal with deep nested YAML files from both product and test codes.
+- We need wrapper class for easy handling/testing of `I18n#translate` to **avoid TYPOs and translation missings**!!
+
+This `i18n-object` provides you can get to use wrapper classes just only assign namespaces in the initializer file:
+
+```ruby
+# config/initializers/i18n_object.rb
+I18n::Object.namespaces = %w[
+  notification
+  slack_notificaiton/admin
+  slack_notificaiton/consumer
+]
+```
+
+And you have to define YAML files on `config/locales` like this:
+
+```yaml
+en:
+  notification:
+    say: Hi, %{name}!
+  slack_notification:
+    admin:
+      say: Hi, admin!
+    consumer:
+      say: Hi, consumer!
+```
+
+Then you can use wrapper classes:
+
+```ruby
+Notificaiton.say(name: 'alice') # Hi, alice!
+SlackNotification::Admin.say # Hi, admin!
+SlackNotification::Consumer.say # Hi, consumer!
+Notification.hello # No Method Error
+```
+
+Finally you can get relief from **pain of TYPOs and translation missings**.
+
+## Installation
+
+1. Add `i18n-object` to your `Gemfile`:
+
+```ruby
+gem 'i18n-object'
+```
+
+2. Execute this command to generate an initializer:
+
+```
+$ bin/rails generate i18n:object:install
+```
+
+3. Assign namespaces and prepare locale files:
+
+```ruby
+# Assign I18n Object names:
+#
+# e.g.)
+#
+# I18n::Object.namespaces = %w[
+#   notification
+#   slack_notificaiton/admin
+#   slack_notificaiton/consumer
+# ]
+#
+# en:
+#   notification:
+#     say: Hi, %{name}!
+#   slack_notification:
+#     admin:
+#       say: Hi, admin!
+#     consumer:
+#       say: Hi, consumer!
+#
+# Notificaiton.say(name: 'alice') # Hi, alice!
+# Notification.hello # NoMethodError
+# SlackNotification::Admin.say # Hi, admin!
+# SlackNotification::Consumer.say # Hi, consumer!
+
+I18n::Object.namespaces = %w[
+]
+```
+
+## 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 "i18n/object"
+
+# 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/i18n-object.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("./lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "i18n/object/version"
+
+Gem::Specification.new do |s|
+  s.name          = "i18n-object"
+  s.version       = I18n::Object::VERSION
+  s.authors       = ["Yoshiyuki Hirano"]
+  s.email         = ["yhirano@me.com"]
+  s.homepage      = "https://github.com/yhirano55/i18n-object"
+  s.summary       = "I18n::Object provides you can get to use wrapper classes for easy handling/testing of I18n by just only configuration."
+  s.description   = s.summary
+  s.license       = "MIT"
+  s.files         = Dir.chdir(File.expand_path(".", __dir__)) do
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.required_ruby_version = ">= 2.5.0"
+
+  s.add_dependency "activesupport", ">= 5.0"
+  s.add_dependency "i18n"
+
+  s.add_development_dependency "bundler", "~> 2.0"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/generators/i18n/object/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Copies the necessary file to get you up and runnning with I18n::Object gem
+
+Examples:
+  rails generate i18n:object:install

data/lib/generators/i18n/object/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators/migration"
+
+module I18n
+  module Object
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root File.expand_path("./templates", __dir__)
+
+        def copy_file_for_initializer
+          copy_file "initializer.tt", "config/initializers/i18n_object.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/i18n/object/templates/initializer.tt

@@ -0,0 +1,26 @@
+# Assign I18n Object names:
+#
+# e.g.)
+#
+# I18n::Object.namespaces = %w[
+#   notification
+#   slack_notificaiton/admin
+#   slack_notificaiton/consumer
+# ]
+#
+# en:
+#   notification:
+#     say: Hi, %{name}!
+#   slack_notification:
+#     admin:
+#       say: Hi, admin!
+#     consumer:
+#       say: Hi, consumer!
+#
+# Notificaiton.say(name: 'alice') # Hi, alice!
+# Notification.hello # NoMethodError
+# SlackNotification::Admin.say # Hi, admin!
+# SlackNotification::Consumer.say # Hi, consumer!
+
+I18n::Object.namespaces = %w[
+]

data/lib/i18n/object.rb

@@ -0,0 +1,18 @@
+require "i18n/object/version"
+
+begin
+  require "rails"
+  require_relative "object/railtie"
+rescue LoadError
+  nil
+end
+
+require "i18n"
+
+module I18n
+  module Object
+    class << self
+      attr_accessor :namespaces
+    end
+  end
+end

data/lib/i18n/object/config.rb

@@ -0,0 +1,11 @@
+module I18n
+  module Object
+    class Config
+      attr_accessor :namespaces
+
+      def initialize
+        @namespaces = []
+      end
+    end
+  end
+end

data/lib/i18n/object/railtie.rb

@@ -0,0 +1,32 @@
+require "active_support/core_ext/string/inflections"
+
+module I18n
+  module Object
+    class Railtie < ::Rails::Railtie
+      initializer "i18n-object.configs" do
+        config.after_initialize do
+          require "i18n/object/translation_methods"
+
+          ::I18n::Object.namespaces.each do |namespace|
+            class_name = namespace.classify
+
+            parent_object = ::Object
+            target_object = nil
+
+            class_name.split("::").each do |const_name|
+              parent_object = if parent_object.const_defined?(const_name)
+                                parent_object.const_get(const_name)
+                              else
+                                parent_object.const_set(const_name, ::Class.new)
+                              end
+              target_object = parent_object
+            end
+
+            target_object.include ::I18n::Object::TranslationMethods
+            target_object.scope = class_name.underscore.split("/").freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/object/translation_methods.rb

@@ -0,0 +1,38 @@
+require "active_support/core_ext/string/inflections"
+
+module I18n
+  module Object
+    module TranslationMethods
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def scope
+          @scope
+        end
+
+        def scope=(value)
+          @scope = value
+        end
+
+        private
+
+          def respond_to_missing?(method_name, *args)
+            !!translate(method_name, args) || super
+          end
+
+          def method_missing(method_name, *args, &block)
+            translate(method_name, args) || super
+          end
+
+          def translate(method_name, args)
+            options = args.first || {}
+            ::I18n.t!(method_name, **options.merge(scope: scope))
+          rescue ::I18n::MissingTranslationData
+            nil
+          end
+      end
+    end
+  end
+end

data/lib/i18n/object/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module Object
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: i18n-object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: I18n::Object provides you can get to use wrapper classes for easy handling/testing
+  of I18n by just only configuration.
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n-object.gemspec
+- lib/generators/i18n/object/USAGE
+- lib/generators/i18n/object/install_generator.rb
+- lib/generators/i18n/object/templates/initializer.tt
+- lib/i18n/object.rb
+- lib/i18n/object/config.rb
+- lib/i18n/object/railtie.rb
+- lib/i18n/object/translation_methods.rb
+- lib/i18n/object/version.rb
+homepage: https://github.com/yhirano55/i18n-object
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: I18n::Object provides you can get to use wrapper classes for easy handling/testing
+  of I18n by just only configuration.
+test_files: []