acts_as_multilingual 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da09ca7f531d12c0464a238d1fb3564a789c2273
+  data.tar.gz: 827435cb797c5619de6547906d8fb9f833b07089
+SHA512:
+  metadata.gz: 9e5657dcf968ca26b02200fd1642460a4e801759f002777d2bc3d76e5c8e3a57e1fc7c15ecbdbd0e25ac94c0f5c91d087e6f302c15a27e6ac6bbc188a51c5d36
+  data.tar.gz: 388383e5cf6e79d04345e036bd05289853693e18f002eebfa658aa30496d4ca798c83b732f8142cf5b341a020654a6ed528dbba0ace3288e2f375b7ccb9c03ae

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+pkg/
+vendor/bundle/
+
+.ruby-version
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# Acts As Multilingual
+
+Don't forget to add some meaningful description here.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = false
+  task.options = %w(--force-exclusion)
+  task.patterns = %w({lib,spec}/**/*.rb)
+  task.requires << 'rubocop-rspec'
+end
+
+task default: %w(spec rubocop)

data/acts_as_multilingual.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'acts_as_multilingual/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_multilingual'
+  spec.version       = ActsAsMultilingual::VERSION
+  spec.authors       = ['Alexander Tipugin']
+  spec.email         = ['atipugin@gmail.com']
+  spec.summary       = 'Store multilingual columns in JSON'
+  spec.homepage      = 'https://github.com/atipugin/acts_as_multilingual'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.3'
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_dependency 'activerecord', '>= 3.2'
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'pry'
+
+require 'acts_as_multilingual'
+
+Pry.start

data/lib/acts_as_multilingual.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+require 'acts_as_multilingual/version'
+require 'acts_as_multilingual/extension'
+require 'acts_as_multilingual/builder'
+require 'acts_as_multilingual/exceptions'
+require 'acts_as_multilingual/attribute_proxy'

data/lib/acts_as_multilingual/attribute_proxy.rb

@@ -0,0 +1,19 @@
+module ActsAsMultilingual
+  class AttributeProxy
+    attr_reader :owner, :column
+
+    def initialize(owner, column)
+      @owner = owner
+      @column = column
+    end
+
+    def read(locale)
+      owner[column][locale]
+    end
+
+    def write(locale, value)
+      owner[column][locale] = value
+      owner[column].delete(locale) unless value
+    end
+  end
+end

data/lib/acts_as_multilingual/builder.rb

@@ -0,0 +1,90 @@
+module ActsAsMultilingual
+  class Builder
+    JSON_TYPES = [:json, :jsonb].freeze
+    TEXT_TYPES = [:text, :string].freeze
+
+    attr_reader :klass, :options, :columns
+
+    def initialize(klass, *args)
+      @klass = klass
+      @options = args.extract_options!.merge(default_options)
+      @columns = args.map(&:to_s)
+
+      check_columns!
+      prepare_klass
+      define_accessors
+    end
+
+    private
+
+    def default_options
+      { locales: I18n.available_locales, default_locale: I18n.locale }
+    end
+
+    def check_columns!
+      columns.each do |column|
+        check_column_presence!(column)
+        check_column_type!(column)
+      end
+    end
+
+    def check_column_presence!(column)
+      return if klass.columns_hash.keys.include?(column)
+      fail Exceptions::MissingColumn,
+           "Column `#{column}` is missing in table `#{klass.table_name}`"
+    end
+
+    def check_column_type!(column)
+      if (JSON_TYPES + TEXT_TYPES).include?(klass.columns_hash[column].type)
+        return
+      end
+
+      fail Exceptions::InvalidColumnType,
+           "Column `#{column}` has invalid column type"
+    end
+
+    def prepare_klass
+      columns.each do |column|
+        if TEXT_TYPES.include?(klass.columns_hash[column].type)
+          klass.send(:serialize, column, Hash)
+        end
+      end
+    end
+
+    def define_accessors
+      columns.each do |column|
+        options[:locales].each do |locale|
+          define_reader(column, locale)
+          define_writer(column, locale)
+        end
+
+        alias_default_locale(column)
+      end
+    end
+
+    def define_reader(column, locale)
+      klass.send(:define_method, "#{column}_#{locale}") do
+        (@_acts_as_multilingual_cache ||= {}).fetch(column) do
+          @_acts_as_multilingual_cache[column] =
+            AttributeProxy.new(self, column)
+        end.read(locale)
+      end
+    end
+
+    def define_writer(column, locale)
+      klass.send(:define_method, "#{column}_#{locale}=") do |value|
+        (@_acts_as_multilingual_cache ||= {}).fetch(column) do
+          @_acts_as_multilingual_cache[column] =
+            AttributeProxy.new(self, column)
+        end.write(locale, value)
+      end
+    end
+
+    def alias_default_locale(column)
+      klass.send(:alias_method, column, "#{column}_#{options[:default_locale]}")
+      klass.send(:alias_method,
+                 "#{column}=",
+                 "#{column}_#{options[:default_locale]}=")
+    end
+  end
+end

data/lib/acts_as_multilingual/exceptions.rb

