utranslate 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21d1d8968c67f1287d0b77a3830d54d7756cbec2491d43b9e31aa5c5c6ae02fa
+  data.tar.gz: 6466bd35ff8908cb00a02658bfa6178dfc8410961565f478777598d6f0e91f8a
+SHA512:
+  metadata.gz: ede1c320a0a3bfeb0708c1785f98d6401c979c4bbb9c160b3c058f61df8b6b3d574ec4a703a7e6be52e45cd36f1afaafdad0e2e924606c68a597bb3be7ea3240
+  data.tar.gz: de7b2fe6406de26f562857c57060ac0b4123758b0f4dbfe0771801e1a662b032b395726157a7fc804d29a0b0d7566a4adbe6ce6fa4fb03e3e013bf393c914c80

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 jcollazos
+
+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,95 @@
+# Utranslate
+A very easy to use and configure gem to add I18n support to Activerecord models using postgresql JSONB columns.
+
+# Usage
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utranslate'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install utranslate
+```
+
+## Configuration
+
+Include utranslate in all the models that you want to translate:
+
+```ruby
+class Post
+  include Utranslate
+end
+```
+
+Add translations for every attribute that you want to translate.
+
+```ruby
+translate :title
+```
+
+You can specify to check for presence of all I18n.available_locales
+
+```ruby
+translate :title, null: false
+```
+
+Or you can define what locales you want to check
+
+```ruby
+translate :title, null: false, locales: [:es, :en]
+```
+
+## Adding a translation for current locale
+
+To add a translation for current locale you just have to assign as usual
+
+```ruby
+post.title = 'translation'
+```
+
+## Adding a translation for a given locale
+
+To add a translation for a given locale you must pass the locale and the translation
+
+```ruby
+post.title(:es, 'traducción')
+```
+
+## Mass assigning translations
+
+To mass assign translations you can do it as usual
+
+```ruby
+post = Post.new(title: { es: 'traducción', en: 'translation'})
+```
+
+## Retriving a translation for current locale
+
+To retrive a translation for current locale you can do it as usual
+
+```ruby
+post.title
+```
+
+## Retriving a translation for given locale
+
+To retrive a translation for current locale you can do it as usual
+
+```ruby
+post.title(:es)
+```
+
+## Contributing
+Feel free to contribute to this project or to contact me through klatooine@gmail.com
+
+## 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,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Utranslate'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/tasks/utranslate_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :utranslate do
+#   # Task goes here
+# end

data/lib/utranslate/errors/column_not_present_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Utranslate
+  class ColumnNotPresentError < StandardError
+  end
+end

data/lib/utranslate/errors/invalid_format_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Utranslate
+  class InvalidFormatError < StandardError
+  end
+end

data/lib/utranslate/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Utranslate
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/utranslate/validators/all_translations_validator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Utranslate
+  class AllTranslationsValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, _)
+      locales = options.fetch(:locales)
+
+      return unless missing_translations?(locales)
+
+      record.errors[attribute] << "#{missing_translations} translations not present for #{attribute}"
+    end
+
+    private
+
+    def missing_translations?(locales)
+      locales.each do |locale|
+        missing_translations << locale unless locale_present?
+      end
+
+      !missing_translations.length.zero?
+    end
+
+    def missing_translations
+      @_missing_translations ||= []
+    end
+
+    def locale_present?
+      false
+    end
+  end
+end

data/lib/utranslate/validators/hash_validator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Utranslate
+  class HashValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      return if value.is_a?(Hash)
+
+      record.errors[attribute] << 'Incorrect format for translated column, should be a hash.'
+    end
+  end
+end

data/lib/utranslate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Utranslate
+  VERSION = '0.1.1'
+end

data/lib/utranslate.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'utranslate/railtie'
+require 'utranslate/errors/column_not_present_error'
+require 'utranslate/errors/invalid_format_error'
+require 'utranslate/validators/all_translations_validator'
+require 'utranslate/validators/hash_validator'
+
+module Utranslate
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def translate(attr_name, null: true, locales: I18n.available_locales)
+      raise Utranslate::ColumnNotPresentError, "ERROR: #{attr_name} not present in #{name}." unless column_names.include?(attr_name.to_s)
+      raise Utranslate::InvalidFormatError, "ERROR: #{attr_name} not a valid JSONB column." unless type_for_attribute(attr_name).type == :jsonb
+
+      validates :"#{attr_name}",
+                "Utranslate::Hash": true
+      validates :"#{attr_name}",
+                "Utranslate::AllTranslations": { locales: locales },
+                unless: -> { null }
+
+      define_method "utranslate_#{attr_name}" do |locale, value|
+        self[:"#{attr_name}"][locale.to_s] = value
+      end
+
+      define_method attr_name.to_s do |locale = I18n.locale, value = nil|
+        if value.present?
+          send(:"utranslate_#{attr_name}", locale, value)
+        else
+          self[:"#{attr_name}"][locale.to_s]
+        end
+      end
+
+      define_method "#{attr_name}=" do |value|
+        if value.is_a?(Hash)
+          self[:"#{attr_name}"] = value
+        else
+          send(:"utranslate_#{attr_name}", I18n.locale, value)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: utranslate
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- jcollazos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  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: pg
+  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: 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'
+description: A simple model translation gem using postgresql JSONB columns
+email:
+- julianjaviercollazos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/utranslate_tasks.rake
+- lib/utranslate.rb
+- lib/utranslate/errors/column_not_present_error.rb
+- lib/utranslate/errors/invalid_format_error.rb
+- lib/utranslate/railtie.rb
+- lib/utranslate/validators/all_translations_validator.rb
+- lib/utranslate/validators/hash_validator.rb
+- lib/utranslate/version.rb
+homepage: https://github.com/klatooine/utranslate
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A simple model translation gem.
+test_files: []