translatable_fields 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1205f77c761a53f2055c75ac6f2cb9616cd4d0aa4387f68e150c8dc3133001f3
+  data.tar.gz: b627a2725aaf1f4cd52fa1c9ee1dec06adf35bb718d53c3e6f59d10d4346c844
+SHA512:
+  metadata.gz: c33ace1c25c702b42fd553fe183308ee51045d18e426e4a20be593f7ba97caa74d0e655af0ecf894c387ff6ba433f02e747a11c56433b0753cdfc0e7bd5278ab
+  data.tar.gz: 6e99efa38ce4752517e60218db2ca7d3682291641fb6c7bdbfe108dd4dd43be391d09673f5546ed16312d8a45d039c1143ca3ff1940d57cd58e3a944a95a34ff

data/.circleci/config.yml

@@ -0,0 +1,25 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-node-browsers
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - translatable_fields-{{ checksum "Gemfile.lock" }}
+            - translatable_fields-
+
+      - run:
+          name: install dependencies
+          command: bundle check || bundle install
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: translatable_fields-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: run tests
+          command: bundle exec rspec

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,55 @@
+---
+AllCops:
+  DisplayCopNames:   true
+  TargetRubyVersion: 2.6
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Naming/UncommunicativeMethodParamName:
+  MinNameLength: 2
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Alias:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/DateTime:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/Semicolon:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in translatable_fields.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    translatable_fields (0.1.0)
+      activesupport (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.2.0)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry
+  rspec (~> 3.0)
+  rubocop
+  simplecov
+  translatable_fields!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ruslan Tolstov
+
+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,70 @@
+# TranslatableFields
+
+Translate your fields in ActiveRecord.
+
+Rails concern allow you to translate your models' attribute values with prefixes like `en_title` or `title_en`
+
+## Requirements
+
+* ActiveRecord
+* I18n
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'translatable_fields'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install translatable_fields
+    $ rails g translatable_fields:install
+
+## Set up
+```diff
+# config/initializers/translatable_fields.rb
+TranslatableFields.configure do |config|
+# Set up your mode:
+# :prefix_at_the_beginning (default) - for fields like en_title, ar_title
+# :prefix_in_the_end - for fields like title_en, title_ar
+#
++ config.mode = :prefix_at_the_beginning
+end
+```
+
+## Usage example
+```diff
+class Allergy < ApplicationRecord
++  include TranslatableFields::Concern
+
++  translatable_fields(:title, :description)
+end
+```
+
+```ruby
+Allergy.first.title
+=> "Food Allergy"
+Allergy.first.description
+=> "There are different types of allergic reactions to foods"
+```
+
+## Thanks
+Implemented based on ideas [@GalenkoEugene](https://github.com/GalenkoEugene), [@AlexTua](https://github.com/AlexTua) thanks, guys.
+
+## Contributing
+
+1. Fork it ( link )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The MIT License

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 "ar/perekladach"
+
+# 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/generators/translatable_fields/install/install_generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators"
+
+module TranslatableFields
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def add_initializer
+      template("translatable_fields.rb", "config/initializers/translatable_fields.rb")
+    end
+  end
+end

data/lib/generators/translatable_fields/install/templates/translatable_fields.rb

@@ -0,0 +1,7 @@
+TranslatableFields.configure do |config|
+  # Set up your mode:
+  # :prefix_at_the_beginning (default) - for fields like en_title, ar_title
+  # :prefix_in_the_end - for fields like title_en, title_ar
+  #
+  # config.mode = :prefix_at_the_beginning
+end

data/lib/translatable_fields.rb

@@ -0,0 +1,13 @@
+require "translatable_fields/version"
+require "translatable_fields/configuration"
+require "translatable_fields/concern"
+
+module TranslatableFields
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/lib/translatable_fields/concern.rb

@@ -0,0 +1,27 @@
+require "active_support/concern"
+
+module TranslatableFields
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      def field_prefix(field)
+        if TranslatableFields.config.mode&.to_sym == :prefix_at_the_beginning
+          "#{I18n.locale}_#{field}"
+        else
+          "#{field}_#{I18n.locale}"
+        end
+      end
+    end
+
+    class_methods do
+      def translatable_fields(*fields)
+        fields.each do |field|
+          define_method(field) do
+            public_send(field_prefix(field))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/translatable_fields/configuration.rb

@@ -0,0 +1,9 @@
+module TranslatableFields
+  class Configuration
+    attr_accessor :mode
+
+    def initialize
+      @mode = :prefix_at_the_beginning
+    end
+  end
+end

data/lib/translatable_fields/version.rb

@@ -0,0 +1,3 @@
+module TranslatableFields
+  VERSION = "0.1.0".freeze
+end

data/translatable_fields.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "translatable_fields/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "translatable_fields"
+  spec.version       = TranslatableFields::VERSION
+  spec.authors       = ["Yevhenii Halenko", "Oleksii Tokarchuk", "Ruslan Tolstov"]
+  spec.email         = ["ruslan.tolstov.ua@gmail.com"]
+
+  spec.summary       = "Translate your fields in ActiveRecord. Rails library allow you to translate your models' attribute values with prefixes like `en_title` or `title_en`"
+  spec.description   = "Translate your fields in ActiveRecord."
+  spec.homepage      = "https://github.com/ruslantolstov/translatable_fields"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.0.0"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: translatable_fields
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yevhenii Halenko
+- Oleksii Tokarchuk
+- Ruslan Tolstov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: Translate your fields in ActiveRecord.
+email:
+- ruslan.tolstov.ua@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/translatable_fields/install/install_generator.rb
+- lib/generators/translatable_fields/install/templates/translatable_fields.rb
+- lib/translatable_fields.rb
+- lib/translatable_fields/concern.rb
+- lib/translatable_fields/configuration.rb
+- lib/translatable_fields/version.rb
+- translatable_fields.gemspec
+homepage: https://github.com/ruslantolstov/translatable_fields
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Translate your fields in ActiveRecord. Rails library allow you to translate
+  your models' attribute values with prefixes like `en_title` or `title_en`
+test_files: []