activerecord_translatable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Philipp Fehre <philipp.fehre@gmail.com>
+
+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/README.rdoc

@@ -0,0 +1,73 @@
+= ActiveRecordTranslatable
+
+Make attributes of an ActiveRecord Model translatable, and store the
+translations in the provided I18n backend.  This is really helpful if there
+already is, a interface to provide ie missing translations for elements in I18n. 
+
+== Usage
+
+class MyModel < ActiveRecord::Base
+  include ActiveRecordTranslatable
+  translate :title
+end
+
+I18n.locale = :en
+mymodel = MyModel.create(title: "My title", title_de: "Mein Title)
+mymodel.title_wk = "Woohhaakkk"
+
+mymodel.title # => "My title"
+mymodel.title_en # => "My title"
+mymodel.title_wk # => "Woohhaakkk"
+
+== Prerequisites
+To save the locales ActiveRecordTranslatable saves an array of the specified locale, for
+this to work, the database needs the ability to save arrays. The easiest way to
+handle this in postgres is via the postgres array
+
+gem 'activerecord-postgres-array'
+
+To add the array to the model the migration looks like this
+
+class CreateMyModel < ActiveRecord::Migration
+  def change
+    create_table :my_model do |t|
+      t.string_array :locales
+    end
+  end
+end
+
+== How it works
+
+Translateable saves the translation via I18n.backend.store_translations, this 
+means that the backend has to be able to store new items. So backend needs to 
+be for example the KeyValue or ActiveRecord one. 
+More http://railscasts.com/episodes/256-i18n-backends
+
+== Miscellaneous
+
+=== Tests
+The tests are using rspec, and there is a dummy app setup in the spec directory.
+Since the example is using postgres, to get the tests working there needs to be
+a setup postgres user with the needed rights.
+
+  $ createuser -h localhost
+  Enter name of role to add: translatable 
+  Shall the new role be a superuser? (y/n) n
+  Shall the new role be allowed to create databases? (y/n) y
+  Shall the new role be allowed to create more new roles? (y/n) n
+
+Afterwards the db needs to be setup
+
+  $ cd spec/dummy
+  $ rake db:create
+  $ rake db:migrate
+  $ rake db:test:prepare
+
+Now the test can be run via
+  
+  $ rspec 
+
+=== Current State
+The gem is still in early development and has just been extracted from a
+project. So any bug reports and contributions are highly welcome.
+

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+  require 'rspec/core/rake_task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Translatable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run the specs'
+task :default => 'spec:unit' 
+
+namespace :spec do
+  desc "Run unit specs"
+  RSpec::Core::RakeTask.new('unit') do |t|
+    t.pattern = 'spec/{*_spec.rb}'
+  end
+end
+
+desc "Run the unit specs"
+task :spec => ['spec:unit']
+

data/lib/activerecord_translatable.rb

@@ -0,0 +1,9 @@
+require "active_record"
+require "active_support/concern"
+require "activerecord_translatable/extension"
+
+module ActiveRecordTranslatable
+
+  VERSION = "0.0.1"
+
+end

data/lib/activerecord_translatable/extension.rb

@@ -0,0 +1,86 @@
+module ActiveRecordTranslatable
+  extend ActiveSupport::Concern
+
+  attr_accessor :translations
+
+  def setup_locale(locale)
+    locales = self.locales || []
+    locales << locale.to_s
+    self.locales = locales.uniq
+    @translations ||= {}
+    @translations[locale] ||= {}
+  end
+
+  def available_locales
+    self.locales.map { |locale| locale.to_sym }   
+  end
+
+  def translation(attribute, locale = I18n.locale)
+    setup_locale(locale)
+    begin
+      @translations[locale][attribute] ||= I18n.t("#{self.base_name}.#{attribute}-#{self.id}",
+                                                  locale: locale, raise: true)
+    rescue I18n::MissingTranslationData
+      @translations[locale][attribute]
+    end
+  end
+
+  def set_translation(attribute, value, locale = I18n.locale)
+    setup_locale(locale)
+    @translations[locale][attribute] = value
+  end
+  
+  def write_translations
+    @translations.each do |locale, translations|
+      translations.each do |attribute, value|
+        I18n.backend.store_translations(locale, { "#{self.base_name}.#{attribute}-#{self.id}" => value }, escape: false)
+      end
+    end
+  end
+
+  def method_missing(method_name, *arguments, &block)
+    self.translateable.each do |attribute|
+      attribute = attribute.to_s
+      if method_name.to_s =~ /^#{attribute}_(.{2})=$/
+        return set_translation(attribute, arguments.first, $1.to_sym)
+      elsif method_name.to_s =~ /^#{attribute}=$/
+        return set_translation(attribute, arguments.first)
+      elsif method_name.to_s =~ /^#{attribute}_(.{2})$/
+        return translation(attribute, $1.to_sym)
+      elsif method_name.to_s =~ /^#{attribute}$/
+        return translation(attribute)
+      end
+    end
+    super
+  end
+  
+  def respond_to_missing?(method_name, include_private = false)
+    self.translateable.each do |attribute|
+      attribute = attribute.to_s
+      if method_name.to_s =~ /^#{attribute}_(.{2})=$/
+        return true
+      elsif method_name.to_s =~ /^#{attribute}=$/
+        return true
+      elsif method_name.to_s =~ /^#{attribute}_(.{2})$/
+        return true
+      elsif method_name.to_s =~ /^#{attribute}$/
+        return true
+      end
+    end
+    false
+  end
+
+  included do
+    after_save :write_translations
+    cattr_accessor :translateable, :base_name
+  end
+
+  module ClassMethods
+    def translate(*attributes)
+      self.base_name = self.name.downcase
+      self.translateable ||= []
+      self.translateable = self.translateable.concat(attributes)
+    end
+  end
+
+end

data/spec/activerecord_translateable_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe "ActiveRecordTranslateable" do
+
+    it "should add name to translateable" do
+      Something.translateable.should include(:name)
+    end
+
+    context "translations" do
+      before(:each) do
+        @something = Something.create!(name: "Something")
+        @locale = I18n.locale
+      end
+
+      after(:each) do
+        I18n.locale = @locale
+      end
+
+      it "should get the translation from stored translations" do
+        @something.set_translation("name", "Etwas", :de)
+        @something.translations[:de]["name"].should == "Etwas"
+      end
+
+      it "should set the translation to the stored translations" do
+        @something.set_translation("name", "Etwas", :de)
+        @something.translation("name", :de).should == "Etwas"
+      end
+
+      it "should get the translation for the default I18n locale" do
+        I18n.locale = :de
+        @something.set_translation("name", "Etwas")
+        @something.translation("name").should == "Etwas"
+      end
+
+      it "should set the translation for the default I18n locale" do
+        I18n.locale = :de
+        @something.set_translation("name", "Etwas")
+        @something.translation("name", :de).should == "Etwas"
+      end
+    
+      it "should write the stored translations to the backend" do
+        backend = double("Backend")
+        I18n.stub(:backend).and_return(backend)
+        backend.should_receive(:store_translations).
+          with(:en, { "something.name-#{@something.id}" => "Something" }, escape: false)
+        @something.write_translations
+      end
+
+    end
+
+    context "custom created methods" do
+      let(:something) { Something.create!(name: "Something") }
+
+      it "should respond to translated attributes" do
+        something.should respond_to(:name)
+        something.should respond_to(:name=)
+        something.should respond_to(:name_de)
+        something.should respond_to(:name_de=)
+      end
+
+      it "should get the translated attributes" do
+        something = Something.create!(name: "Something", name_de: "Etwas")
+        something_from_db = Something.find(something.id)
+        something_from_db.name.should == "Something"
+        something_from_db.name_de.should == "Etwas"
+      end
+
+    end
+
+    context "locales" do
+      let(:something) { Something.create!(name: "Something") }
+
+      it "should respond with available locales" do
+        something.available_locales.should include(:en)
+        something.name_de = "Etwas"
+        something.available_locales.should include(:en, :de)
+      end
+      
+    end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.