snusnu-dm-is-localizable 0.0.5

data/TODO

@@ -0,0 +1,2 @@
+* Add accessors for the localized properties in the localizable resource
+* Think about validation and null constraints

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/dm-is-localizable.gemspec

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-is-localizable}
+  s.version = "0.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Gamsjaeger (snusnu)"]
+  s.date = %q{2009-05-18}
+  s.email = %q{gamsnjaga@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "dm-is-localizable.gemspec",
+     "features/dm-is-localizable.feature",
+     "features/step_definitions/dm-is-localizable_steps.rb",
+     "features/support/env.rb",
+     "lib/dm-is-localizable.rb",
+     "lib/dm-is-localizable/is/localizable.rb",
+     "lib/dm-is-localizable/storage/language.rb",
+     "lib/dm-is-localizable/storage/translation.rb",
+     "spec/fixtures/item.rb",
+     "spec/lib/rspec_tmbundle_support.rb",
+     "spec/shared/shared_examples_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/unit/auto_migrate_spec.rb",
+     "spec/unit/class_level_api_spec.rb",
+     "spec/unit/instance_level_api_spec.rb",
+     "spec/unit/is_localizable_spec.rb",
+     "spec/unit/language_spec.rb",
+     "spec/unit/translation_spec.rb",
+     "tasks/changelog.rb",
+     "tasks/whitespace.rb"
+  ]
+  s.homepage = %q{http://github.com/snusnu/dm-is-localizable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Datamapper support for localization of content in multilanguage applications}
+  s.test_files = [
+    "spec/fixtures/item.rb",
+     "spec/lib/rspec_tmbundle_support.rb",
+     "spec/shared/shared_examples_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/auto_migrate_spec.rb",
+     "spec/unit/class_level_api_spec.rb",
+     "spec/unit/instance_level_api_spec.rb",
+     "spec/unit/is_localizable_spec.rb",
+     "spec/unit/language_spec.rb",
+     "spec/unit/translation_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.9.11"])
+      s.add_runtime_dependency(%q<dm-is-remixable>, [">= 0.9.11"])
+      s.add_runtime_dependency(%q<dm-validations>, [">= 0.9.11"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0.9.11"])
+      s.add_dependency(%q<dm-is-remixable>, [">= 0.9.11"])
+      s.add_dependency(%q<dm-validations>, [">= 0.9.11"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0.9.11"])
+    s.add_dependency(%q<dm-is-remixable>, [">= 0.9.11"])
+    s.add_dependency(%q<dm-validations>, [">= 0.9.11"])
+  end
+end

data/features/dm-is-localizable.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'dm-is-localizable'
+
+require 'spec/expectations'

data/lib/dm-is-localizable.rb

@@ -0,0 +1,8 @@
+# Require plugin-files
+dir = Pathname(__FILE__).dirname.expand_path / 'dm-is-localizable'
+require dir / 'is' / 'localizable'
+require dir / 'storage' / 'language'
+require dir / 'storage' / 'translation'
+
+# Include the plugin in Model
+DataMapper::Model.append_extensions DataMapper::Is::Localizable

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

@@ -0,0 +1,89 @@
+module DataMapper
+  module Is
+
+    module Localizable
+
+
+      def is_localizable(options = {}, &block)
+
+        extend  ClassMethods
+        include InstanceMethods
+
+        options = {
+          :as         => nil,
+          :class_name => "#{self}Translation"
+        }.merge(options)
+
+        remixer_fk = Extlib::Inflection.foreign_key(self.name).to_sym
+        remixer    = remixer_fk.to_s.gsub('_id', '').to_sym
+        remixee    = Extlib::Inflection.tableize(options[:class_name]).to_sym
+
+        remix n, Translation, :as => options[:as], :class_name => options[:class_name]
+
+        @translation_class = Extlib::Inflection.constantize(options[:class_name])
+        class_inheritable_accessor :translation_class
+
+        enhance :translation, @translation_class do
+
+          property remixer_fk,   Integer, :nullable => false, :unique_index => :unique_languages
+          property :language_id, Integer, :nullable => false, :unique_index => :unique_languages
+
+          belongs_to remixer
+          belongs_to :language
+
+          class_eval &block
+
+          validates_is_unique :language_id, :scope => remixer_fk
+
+        end
+
+        has n, :languages, :through => remixee
+
+        self.class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          alias :translations #{remixee}
+        EOS
+
+      end
+
+      module ClassMethods
+
+        # list all available languages for the localizable model
+        def available_languages
+          Language.all :id => translation_class.all.map { |t| t.language_id }.uniq
+        end
+
+        # the number of all available languages for the localizable model
+        def nr_of_available_languages
+          available_languages.size
+        end
+
+        # checks if all localizable resources are translated in all available languages
+        def translations_complete?
+          available_languages.size * all.size == translation_class.all.size
+        end
+
+      end
+
+      module InstanceMethods
+
+        # list all available languages for this instance
+        def available_languages
+          Language.all :id => translations.map { |t| t.language_id }.uniq
+        end
+
+        # the number of all available languages for this instance
+        def nr_of_available_languages
+          available_languages.size
+        end
+
+        # checks if this instance is translated into all available languages for this model
+        def translations_complete?
+          self.class.nr_of_available_languages == translations.size
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+class Language
+
+  include DataMapper::Resource
+
+  # properties
+
+  property :id, Serial
+
+  property :code, String, :nullable => false, :unique => true, :unique_index => true
+  property :name, String, :nullable => false
+
+  # locale string like 'en-US'
+  validates_format :code, :with => /^[a-z]{2}-[A-Z]{2}$/
+
+end

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

@@ -0,0 +1,18 @@
+module DataMapper
+  module Is
+    module Localizable
+
+      module Translation
+
+        include DataMapper::Resource
+
+        is :remixable
+
+        property :id,          Serial
+        property :language_id, Integer, :nullable => false
+
+      end
+
+    end
+  end
+end

data/spec/fixtures/item.rb

@@ -0,0 +1,12 @@
+class Item
+
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  is :localizable do
+    property :name, String
+    property :desc, String
+  end
+
+end

data/spec/lib/rspec_tmbundle_support.rb

@@ -0,0 +1,35 @@
+# -----------------------------------------------
+# support for nice html output in rspec tmbundle
+# -----------------------------------------------
+
+module RSpecTmBundleHelpers
+
+  class TextmateRspecLogger < DataMapper::Logger
+    def prep_msg(message, level)
+      "#{super}<br />"
+    end
+  end
+
+  def with_dm_logger(level = :debug)
+    DataMapper.logger.level = level
+    yield
+  ensure
+    DataMapper.logger.level = :off
+  end
+
+  def print_call_stack(from = 2, to = nil, html = true)
+    (from..(to ? to : caller.length)).each do |idx|
+      p "[#{idx}]: #{caller[idx]}#{html ? '<br />' : ''}"
+    end
+  end
+
+  def puth(html = nil)
+    print "#{h(html)}<br />"
+  end
+
+  ESCAPE_TABLE = { '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;', '"'=>'&quot;', "'"=>'&#039;', }
+  def h(value)
+    value.to_s.gsub(/[&<>"]/) {|s| ESCAPE_TABLE[s] }
+  end
+
+end

data/spec/shared/shared_examples_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "all available_languages providers", :shared => true do
+
+  describe "with no translations" do
+
+    it "should return 0 languages" do
+      @provider.available_languages.size.should == 0
+    end
+
+  end
+
+  describe "with 1 translation in 1 language" do
+
+    before :each do
+      @l = Language.create :code => 'en-US', :name => 'English'
+      @t = ItemTranslation.create :item => @item, :language => @l, :name => "Book", :desc => "Literature"
+    end
+
+    it "should return 1 language" do
+      @provider.available_languages.size.should == 1
+    end
+
+    it "should return the right language" do
+      @provider.available_languages.first.should == @l
+    end
+
+  end
+
+  describe "with 2 translations in 1 language" do
+
+    before :each do
+      @l = Language.create :code => 'en-US', :name => 'English'
+      @t = ItemTranslation.create :item => @item, :language => @l, :name => "Book", :desc => "Literature"
+      @t = ItemTranslation.create :item => @item, :language => @l, :name => "Hook", :desc => "Tool"
+      @item.reload
+    end
+
+    it "should return 1 language" do
+      @provider.available_languages.size.should == 1
+    end
+
+    it "should return the right language" do
+      @provider.available_languages.first.should == @l
+    end
+
+  end
+
+  describe "with 3 translations in 2 languages" do
+
+    before :each do
+      @l1 = Language.create :code => 'en-US', :name => 'English'
+      @l2 = Language.create :code => 'de-AT', :name => 'Deutsch'
+      @t  = ItemTranslation.create :item => @item, :language => @l1, :name => "Book",  :desc => "Literature"
+      @t  = ItemTranslation.create :item => @item, :language => @l1, :name => "Hook",  :desc => "Tool"
+      @t  = ItemTranslation.create :item => @item, :language => @l2, :name => "Haken", :desc => "Werkzeug"
+    end
+
+    it "should return 2 language" do
+      @provider.available_languages.size.should == 2
+    end
+
+    it "should return the right language" do
+      @provider.available_languages.first.should == @l1
+      @provider.available_languages.last.should  == @l2
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'pathname'
+require 'spec'
+
+require 'dm-is-remixable'
+require 'dm-validations'
+
+require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-is-localizable'
+
+ENV["SQLITE3_SPEC_URI"]  ||= 'sqlite3::memory:'
+ENV["MYSQL_SPEC_URI"]    ||= 'mysql://localhost/dm-accepts_nested_attributes_test'
+ENV["POSTGRES_SPEC_URI"] ||= 'postgres://postgres@localhost/dm-accepts_nested_attributes_test'
+
+
+def setup_adapter(name, default_uri = nil)
+  begin
+    DataMapper.setup(name, ENV["#{ENV['ADAPTER'].to_s.upcase}_SPEC_URI"] || default_uri)
+    Object.const_set('ADAPTER', ENV['ADAPTER'].to_sym) if name.to_s == ENV['ADAPTER']
+    true
+  rescue Exception => e
+    if name.to_s == ENV['ADAPTER']
+      Object.const_set('ADAPTER', nil)
+      warn "Could not load do_#{name}: #{e}"
+    end
+    false
+  end
+end
+
+# have the loggers handy
+# DataObjects::Logger.new(STDOUT, :debug)
+# DataObjects::Sqlite3.logger = DataObjects::Logger.new(STDOUT, :debug)
+
+# -----------------------------------------------
+# support for nice html output in rspec tmbundle
+# -----------------------------------------------
+
+USE_TEXTMATE_RSPEC_BUNDLE = true # set to false if not using textmate
+
+if USE_TEXTMATE_RSPEC_BUNDLE
+
+  require Pathname(__FILE__).dirname.expand_path + 'lib/rspec_tmbundle_support'
+
+  # use the tmbundle logger
+  RSpecTmBundleHelpers::TextmateRspecLogger.new(STDOUT, :off)
+
+
+  class Object
+    include RSpecTmBundleHelpers
+  end
+
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+setup_adapter(:default)
+Dir[Pathname(__FILE__).dirname.to_s + "/fixtures/**/*.rb"].each { |rb| require(rb) }
+
+
+Spec::Runner.configure do |config|
+
+  config.before(:all) do
+    DataMapper.auto_migrate!
+  end
+
+  config.before(:each) do
+    DataMapper.repository(:default) do |r|
+      transaction = DataMapper::Transaction.new(r)
+      transaction.begin
+      r.adapter.push_transaction(transaction)
+    end
+  end
+
+  config.after(:each) do
+    DataMapper.repository(:default) do |r|
+      adapter = r.adapter
+      while adapter.current_transaction
+        adapter.current_transaction.rollback
+        adapter.pop_transaction
+      end
+    end
+  end
+
+end