@@ -0,0 +1,2 @@
+require 'acts_as_multilingual/exceptions/base'
+require 'acts_as_multilingual/exceptions/missing_column'

data/lib/acts_as_multilingual/exceptions/base.rb

@@ -0,0 +1,6 @@
+module ActsAsMultilingual
+  module Exceptions
+    class Base < StandardError
+    end
+  end
+end

data/lib/acts_as_multilingual/exceptions/invalid_column_type.rb

@@ -0,0 +1,6 @@
+module ActsAsMultilingual
+  module Exceptions
+    class InvalidColumnType < Base
+    end
+  end
+end

data/lib/acts_as_multilingual/exceptions/missing_column.rb

@@ -0,0 +1,6 @@
+module ActsAsMultilingual
+  module Exceptions
+    class MissingColumn < Base
+    end
+  end
+end

data/lib/acts_as_multilingual/extension.rb

@@ -0,0 +1,15 @@
+module ActsAsMultilingual
+  module Extension
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def acts_as_multilingual(*args)
+        ActsAsMultilingual::Builder.new(self, *args)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActsAsMultilingual::Extension)

data/lib/acts_as_multilingual/version.rb

@@ -0,0 +1,3 @@
+module ActsAsMultilingual
+  VERSION = '0.0.1'
+end

data/spec/lib/acts_as_multilingual/attribute_proxy_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe ActsAsMultilingual::AttributeProxy do
+  let(:owner) { User.new }
+  let(:column) { :first_name }
+
+  subject { described_class.new(owner, column) }
+
+  describe '#read' do
+    # ...
+  end
+
+  describe '#write' do
+    # ...
+  end
+end

data/spec/lib/acts_as_multilingual/builder_spec.rb

@@ -0,0 +1,59 @@
+RSpec.describe ActsAsMultilingual::Builder do
+  let(:klass) { User }
+  let(:columns) { %w(first_name last_name) }
+  let(:object) { subject.klass.new }
+  let(:attr_name) { subject.columns.sample }
+
+  subject { described_class.new(klass, *columns) }
+
+  it 'has options' do
+    expect(subject.options).to be
+  end
+
+  describe '#check_columns!' do
+    context 'when column is missing' do
+      let(:columns) { %w(hola) }
+
+      it 'raises an error' do
+        expect { subject }
+          .to raise_error(ActsAsMultilingual::Exceptions::MissingColumn)
+      end
+    end
+  end
+
+  describe '#define_accessors' do
+    it 'defines getters' do
+      expect(object).to respond_to(attr_name)
+    end
+
+    it 'defines setters' do
+      expect(object).to respond_to("#{attr_name}=")
+    end
+  end
+
+  describe '#define_reader' do
+    it 'instantiates cache' do
+      object.send(attr_name)
+      expect(object.instance_variable_get('@_acts_as_multilingual_cache')).to be
+    end
+
+    it 'reads value properly' do
+      val = 'hey'
+      object.send("#{attr_name}=", val)
+      expect(object.send(attr_name)).to eq(val)
+    end
+  end
+
+  describe '#define_writer' do
+    it 'instantiates cache' do
+      object.send("#{attr_name}=", 'hello')
+      expect(object.instance_variable_get('@_acts_as_multilingual_cache')).to be
+    end
+
+    it 'writes value properly' do
+      val = 'hoi'
+      expect { object.send("#{attr_name}=", val) }
+        .to change { object.send(attr_name) }.to(val)
+    end
+  end
+end

data/spec/lib/acts_as_multilingual/extension_spec.rb

@@ -0,0 +1,10 @@
+RSpec.describe ActsAsMultilingual::Extension do
+  it 'extends AR methods' do
+    expect(ActiveRecord::Base).to respond_to(:acts_as_multilingual)
+  end
+
+  it 'invokes builder' do
+    expect(ActsAsMultilingual::Builder).to receive(:new)
+    ActiveRecord::Base.acts_as_multilingual
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'acts_as_multilingual'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }

data/spec/support/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                        database: ':memory:')
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.text :first_name
+    t.text :last_name
+  end
+end
+
+class User < ActiveRecord::Base
+  acts_as_multilingual :first_name, :last_name
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_multilingual
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Tipugin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- atipugin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- acts_as_multilingual.gemspec
+- bin/console
+- lib/acts_as_multilingual.rb
+- lib/acts_as_multilingual/attribute_proxy.rb
+- lib/acts_as_multilingual/builder.rb
+- lib/acts_as_multilingual/exceptions.rb
+- lib/acts_as_multilingual/exceptions/base.rb
+- lib/acts_as_multilingual/exceptions/invalid_column_type.rb
+- lib/acts_as_multilingual/exceptions/missing_column.rb
+- lib/acts_as_multilingual/extension.rb
+- lib/acts_as_multilingual/version.rb
+- spec/lib/acts_as_multilingual/attribute_proxy_spec.rb
+- spec/lib/acts_as_multilingual/builder_spec.rb
+- spec/lib/acts_as_multilingual/extension_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+homepage: https://github.com/atipugin/acts_as_multilingual
+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.1
+signing_key: 
+specification_version: 4
+summary: Store multilingual columns in JSON
+test_files: []