buddy_translatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c27f8d71a4a6a67dcd1883d54e96031cac1675ac1ae880f4a47eece86f59e076
+  data.tar.gz: 1b88ce42d87729ecf590f851bbc4ede2c0dec4a883fc0e6b09cd24a82ae4cff0
+SHA512:
+  metadata.gz: d9353bd3551054a978b2b9a56ca63f55252f655112995b2f919269f385420e02abf16d66ed397efabcb1f1d10eec3e88f0b037a7d544718cfebb944b46527b92
+  data.tar.gz: 5d9e36cff5af21f0fc1bb926247b0e7831d535dc0e5536e0dbff3cd670617f6146f46d9b6fe931280416f978b30f3b76c88e4e429e0320ece39cafe54dcc20fa

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at owenperedo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 buddy_translatable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    buddy_translatable (0.1.0)
+      activerecord (>= 5.0)
+      activesupport (>= 5.0)
+      i18n
+      pg
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    pg (1.1.4)
+    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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      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.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  buddy_translatable!
+  bundler
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Owen
+
+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,167 @@
+# JSON Buddy Translatable
+
+Allows you to store text data in multiple languages or Sales channels. Based on [translateable](https://github.com/olegantonyan/translateable), but with a few differences:
+
+1. Support for key methods
+2. Support for Sales channels
+
+### Translations
+```ruby
+class Post < ActiveRecord::Base
+  include BuddyTranslatable
+  translatable :title, default_key: :de
+end
+
+post = Post.create(title: { de: 'Hallo', en: 'Hello' })
+
+# getter using current locale
+I18n.locale = :en
+post.title #=> Hello
+I18n.locale = :de
+post.title #=> Hallo
+
+# Getter using methods
+post.title_en #=> Hello
+post.title_de #=> Hallo
+post.title_data_for(:en) #=> Hello
+post.title_data # => return all data (Hash)
+
+# Update current locale and maintain others
+I18n.locale = :en
+post.update(title: 'Hello changed')
+post.title_en # => Hello changed
+post.title_de # => Hallo
+post.title_es # => Hallo (return default key if not found)
+
+# Replace all data
+post.update(title: { en: 'En val', de: 'De val' })
+post.title_en # => En val
+```
+
+### Sales Channels
+```ruby
+class Post < ActiveRecord::Base
+  include BuddyTranslatable
+  sales_datable :key, default_key: :vev
+end
+post = Post.create(key: { vev: 'vev', ebay: 'ebay' })
+
+# getter
+post.key #=> vev # return default key
+BuddyTranslatable.config.current_sales_key = :ebay
+post.key #=> ebay
+
+# you can reset current sales channel by
+BuddyTranslatable.config.reset_current_sales_key
+
+# Getter using methods
+post.key_vev #=> vev
+post.key_ebay #=> ebay
+post.key_data_for(:vev) #=> vev
+post.key_data # => return all data (Hash)
+
+# Update current sales key (if empty will use default_key) and maintain others
+BuddyTranslatable.config.current_sales_key = :ebay 
+post.update(key: 'Ebay changed')
+post.key_ebay # => Ebay changed
+post.key_vev # => vev
+
+# Replace all data
+post.update(key: { vev: 'vev val', ebay: 'ebay val' })
+post.key_vev # => vev val
+```
+
+## Requirements
+
+- PostgreSQL >= 9.4
+- ActiveRecord >= 4.2
+- I18n
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'buddy_translatable'
+```
+
+Create initializer:
+```ruby
+# config/initializers/translatable.rb
+BuddyTranslatable.config.available_sales_keys = %i[de ebay]
+I18n.available_locales = %i[de en es]
+```
+
+And then execute:
+``` bundle install ```
+
+## Usage
+
+```ruby
+class TestModel < ActiveRecord::Base
+  include BuddyTranslatable
+
+  translatable :title, default_key: :de
+  sales_datable :key, default_key: :vev #, available_keys: [:ebay, :amazon, :vev]
+end
+```
+
+### Migration
+
+Attributes must be `JSONB` type.
+```ruby
+class AddTitleToPosts < ActiveRecord::Migration
+  def change
+    add_column :posts, :title, :jsonb, null: false, default: {}
+    add_column :posts, :key, :jsonb, null: false, default: {}
+  end
+end
+```
+
+### Queries
+
+For searching you can use the following concern:
+```ruby
+module JsonbQuerable
+  extend ActiveSupport::Concern
+
+  included do
+    scope :where_jsonb_value, lambda { |attr, value|
+      attr_query = sanitize_sql("#{table_name}.#{attr}")
+      where("EXISTS (SELECT 1 FROM jsonb_each_text(#{attr_query}) j
+                              WHERE j.value = ?)", value)
+    }
+
+    scope :where_jsonb_value_like, lambda { |attr, value, case_sens = false|
+      attr_query = sanitize_sql("#{table_name}.#{attr}")
+      condition = case_sens ? 'j.value LIKE ?' : 'lower(j.value) LIKE lower(?)'
+      where("EXISTS (SELECT 1
+                     FROM jsonb_each_text(#{attr_query}) j
+                     WHERE #{condition})", "%#{value}%")
+    }
+  end
+end
+
+class Post < ActiveRecord::Base
+  #...
+  include JsonbQuerable
+  #...
+end
+
+Post.where_jsonb_value_like(:key, 'ebay')
+```
+Simple queries:
+```ruby
+Post.where("title->>'en' = ?", 'hello')
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/owen2345/buddy_translatable.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://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 "buddy_translatable"
+
+# 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/buddy_translatable.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'buddy_translatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'buddy_translatable'
+  spec.version       = BuddyTranslatable::VERSION
+  spec.authors       = ['Owen']
+  spec.email         = ['owenperedo@gmail.com']
+
+  spec.summary       = 'Manages translations and sales data fields'
+  spec.description   = 'Manages translations and sales data fields'
+  spec.homepage      = 'https://github.com/owen2345/buddy_translatable'
+  spec.license       = 'MIT'
+
+  # 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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_dependency 'activerecord', '>= 5.0'
+  spec.add_dependency 'activesupport', '>= 5.0'
+  spec.add_dependency 'i18n'
+  spec.add_dependency 'pg'
+end

data/lib/buddy_translatable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'buddy_translatable/version'
+require 'buddy_translatable/configuration'
+require 'buddy_translatable/core'
+module BuddyTranslatable
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.included(base)
+    base.extend BuddyTranslatable::Core
+  end
+end

data/lib/buddy_translatable/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module BuddyTranslatable
+  class Configuration
+    attr_accessor :available_sales_keys, :current_sales_key
+
+    def initialize
+      @available_sales_keys = %i[vev ebay]
+    end
+
+    def reset_current_sales_key
+      @current_sales_key = nil
+    end
+  end
+end

data/lib/buddy_translatable/core.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module BuddyTranslatable
+  module Core
+    def translatable(*attrs, default_key: :de, available_keys: [])
+      available_keys = I18n.available_locales unless available_keys.present?
+      attrs.each do |attr|
+        translatable_sanity_check(attr)
+        define_translatable_methods(attr, default_key)
+        define_translatable_key_methods(attr, available_keys)
+      end
+    end
+
+    def sales_datable(*attrs, default_key: :vev, available_keys: [])
+      unless available_keys.present?
+        available_keys = BuddyTranslatable.config.available_sales_keys
+      end
+      attrs.each do |attr|
+        translatable_sanity_check(attr)
+        define_translatable_methods(attr, default_key, is_locale: false)
+        define_translatable_key_methods(attr, available_keys)
+      end
+    end
+
+    def translatable_sanity_check(attr)
+      msg = "no such column '#{attr}' in '#{name}' model"
+      raise ArgumentError, msg unless column_names.include?(attr.to_s)
+    end
+
+    def define_translatable_methods(attr, default_key, is_locale: true)
+      current_key = lambda do
+        res = I18n.locale
+        current_sales_key = BuddyTranslatable.config.current_sales_key
+        res = current_sales_key || default_key unless is_locale
+        res.to_sym
+      end
+      define_translatable_setters(attr, current_key)
+      define_translatable_key_getters(attr, default_key)
+      define_translatable_getters(attr, current_key)
+    end
+
+    def define_translatable_setters(attr, current_key)
+      define_method("#{attr}_data=") do |arg|
+        data = send("#{attr}_data")
+        self[attr] = arg.is_a?(Hash) ? arg : data.merge(current_key.call => arg)
+      end
+
+      define_method("#{attr}=") do |arg|
+        send("#{attr}_data=", arg)
+      end
+    end
+
+    def define_translatable_key_getters(attr, default_key)
+      define_method("#{attr}_data_for") do |key|
+        value = send("#{attr}_data")
+        value[key] ||
+          value[default_key].presence ||
+          value.values.find(&:present?)
+      end
+    end
+
+    def define_translatable_getters(attr, current_key)
+      define_method("#{attr}_data") do
+        res = self[attr]
+        res = new_record? ? { current_key.call => '' } : {} unless res.present?
+        res.symbolize_keys.with_indifferent_access
+      end
+
+      define_method(attr) do |**_args|
+        send("#{attr}_data_for", current_key.call)
+      end
+    end
+
+    def define_translatable_key_methods(attr, keys)
+      keys.each do |key|
+        define_method("#{attr}_#{key}") do
+          send("#{attr}_data_for", key)
+        end
+      end
+    end
+  end
+end

data/lib/buddy_translatable/version.rb

@@ -0,0 +1,3 @@
+module BuddyTranslatable
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: buddy_translatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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: pg
+  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: Manages translations and sales data fields
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- buddy_translatable.gemspec
+- lib/buddy_translatable.rb
+- lib/buddy_translatable/configuration.rb
+- lib/buddy_translatable/core.rb
+- lib/buddy_translatable/version.rb
+homepage: https://github.com/owen2345/buddy_translatable
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Manages translations and sales data fields
+test_files: []