babylonia 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a13bf3ea4fe0951e8ee79c6a22787739541c1225
-  data.tar.gz: f92431777d5a4df6fb6068ec6c4fbd37a5703d37
+  metadata.gz: 7ec84f550c2f0845d6b9a2b16ede6c04dcd8db75
+  data.tar.gz: e181bce61c3a830c95017a9464577a602a3917e9
 SHA512:
-  metadata.gz: e61ded2cb171b09824548fb281b768ae98d6a8289618613607cd37af950fb7876ed8046ece7cbe6f5c2c87ee2a70ef8ebc1094a447b07e9c706af395800d1257
-  data.tar.gz: 3d434f2287d4e7da7c80af4815fc00a3faae7f866c39b0b3ad079fb4c7dd5a077d023094fb486905370cd5e723b248a84abbdb83497c8979f9116534c68959aa
+  metadata.gz: bf514ab66051cf4c21a6068df9c2dba0bd6eeb41acddf838a32f03d4aae9a3ed6df0e990d05efab0560ecc09abe74a6f7c62006958edd3c458d9d8e011ea3346
+  data.tar.gz: cdb741ec672ca3f50c4072193c1d392ff9240a5a8fda1e9d44ced1001dbbd84b1c383cd518a0eaf438081ab23c32801363ef5a2cde7623efadd889bfbbf6e996

data/.gitignore

@@ -1,3 +1,4 @@
+Gemfile.lock
 *.gem
 *.rbc
 .bundle

data/.ruby-gemset

@@ -0,0 +1 @@
+babylonia

data/.ruby-version

@@ -0,0 +1 @@
+2.0

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - rbx-19mode

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 gemspec
 
 group :development do
+  gem "rake"
   gem "yard",       ">= 0.7.4"
   gem "bundler",    ">= 1.0.0"
 end

