dm-is-localizable 0.10.1

data/spec/shared/shared_examples_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe "all available_languages providers", :shared => true do
+
+  describe "with no translations" do
+
+    it "should return 0 languages" do
+      @provider.available_languages.size.should == 0
+    end
+
+  end
+
+  describe "with 1 translation in 1 language" do
+
+    before :each do
+      @l = Language.create :code => 'en-US', :name => 'English'
+      @t = ItemTranslation.create :item => @item, :language => @l, :name => "Book", :desc => "Literature"
+    end
+
+    it "should return 1 language" do
+      @provider.available_languages.size.should == 1
+    end
+
+    it "should return the right language" do
+      @provider.available_languages.first.should == @l
+    end
+
+  end
+
+  describe "with 2 translations in 1 language" do
+
+    before :each do
+      @l = Language.create :code => 'en-US', :name => 'English'
+      @t = ItemTranslation.create :item => @item, :language => @l, :name => "Book", :desc => "Literature"
+      @t = ItemTranslation.create :item => @item, :language => @l, :name => "Hook", :desc => "Tool"
+      @item.reload
+    end
+
+    it "should return 1 language" do
+      @provider.available_languages.size.should == 1
+    end
+
+    it "should return the right language" do
+      @provider.available_languages.first.should == @l
+    end
+
+  end
+
+  describe "with 3 translations in 2 languages" do
+
+    before :each do
+      @item2 = Item.create
+      @l1 = Language.create :code => 'en-US', :name => 'English'
+      @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+      ItemTranslation.create :item => @item,  :language => @l1, :name => "Book",  :desc => "Literature"
+      ItemTranslation.create :item => @item,  :language => @l2, :name => "Haken", :desc => "Werkzeug"
+      ItemTranslation.create :item => @item2, :language => @l1, :name => "Hook",  :desc => "Tool"
+    end
+
+    it "should return 2 language" do
+      @provider.available_languages.size.should == 2
+    end
+
+    it "should return the right language" do
+      @provider.available_languages.size.should == 2
+      @provider.available_languages.should include(@l1)
+      @provider.available_languages.should include(@l2)
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+
+require 'dm-core'
+require 'dm-is-remixable'
+require 'dm-validations'
+require 'dm-accepts_nested_attributes'
+
+# Support running specs with 'rake spec' and 'spec'
+$LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
+
+require 'dm-is-localizable'
+
+ENV["SQLITE3_SPEC_URI"]  ||= 'sqlite3::memory:'
+ENV["MYSQL_SPEC_URI"]    ||= 'mysql://localhost/dm-is_localizable_test'
+ENV["POSTGRES_SPEC_URI"] ||= 'postgres://postgres@localhost/dm-is_localizable_test'
+
+
+def setup_adapter(name, default_uri = nil)
+  begin
+    DataMapper.setup(name, ENV["#{ENV['ADAPTER'].to_s.upcase}_SPEC_URI"] || default_uri)
+    Object.const_set('ADAPTER', ENV['ADAPTER'].to_sym) if name.to_s == ENV['ADAPTER']
+    true
+  rescue Exception => e
+    if name.to_s == ENV['ADAPTER']
+      Object.const_set('ADAPTER', nil)
+      warn "Could not load do_#{name}: #{e}"
+    end
+    false
+  end
+end
+
+# have the loggers handy
+# DataObjects::Logger.new(STDOUT, :debug)
+# DataObjects::Sqlite3.logger = DataObjects::Logger.new(STDOUT, :debug)
+
+# -----------------------------------------------
+# support for nice html output in rspec tmbundle
+# -----------------------------------------------
+
+USE_TEXTMATE_RSPEC_BUNDLE = true # set to false if not using textmate
+
+if USE_TEXTMATE_RSPEC_BUNDLE
+
+  require Pathname(__FILE__).dirname.expand_path + 'lib/rspec_tmbundle_support'
+
+  # use the tmbundle logger
+  #RSpecTmBundleHelpers::TextmateRspecLogger.new(STDOUT, :off)
+
+
+  class Object
+    include RSpecTmBundleHelpers
+  end
+
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+setup_adapter(:default)
+Dir[Pathname(__FILE__).dirname.to_s + "/fixtures/**/*.rb"].each { |rb| require(rb) }
+
+
+Spec::Runner.configure do |config|
+
+  config.before(:each) do
+    DataMapper.auto_migrate!
+  end
+
+end

