snusnu-dm-is-localizable 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,3 +1,42 @@
+[59dd665 | Mon May 18 17:23:50 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * Version bump to 0.0.7
+
+[845b6f0 | Mon May 18 16:44:16 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * more specs for the generated property translation readers
+
+[30990da | Mon May 18 16:31:07 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * fixed README
+
+[e8c9981 | Mon May 18 16:25:46 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * added readers that return the property translated to the target language.
+
+    If the property :name is declared to be localizable for class Item,
+    and there is a ItemTranslation for 'en-US', you're able to call
+    
+      * i.name(:en_US)
+    
+    on an instance of Item named i
+
+[0981aa8 | Mon May 18 16:10:25 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * README cosmetics
+
+[f8993ae | Mon May 18 16:07:00 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * added localizable_properties class level API
+
+[9bace64 | Mon May 18 15:52:23 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * updated README to reflect latest API addition
+
+[4a43df6 | Mon May 18 15:43:52 UTC 2009] snusnu <gamsnjaga@gmail.com>
+
+ * stripped whitespace, updated changelog and regenerated gemspec
+
 [82db7fd | Mon May 18 15:42:50 UTC 2009] snusnu <gamsnjaga@gmail.com>
 
  * Version bump to 0.0.6

data/README.textile

@@ -68,7 +68,13 @@ end
 
 The above @Item@ model will define and thus be able to @DataMapper.auto_migrate!@ the @ItemTranslation@ model. The _naming convention_ used here is @"#{ClassToBeLocalized.name}Translation"@.
 
-Preliminary support for changing this is available by using the @:class_name@ option like so: @DataMapper::Model.is :localized, :class_name => 'ItemLocalization'@. However, this currently not yet specced.
+Preliminary support for changing this is available by using the @:class_name@ option like so (note that this isn't specced yet).
+
+<pre>
+<code>
+@DataMapper::Model.is :localized, :class_name => 'ItemLocalization'@
+</code>
+</pre>
 
 <pre>
 <code>
@@ -138,6 +144,16 @@ class Item
     nr_of_available_languages * all.size == translation_class.all.size
   end
   
+  # returns a list of symbols reflecting all localizable property names of this resource
+  def localizable_properties
+    translation_class.properties.map do |p|
+      p.name
+    end.select do |p|
+      # exclude properties that are'nt localizable
+      p != :id && p != :language_id && p != Extlib::Inflection.foreign_key(self.name).to_sym
+    end
+  end
+  
   # ----------------------
   #   instance level API
   # ----------------------
@@ -157,6 +173,26 @@ class Item
     self.class.nr_of_available_languages == translations.size
   end
   
+  # translates the given attribute to the language identified by the given language_code
+  def translate(attribute, language_code)
+    if language = Language[language_code]
+      t = translations.first(:language_id => language.id)
+      t.respond_to?(attribute) ? t.send(attribute) : nil
+    else
+      nil
+    end
+  end
+  
+  # translates the :name property to the given language
+  def name(language_code)
+    translate(:name, language_code)
+  end
+  
+  # translates the :desc property to the given language
+  def desc(language_code)
+    translate(:desc, language_code)
+  end
+  
   
   # TODO
   # more API to support common usecases (and i18n/l10n solutions)

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/dm-is-localizable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-is-localizable}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Gamsjaeger (snusnu)"]

data/lib/dm-is-localizable/is/localizable.rb

@@ -39,9 +39,19 @@ module DataMapper
 
         has n, :languages, :through => remixee
 
-        self.class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        self.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
           alias :translations #{remixee}
-        EOS
+        RUBY
+
+        localizable_properties.each do |property_name|
+          self.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+
+            def #{property_name}(language_code)
+              translate(:#{property_name.to_sym}, language_code)
+            end
+
+          RUBY
+        end
 
       end
 
@@ -62,6 +72,16 @@ module DataMapper
           available_languages.size * all.size == translation_class.all.size
         end
 
+        # returns a list of symbols reflecting all localizable property names of this resource
+        def localizable_properties
+          translation_class.properties.map do |p|
+            p.name
+          end.select do |p|
+            # exclude properties that are'nt localizable
+            p != :id && p != :language_id && p != Extlib::Inflection.foreign_key(self.name).to_sym
+          end
+        end
+
       end
 
       module InstanceMethods
@@ -81,6 +101,7 @@ module DataMapper
           self.class.nr_of_available_languages == translations.size
         end
 
+        # translates the given attribute to the language identified by the given language_code
         def translate(attribute, language_code)
           if language = Language[language_code]
             t = translations.first(:language_id => language.id)

data/spec/unit/class_level_api_spec.rb

@@ -156,4 +156,14 @@ describe "class level API:" do
 
   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

@@ -208,4 +208,43 @@ describe "instance level API:" do
 
   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
+
+      it "should return nil" do
+        @i1.name(:it).should be_nil
+      end
+
+    end
+
+    describe "with an existing language_code" 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: snusnu-dm-is-localizable
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Martin Gamsjaeger (snusnu)