data/Rakefile

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.require(:default, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => :test
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/lib/babylonia/class_methods.rb

@@ -1,13 +1,44 @@
 require 'yaml'
 require 'i18n'
 
+# Let your users translate their content into their languages without additional tables or columns in your tables
+# @author Beat Richartz
+# @version 0.0.2
+# @since 0.0.1
+#
 module Babylonia
+  
+  # Class methods to extend a class with in order to make it able to handle translatable attributes
+  #
   module ClassMethods
     
+    private
+
+    def add_to_handled_babylonian_fields data
+      instance_variable_set(:@handled_babylonian_fields, (instance_variable_get(:@handled_babylonian_fields) || []) + data.map(&:to_sym))
+    end
+  
+    public
+    # Store all handled fields in a class instance variable
+    #
+    def handled_babylonian_fields
+      instance_variable_get(:@handled_babylonian_fields) || instance_variable_set(:@handled_babylonian_fields, [])
+    end
+    # Main class method ob Babylonia. Use to make attributes translatable
+    # @param [Symbol] fields the attributes to translate
+    # @param [Hash] options The options for translation
+    # @option [Symbol, Proc, String] locale The current locale - can be either a symbol that will be sent to the instance, a locale symbol that is included in available_locales or a proc that will get called with the instance and the attribute name. Defaults to I18n.locale at the time of use
+    # @option [Symbol, Proc, String] default_locale The fallback / default locale - can be either a symbol that will be sent to the instance, a locale symbol that is included in available_locales, a proc that will get called with the instance and the attribute name
+    # @option [Symbol, Proc, Array] available_locales The available locales - can be either a symbol that will be sent to the instance, a proc that will get called with the instance and the attribute name, or an Array of symbols of available locales. Defaults to I18n.available_locales at the time of use.
+    # @option [Boolean] fallback Wheter to fallback to the default locale or not
+    # @option [String] placeholder The placeholder to use for missing translations
+    #
     def build_babylonian_tower_on(*fields)
       babylonian_options = fields.last.is_a?(Hash) ? fields.pop : {}
+      add_to_handled_babylonian_fields fields
       babylonian_options[:locale]          ||= lambda { |r, f| I18n.locale }
       babylonian_options[:default_locale]  ||= lambda { |r, f| I18n.default_locale }
+      babylonian_options[:available_locales] ||= lambda { |r, f| I18n.available_locales }
       babylonian_options[:fallback]        = true if babylonian_options[:fallback].nil?
       
       fields.each do |field|
@@ -43,6 +74,24 @@ module Babylonia
           send(:"#{field}_hash").keys
         end
         
+        define_method :has_translated_attribute? do |attr|
+          self.class.handled_babylonian_fields.include?(attr.to_sym)
+        end
+        
+        # Return if a translation in the language is stored for the field
+        # @return [Boolean] True if a translation is stored
+        #
+        define_method :"#{field}_has_locale?" do |locale|
+          send(:"#{field}_languages").include?(locale.to_sym)
+        end
+        
+        # Return if a locale is theoretically available for the field
+        # @return [Boolean] True if the language is available
+        #
+        define_method :"#{field}_has_available_locale?" do |locale|
+          evaluate_babylonian_option!(:available_locales, field).include?(locale.to_sym)
+        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
@@ -58,6 +107,7 @@ module Babylonia
           if data.is_a?(String)
             current_hash.merge! evaluate_babylonian_option!(:locale, field) => data
           elsif data.is_a?(Hash)
+            data.delete_if{|k,v| !send(:"#{field}_has_available_locale?", k) }
             current_hash.merge! data
           end
           
@@ -67,13 +117,22 @@ module Babylonia
         alias_method :"#{field}=", :"#{field}_translated="
       end
       
-      define_method :evaluate_babylonian_option! do |option, field|
+      # Define method missing to be able to access a language directly
+      define_method :method_missing do |meth, *args, &block|
+        if (m = meth.to_s.match(/\A([^_]+)_(\w+)(=)?\z/).to_a[1..3]) && has_translated_attribute?(m[0]) && send(:"#{m[0]}_has_available_locale?", m[1])
+          send(m[0] + m[2].to_s, m[2] ? {m[1].to_sym => args.first} : m[1].to_sym)
+        else
+          super(meth, *args, &block)
+        end
+      end
+      
+      define_method :evaluate_babylonian_option! do |option, field, recursion=false|
         options = self.class.instance_variable_get :"@babylonian_options_for_#{field}"
 
         o = options[option]
-        if o.is_a? Proc
+        if o.is_a?(Proc)
           o.call self, field
-        elsif o.is_a? Symbol
+        elsif o.is_a?(Symbol) && (recursion || !evaluate_babylonian_option!(:available_locales, field, true).include?(o))
           send o
         else
           o

data/lib/babylonia/version.rb

@@ -1,3 +1,5 @@
 module Babylonia
-  VERSION = '0.0.2'
+  # The current gem version
+  #
+  VERSION = '0.0.3'
 end

data/spec/babylonia/class_methods_spec.rb

@@ -8,7 +8,7 @@ describe Babylonia::ClassMethods do
     attr_accessor :marshes, :grasslands, :desert, :sky
     
     build_babylonian_tower_on :marshes
-    build_babylonian_tower_on :grasslands, locales: %i(pi de en), locale: :architects_tongue, default_locale: lambda {|r, f| r.builders_tongue || :en }
+    build_babylonian_tower_on :grasslands, available_locales: [:pi, :de, :en, :it], locale: :architects_tongue, default_locale: lambda {|r, f| r.builders_tongue || :en }
     build_babylonian_tower_on :desert, :sky, fallback: false, placeholder: lambda {|r, field| "<span class='missing translation'>Translation missing for " + field.to_s + "</span>"}
   
     def architects_tongue
@@ -23,7 +23,7 @@ describe Babylonia::ClassMethods do
   context "without options" do
     subject { BabylonianFields.new }
     before(:each) do
-      I18n.stub locale: :en, default_locale: :de
+      I18n.stub locale: :en, default_locale: :de, available_locales: [:de, :en, :it]
     end
     
     describe "#marshes" do
@@ -72,6 +72,50 @@ describe Babylonia::ClassMethods do
         end
       end
     end
+    describe "methods via method missing" do
+      context "getters" do
+        context "with the missing method matching the pattern FIELD_LANGUAGE" do
+          let(:meth) { :marshes_en }
+          it "should call the attribute method with an argument" do
+            subject.should_receive(:marshes).with(:en).once
+            subject.send(meth)
+          end
+        end
+        context "with the missing method not matching the pattern" do
+          let(:meth) { :marshes_something_else_entirely }
+          it "should raise Method Missing" do
+            lambda { subject.send(meth) }.should raise_error(NoMethodError)
+          end
+        end
+        context "with the missing method matching the pattern but an unavailable language" do
+          let(:meth) { :marshes_he }
+          it "should raise Method Missing" do
+            lambda { subject.send(meth) }.should raise_error(NoMethodError)
+          end
+        end
+      end
+      context "setters" do
+        context "with the missing method matching the pattern FIELD_LANGUAGE=" do
+          let(:meth) { :marshes_en= }
+          it "should call the attribute method with an argument" do
+            subject.should_receive(:marshes=).with(en: 'DATA').once
+            subject.send(meth, 'DATA')
+          end
+        end
+        context "with the missing method not matching the pattern" do
+          let(:meth) { :marshes_something_else_entirely }
+          it "should raise Method Missing" do
+            lambda { subject.send(meth) }.should raise_error(NoMethodError)
+          end
+        end
+        context "with the missing method matching the pattern but an unavailable language" do
+          let(:meth) { :marshes_he }
+          it "should raise Method Missing" do
+            lambda { subject.send(meth) }.should raise_error(NoMethodError)
+          end
+        end
+      end
+    end
     describe "marshes=" do
       context "with no existing data" do
         context "with a string" do
@@ -126,7 +170,7 @@ describe Babylonia::ClassMethods do
         subject.marshes_raw = "---\n:it: SOME ITALIAN\n:en: SOME ENGLISH\n:de: SOME DEUTSCH\n"
       end
       it "should return the translated languages of the field" do
-        subject.marshes_languages.sort.should == %i(de en it)
+        subject.marshes_languages.sort.should == [:de, :en, :it]
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: babylonia
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Beat Richartz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -47,11 +47,13 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.rdoc
+- Rakefile
 - babylonia.gemspec
 - lib/babylonia.rb
 - lib/babylonia/class_methods.rb

data/Gemfile.lock

@@ -1,29 +0,0 @@
-PATH
-  remote: .
-  specs:
-    babylonia (0.0.1)
-      i18n (>= 0.5.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    i18n (0.6.5)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    yard (0.8.7.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  babylonia!
-  bundler (>= 1.0.0)
-  rspec
-  yard (>= 0.7.4)