localizable_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2cfa395a30db8062f472845636f6fbfe118c7d5
+  data.tar.gz: 8d6e6c2b743b69648ef92990260e18de313c6672
+SHA512:
+  metadata.gz: bb2536b98ca7556e2fcbdfe26faadfd13b8912fd9e9499f2a4858fa3be2e8f1a289a57aaa59ca0128ca9982a54099017941b8b50d3371c402ed1fc4ea29badb3
+  data.tar.gz: 35a202be39a802512a60f138acbd56a23f74de8d8118a205fbb8aedbdc9ca7d9a518bf8dd91538d9d957a3f99a281db13afe41f209e77e3ca2459251dbae5a56

data/README.md

@@ -0,0 +1,23 @@
+# LocalizableModel
+
+[![Build Status](https://travis-ci.org/kord-as/localizable_model.svg?branch=master)](https://travis-ci.org/kord-as/localizable_model) [![Code Climate](https://codeclimate.com/github/kord-as/localizable_model/badges/gpa.svg)](https://codeclimate.com/github/kord-as/localizable_model) [![Test Coverage](https://codeclimate.com/github/kord-as/localizable_model/badges/coverage.svg)](https://codeclimate.com/github/kord-as/localizable_model) [![Dependency Status](https://gemnasium.com/kord-as/localizable_model.svg)](https://gemnasium.com/kord-as/localizable_model)
+
+## Usage
+
+Add the `localizable_model` gem to your Gemfile:
+
+``` ruby
+gem "localizable_model"
+```
+
+Generate the migration:
+
+``` shell
+bin/rails g localizable_model:migration
+```
+
+
+## License
+
+LocalizableModel is licensed under the
+[MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+APP_RAKEFILE = "spec/internal/Rakefile".freeze
+load "rails/tasks/engine.rake"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/app/models/localization.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+class Localization < ActiveRecord::Base
+  belongs_to :localizable, polymorphic: true
+
+  class << self
+    def locales
+      order("locale ASC").pluck("DISTINCT locale")
+    end
+
+    def names
+      order("name ASC").pluck("DISTINCT name")
+    end
+  end
+
+  def to_s
+    value || ""
+  end
+
+  delegate :empty?, to: :to_s
+
+  def translate(locale)
+    localizable.localizations.find_by(name: name, locale: locale)
+  end
+end

data/lib/localizable_model.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+load "localizable_model/active_record_extension.rb"
+load "localizable_model/class_methods.rb"
+load "localizable_model/configuration.rb"
+load "localizable_model/engine.rb"
+load "localizable_model/instance_methods.rb"
+load "localizable_model/localizer.rb"
+load "localizable_model/scope_extension.rb"
+load "localizable_model/version.rb"
+
+# = Localizable
+#
+# Localizable allows any model to have localized attributes.
+#
+# == Configuring the model
+#
+#  class Page < ActiveRecord::Base
+#    localizable do
+#      attribute :name
+#      attribute :body
+#    end
+#  end
+#
+# == Usage
+#
+#  page = Page.create(name: 'Hello', locale: 'en')
+#  page.name?     # => true
+#  page.name.to_s # => 'Hello'
+#
+# The localized attributes always return an instance of Localization.
+#
+# To get a localized version of a page, call .localize on it:
+#
+#  page = Page.first.localize('en')
+#
+# .localize also takes a block argument:
+#
+#  page.localize('nb') do |p|
+#    p.locale # => 'nb'
+#  end
+#  page.locale # => 'en'
+#
+# Multiple locales can be updated at the same time:
+#
+#  page.name = {'en' => 'Hello', 'nb' => 'Hallo'}
+#
+module LocalizableModel
+end

data/lib/localizable_model/active_record_extension.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module LocalizableModel
+  # = LocalizableModel::ActiveRecordExtension
+  #
+  # Extends ActiveRecord::Base with the localizable setup method.
+  #
+  module ActiveRecordExtension
+    # Extends the model with Localizable features.
+    # It takes an optional block as argument, which yields an instance of
+    # LocalizableModel::Configuration.
+    #
+    # Example:
+    #
+    #  class Page < ActiveRecord::Base
+    #    localizable do
+    #      attribute :name
+    #      attribute :body
+    #    end
+    #  end
+    #
+    def localizable(&block)
+      unless is_a?(LocalizableModel::ClassMethods)
+        send :extend,  LocalizableModel::ClassMethods
+        send :include, LocalizableModel::InstanceMethods
+        has_many(:localizations,
+                 as: :localizable,
+                 dependent: :destroy,
+                 autosave: true)
+        before_save :cleanup_localizations!
+      end
+      localizable_configuration.instance_eval(&block) if block_given?
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, LocalizableModel::ActiveRecordExtension)

data/lib/localizable_model/class_methods.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module LocalizableModel
+  # = LocalizableModel::ClassMethods
+  #
+  # Class methods for all Localizable models.
+  #
+  module ClassMethods
+    # Returns a scope where all records will be set to the given locale.
+    #
+    def in_locale(locale)
+      all
+        .extending(LocalizableModel::ScopeExtension)
+        .localize(locale)
+        .includes(:localizations)
+    end
+
+    # Returns a scope with only records matching the given locale.
+    #
+    #  Page.localized('en').first.locale # => 'en'
+    #
+    def localized(locale)
+      in_locale(locale)
+        .where("localizations.locale = ?", locale)
+        .references(:localizations)
+    end
+
+    def localized_attributes
+      localizable_configuration.attributes.keys
+    end
+
+    # Accessor for the configuration.
+    def localizable_configuration
+      @localizable_configuration ||= inherited_localizable_configuration
+    end
+
+    private
+
+    def inherited_localizable_configuration
+      if superclass.respond_to?(:localizable_configuration)
+        LocalizableModel::Configuration.new(
+          superclass.localizable_configuration.attributes.dup
+        )
+      else
+        LocalizableModel::Configuration.new
+      end
+    end
+  end
+end

data/lib/localizable_model/configuration.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module LocalizableModel
+  class Configuration
+    def initialize(attributes = nil)
+      @attributes = attributes
+    end
+
+    def attribute(attribute_name, options = {})
+      attribute_table[attribute_name.to_sym] = options
+    end
+
+    def attributes
+      attribute_table.merge(dictionary_attributes)
+    end
+
+    def dictionary(dict)
+      dictionaries << dict
+    end
+
+    def attribute?(attribute)
+      attributes.keys.include?(attribute)
+    end
+
+    private
+
+    def dictionaries
+      @dictionaries ||= []
+    end
+
+    def dictionary_attributes
+      dictionaries.map(&:call).inject({}) do |attrs, list|
+        attrs.merge(hashify(list))
+      end
+    end
+
+    def hashify(list)
+      return list if list.is_a?(Hash)
+      list.each_with_object({}) do |e, a|
+        a[e] = {}
+      end
+    end
+
+    def attribute_table
+      @attributes ||= {}
+    end
+  end
+end

data/lib/localizable_model/engine.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module LocalizableModel
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/localizable_model/instance_methods.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+module LocalizableModel
+  # = LocalizableModel::InstanceMethods
+  #
+  # This is the public API for all localizable models.
+  # See Localizable for usage examples.
+  #
+  module InstanceMethods
+    # Returns all locales saved for this page.
+    #
+    delegate :locales, to: :localizer
+
+    # Getter for locale
+    #
+    #  page.locale # => 'en'
+    #
+    delegate :locale, to: :localizer
+
+    # Setter for locale
+    #
+    #  page.locale = 'no' # => 'no'
+    #
+    def locale=(locale)
+      @localizer = Localizer.new(self)
+      localizer.locale = locale
+    end
+
+    # Returns true if this page has a locale set
+    #
+    delegate :locale?, to: :localizer
+
+    # Returns a copy of the model with a different locale.
+    #
+    #  localized = page.localize('en')
+    #
+    # localize also takes a block as an argument, which returns the
+    # result of the block.
+    #
+    #  page.localize('nb') do |p|
+    #    p.locale # => 'nb'
+    #  end
+    #  page.locale # => 'en'
+    #
+    def localize(locale)
+      clone = self.clone.localize!(locale)
+      block_given? ? (yield clone) : clone
+    end
+
+    # In-place variant of #localize.
+    #
+    #  page.localize!('en')
+    #
+    # This is functionally equivalent to setting locale=,
+    # but returns the model instead of the locale and is chainable.
+    #
+    def localize!(locale)
+      @localizer = Localizer.new(self)
+      localizer.locale = locale
+      self
+    end
+
+    # assign_attributes from ActiveRecord is overridden to catch locale before
+    # any other attributes are written. This enables the following construct:
+    #
+    #  Page.create(name: 'My Page', locale: 'en')
+    #
+    def assign_attributes(new_attributes)
+      if new_attributes.is_a?(Hash)
+        attributes = new_attributes.stringify_keys
+        self.locale = attributes["language"] if attributes.key?("language")
+        self.locale = attributes["locale"]   if attributes.key?("locale")
+      end
+      super
+    end
+
+    # A localized model responds to :foo, :foo= and :foo?
+    #
+    def respond_to?(method_name, *args)
+      requested_attribute, = method_name.to_s.match(/(.*?)([\?=]?)$/)[1..2]
+      localizer.attribute?(requested_attribute.to_sym) ? true : super
+    end
+
+    alias translate localize
+    alias translate! localize!
+    alias working_language locale
+    alias working_language= locale=
+
+    protected
+
+    # Getter for the model's Localizer.
+    #
+    def localizer
+      @localizer ||= Localizer.new(self)
+    end
+
+    # Callback for cleaning up empty localizations.
+    # This is performed automatically when the model is saved.
+    #
+    def cleanup_localizations!
+      localizer.cleanup_localizations!
+    end
+
+    def method_missing(method_name, *args)
+      attr = method_to_attr(method_name)
+      super unless localizer.attribute?(attr)
+
+      case method_name.to_s
+      when /\?$/
+        localizer.value_for?(attr)
+      when /=$/
+        localizer.set(attr, args.first)
+      else
+        localizer.get(attr).to_s
+      end
+    end
+
+    def method_to_attr(method_name)
+      method_name.to_s.match(/(.*?)([\?=]?)$/)[1].to_sym
+    end
+  end
+end

data/lib/localizable_model/localizer.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module LocalizableModel
+  class Localizer
+    attr_accessor :locale
+    def initialize(model)
+      @model         = model
+      @configuration = model.class.localizable_configuration
+    end
+
+    def attribute?(attribute)
+      @configuration.attribute?(attribute)
+    end
+
+    def locales
+      @model.localizations.map(&:locale).uniq
+    end
+
+    def locale?
+      locale ? true : false
+    end
+
+    def get(attribute, options = {})
+      get_options = { locale: locale }.merge(options)
+
+      find_localizations(
+        attribute.to_s,
+        get_options[:locale].to_s
+      ).try(&:first) ||
+        @model.localizations.new(
+          locale: get_options[:locale].to_s,
+          name: attribute.to_s
+        )
+    end
+
+    def set(attribute, value, options = {})
+      set_options = { locale: locale }.merge(options)
+      if value.is_a?(Hash)
+        value.each { |loc, val| set(attribute, val, locale: loc) }
+      else
+        require_locale!(attribute, set_options[:locale])
+        get(attribute, locale: set_options[:locale]).value = value
+      end
+      value
+    end
+
+    def value_for?(attribute)
+      get(attribute).value?
+    end
+
+    def cleanup_localizations!
+      @model.localizations = @model.localizations.select(&:value?)
+    end
+
+    private
+
+    def find_localizations(name, locale)
+      @model.localizations.select do |l|
+        l.name == name && l.locale == locale
+      end
+    end
+
+    def require_locale!(attribute, locale)
+      return if locale
+      raise(ArgumentError,
+            "Tried to set :#{attribute}, but no locale has been set")
+    end
+  end
+end

data/lib/localizable_model/scope_extension.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module LocalizableModel
+  # = LocalizableModel::ScopeExtension
+  #
+  # Injected into the Relation when Model.localized is called.
+  #
+  module ScopeExtension
+    attr_accessor :locale
+
+    def localize(locale)
+      @locale = locale
+      self
+    end
+
+    def to_a
+      super.map { |record| record.localize(@locale) }
+    end
+  end
+end

data/lib/localizable_model/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module LocalizableModel
+  VERSION = "0.0.1".freeze unless LocalizableModel.const_defined?("VERSION")
+end

data/lib/rails/generators/localizable_model/migration/migration_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators/active_record/migration"
+
+module LocalizableModel
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      desc "Creates the LocalizableModel migration"
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_files
+        migration_template(
+          "create_localizations.rb",
+          "db/migrate/create_localizations.rb"
+        )
+      end
+    end
+  end
+end

data/lib/rails/generators/localizable_model/migration/templates/create_localizations.rb

@@ -0,0 +1,11 @@
+class CreateLocalizations < ActiveRecord::Migration
+  def change
+    create_table :localizations do |t|
+      t.references :localizable, polymorphic: true
+      t.string :name
+      t.string :locale
+      t.text :value, limit: 16_777_215
+      t.timestamps null: false
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: localizable_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Inge Jørgensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: LocalizableModel provides localization support for ActiveRecord objects
+email:
+- inge@kord.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/models/localization.rb
+- lib/localizable_model.rb
+- lib/localizable_model/active_record_extension.rb
+- lib/localizable_model/class_methods.rb
+- lib/localizable_model/configuration.rb
+- lib/localizable_model/engine.rb
+- lib/localizable_model/instance_methods.rb
+- lib/localizable_model/localizer.rb
+- lib/localizable_model/scope_extension.rb
+- lib/localizable_model/version.rb
+- lib/rails/generators/localizable_model/migration/migration_generator.rb
+- lib/rails/generators/localizable_model/migration/templates/create_localizations.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: Localization support for ActiveRecord objects
+test_files: []