pg_translatable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 195ffcc2dac4d8869cebed29bf078e351251813a
+  data.tar.gz: 6b3445128fb029069c4aa3067e6249f87be7b4e2
+SHA512:
+  metadata.gz: 20425efa82a9a5f0402db52a64e3bbfd7a9b62cf6255de8fd64ef99ddcd88ca1d6dd5e560cbc066a7fbe66183cc8a7d3760dbfbb381413cfc0c0867a7481716e
+  data.tar.gz: 19c3363943b76ede4cd2933b7b5fb3016fa0a9dd8f2b56919372f8f76222b39918d5d508408dbbf2049e3988d3f2d30bbcd50f239fd209a78a660c85f43266c9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/test_app/log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.2.0
+gemfile:
+  - gemfile
+install:
+  - 'travis_retry bundle install'
+addons:
+  postgresql: '9.4'
+  code_climate:
+    repo_token: 'f63c4f1a42eacd5c44d1393fea83ff8d669d1ef15e192584a8aada456883698b'
+script:
+  - 'bundle exec rake spec'
+before_script:
+  - psql -c 'create database pg_translatable_test;' -U postgres

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec-rails',         '~> 3.2'
+  gem 'factory_girl_rails',  '~> 4.5'
+  gem 'rocket_pants',        '~> 1.10'
+  gem 'pry',                 '~> 0.10'
+  gem 'pry-rails',           '~> 0.3'
+  gem 'better_errors',       '~> 2.1'
+  gem 'binding_of_caller',   '~> 0.7'
+  gem 'sqlite3',             '~> 1.3'
+  gem 'appraisal',           '~> 1.0'
+  gem 'simplecov',           '~> 0.9', require: false
+  gem 'codeclimate-test-reporter',     require: nil
+end

data/README.md

