sequel-localize 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+#specific files
+
+# dirs
+.bundle
+bin
+
+# tempfiles
+*[~#]
+.#*
+*_flymake*
+/.emacs-project
+/.irbrc
+*_out
+*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-localize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    sequel-localize (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.2)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sequel (3.46.0)
+    sqlite3 (1.3.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rspec
+  sequel
+  sequel-localize!
+  sqlite3

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonas von Andrian
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1,8 @@
+* [5/5] Basis
+- [X] infer translated fields from table and only use plugin :localize
+- [X] create setters
+- [X] spec
+  - [X] setters and getters work
+  - [X] validate translations
+- [X] validate translations
+- [X] ensure table inheritance works

data/lib/sequel/localize/language.rb

@@ -0,0 +1,27 @@
+class Language < Sequel::Model
+  plugin :validation_helpers
+  def validate
+    super
+    validates_presence [:code, :name]
+    validates_unique :code
+    # locale string like 'en'
+    validates_format /^[a-z]{2}$/, :code
+  end
+
+  def after_create
+    Sequel::Plugins::Localize.localized_models.each do |m|
+      m.add_translation_accessors code
+    end
+  end
+
+  class << self
+    def [](code)
+      if code.respond_to? :to_sym
+        code = code.to_sym
+        (@cache ||= {})[code] ||= super(:code => code.to_s) || create(:code => code, :name => code)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/sequel/localize/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module Localize
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/sequel/localize.rb

@@ -0,0 +1,123 @@
+require 'sequel/localize/language'
+require "sequel/localize/version"
+
+module Sequel
+  module Plugins
+    module Localize
+      def self.configure(model, opts={})
+        model._init_translations
+        localized_models << model
+      end
+      def self.localized_models
+        @localized_models ||= []
+      end
+      module ClassMethods
+        def _init_translations
+          @@_lowercase_name = underscore(demodulize(self.to_s))
+          create_translation_class
+          create_translated_field_methods
+          create_translation_accessors
+        end
+        def localized_fields
+          @@localized_fields ||= translation_class.columns - [translation_class.primary_key, :"#{@@_lowercase_name}_id", :language_id]
+        end
+        def translation_class
+          @@translation_class ||= Object.const_get("#{self}Translation")
+        end
+        def add_translation_accessors(code)
+          create_translation_writer(code)
+          create_translation_reader(code)
+        end
+        
+        protected
+        
+        def create_translation_class
+          one_to_many :"#{@@_lowercase_name}_translations"
+          alias_method :translations_dataset, :"#{@@_lowercase_name}_translations_dataset"
+          alias_method :translations, :"#{@@_lowercase_name}_translations"
+          alias_method :add_translation, :"add_#{@@_lowercase_name}_translation"
+          self.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+          class ::#{self}Translation < Sequel::Model
+            many_to_one :#{@@_lowercase_name}
+            many_to_one :language
+          end
+          RUBY
+        end
+        def create_translated_field_methods
+          localized_fields.each do |field_name|
+            self.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+            def #{field_name}(locale = I18n.site_locale)
+              (translation(locale) || translation(default_locale)).#{field_name}
+            end
+            def #{field_name}=(value, locale)
+              translation(locale).#{field_name}= value
+            end
+            RUBY
+          end
+        end
+        def create_translation_accessors
+          Language.all.each do |l|
+            create_translation_writer(l.code)
+            create_translation_reader(l.code)
+          end
+        end
+
+        def create_translation_writer(locale)
+          self.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+          def #{locale}=(attributes = {})
+            attributes.each do |method, value|
+              modified!
+              self.send :"\#{method}=", value, :#{locale}
+            end
+          end
+          RUBY
+        end
+
+        def create_translation_reader(locale)
+          self.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+          def #{locale}
+            translation :#{locale}
+          end
+          RUBY
+        end
+      end
+      module InstanceMethods
+        def after_save
+          each_translation do |locale, translation|
+            if translation.pk
+              translation.save
+            else
+              add_translation(translation)
+            end
+          end
+        end
+
+        def default_locale
+          'de'
+        end
+
+        def translation(locale)
+          l = Language[locale]
+          (@_translations ||= {})[locale.to_sym] ||=
+            if pk
+              translations_dataset.where(:language_id => l.id).first 
+            end || self.class.translation_class.new(:language_id => l.id)
+        end
+
+        def validate
+          super
+          each_translation do |locale, translation|
+            errors.add(locale, translation.errors) unless translation.valid?
+          end
+        end
+
+        private
+
+        def each_translation(&block)
+          return unless @_translations
+          @_translations.each(&block)
+        end
+      end
+    end
+  end
+end

data/sequel-localize.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel/localize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-localize"
+  spec.version       = Sequel::Plugins::Localize::VERSION
+  spec.authors       = ["Jonas von Andrian"]
+  spec.email         = ["jvadev@gmail.com"]
+  spec.description   = %q{Localize plugin for Sequel}
+  spec.summary       = %q{Adds support to localize Sequel::Model. Uses one tabel per model}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "rspec"
+end

data/spec/localize_spec.rb

@@ -0,0 +1,87 @@
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe 'description' do
+  
+  it 'should create translations' do
+    a = create_post
+    a.title(:de).should == 'de'
+    a.title('en').should == 'en'
+  end
+
+  it 'should hold translations before save' do
+    x = new_post
+    x.title(:de).should == 'de'
+    x.title('en').should == 'en'
+  end
+
+  it 'should update translations' do
+    a = create_post
+    a.update(:en => {:title => 'en up'}, :de => {:title => 'de up'})
+    a.title(:de).should == 'de up'
+    a.title(:en).should == 'en up'
+  end
+
+  it 'should add error if attribute missing' do
+    a = Post.new(:de => {:title => ''}, :uri => '')
+    a.save
+    a.errors.on(:uri).should be_true
+    a.errors.on(:de).should be_true
+    a.errors.on(:de).first.on(:title).should be_true
+    a.errors.on(:en).should be_false
+
+    a = Post.new('de' => {:title => ''}, 'en' => {:subtitle => 'asd'}, :uri => '')
+    a.save
+    a.errors.on(:uri).should be_true
+    a.errors.on(:de).should be_true
+    a.errors.on(:de).first.on(:title).should be_true
+    a.errors.on(:en).should be_true
+    a.errors.on(:en).first.on(:title).should be_true
+  end
+  
+  it 'should add error if a new translation is not valid' do
+    a = Post.new(:uri => 'test',
+                 :de => {
+                   :title => 'de'
+                 })
+    a.save.should be_true
+    a.update(:en => { :subtitle => 'bla'}).should be(false)
+
+    a.update(:en => {:title => 'en up'}, :de => { :title => '' }).should be(false)
+  end
+
+  it 'should work with single table inheritance' do
+    a = SpecialPost.new(:uri => 'test',
+                 :de => {
+                   :title => 'de'
+                 })
+    a.save.should be_true
+    a.title(:de).should == 'de'
+    SpecialPost.localized_fields.should == Post.localized_fields
+  end
+  
+  it 'should create new setters on the fly' do
+    l = Language[:xy]
+    a = Post.new(:uri => 'test',
+                 :xy => {
+                   :title => 'xy'
+                 })
+    a.title(:xy).should == 'xy'
+    a.xy.should be_true
+  end
+  
+  def new_post
+    Post.new(:uri => 'test',
+             :de => {
+               :title => 'de'
+             },
+             :en => {
+               :title => 'en'
+             }
+             )
+  end
+  def create_post
+    post = new_post
+    post.save.should be_true
+    post
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--backtrace
+

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+
+require 'sequel'
+require 'rspec'
+require 'rspec/autorun'
+
+DB = Sequel.sqlite
+Sequel::Model.plugin :validation_helpers
+Sequel::Model.raise_on_save_failure = false
+
+DB.create_table :languages do
+  primary_key :id
+  String :code
+  String :name
+end
+
+require 'sequel/localize'
+
+require 'logger'
+DB.logger = Logger.new('db.log')
+
+require 'support/classes'
+#require 'shared_specs'
+

data/spec/support/classes.rb

@@ -0,0 +1,38 @@
+DB.create_table :post_translations do
+  primary_key :id
+  String :title
+  String :subtitle
+  integer :language_id
+  integer :post_id
+end
+
+DB.create_table :posts do
+  primary_key :id
+  String :uri
+  String :type
+end
+
+DB[:languages] << {"name"=>"en", "code" => 'en'}
+DB[:languages] << {"name"=>"de", "code" => 'de'}
+
+
+class Post < Sequel::Model
+  plugin :localize
+  plugin :single_table_inheritance, :type
+  
+  def validate
+    super
+    validates_presence [:uri]
+  end
+end
+
+class SpecialPost < Post
+  
+end
+
+class PostTranslation < Sequel::Model
+  def validate
+    super
+    validates_presence [:title]
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: sequel-localize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonas von Andrian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Localize plugin for Sequel
+email:
+- jvadev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- TODO
+- lib/sequel/localize.rb
+- lib/sequel/localize/language.rb
+- lib/sequel/localize/version.rb
+- sequel-localize.gemspec
+- spec/localize_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/classes.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3081936343475499294
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3081936343475499294
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Adds support to localize Sequel::Model. Uses one tabel per model
+test_files:
+- spec/localize_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/classes.rb