buddy_translatable 0.2.0 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7400068f6a44cecc838b666b11a3d04e2379bd0e10f3ef64e92b62bb70438d8d
-  data.tar.gz: e41ee4fbe96d09530663597c37114f9dac7375e45008eeb4bafa3325b3790520
+  metadata.gz: 6b07b1d70b041c19890ca5130304dad96be154355506847b0819129bc44b6b9f
+  data.tar.gz: 9c47ee39424f448f4ec8ed4dad0d865af3df9e0bc4247d51af507d240e0af0d6
 SHA512:
-  metadata.gz: 9efbcbc8f420ebd9011528e0d086d2836f8be5dfb6b0946c2911ba4c6089c6237ddb0e6b2f22542bdfecc95398df7a94483847a68430d9d6cd55e5a17adf3f7d
-  data.tar.gz: 41c4c3a915c831689e52088cf6b44c3fa1e0274283b33bfe55bc4e61bf6324f8a9d06e88410c3b647340807a5f1c51e3814a8e7131e0fe35c70d3309b1f956eb
+  metadata.gz: e342c4fbecd70240b2f388a30048c6c1653aa325c37c0b431ac158add0987094e8427db1d653ce81703b284313193bd160750b1dd7b74eec5a4541e9701d96c9
+  data.tar.gz: e46117f2d65e8ece226134caa1f6d29c9a8f6a6c8e1a7ae165ab07395665f128b94607a61cd7b4923aba5e50f789d7c08c4b15c98f0ddd51e88c5bf92cac3c16

data/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+on:
+  push:
+    tags: # triggered once a git tag is published
+      - '*'
+
+name: Create Release
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      # Changelog action adaptations
+      - name: Create required package.json
+        run: test -f package.json || echo '{}' >package.json
+      - name: Detect Previous Tag (action not detecting very well)
+        run: echo "::set-output name=previous_tag::$(git describe --abbrev=0 --tags `git rev-list --tags --skip=1 --max-count=1`)"
+        id: tag_checker
+
+      - name: Generate Changelog
+        uses: scottbrenner/generate-changelog-action@master
+        id: Changelog
+        with:
+          from-tag: ${{steps.tag_checker.outputs.previous_tag}}
+          to-tag: HEAD
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: |
+            ${{ steps.Changelog.outputs.changelog }}
+          draft: false
+          prerelease: false

data/.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: App tests
+
+on:
+  push:
+    branches:
+      - master
+      - staging
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Cancel previous Workflow Actions
+        uses: styfle/cancel-workflow-action@0.6.0
+        with:
+          access_token: ${{ github.token }}
+      - name: download docker-compose cache
+        run: docker-compose pull
+      - uses: satackey/action-docker-layer-caching@v0.0.11 # Cache or restore docker cache
+        continue-on-error: true # Ignore the failure of a step and avoid terminating the job.
+        with:
+          key: app_docker
+
+      - name: Run rspec test
+        run: docker-compose run test /bin/sh -c "rspec"
+      - name: Check codestyle
+        run: docker-compose run test /bin/sh -c "rubocop"

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/**/*'
+    - 'spec/spec_helper.rb'
+    - 'Gemfile'
+    - 'buddy_translatable.gemspec'
+
+Style/BlockComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.5.5
 before_install: gem install bundler -v 1.16.2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.0 (17-06-2021)
+- feat: Support for text format attributes (non jsonb attributes)
+- chore: Add container settings
+- refactor: Change default data format from stringified keys into symbolized keys
+- feat: support for locale specific setter
+
 # 0.2.0 (14-08-2020)
 - Removed sales_datable
 

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.5
+RUN apt-get update -qq
+RUN gem install bundler
+WORKDIR /app
+COPY . /app
+RUN bundle install
+

data/Gemfile

@@ -4,3 +4,6 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in buddy_translatable.gemspec
 gemspec
+
+gem 'pg'
+gem 'rubocop'

data/Gemfile.lock