data/spec/unit/auto_migrate_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "DataMapper.auto_migrate!" do
+
+  it "should allow to automigrate the resource to be translated" do
+    lambda { Item.auto_migrate! }.should_not raise_error
+  end
+
+  it "should allow to automigrate the resource where translations will be stored" do
+    lambda { ItemTranslation.auto_migrate! }.should_not raise_error
+  end
+
+end

data/spec/unit/class_level_api_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+require 'shared/shared_examples_spec'
+
+describe "class level API:" do
+
+  describe "translation_model" do
+
+    it "should follow naming conventions" do
+      Item.translation_model.should == ItemTranslation
+    end
+
+  end
+
+  describe "available_languages" do
+
+    before :each do
+      @item  = Item.create
+      @provider = Item
+    end
+
+    it_should_behave_like "all available_languages providers"
+
+  end
+
+  describe "nr_of_available_languages" do
+
+    describe "with 0 items" do
+
+      it "should return 0" do
+        Item.nr_of_available_languages.should == 0
+      end
+
+    end
+
+    describe "with 1 item" do
+
+      before :each do
+        @l1 = Language.create :code => 'en-US', :name => 'English'
+        @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+        @i1 = Item.create
+      end
+
+      describe "and 0 translations" do
+
+        it "should return 0" do
+          Item.nr_of_available_languages == 0
+        end
+
+      end
+
+      describe "and 1 translation" do
+
+        it "should return 1" do
+          ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+          Item.nr_of_available_languages == 1
+        end
+
+      end
+
+      describe "and 2 translations" do
+
+        it "should return 2" do
+          ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+          ItemTranslation.create :item => @i1, :language => @l2, :name => 'Book', :desc => 'Literature'
+          Item.nr_of_available_languages == 2
+        end
+
+      end
+
+    end
+
+  end
+
+
+  describe "translations_complete?" do
+
+    describe "with 0 items" do
+
+      it "should return true" do
+        Item.translations_complete?.should be_true
+      end
+
+    end
+
+    describe "with 1 item" do
+
+      before :each do
+        @i1 = Item.create
+        @provider = Item
+      end
+
+      describe "and 0 translations" do
+
+        it "should return true" do
+          Item.translations_complete?.should be_true
+        end
+
+      end
+
+      describe "and 1 translation" do
+
+        it "should return true" do
+          l = Language.create :code => 'en-US', :name => 'English'
+          ItemTranslation.create :item => @i1, :language => l, :name => 'Book', :desc => 'Literature'
+          Item.translations_complete?.should be_true
+        end
+
+      end
+
+      describe "and more than 1 translation" do
+
+        it "should return true" do
+          l1 = Language.create :code => 'en-US', :name => 'English'
+          l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+          ItemTranslation.create :item => @i1, :language => l1, :name => 'Book', :desc => 'Literature'
+          ItemTranslation.create :item => @i1, :language => l2, :name => 'Buch', :desc => 'Literatur'
+          Item.translations_complete?.should be_true
+        end
+
+      end
+
+    end
+
+    describe "with 2 items" do
+
+      before :each do
+        @l1 = Language.create :code => 'en-US', :name => 'English'
+        @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+        @i1 = Item.create
+        @i2 = Item.create
+      end
+
+      describe "and not all items are translated" do
+
+        it "should return false" do
+          ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+          ItemTranslation.create :item => @i1, :language => @l2, :name => 'Buch', :desc => 'Literatur'
+          Item.translations_complete?.should be_false
+        end
+
+      end
+
+      describe "and all items are translated" do
+
+        it "should return true" do
+          ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book',  :desc => 'Literature'
+          ItemTranslation.create :item => @i1, :language => @l2, :name => 'Buch',  :desc => 'Literatur'
+          ItemTranslation.create :item => @i2, :language => @l1, :name => 'Hook',  :desc => 'Tool'
+          ItemTranslation.create :item => @i2, :language => @l2, :name => 'Haken', :desc => 'Werkzeug'
+          Item.translations_complete?.should be_true
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "localizable_properties" do
+
+    it "should return a list of symbols reflecting the localizable properties" do
+      Item.localizable_properties.size.should == 2
+      Item.localizable_properties.should include(:name)
+      Item.localizable_properties.should include(:desc)
+    end
+
+  end
+
+end

