translatable 0.2.4 → 0.3.0

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
-  - 1.9.3
+  - 1.9.3
+bundler_args: --without=debug

data/Gemfile

@@ -1,21 +1,25 @@
 source "http://rubygems.org"
 
 gem "activerecord"
+gem "activesupport", :require => false
 gem "i18n"
 
+group :debug do
+  gem "simplecov", ">= 0.6.0", :platform => :ruby_19
+  gem "debugger", "~> 1.1.3", :platform => :ruby_19
+  gem "ruby-debug", :platform => :ruby_18
+end
+
 group :development do
   gem "yard"
   gem "jeweler", ">= 1.6.0"
-  gem "bundler", ">= 1.0.0"
-  gem "simplecov", ">= 0.6.0", :platform => :ruby_19
-  gem "rcov", ">= 1.0.0", :platform => :ruby_18
+  gem "bundler", ">= 1.2.0"
 end
 
 group :test do
-  gem "test-spec"
-
-  gem "debugger", "~> 1.1.3", :platform => :ruby_19
-  gem 'ruby-debug', :platform => :ruby_18
+  gem "rails"
+  gem "test-unit"
+  gem "shoulda"
 
   gem "database_cleaner"
   gem "sqlite3"

data/Gemfile.lock

@@ -1,6 +1,20 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.1.8)
+      actionpack (= 3.1.8)
+      mail (~> 2.3.3)
+    actionpack (3.1.8)
+      activemodel (= 3.1.8)
+      activesupport (= 3.1.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.6)
+      rack-cache (~> 1.2)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.4)
     activemodel (3.1.8)
       activesupport (= 3.1.8)
       builder (~> 3.0.0)
@@ -10,6 +24,9 @@ GEM
       activesupport (= 3.1.8)
       arel (~> 2.2.3)
       tzinfo (~> 0.3.29)
+    activeresource (3.1.8)
+      activemodel (= 3.1.8)
+      activesupport (= 3.1.8)
     activesupport (3.1.8)
       multi_json (>= 1.0, < 1.3)
     arel (2.2.3)
@@ -23,29 +40,78 @@ GEM
     debugger-linecache (1.1.2)
       debugger-ruby_core_source (>= 1.1.1)
     debugger-ruby_core_source (1.1.3)
+    erubis (2.7.0)
     git (1.2.5)
+    hike (1.2.1)
     i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    json (1.7.5)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
+    mail (2.3.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
     multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.3.6)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.1.8)
+      actionmailer (= 3.1.8)
+      actionpack (= 3.1.8)
+      activerecord (= 3.1.8)
+      activeresource (= 3.1.8)
+      activesupport (= 3.1.8)
+      bundler (~> 1.0)
+      railties (= 3.1.8)
+    railties (3.1.8)
+      actionpack (= 3.1.8)
+      activesupport (= 3.1.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
     rake (0.9.2.2)
     rbx-require-relative (0.0.9)
-    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
     ruby-debug-base (0.10.4)
       linecache (>= 0.3)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.1)
+      activesupport (>= 3.0.0)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
+    sprockets (2.0.4)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
     sqlite3 (1.3.6)
-    test-spec (0.10.0)
+    test-unit (2.5.3)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
     tzinfo (0.3.33)
     yard (0.6.8)
 
@@ -54,14 +120,16 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord
-  bundler (>= 1.0.0)
+  activesupport
+  bundler (>= 1.2.0)
   database_cleaner
   debugger (~> 1.1.3)
   i18n
   jeweler (>= 1.6.0)
-  rcov (>= 1.0.0)
+  rails
   ruby-debug
+  shoulda
   simplecov (>= 0.6.0)
   sqlite3
-  test-spec
+  test-unit
   yard

data/Rakefile

@@ -28,12 +28,16 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
 
 task :default => :test
 