@@ -2,32 +2,38 @@ PATH
   remote: .
   specs:
     buddy_translatable (0.2.0)
-      activerecord (>= 5.0)
-      activesupport (>= 5.0)
+      activerecord
+      activesupport
       i18n
-      pg
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       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.7)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
     pg (1.2.3)
+    rainbow (3.0.0)
     rake (10.5.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -41,10 +47,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    rubocop (1.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -52,8 +70,10 @@ PLATFORMS
 DEPENDENCIES
   buddy_translatable!
   bundler
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  pg
+  rake
+  rspec
+  rubocop
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -5,6 +5,7 @@ Allows you to store text data in multiple languages. Based on [translateable](ht
 1. Support for key methods
 2. No extra table dependency
 3. Single attribute
+4. Support for `jsonb` and `text` format attributes
 
 ### Translations
 ```ruby
@@ -34,6 +35,8 @@ post.update(title: 'Hello changed')
 post.title_en # => Hello changed
 post.title_de # => Hallo
 post.title_es # => Hallo (return default key if not found)
+post.title_es = 'Hola' # => Set value for a specific locale
+post.title_es # => Hola (return defined value)
 
 # Replace all data
 post.update(title: { en: 'En val', de: 'De val' })
@@ -42,8 +45,6 @@ post.title_es # => De val # default_key value is used when not defined
 ```
 
 ## Requirements
-
-- PostgreSQL >= 9.4
 - ActiveRecord >= 4.2
 - I18n
 
@@ -52,7 +53,7 @@ post.title_es # => De val # default_key value is used when not defined
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'buddy_translatable'
+gem 'buddy_translatable', '>= 1.0'
 ```
 
 Configure your available locales in your rails app, like:
@@ -79,13 +80,16 @@ class AddTitleToPosts < ActiveRecord::Migration
   def change
     add_column :posts, :title, :jsonb, null: false, default: {}
     add_column :posts, :key, :jsonb, null: false, default: {}
+    
+    # for databases that does not support jsonb format
+    # add_column :posts, :title, :text, null: false, default: '{}'
   end
 end
 ```
 
 ### Queries
 
-For searching you can use the following concern:
+For searching you can use the following concern (Only `jsonb` format attributes):
 ```ruby
 module JsonbQuerable
   extend ActiveSupport::Concern
@@ -121,8 +125,11 @@ Post.where("title->>'en' = ?", 'hello')
 ```
 
 ## Development
+Run tests with:    
+`docker-compose run test bash -c "rspec"`    
+Check code style:    
+`docker-compose run test bash -c "rubocop"`    
 
-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.
 
 ## Contributing
 
@@ -130,3 +137,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/owen23
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/buddy_translatable.gemspec

@@ -29,11 +29,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 
-  spec.add_dependency 'activerecord', '>= 5.0'
-  spec.add_dependency 'activesupport', '>= 5.0'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'i18n'
-  spec.add_dependency 'pg'
 end

data/docker-compose.yaml

@@ -0,0 +1,25 @@
+version: '2'
+
+services:
+  postgres:
+    image: postgres:10.6-alpine
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    ports:
+      - ${PGPORT:-5432}:5432
+    environment:
+      POSTGRES_USER: ${POSTGRES_USER:-root}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-password}
+
+  test:
+    build: .
+    command: sh -c 'bundle exec rspec'
+    volumes:
+      - .:/app
+      - bundler_gems:/usr/local/bundle/
+    depends_on:
+      - postgres
+
+volumes:
+  bundler_gems:
+  postgres_data:

data/lib/buddy_translatable/core.rb

@@ -2,24 +2,30 @@
 
 module BuddyTranslatable
   module Core
-    def translatable(*attrs, default_key: :en, available_keys: nil)
-      available_keys ||= I18n.available_locales
+    def translatable(*attrs, default_key: :en, available_locales: nil)
+      available_locales ||= I18n.available_locales
       attrs.each do |attr|
-        define_translatable_methods(attr, default_key)
-        define_translatable_key_methods(attr, available_keys)
+        define_translatable_methods(attr, default_key.to_sym)
+        define_translatable_key_methods(attr, available_locales.map(&:to_sym))
       end
     end
 
-    def define_translatable_methods(attr, default_key)
-      define_translatable_setters(attr)
-      define_translatable_key_getters(attr, default_key)
+    def define_translatable_methods(attr, fallback_locale)
+      format = respond_to?(:column_types) ? column_types[attr.to_s].type : attribute_types[attr.to_s].type
+      define_translatable_setters(attr, format)
+      define_translatable_key_getters(attr, fallback_locale)
       define_translatable_getters(attr)
     end
 
-    def define_translatable_setters(attr)
+    # Sample:
+    #   model.title_data = { de: 'de val', en: 'en val' } # ==> replace value data
+    #   model.title = { de: 'de val', en: 'en val' } # replace value data
+    #   model.title = 'custom value' # sets new value for current locale
+    def define_translatable_setters(attr, format)
       define_method("#{attr}_data=") do |arg|
         data = send("#{attr}_data")
-        self[attr] = arg.is_a?(Hash) ? arg : data.merge(I18n.locale => arg)
+        data = arg.is_a?(Hash) ? arg.symbolize_keys : data.merge(I18n.locale => arg)
+        self[attr] = %i[string text].include?(format) ? data.to_json : data
       end
 
       define_method("#{attr}=") do |arg|
@@ -27,11 +33,14 @@ module BuddyTranslatable
       end
     end
 
-    def define_translatable_key_getters(attr, default_key)
+    # Sample:
+    #   model.title_for(:de) # ==> print value for provided locale
+    #   model.title_data_for(:de) # print value for provided locale
+    def define_translatable_key_getters(attr, fallback_locale)
       define_method("#{attr}_data_for") do |key|
         value = send("#{attr}_data")
         value[key] ||
-          value[default_key].presence ||
+          value[fallback_locale].presence ||
           value.values.find(&:present?)
       end
 
@@ -40,11 +49,15 @@ module BuddyTranslatable
       end
     end
 
+    # Sample:
+    #   model.title_data # ==> print values data
+    #   model.title # print value for current locale
     def define_translatable_getters(attr)
       define_method("#{attr}_data") do
-        res = self[attr]
+        res = self[attr] || {}
         res = new_record? ? { I18n.locale => '' } : {} unless res.present?
-        res.symbolize_keys.with_indifferent_access
+        res = JSON.parse(res) if res.is_a?(String)
+        res.symbolize_keys
       end
 
       define_method(attr) do |**_args|
@@ -52,12 +65,20 @@ module BuddyTranslatable
       end
     end
 
-    def define_translatable_key_methods(attr, keys)
-      keys.each do |key|
-        define_method("#{attr}_#{key}") do
-          send("#{attr}_data_for", key)
+    # Sample:
+    #   model.title_de # ==> "de title"
+    #   model.title_de = "new title" # assign value for specific locale
+    def define_translatable_key_methods(attr, locales)
+      locales.each do |locale|
+        define_method("#{attr}_#{locale}") do
+          send("#{attr}_data_for", locale)
+        end
+
+        define_method("#{attr}_#{locale}=") do |value|
+          data = send("#{attr}_data").merge(locale => value)
+          send("#{attr}_data=", data)
         end
       end
     end
   end
-end
+end

data/lib/buddy_translatable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BuddyTranslatable
-  VERSION = '0.2.0'.freeze
+  VERSION = '1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buddy_translatable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: '1.0'
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2021-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,60 +28,46 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !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:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,11 +101,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -128,6 +118,7 @@ files:
 - bin/console
 - bin/setup
 - buddy_translatable.gemspec
+- docker-compose.yaml
 - lib/buddy_translatable.rb
 - lib/buddy_translatable/core.rb
 - lib/buddy_translatable/version.rb
@@ -150,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Manages attribute translations translations