data/spec/unit/instance_level_api_spec.rb

@@ -0,0 +1,328 @@
+require 'spec_helper'
+require 'shared/shared_examples_spec'
+
+
+describe "instance level API:" do
+
+  it "should create a one_to_many association that follows naming conventions" do
+    Item.new.should respond_to :item_translations
+  end
+
+  it "should add a translations alias to the one_to_many association" do
+    Item.new.should respond_to :translations
+  end
+
+  it "should create a many_to_many association to languages" do
+    Item.new.should respond_to :languages
+  end
+
+  describe "available_languages" do
+
+    before :each do
+      @item  = Item.create
+      @provider = @item
+    end
+
+    it_should_behave_like "all available_languages providers"
+
+  end
+
+
+  describe "nr_of_available_languages" do
+
+    before :each do
+      @l1 = Language.create :code => 'en-US', :name => 'English'
+      @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+      @i1 = Item.create
+    end
+
+    describe "with 0 translations" do
+
+      it "should return 0" do
+        @i1.nr_of_available_languages.should == 0
+      end
+
+    end
+
+    describe "with 1 translation" do
+
+      it "should return 1" do
+        ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+        @i1.nr_of_available_languages == 1
+      end
+
+    end
+
+    describe "with 2 translations in 1 language" do
+
+      it "should return 1" do
+        ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+        ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+        @i1.nr_of_available_languages == 1
+      end
+
+    end
+
+    describe "with 2 translations in 2 language" do
+
+      it "should return 2" do
+        ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+        ItemTranslation.create :item => @i1, :language => @l2, :name => 'Book', :desc => 'Literature'
+        @i1.nr_of_available_languages == 2
+      end
+
+    end
+
+  end
+
+
+  describe "translations_complete?" do
+
+    describe "with 1 item" do
+
+      before :each do
+        @i1 = Item.create
+      end
+
+      describe "and 0 translations" do
+
+        it "should return true" do
+          @i1.translations_complete?.should be_true
+        end
+
+      end
+
+      describe "and 1 translation" do
+
+        it "should return true" do
+          l = Language.create :code => 'en-US', :name => 'English'
+          ItemTranslation.create :item => @i1, :language => l, :name => 'Book', :desc => 'Literature'
+          @i1.translations_complete?.should be_true
+        end
+
+      end
+
+      describe "and more than 1 translation" do
+
+        it "should return true" do
+          l1 = Language.create :code => 'en-US', :name => 'English'
+          l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+          ItemTranslation.create :item => @i1, :language => l1, :name => 'Book', :desc => 'Literature'
+          ItemTranslation.create :item => @i1, :language => l2, :name => 'Buch', :desc => 'Literatur'
+          @i1.translations_complete?.should be_true
+        end
+
+      end
+
+    end
+
+    describe "with 2 items" do
+
+      before :each do
+        @l1 = Language.create :code => 'en-US', :name => 'English'
+        @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+        @i1 = Item.create
+        @i2 = Item.create
+      end
+
+      describe "both having 1 translation into different languages" do
+
+        it "should return false" do
+          ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+          ItemTranslation.create :item => @i2, :language => @l2, :name => 'Buch', :desc => 'Literatur'
+          @i1.translations_complete?.should be_false
+          @i2.translations_complete?.should be_false
+        end
+
+      end
+
+      describe "both having 1 translation into all different languages" do
+
+        it "should return true" do
+          ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book',  :desc => 'Literature'
+          ItemTranslation.create :item => @i1, :language => @l2, :name => 'Buch',  :desc => 'Literatur'
+          ItemTranslation.create :item => @i2, :language => @l1, :name => 'Hook',  :desc => 'Tool'
+          ItemTranslation.create :item => @i2, :language => @l2, :name => 'Haken', :desc => 'Werkzeug'
+          @i1.translations_complete?.should be_true
+          @i2.translations_complete?.should be_true
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "translate(attribute, language_code)" do
+
+    before :each do
+      @l1 = Language.create :code => 'en-US', :name => 'English'
+      @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+      @i1 = Item.create
+      @t1 = ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+      @t2 = ItemTranslation.create :item => @i1, :language => @l2, :name => 'Buch', :desc => 'Literatur'
+    end
+
+    describe "with an existing attribute" do
+
+      describe "and an existing language_code" do
+
+        describe "passed as Symbol" do
+
+          it "should return the translated string" do
+            @i1.translate(:name, :en_US).should == 'Book'
+            @i1.translate(:desc, :en_US).should == 'Literature'
+            @i1.translate(:name, :de_AT).should == 'Buch'
+            @i1.translate(:desc, :de_AT).should == 'Literatur'
+          end
+
+        end
+
+        describe "passed as String" do
+
+          it "should return the translated string" do
+            @i1.translate(:name, 'en_US').should == 'Book'
+            @i1.translate(:desc, 'en_US').should == 'Literature'
+            @i1.translate(:name, 'de_AT').should == 'Buch'
+            @i1.translate(:desc, 'de_AT').should == 'Literatur'
+          end
+
+        end
+
+      end
+
+      describe "and a non existent language_code" do
+
+        describe "passed as Symbol" do
+
+          it "should return the translated string" do
+            @i1.translate(:name, :it).should be_nil
+          end
+
+        end
+
+        describe "passed as String" do
+
+          it "should return the translated string" do
+            @i1.translate(:name, 'it').should be_nil
+          end
+
+        end
+
+      end
+
+    end
+
+    describe "with a non existent attribute" do
+
+      describe "and an existing language_code" do
+
+        describe "passed as Symbol" do
+
+          it "should return the translated string" do
+            @i1.translate(:foo, :en_US).should be_nil
+          end
+
+        end
+
+        describe "passed as String" do
+
+          it "should return the translated string" do
+            @i1.translate(:foo, 'en_US').should be_nil
+          end
+
+        end
+
+      end
+
+      describe "and a non existent language_code" do
+
+        describe "passed as Symbol" do
+
+          it "should return the translated string" do
+            @i1.translate(:foo, :it).should be_nil
+          end
+
+        end
+
+        describe "passed as String" do
+
+          it "should return the translated string" do
+            @i1.translate(:foo, 'it').should be_nil
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "property_name(language_code)" do
+
+    before :each do
+      @l1 = Language.create :code => 'en-US', :name => 'English'
+      @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+      @i1 = Item.create
+      @t1 = ItemTranslation.create :item => @i1, :language => @l1, :name => 'Book', :desc => 'Literature'
+      @t2 = ItemTranslation.create :item => @i1, :language => @l2, :name => 'Buch', :desc => 'Literatur'
+    end
+
+    describe "with a nil language_code" do
+
+      it "should return nil" do
+        @i1.name(nil).should be_nil
+      end
+
+    end
+
+    describe "with a non existent language_code" do
+
+      describe "passed as Symbol" do
+
+        it "should return nil" do
+          @i1.name(:it).should be_nil
+        end
+
+      end
+
+      describe "passed as String" do
+
+        it "should return nil" do
+          @i1.name('it').should be_nil
+        end
+
+      end
+
+    end
+
+    describe "with an existing language_code" do
+
+      describe "passed as Symbol" do
+
+        it "should return the translated property" do
+          @i1.name(:en_US).should == 'Book'
+          @i1.desc(:en_US).should == 'Literature'
+          @i1.name(:de_AT).should == 'Buch'
+          @i1.desc(:de_AT).should == 'Literatur'
+        end
+
+      end
+
+      describe "passed as String" do
+
+        it "should return the translated property" do
+          @i1.name('en_US').should == 'Book'
+          @i1.desc('en_US').should == 'Literature'
+          @i1.name('de_AT').should == 'Buch'
+          @i1.desc('de_AT').should == 'Literatur'
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/unit/is_localizable_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "is_localizable with no options" do
+
+  before :each do
+    @i = Item.create
+    @l = Language.create :code => 'en', :name => 'English'
+    @t = ItemTranslation.new :item => @i, :language => @l
+  end
+
+  it "should belong_to a resource" do
+    @t.respond_to?(:item).should == true
+    @t.item.should be_instance_of(Item)
+  end
+
+  it "should belong_to a language" do
+    @t.respond_to?(:language).should == true
+    @t.language.should be_instance_of(Language)
+    @t.language.code.should == 'en'
+    @t.language.name.should == 'English'
+  end
+
+  it "should store properties defined inside the block in the translations resource" do
+    @t.respond_to?(:name).should == true
+    @t.respond_to?(:desc).should == true
+  end
+
+end