babylonia 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 073d7b1426c878adc6e781b9f92c312ffc839b24
-  data.tar.gz: 1a2e6c6ee29702aa1a4e2dce7cd9dc0532d1dd52
+  metadata.gz: a13bf3ea4fe0951e8ee79c6a22787739541c1225
+  data.tar.gz: f92431777d5a4df6fb6068ec6c4fbd37a5703d37
 SHA512:
-  metadata.gz: b100a52c1ec74ee94b59389474f0e41b5518d379f10df37344d244edceeda4cc7cda92f925ad8338d888a1bea7f59f4418bcf6bcc85393028feac458d38c9d22
-  data.tar.gz: 4698094b8e16d962b870b02b37c8b8fad5fba9d928a77456120bfe3d2d155a4415a60bdb5622136ca71daa5b524455f89eeeeebfbaa36452a4feef23e2ae1417
+  metadata.gz: e61ded2cb171b09824548fb281b768ae98d6a8289618613607cd37af950fb7876ed8046ece7cbe6f5c2c87ee2a70ef8ebc1094a447b07e9c706af395800d1257
+  data.tar.gz: 3d434f2287d4e7da7c80af4815fc00a3faae7f866c39b0b3ad079fb4c7dd5a077d023094fb486905370cd5e723b248a84abbdb83497c8979f9116534c68959aa

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - rbx-20mode
+  - jruby-19mode
+  - jruby-20mode
+  
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    babylonia (0.1.0)
+    babylonia (0.0.1)
       i18n (>= 0.5.0)
 
 GEM

data/lib/babylonia/class_methods.rb

@@ -3,16 +3,22 @@ require 'i18n'
 
 module Babylonia
   module ClassMethods
+    
     def build_babylonian_tower_on(*fields)
       babylonian_options = fields.last.is_a?(Hash) ? fields.pop : {}
       babylonian_options[:locale]          ||= lambda { |r, f| I18n.locale }
       babylonian_options[:default_locale]  ||= lambda { |r, f| I18n.default_locale }
       babylonian_options[:fallback]        = true if babylonian_options[:fallback].nil?
       
-      # loop through fields to define methods such as "name" and "description"
       fields.each do |field|
         instance_variable_set(:"@babylonian_options_for_#{field}", babylonian_options)
         
+        # Alias method chain the field to a translated value
+        # @param [Symbol] locale Pass a locale to get the field translation in this specific locale
+        # @return [String, NilClass] Either the string with the translation, the fallback, the placeholder or nil
+        # @example Call a field in italian
+        #   your_instance.field(:it) #=> "Translation" 
+        #
         define_method :"#{field}_translated" do |locale=nil|
           field_hash    = send(:"#{field}_hash")
           translation   = field_hash[locale || evaluate_babylonian_option!(:locale, field)]
@@ -22,15 +28,30 @@ module Babylonia
         alias_method :"#{field}_raw", field
         alias_method field, :"#{field}_translated"
         
+        # Return the translated values as a hash
+        # @return [Hash] The hash with all the translations stored in the field
+        #
         define_method :"#{field}_hash" do
           field_content = send(:"#{field}_raw")
           field_content.is_a?(String) ? YAML.load(field_content) : {}
         end
         
+        # Return all the languages stored
+        # @return [Array] An array containing all languages stored in the field
+        #
         define_method :"#{field}_languages" do
           send(:"#{field}_hash").keys
         end
         
+        # Set the field to a value. This either takes a string or a hash
+        # If given a String, the current locale is set to this value
+        # If given a Hash, the hash is merged into the current translation hash, and empty values are purged
+        # @param [String, Hash] data The data to set either the current language translation or all translations to
+        # @example Set the translation for the current locale
+        #   your_object.field = "TRANSLATION"
+        # @example Set the translation and delete italian
+        #   your_object.field = {de: 'DEUTSCH', it: ''}
+        #
         define_method :"#{field}_translated=" do |data|
           current_hash = send(:"#{field}_hash")
           
@@ -40,7 +61,7 @@ module Babylonia
             current_hash.merge! data
           end
           
-          send(:"#{field}_raw=", YAML.dump(current_hash))
+          send(:"#{field}_raw=", YAML.dump(current_hash.delete_if{|k,v| v.nil? || v.empty? }))
         end
         alias_method :"#{field}_raw=", :"#{field}="
         alias_method :"#{field}=", :"#{field}_translated="

data/lib/babylonia/version.rb

@@ -1,3 +1,3 @@
 module Babylonia
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/babylonia/class_methods_spec.rb

@@ -235,6 +235,32 @@ describe Babylonia::ClassMethods do
             subject.grasslands(:it).should == 'SOME ITALIAN'
           end
         end
+        context "deleting a value" do
+          context "with a string" do
+            it "should be deleted" do
+              subject.grasslands = ''
+              subject.grasslands.should be_nil
+            end
+          end
+          context "with nil" do
+            it "should be deleted" do
+              subject.grasslands = nil
+              subject.grasslands.should be_nil
+            end 
+          end
+          context "with a hash containing an empty string" do
+            it "should be deleted" do
+              subject.grasslands = {it: ''}
+              subject.grasslands(:it).should be_nil
+            end 
+          end
+          context "with a hash containing nil" do
+            it "should be deleted" do
+              subject.grasslands = {it: nil}
+              subject.grasslands(:it).should be_nil
+            end 
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: babylonia
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Beat Richartz
@@ -47,10 +47,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.md
 - README.rdoc
 - babylonia.gemspec
 - lib/babylonia.rb

data/README.md

@@ -1,4 +0,0 @@
-babylonia
-=========
-
-User-side translation for ruby apps, persistence is yours