localizable 1.0

data/README

@@ -0,0 +1,50 @@
+Localizable gives you an easy way to define localizable fields in your
+MongoMapper::Document or MongoMapper::EmbeddedDocument.
+
+Example class definition:
+
+    class Dummy
+
+        include MongoMapper::Document
+        include Localizable
+
+        localized_key :fieldname
+        localized_key :integer_field, Integer
+
+
+    end
+
+Assignment and fetching:
+
+    obj = Dummy.new
+    obj.fieldname = {
+        'en' => 'test 1',
+        'nl' => 'test 2'
+    }
+
+    obj.fieldname('en)' # returns 'test 1'
+    obj.fieldname('nl') # returns 'test 2'
+
+    obj.integer_field = {
+        'en => '1',
+        'nl' => '2'
+    }
+
+    obj.integer_field('en') # returns 1
+    obj.integer_field('nl') # returns 2
+
+You can define how to fetch the default locale and how to convert the locale
+to a string (it assumes that string is given in the assignment)
+
+    Localizable.fetch_default_locale = Proc.new do
+        Locale.first({ :default => true })
+    end
+
+    Localizable.locale_to_string = Proc.new do |locale|
+        locale.slug # assuming this is a string value
+    end
+
+    obj.fieldname # returns 'test 1' when Locale.first({ :default => true }).slug == 'en'
+
+
+

data/lib/localizable.rb

@@ -0,0 +1,95 @@
+module Localizable
+
+    def self.reset
+        @default_locale_fetcher = nil
+        @locale_to_string = Proc.new do |l|
+            l.to_s
+        end
+    end
+
+    def self.fetch_default_locale= (default_locale_fetcher)
+        @default_locale_fetcher = default_locale_fetcher
+    end
+
+    def self.fetch_default_locale
+        raise 'no default locale fetcher defined' unless @default_locale_fetcher
+        @default_locale_fetcher.call
+    end
+
+    def self.locale_to_string (locale)
+        @locale_to_string ||= Proc.new do |l|
+            l.to_s
+        end
+
+        @locale_to_string.call(locale)
+    end
+
+    def self.locale_to_string= (locale_to_string)
+        @locale_to_string = locale_to_string
+    end
+
+    def self.included(model)
+
+        model.class_eval do
+            extend ClassMethods
+            include InstanceMethods
+        end
+
+    end
+
+    module ClassMethods
+
+        def localized_key (fieldname, type = String)
+            key "#{fieldname}_values".to_sym, Hash
+            localized_type[fieldname] = type
+
+            self.class_eval <<-end_eval
+
+                def #{fieldname} (locale = nil, default_text = '')
+                    fetch_localized_value :#{fieldname}, locale, default_text
+                end
+
+                def #{fieldname}= (mapping)
+                    store_localized_values :#{fieldname}, mapping
+                end
+
+            end_eval
+
+        end
+
+        def localized_type
+            @localized_type ||= {}
+        end
+
+    end
+
+    module InstanceMethods
+
+        def fetch_localized_value (fieldname, locale, default_text)
+            field = "#{fieldname}_values".to_sym
+            locale ||= Localizable.fetch_default_locale
+            locale_str = Localizable.locale_to_string(locale)
+
+            if self[field].key?(locale_str)
+                localized_type[fieldname].from_mongo(self[field][locale_str])
+            else
+                default_text
+            end
+        end
+
+        def store_localized_values (fieldname, mapping)
+            field = "#{fieldname}_values".to_sym
+
+            mapping.each do |locale, value|
+                self[field][locale] = localized_type[fieldname].to_mongo(value)
+            end
+        end
+
+        def localized_type
+            self.class.localized_type
+        end
+
+
+    end
+
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: localizable
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Stefaan Colman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-18 00:00:00.000000000 Z
+dependencies: []
+description: An easy way to localize fields of MongoMapper::Document classes
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/localizable.rb
+- README
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Localize your models
+test_files: []