pages_core 3.4.3 → 3.5.1

data/lib/pages_core/localizable.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-
-load "pages_core/localizable/active_record_extension.rb"
-load "pages_core/localizable/class_methods.rb"
-load "pages_core/localizable/configuration.rb"
-load "pages_core/localizable/instance_methods.rb"
-load "pages_core/localizable/localizer.rb"
-load "pages_core/localizable/scope_extension.rb"
-
-module PagesCore
-  # = 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 Localizable
-  end
-end

data/lib/pages_core/localizable/active_record_extension.rb

@@ -1,41 +0,0 @@
-# encoding: utf-8
-
-module PagesCore
-  module Localizable
-    # = Localizable::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
-      # Localizable::Configuration.
-      #
-      # Example:
-      #
-      #  class Page < ActiveRecord::Base
-      #    localizable do
-      #      attribute :name
-      #      attribute :body
-      #    end
-      #  end
-      #
-      def localizable(&block)
-        unless self.is_a?(Localizable::ClassMethods)
-          send :extend,  Localizable::ClassMethods
-          send :include, Localizable::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
-end
-
-ActiveRecord::Base.send(:extend, PagesCore::Localizable::ActiveRecordExtension)

data/lib/pages_core/localizable/class_methods.rb

@@ -1,51 +0,0 @@
-# encoding: utf-8
-
-module PagesCore
-  module Localizable
-    # = Localizable::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(Localizable::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)
-          Localizable::Configuration.new(
-            superclass.localizable_configuration.attributes.dup
-          )
-        else
-          Localizable::Configuration.new
-        end
-      end
-    end
-  end
-end

data/lib/pages_core/localizable/configuration.rb

@@ -1,50 +0,0 @@
-# encoding: utf-8
-
-module PagesCore
-  module Localizable
-    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
-end

data/lib/pages_core/localizable/instance_methods.rb

@@ -1,130 +0,0 @@
-# encoding: utf-8
-
-module PagesCore
-  module Localizable
-    # = Localizable::InstanceMethods
-    #
-    # This is the public API for all localizable models.
-    # See Localizable for usage examples.
-    #
-    module InstanceMethods
-      # Returns all locales saved for this page.
-      #
-      def locales
-        localizer.locales
-      end
-
-      # Getter for locale
-      #
-      #  page.locale # => 'en'
-      #
-      def locale
-        localizer.locale
-      end
-
-      # 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
-      #
-      def locale?
-        localizer.locale?
-      end
-
-      # 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_method :translate,  :localize
-      alias_method :translate!, :localize!
-      alias_method :working_language,  :locale
-      alias_method :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
-end

data/lib/pages_core/localizable/localizer.rb

@@ -1,72 +0,0 @@
-# encoding: utf-8
-
-module PagesCore
-  module Localizable
-    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 do |loc, val|
-            set(attribute, val, locale: loc)
-          end
-        else
-          unless set_options[:locale]
-            fail(
-              ArgumentError,
-              "Tried to set :#{attribute}, but no locale has been set"
-            )
-          end
-          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
-    end
-  end
-end

data/lib/pages_core/localizable/scope_extension.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-
-module PagesCore
-  module Localizable
-    # = Localizable::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
-end