@@ -0,0 +1,34 @@
+[![Build Status](https://travis-ci.org/Stankec/pg_translatable.svg?branch=master)](https://travis-ci.org/Stankec/pg_translatable)
+[![Code Climate](https://codeclimate.com/github/Stankec/pg_translatable/badges/gpa.svg)](https://codeclimate.com/github/Stankec/pg_translatable)
+[![Test Coverage](https://codeclimate.com/github/Stankec/pg_translatable/badges/coverage.svg)](https://codeclimate.com/github/Stankec/pg_translatable/coverage)
+
+# About
+
+Store translations in your PG database as HSTORE, JSON or JSONB.
+
+# Instalation
+
+To use this gem in your rails app simply add the following to your `Gemfile`:
+
+```Ruby
+gem 'pg_translatable'
+```
+
+# Development
+
+After checking out the repo, make sure you have a Postgres database server
+ running on your machine then move to the `spec/test_app` directory and run the
+ following commands:
+
+```Bash
+rake db:create
+rake db:migrate
+```
+
+# Contributing
+
+1. [Fork it]( https://github.com/Stankec/pg_translatable/fork )
+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

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'rubygems'
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rspec'
+rescue LoadError
+  puts 'You must `gem install rspec` to run tests'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/test_app/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pg_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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pg_translatable/translatable/methods/class_methods.rb

@@ -0,0 +1,22 @@
+module PgTranslatable
+  module Translatable
+    class Methods
+      class ClassMethods < PgTranslatable::Translatable::Methods
+        def define_methods
+          define_strong_params_fields
+        end
+
+        private
+
+        def define_strong_params_fields
+          languages_list = @languages.map { |locale| ":#{@column}_#{locale}" }
+          @object.class_eval <<-RUBY
+            define_singleton_method("#{@column}_fields") do
+              [#{languages_list.join(', ')}]
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/pg_translatable/translatable/methods/instance_methods.rb

@@ -0,0 +1,80 @@
+module PgTranslatable
+  module Translatable
+    class Methods
+      class InstanceMethods < PgTranslatable::Translatable::Methods
+        def define_methods
+          define_formatter
+          define_getter
+          define_hash_getter_and_setter
+          define_locale_setters_and_getters
+        end
+
+        private
+
+        def define_formatter
+          @object.class_eval <<-RUBY
+            define_method("#{@column_name}_formatter") do |value|
+              value
+            end
+          RUBY
+        end
+
+        def define_getter
+          @object.class_eval <<-RUBY
+            define_method("#{@column_name}") do
+              send("#{@column_name}_#{I18n.locale}")
+            end
+          RUBY
+        end
+
+        def define_hash_getter_and_setter
+          define_hash_getter
+          define_hash_setter
+        end
+
+        def define_hash_getter
+          @object.class_eval <<-RUBY
+            define_method("#{@column_name_plural}") do
+              self["#{@column}"] || {}
+            end
+          RUBY
+        end
+
+        def define_hash_setter
+          @object.class_eval <<-RUBY
+            define_method("#{@column_name_plural}=") do |value|
+              self[:#{@column}] = value
+            end
+          RUBY
+        end
+
+        def define_locale_setters_and_getters
+          define_locale_getter
+          define_locale_setter
+        end
+
+        def define_locale_getter
+          @languages.each do |locale|
+            @object.class_eval <<-RUBY
+              define_method("#{@column_name}_#{locale}") do
+                send("#{@column_name}_formatter",
+                  send("#{@column_name_plural}")["#{locale}"]
+                )
+              end
+            RUBY
+          end
+        end
+
+        def define_locale_setter
+          @languages.each do |locale|
+            @object.class_eval <<-RUBY
+              define_method("#{@column_name}_#{locale}=") do |value|
+                send("#{@column_name_plural}")["#{locale}"] = value
+              end
+            RUBY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pg_translatable/translatable/methods.rb

@@ -0,0 +1,56 @@
+require 'pg_translatable/translatable/methods/class_methods'
+require 'pg_translatable/translatable/methods/instance_methods'
+
+module PgTranslatable
+  module Translatable
+    class Methods
+      def initialize(object, column)
+        @object = object
+        @column = column
+        @languages = I18n.available_locales
+
+        raise_wrong_column_object_type
+
+        @column_name = @column.to_s.singularize
+        @column_name_plural = @column.to_s.pluralize
+
+        ensure_different_plural
+
+        @type = @object.columns_hash[@column.to_s].type
+
+        raise_wrong_column_type
+      end
+
+      private
+
+      def ensure_different_plural
+        return unless @column_name_plural == @column_name
+        @column_name_plural = "#{@column_name_plural}_translations"
+      end
+
+      def raise_wrong_column_type
+        accepted_types = [:hstore, :json, :jsonb]
+
+        return if accepted_types.include?(@type)
+
+        fail(
+          ArgumentError,
+          "Expected column '#{@column}' to be of type "\
+          "#{accepted_types.map { |type| type.to_s.upcase }.join(', ')} "\
+          "but was of type #{@type}"
+        )
+      end
+
+      def raise_wrong_column_object_type
+        return if @column.is_a?(String)
+        return if @column.is_a?(Symbol)
+
+        fail(
+          ArgumentError,
+          'Pass the column name as a String or Symbol. '\
+          "You passed a #{@column.class.name}!"
+        )
+      end
+    end
+  end
+end

data/lib/pg_translatable/translatable.rb

@@ -0,0 +1,12 @@
+require 'pg_translatable/translatable/methods'
+
+module PgTranslatable
+  module Translatable
+    def translate(*attrs)
+      attrs.each do |column|
+        Methods::ClassMethods.new(self, column).define_methods
+        Methods::InstanceMethods.new(self, column).define_methods
+      end
+    end
+  end
+end

data/lib/pg_translatable/version.rb

@@ -0,0 +1,10 @@
+module PgTranslatable
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/pg_translatable.rb

@@ -0,0 +1,12 @@
+require 'pg_translatable/version'
+require 'pg_translatable/translatable'
+require 'pry'
+
+module PgTranslatable
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend(PgTranslatable::Translatable)
+end
+
+# binding.pry

data/pg_translatable.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_translatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pg_translatable'
+  spec.version = PgTranslatable::Version::STRING
+  spec.authors = ['Stanko Krtalić Rusendić']
+  spec.email = ['stanko.krtalic@gmail.com']
+
+  spec.summary = 'Store translations in PG\'s non-sql store types'
+
+  spec.description = 'Store translations in your PG database as HSTORE, JSON '\
+                     'or JSONB.'
+
+  spec.homepage = 'https://github.com/Stankec/pg_translatable'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'rails'
+  spec.add_dependency 'pg'
+
+  spec.add_development_dependency 'rspec-rails',         '~> 3.2'
+  spec.add_development_dependency 'factory_girl_rails',  '~> 4.5'
+  spec.add_development_dependency 'pry',                 '~> 0.10'
+  spec.add_development_dependency 'pry-rails',           '~> 0.3'
+  spec.add_development_dependency 'better_errors',       '~> 2.1'
+  spec.add_development_dependency 'binding_of_caller',   '~> 0.7'
+  spec.add_development_dependency 'rake',                '~> 10.0'
+  spec.add_development_dependency 'bundler'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: pg_translatable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stanko Krtalić Rusendić
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: better_errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !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: 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'
+description: Store translations in your PG database as HSTORE, JSON or JSONB.
+email:
+- stanko.krtalic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg_translatable.rb
+- lib/pg_translatable/translatable.rb
+- lib/pg_translatable/translatable/methods.rb
+- lib/pg_translatable/translatable/methods/class_methods.rb
+- lib/pg_translatable/translatable/methods/instance_methods.rb
+- lib/pg_translatable/version.rb
+- pg_translatable.gemspec
+homepage: https://github.com/Stankec/pg_translatable
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Store translations in PG's non-sql store types
+test_files: []
+has_rdoc: