mongoid_localization 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= MongoidLocalization
+
+This project rocks and uses MIT-LICENSE.
+
+A simple gem for use with mongoid "~> 2.3.3", that adds attribute readers and writers to any Mongoid document, where a field has been set with :localize => true.
+
+Usage:
+
+Add to gemfile:
+
+  gem "mongoid_localization"
+  
+Add to Mongoid document class:
+  "include Mongoid::Localization"
+  
+Now any fields in a mongoid document that has localize set to true will have the following methods available appended with "_translations"
+
+Example:
+
+class Post
+  include Mongoid::Document
+  include Mongoid::Localization
+  
+  field :name, :localize => true, :default => ""
+  
+end
+
+The following methods will now be automatically available:
+
+  @post.name_translations
+  @post.name_translations =

data/lib/mongoid/localization/version.rb

@@ -0,0 +1,5 @@
+module Mongoid #:nodoc:
+  module Localization
+    VERSION = "0.0.2"
+  end
+end

data/lib/mongoid/localization.rb

@@ -0,0 +1,38 @@
+module Mongoid
+
+  # this module adds attribute reader and writer methods for any mongoid document fields
+  # that have :localize set to true. This methods will access or write a hash of translations to any
+  # of these fields by using methods with "_translations" appended to them
+
+  module Localization
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      
+      def create_accessors(name, meth, options ={})
+        self.fields.keys.each do |field|
+          if self.fields[field].options[:localize] == true
+            define_method("#{field}_translations") {read_attribute(field)}
+            define_method("#{field}_translations=") do |value|
+              if value.is_a?(Hash)
+                start_locale = I18n.locale
+                value.keys.each do |key|
+                  if I18n.available_locales.include?(key.to_sym)
+                    I18n.locale = key
+                    write_attribute(field, value[key])
+                  end
+                  I18n.locale = start_locale
+                end
+              end
+            end
+          else
+            super
+          end
+        end
+      end
+    
+    end
+  
+  end
+
+end

data/spec/models/localized_model_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+class Post
+  include Mongoid::Document
+  include Mongoid::Localization
+  
+  field :translations_available, :type => Array
+
+  field :name, :type => String, :localize => true, :default => ""
+
+end
+
+describe Mongoid::Localization, "fields with localize = true" do
+  before do
+    I18n.available_locales = [:en, :es]
+    I18n.locale =:en
+  end
+  
+  describe "without an assigned value" do
+    before do
+      @post = Post.new
+    end
+
+    it "should return blank" do
+      @post.name.should be_blank
+      debugger
+    end
+  end
+
+  describe "with an assigned value" do
+    before do
+      @post = Post.new(:name => 'Title')
+    end
+
+    it "should return that value" do
+      @post.name.should == 'Title'
+    end
+  
+    describe "and persisted" do
+      before do
+        @post.save
+      end
+
+      describe "find by id" do
+        it "should find the document" do
+          Post.find(@post.id).should == @post
+        end
+      end
+
+        describe "where() criteria" do
+          it "should use the current locale value" do
+            Post.where(:name => 'Title').first.should == @post
+          end
+        end
+
+        describe "find(:first) with :conditions" do
+          it "should use the current locale value" do
+            Post.find(:first, :conditions => {:name => 'Title'}).should == @post
+          end
+        end
+      end
+
+      describe "when the locale is changed" do
+        before do
+          I18n.locale = :es
+        end
+
+        it "should return a blank value" do
+          @post.name.should be_blank
+        end
+
+        describe "a new value is assigned" do
+          before do
+            @post.name = 'Titulo'
+          end
+
+          it "should return the new value" do
+            @post.name.should == 'Titulo'
+          end
+
+          describe "persisted and retrieved from db" do
+            before do
+              @post.save
+              @post.reload
+            end
+
+            it "the localized field value should be correct" do
+              @post.name.should == 'Titulo'
+              I18n.locale = :en
+              @post.name.should == 'Title'
+              @post.name_translations.should == {'en' => 'Title', 'es' => 'Titulo'}
+            end
+          end
+
+          describe "field_translations" do
+            it "should return all translations" do
+              @post.name_translations.should == {'en' => 'Title', 'es' => 'Titulo'}
+            end
+          end
+
+          describe "with mass-assigned translations" do
+            before do
+              @post.name_translations = {'en' => 'New title', 'es' => 'Nuevo Titulo'}
+            end
+
+            it "should set all translations" do
+              @post.name_translations.should == {'en' => 'New title', 'es' => 'Nuevo Titulo'}
+            end
+
+            it "the getter should return the new translation" do
+              @post.name.should == 'Nuevo Titulo'
+            end
+          end
+
+          describe "if we go back to the original locale" do
+            before do
+              I18n.locale = :en
+            end
+
+            it "should return the original value" do
+              @post.name.should == 'Title'
+            end
+          end
+        end
+      end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'mongoid'
+require 'mongoid/localization'
+require 'rspec'
+require 'rspec/autorun'
+
+
+RSpec.configure do |config|
+  config.after :each do
+    Mongoid.master.collections.reject { |c| c.name =~ /^system\./ }.each(&:drop)
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('mongoid_localization_test')
+  config.allow_dynamic_fields = false
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_localization
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- David Krett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70340324546140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340324546140
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70340324544800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340324544800
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70340324543600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *70340324543600
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: &70340324542760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70340324542760
+description: Simple gem that adds reader and writer methods to a mongoid document
+  to write and access translations when :localize has been set to true for a field
+email:
+- david@what2do.asia
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongoid/localization/version.rb
+- lib/mongoid/localization.rb
+- MIT-LICENSE
+- README.rdoc
+- spec/models/localized_model_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dbkbali/mongoid_localization
+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.10
+signing_key: 
+specification_version: 3
+summary: Adds reader and writer methods to allow access to mongoid translations for
+  mongoid ~> 2.3.3
+test_files:
+- spec/models/localized_model_spec.rb
+- spec/spec_helper.rb