mongoid_i18n 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.bundle
+
+## PROJECT::SPECIFIC
+

data/Gemfile

@@ -0,0 +1,8 @@
+source :gemcutter
+
+gem 'bson_ext', '0.20.1'
+gem 'mongoid', '2.0.0.beta4'
+gem 'rspec', '2.0.0.beta.8'
+gem 'mocha'
+
+gem 'jeweler'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Rodrigo Álvarez
+
+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,45 @@
+= mongoid_i18n
+
+Mongoid::I18n is a gem that makes localization almost transparent for the developer.
+
+== Usage
+  
+  class Entry
+    include Mongoid::Document
+    include Mongoid::I18n
+    
+    localized_field :title # Just use localized_field instead of field
+    field :published, :type => Boolean
+  end
+  
+This will allow you to do stuff like this:
+
+  I18n.locale = :en
+  @entry = Entry.new(:title => 'Title') # will be stored in the 'en' translation
+  
+  I18n.locale :es
+  @entry.title = 'Título' # will be stored in the 'es' translation
+  
+  @entry.title_translations # this returns a hash: {'en' => 'Title', 'es' => 'Title'}
+  @entry.title_translations = {'en' => 'New title', 'es' => 'Nuevo título} # You can always mass-assign.
+  
+Criteria is handled for you:
+
+  I18n.locale = :en
+  Entry.where(:title => 'Title') # This will search automatically for the 'en' translation
+  Entry.find(:first, :title.in => ['Stuff', 'More stuff']) # find() and complex criteria also works
+  
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Rodrigo Álvarez. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongoid_i18n"
+    gem.summary = %Q{Mongoid plugin to deal with localizable fields}
+    gem.description = %Q{This gem aims to be a transparent way to deal with localizable fields.
+      Basically use localized_field() instead of field() and that's it.
+      It will take care of locales for you when using find.
+      }
+    gem.email = "papipo@gmail.com"
+    gem.homepage = "http://github.com/Papipo/mongoid_i18n"
+    gem.authors = ["Rodrigo Álvarez"]
+    gem.add_dependency "mongoid", '2.0.0.beta4'
+    gem.add_development_dependency "rspec", "2.0.0.beta.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+desc "Run all examples"
+Rspec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongoid_i18n #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/mongoid/i18n/localized_criteria.rb

@@ -0,0 +1,24 @@
+module Mongoid
+  module I18n
+    class LocalizedCriteria < Mongoid::Criteria
+      def where(selector = nil)
+        case selector
+        when String
+          @selector.update("$where" => selector)
+        else
+          @selector.update(selector ? selector.expand_complex_criteria : {})
+          expand_localized_fields_in_selector if @selector.is_a?(Hash)
+        end
+        self
+      end
+      
+      protected
+      
+      def expand_localized_fields_in_selector
+        @klass.fields.select { |k,f| @selector.keys.include?(k.to_sym) && f.type == LocalizedField }.each_key do |k|
+          @selector["#{k}.#{::I18n.locale}"] = @selector.delete(k.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/i18n/localized_field.rb

@@ -0,0 +1,6 @@
+module Mongoid
+  module I18n
+    class LocalizedField < Hash
+    end
+  end
+end

data/lib/mongoid/i18n/patches.rb

@@ -0,0 +1,17 @@
+module Mongoid
+  class Criteria
+    def self.translate(*args)
+      klass = args[0]
+      params = args[1] || {}
+      unless params.is_a?(Hash)
+        return klass.criteria.id_criteria(params)
+      end
+      conditions = params.delete(:conditions) || {}
+      if conditions.include?(:id)
+        conditions[:_id] = conditions[:id]
+        conditions.delete(:id)
+      end
+      return klass.criteria.where(conditions).extras(params)
+    end
+  end
+end

data/lib/mongoid/i18n.rb

@@ -0,0 +1,35 @@
+gem 'mongoid', '2.0.0.beta4'
+require 'mongoid'
+require 'mongoid/i18n/localized_field'
+require 'mongoid/i18n/localized_criteria'
+require 'mongoid/i18n/patches'
+
+module Mongoid
+  module I18n
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def localized_field(name, options = {})
+        field name, options.merge(:type => LocalizedField, :default => {})
+      end
+      
+      def criteria
+        I18n::LocalizedCriteria.new(self)
+      end
+    
+      protected
+      def create_accessors(name, meth, options = {})
+        if options[:type] == LocalizedField
+          define_method(meth) { read_attribute(name)[::I18n.locale.to_s] }
+          define_method("#{meth}=") do |value| 
+            write_attribute(name, (@attributes[name] || {}).merge(::I18n.locale.to_s => value))
+          end
+          define_method("#{meth}_translations") { read_attribute(name) }
+          define_method("#{meth}_translations=") { |value| write_attribute(name, value) }
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/integration/mongoid/i18n_spec.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+require 'spec_helper'
+
+class Entry
+  include Mongoid::Document
+  include Mongoid::I18n
+  
+  localized_field :title
+  field :published, :type => Boolean
+end
+
+describe Mongoid::I18n, "localized_field" do
+  before do
+    I18n.locale = :en
+  end
+  
+  describe "with an assigned value" do
+    before do
+      @entry = Entry.new(:title => 'Title')
+    end
+    
+    describe "and persisted" do
+      before do
+        @entry.save
+      end
+      
+      describe "where() criteria" do
+        it "should use the current locale value" do
+          Entry.where(:title => 'Title').first.should == @entry
+        end
+      end
+      
+      describe "find(:first) with :conditions" do
+        it "should use the current locale value" do
+          Entry.find(:first, :conditions => {:title => 'Title'}).should == @entry
+        end
+      end
+    end
+    
+    it "should return that value" do
+      @entry.title.should == 'Title'
+    end
+    
+    describe "when the locale is changed" do
+      before do
+        I18n.locale = :es
+      end
+      
+      it "should return a blank value" do
+        @entry.title.should be_blank
+      end
+      
+      describe "a new value is assigned" do
+        before do
+          @entry.title = 'Título'
+        end
+        
+        it "should return the new value" do
+          @entry.title.should == 'Título'
+        end
+        
+        describe "persisted and retrieved from db" do
+          before do
+            @entry.save
+            @entry = Entry.find(:first, :conditions => {:title => 'Título'})
+          end
+          
+          it "the localized field value should be ok" do
+            @entry.title.should == 'Título'
+            I18n.locale = :en
+            @entry.title.should == 'Title'
+            @entry.title_translations.should == {'en' => 'Title', 'es' => 'Título'}
+          end
+        end
+        
+        describe "getter.translations" do
+          it "should return all translations" do
+            @entry.title_translations.should == {'en' => 'Title', 'es' => 'Título'}
+          end
+        end
+        
+        describe "getter.translations=" do
+          before do
+            @entry.title_translations = {'en' => 'New title', 'es' => 'Nuevo título'}
+          end
+          
+          it "should accept new translations" do
+            @entry.title_translations.should == {'en' => 'New title', 'es' => 'Nuevo título'}
+          end
+          
+          it "the getter should return the new translation" do
+            @entry.title.should == 'Nuevo título'
+          end
+        end
+        
+        describe "and we go back to the original locale" do
+          before do
+            I18n.locale = :en
+          end
+          
+          it "should return the original value" do
+            @entry.title.should == 'Title'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'mongoid/i18n'
+require 'rspec'
+require 'rspec/autorun'
+
+Rspec.configure do |config|
+  config.mock_with :mocha
+  config.after :each do
+    Mongoid.master.collections.each(&:drop)
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('mongoid_i18n_test')
+  config.allow_dynamic_fields = false
+end

data/spec/unit/mongoid/i18n/localized_criteria_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Mongoid::I18n::LocalizedCriteria do
+  describe "where" do
+    before do
+      klass = stub(:fields => {'title' => mock(:type => Mongoid::I18n::LocalizedField), 'published' => mock(:type => Boolean)})
+      @criteria = Mongoid::I18n::LocalizedCriteria.new(klass)
+      @criteria.where(:title.in => ['Title'], :published => true)
+    end
+    
+    it "should expand fields that are LocalizedFields" do
+      @criteria.instance_variable_get("@selector").should == {'title.en' => {'$in' => ['Title']}, :published => true}
+    end
+  end
+end

data/spec/unit/mongoid/i18n_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Mongoid::I18n do
+  before do
+    @class = Class.new do
+      include Mongoid::I18n
+    end
+    I18n.stubs(:locale).returns(:en)
+  end
+  
+  describe "criteria" do
+    it "should return a LocalizedCriteria" do
+      @class.criteria.should be_a(Mongoid::I18n::LocalizedCriteria)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_i18n
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Rodrigo \xC3\x81lvarez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta4
+        version: 2.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 8
+        version: 2.0.0.beta.8
+  type: :development
+  version_requirements: *id002
+description: "This gem aims to be a transparent way to deal with localizable fields.\n      Basically use localized_field() instead of field() and that's it.\n      It will take care of locales for you when using find.\n      "
+email: papipo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/mongoid/i18n.rb
+- lib/mongoid/i18n/localized_criteria.rb
+- lib/mongoid/i18n/localized_field.rb
+- lib/mongoid/i18n/patches.rb
+- spec/.rspec
+- spec/integration/mongoid/i18n_spec.rb
+- spec/spec_helper.rb
+- spec/unit/mongoid/i18n/localized_criteria_spec.rb
+- spec/unit/mongoid/i18n_spec.rb
+has_rdoc: true
+homepage: http://github.com/Papipo/mongoid_i18n
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Mongoid plugin to deal with localizable fields
+test_files: 
+- spec/integration/mongoid/i18n_spec.rb
+- spec/spec_helper.rb
+- spec/unit/mongoid/i18n/localized_criteria_spec.rb
+- spec/unit/mongoid/i18n_spec.rb