-require 'yard'
-YARD::Rake::YardocTask.new
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  $stderr.puts "Skipping Yard tasks"
+end
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/lib/generators/translatable/model_generator.rb

@@ -0,0 +1,45 @@
+require "translatable/generator_helper"
+
+module Translatable
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      include Translatable::GeneratorHelper
+
+      desc "Creates ActiveRecord model and injects translatable block into it"
+
+      class_option :translated_model, :type => :string, :desc => "Defines the model responsible for translations"
+      class_option :origin,           :type => :string, :desc => "Defines the association name for translation record that deals with origin"
+      class_option :locale,           :type => :string, :desc => "Defines the column for translation record that keeps the locale"
+
+      def create_model
+        self.attributes = attrs
+        parse_attributes!
+        invoke "active_record:model", [class_name], {migration: true, timestamps: true} unless model_exists?
+      end
+
+      # all public methods in here will be run in order
+      def inject_translatable_block
+        inject_into_class model_path, class_name, generate_translatable_block
+      end
+
+      protected
+
+      def generate_translatable_block
+        block = "  translatable do"
+        attributes.each do |attr|
+          block << "\n    translatable :#{attr.name}, :presence => true#, :uniqueness => true"
+        end
+        block << (options[:translated_model].nil? ?
+            "\n    #translatable_model 'Translated#{class_name}'" :
+            "\n    translatable_model '#{options[:translated_model]}'")
+        block << (options[:origin].nil? ?
+            "\n    #translatable_origin :#{singular_table_name}" :
+            "\n    translatable_origin :#{options[:origin]}")
+        block << (options[:locale].nil? ?
+            "\n    #translatable_locale :locale" :
+            "\n    translatable_locale :#{options[:locale]}")
+        block << "\n  end\n"
+      end
+    end
+  end
+end

data/lib/generators/translatable/translation_generator.rb

@@ -0,0 +1,45 @@
+require "translatable/generator_helper"
+
+module Translatable
+  module Generators
+    class TranslationGenerator < Rails::Generators::NamedBase
+      include Translatable::GeneratorHelper
+
+      desc "Creates ActiveRecord for translation dealer"
+
+      class_option :prefix, :type => :string, :default => "translatable", :desc => "Specifies the prefix to used tof translation dealer (Default: translatable)"
+      class_option :origin, :type => :string, :default => "origin",       :desc => "Specifies the association name to be use for origin (Default: origin)"
+      class_option :locale, :type => :string, :default => "locale",       :desc => "Specifies the column to be use for locale (Default: locale)"
+
+      def create_model
+        self.attributes = attrs
+        parse_attributes!
+        invoke "active_record:model", [class_name] + attrs + ["#{options[:origin]}_id:integer:true", "#{options[:locale]}:string"], {migration: true, timestamps: true} unless model_exists?
+      end
+
+      # all public methods in here will be run in order
+      def inject_translatable_block
+        inject_into_class model_path, class_name, generate_translatable_block
+      end
+
+      protected
+
+      def generate_translatable_block
+        block = <<CONTENT
+  # This class deals purely with translations themselves. Hence, any edition of
+  # should be avoided.
+  # In later gem version its existance might not be necessary.
+CONTENT
+        unless attributes.empty?
+          block << "  attr_accessible :#{attributes.map(&:name).join(", :")}\n"
+        end
+        block << "  #attr_protected :#{options[:origin]}_id, :#{options[:locale]}\n"
+        block
+      end
+
+      def file_name
+        "#{options[:prefix].downcase}_#{@file_name}"
+      end
+    end
+  end
+end

data/lib/translatable/active_record.rb

@@ -0,0 +1,254 @@
+require 'active_record'
+require 'i18n'
+
+module Translatable
+  ###
+  # In order to made the model Translatable, an additional fields should
+  # should be added first to it. Here is an example of it might be implemented:
+  # 
+  # Examples:
+  #
+  #   class Author < ActiveRecord::Base
+  #     validates :name, :presence => true
+  #   end
+  #
+  #   class TranslatableNews < ActiveRecord::Base  #
+  #     attr_accessible :title, :content
+  #   end
+  #
+  #   class News < ActiveRecord::Base
+  #
+  #     belongs_to  :author
+  #
+  #     translatable do
+  #       translatable  :title, :presence => true, :uniqueness => true
+  #       translatable  :content, :presence => true
+  #       translatable_model "TranslatedNews"
+  #       translatable_origin :origin_id
+  #     end
+  #
+  #     attr_accessible :author_id, :author
+  #   end
+  #
+  # An example of application:
+  #
+  #   news = News.create :translations_attributes => [{title: "Resent News", content: "That is where the text goes", locale: "en"}]
+  #   news.translations.create title: "Заголовок", content: "Содержание",locale: "ru"
+  #
+  #   news.content
+  #   # => "That is where the text goes"
+  #
+  #   ::I18n.locale = "ru"
+  #   news.content
+  #   # => "Сюди идет текст"
+  #
+  #   ::I18n.locale = "de"
+  #   news.content
+  #   # => nil
+  #
+  #   ::I18n.locale = ::I18n.default_locale
+  #   news.content
+  #   # => "That is where the text goes"
+  #
+  module ActiveRecord
+
+    def translatable
+      extend Translatable::ActiveRecord::ClassMethods
+      include Translatable::ActiveRecord::InstanceMethods
+
+      translatable_define_hash
+      yield
+      translatable_register
+    end
+
+    module ClassMethods
+
+      protected
+
+      ###
+      # Fields that are translatable.
+      # Those fields should be defined in the original model including all the related params.
+      # Examples:
+      #
+      #   translatable_property  :title,    String,   required: true, unique: true
+      #   translatable_property  :content,  Text
+      #
+      # NB! Will raise an error if there was no fields specified
+      #
+      def translatable *args
+        (@translatable[:properties] ||= [])  << args
+      end
+
+      ###
+      # Defines model that will be treated as translation handler.
+      # Model can be defined as String, Symbol or Constant.
+      # Examples:
+      #
+      #   translated_model TranslatedNews
+      #   translated_model "TranslatedNews"
+      #   translated_model :TranslatedNews
+      #
+      # Default: Translatable<ModelName>
+      #
+      def translatable_model model_name
+        @translatable[:model] = translatable_model_prepared model_name
+      end
+
+      ###
+      # Define the key that the translation will be used for belongs_to association,
+      # to communicate with original model
+      # Example:
+      #
+      #   translatable_origin :news
+      #
+      # Default: :origin
+      #
+      def translatable_origin origin_key
+        @translatable[:origin] = translatable_origin_prepared origin_key
+      end
+
+      ###
+      # Will not register the attributes as accessible.
+      # IMPORTANT: Translatable block will be evaluated on the model after it
+      # was loaded, so it will modify certain thing on final version. Hence this thing is needed.
+      # Examples:
+      #
+      #   translatable_attr_protected
+      #
+      # Default: false
+      #
+      def translatable_attr_protected
+        @translatable[:attr_accessible] = false
+      end
+
+      ###
+      # Will not register the attributes as accessible.
+      # IMPORTANT: Translatable block will be evaluated on the model after it
+      # was loaded, so it will modify certain thing on final version. Hence this thing is needed.
+      # Examples:
+      #
+      #   translatable_attr_protected
+      #
+      # Default: false
+      #
+      def translatable_attr_accessible
+        @translatable[:attr_accessible] = true
+      end
+
+      ###
+      # Define the key that the translation will be used for belongs_to association,
+      # to communicate with original model
+      # Example:
+      #
+      #   translatable_origin :language
+      #
+      # Default: :locale
+      #
+      def translatable_locale locale_attr
+        @translatable[:locale] = translatable_locale_prepared locale_attr
+      end
+
+      ###
+      # Returns Model as a constant that deals with translations
+      def translatable_model_prepared model_name = nil
+        model_constant = model_name
+        model_constant ||= "Translatable#{self.name}"
+        model_constant.to_s.constantize
+      end
+
+
+      def translatable_origin_prepared origin_key = nil
+        origin_key || "origin"
+      end
+
+      def translatable_locale_prepared locale = nil
+        locale || "locale"
+      end
+
+      ###
+      # Define hash that contains all the translations
+      def translatable_define_hash
+        @translatable = {}
+      end
+
+      ###
+      # Handles all the registring routine, defining methods,
+      # properties, and everything else
+      def translatable_register
+        raise ArgumentError.new("At least one property should be defined") if [nil, []].include?(@translatable[:properties])
+        [:model,:origin,:locale].each { |hash_key| @translatable[hash_key] ||= send "translatable_#{hash_key}_prepared" }
+
+        translatable_register_properties_for_origin
+        translatable_register_properties_for_translatable
+      end
+
+      ###
+      # Handle the routine to define all th required stuff on the original maodel
+      def translatable_register_properties_for_origin
+        has_many :translations, :class_name => @translatable[:model].name, :foreign_key => :"#{@translatable[:origin]}_id"
+        accepts_nested_attributes_for :translations
+        attr_accessible :translations_attributes
+
+        @translatable[:properties].each do |p|
+          accessible_as = (p.last.delete(:as) || p.first rescue p.first)
+          self.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{accessible_as}
+              current_translation.try(:#{p.first})
+            end
+          RUBY
+        end
+
+        self.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def translatable_set_current(locale = ::I18n.locale)
+            locale = locale.to_s
+            @current_translation = if translations.loaded?
+              translations.select { |t| t.send(:"#{@translatable[:locale]}") == locale }
+            else
+              translations.where(:"#{@translatable[:locale]}" => locale)
+            end.first
+          end
+          alias_method :set_current_translation, :translatable_set_current
+        RUBY
+      end
+
+      def translatable_register_properties_for_translatable
+        @translatable[:model].module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          validates :#{@translatable[:locale]}, :presence => true
+          validates :#{@translatable[:locale]}, :format => { :with => /[a-z]{2}/}, :if => Proc.new {|record| !record.#{@translatable[:locale]}.blank? }
+          validates :#{@translatable[:locale]}, :uniqueness => { :scope => :#{@translatable[:origin]}_id }
+
+          belongs_to :#{@translatable[:origin]}, :class_name => "#{self.name}"
+        RUBY
+
+        unless @translatable[:attr_accessible].nil?
+          @translatable[:model].module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            attr_#{!!@translatable[:attr_accessible] ? "accessible" : "protected" } :#{@translatable[:locale]}, :#{@translatable[:origin]}_id
+          RUBY
+        end
+
+        @translatable[:properties].each do |p|
+          if p.size > 1
+            @translatable[:model].module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              validates :#{p.first}, #{p.last.inspect}
+            RUBY
+          end
+        end
+      end
+    end
+
+    module InstanceMethods
+      def current_translation
+        update_current_translation unless @translatable_locale
+        @current_translation
+      end
+
+      def update_current_translation
+        translatable_set_current(@translatable_locale = ::I18n.locale.to_s)
+      end
+
+      def other_translations
+        translations - [current_translation]
+      end
+    end
+  end
+end

data/lib/translatable/engine.rb

@@ -0,0 +1,6 @@
+require 'rails/engine'
+
+module Translatable
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/translatable/generator_helper.rb

@@ -0,0 +1,20 @@
+module Translatable
+  module GeneratorHelper
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :attributes
+        argument :attrs, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+      end
+    end
+
+    protected
+
+    def model_path
+      File.join(destination_root, 'app/models', class_path, "#{file_name}.rb")
+    end
+
+    def model_exists?
+      File.exists?(model_path)
+    end
+  end
+end