globalize-accessors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7defb92b751ffc09ccb3dfe0dc0c8df08488e1dd
+  data.tar.gz: a620943951380974008d867118a3f82ccd6c505b
+SHA512:
+  metadata.gz: 0c29be7111eafd912a409f0e5fd35b8d67d36ed2fff702c7505e79c5530c824eed6b829bd142d65105d0bb035e64326b23ce0b6fdfbeb176d8f60ef84b2d702a
+  data.tar.gz: 26615c51f8318312099d7ff03704d516d627b51d1c71e6b960f8c3d0b8ba3d73064e88132bf6d301ef3d7c150e7b236d0fd051259aa7e00fd9a233ebf76023ba

data/.gitignore

@@ -0,0 +1,8 @@
+pkg/*
+*.gem
+.bundle
+nbproject
+*.sqlite3
+test/debug.log
+test/db/database.yml
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,56 @@
+= Globalize Accessors
+
+== Introduction
+
+Generator of accessor methods for models using Globalize. Use globalize-accessors with a list of translated fields you want easily access to and extra :locales array listing locales for which you want the accessors to be generated.
+
+This way a single form can be used to edit given model fields with all anticipated translations.
+
+Note that globalize-accessors is currently only compatible with the globalize3 gem for Rails 3.x.
+
+
+== Installation
+
+  gem install globalize-accessors
+
+== Example
+
+Definition like this:
+
+  class Product
+    translates :title, :description
+    globalize_accessors :locales => [:en, :pl], :attributes => [:title]
+  end
+
+Gives you access to methods: `title_pl`, `title_en`, `title_pl=`, `title_en=` (and a similar set of description_* methods). They work seamlessly with Globalize (not even touching the "core" title, title= methods used by Globalize itself).
+
+`:locales` and `:attributes` are optional. Default values are:
+
+  :locales => I18n.available_locales
+  :attributes => translated_attribute_names
+
+which means that skipping all options will generate you accessor method for all translated fields and available languages.
+
+You can also get the accessor locales for a class with the `globalize_locales` method:
+
+  Product.globalize_locales # => [:en, :pl]
+
+== Always define accessors
+
+If you wish to always define accessors and don't want to call the globalize_accessors method in every class, you can extend ActiveRecord::Base with a module:
+
+  module TranslatesWithAccessors
+
+    def translates(*params)
+      options = params.extract_options!
+      options.reverse_merge!(:globalize_accessors => true)
+      accessors = options.delete(:globalize_accessors)
+      super
+      globalize_accessors if accessors
+    end
+
+  end
+
+== Licence
+
+Copyright (c) 2009-2013 Tomek "Tomash" Stachewicz (http://tomash.wrug.eu),  Robert Pankowecki (http://robert.pankowecki.pl) released under the MIT license

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+require 'rdoc/task'
+require 'rake/testtask'
+require 'rake'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the easy_globalize_accessors plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the easy_globalize_accessors plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EasyGlobalizeAccessors'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/globalize-accessors.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/globalize-accessors/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "globalize-accessors"
+  s.version     = GlobalizeAccessors::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tomasz Stachewicz", "Wojciech Pietrzak", "Steve Verlinden", "Robert Pankowecki", "Chris Salzberg"]
+  s.email       = ["tomekrs@o2.pl", "steve.verlinden@gmail.com", "robert.pankowecki@gmail.com", "rpa@gavdi.com", "chrissalzberg@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/globalize-accessors"
+  s.summary     = "Define methods for accessing translated attributes"
+  s.description = "Define methods for accessing translated attributes"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "globalize-accessors"
+
+  s.add_dependency "globalize3", "~> 0.3.0"
+
+  s.add_development_dependency "bundler", "~> 1.3.5"
+  s.add_development_dependency "rake", "~> 0.9.2"
+  s.add_development_dependency "sqlite3"
+
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/globalize-accessors.rb

@@ -0,0 +1,50 @@
+require 'globalize3'
+
+module GlobalizeAccessors
+  attr_reader :globalize_locales
+
+  def globalize_accessors(options = {})
+    options.reverse_merge!(:locales => I18n.available_locales, :attributes => translated_attribute_names)
+    @globalize_locales = options[:locales]
+
+    each_attribute_and_locale(options) do |attr_name, locale|
+      define_accessors(attr_name, locale)
+    end
+  end
+
+
+  private
+
+
+  def define_accessors(attr_name, locale)
+    define_getter(attr_name, locale)
+    define_setter(attr_name, locale)
+  end
+
+
+  def define_getter(attr_name, locale)
+    define_method :"#{attr_name}_#{locale.to_s.underscore}" do
+      read_attribute(attr_name, :locale => locale)
+    end
+  end
+
+  def define_setter(attr_name, locale)
+    define_method :"#{attr_name}_#{locale.to_s.underscore}=" do |value|
+      write_attribute(attr_name, value, :locale => locale)
+    end
+    if respond_to?(:accessible_attributes) && accessible_attributes.include?(attr_name)
+      attr_accessible :"#{attr_name}_#{locale.to_s.underscore}"
+    end
+  end
+
+  def each_attribute_and_locale(options)
+    options[:attributes].each do |attr_name|
+      options[:locales].each do |locale|
+        yield attr_name, locale
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.extend GlobalizeAccessors

data/lib/globalize-accessors/version.rb

@@ -0,0 +1,3 @@
+module GlobalizeAccessors
+  VERSION = '0.1.0'
+end

data/test/db/database.yml.example

@@ -0,0 +1,21 @@
+sqlite3:
+  adapter: sqlite3
+  dbfile: globalize.sqlite3
+  database: globalize.sqlite3
+sqlite3mem:
+  adapter: sqlite3
+  dbfile: ":memory:"
+  database: globalize.sqlite3
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: globalize
+  min_messages: ERROR
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: globalize
+

data/test/db/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "units", :force => true do |t|
+    t.integer  "capacity"
+  end
+
+  create_table "unit_translations", :force => true do |t|
+    t.references :unit
+    t.string "name"
+    t.string "title"
+    t.string "locale"
+  end
+
+end

data/test/globalize_accessors_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+class GlobalizeAccessorsTest < ActiveSupport::TestCase
+
+  class Unit < ActiveRecord::Base
+    translates :name, :title
+    globalize_accessors
+  end
+
+  class UnitTranslatedWithOptions < ActiveRecord::Base
+    self.table_name = :units
+    translates :name
+    globalize_accessors :locales => [:pl], :attributes => [:name]
+  end
+
+  class UnitWithAttrAccessible < ActiveRecord::Base
+    self.table_name = :units
+    attr_accessible :name
+    translates :name, :title
+    globalize_accessors
+  end
+
+  class UnitWithDashedLocales < ActiveRecord::Base
+    self.table_name = :units
+    translates :name
+    globalize_accessors :locales => [:"pt-BR", :"en-AU"], :attributes => [:name]
+  end
+
+  setup do
+    assert_equal :en, I18n.locale
+  end
+
+  test "read and write on new object" do
+    u = Unit.new(:name_en => "Name en", :title_pl => "Title pl")
+
+    assert_equal "Name en",  u.name
+    assert_equal "Name en",  u.name_en
+    assert_equal "Title pl", u.title_pl
+
+    assert_nil u.name_pl
+    assert_nil u.title_en
+  end
+
+  test "write on new object and read on saved" do
+    u = Unit.create!(:name_en => "Name en", :title_pl => "Title pl")
+
+    assert_equal "Name en",  u.name
+    assert_equal "Name en",  u.name_en
+    assert_equal "Title pl", u.title_pl
+
+    assert_nil u.name_pl
+    assert_nil u.title_en
+  end
+
+  test "read on existing object" do
+    u = Unit.create!(:name_en => "Name en", :title_pl => "Title pl")
+    u = Unit.find(u.id)
+
+    assert_equal "Name en",  u.name
+    assert_equal "Name en",  u.name_en
+    assert_equal "Title pl", u.title_pl
+
+    assert_nil u.name_pl
+    assert_nil u.title_en
+  end
+
+  test "read and write on existing object" do
+    u = Unit.create!(:name_en => "Name en", :title_pl => "Title pl")
+    u = Unit.find(u.id)
+
+    u.name_pl = "Name pl"
+    u.name_en = "Name en2"
+    u.save!
+
+    assert_equal "Name en2",  u.name
+    assert_equal "Name en2",  u.name_en
+    assert_equal "Name pl",   u.name_pl
+    assert_equal "Title pl",  u.title_pl
+
+    assert_nil u.title_en
+  end
+
+  test "read and write on class with options" do
+    u = UnitTranslatedWithOptions.new()
+
+    assert u.respond_to?(:name_pl)
+    assert u.respond_to?(:name_pl=)
+
+    assert ! u.respond_to?(:name_en)
+    assert ! u.respond_to?(:name_en=)
+
+    u.name = "Name en"
+    u.name_pl = "Name pl"
+
+    assert_equal "Name en",  u.name
+    assert_equal "Name pl",  u.name_pl
+  end
+
+  test "whitelist locale accessors if the original attribute is whitelisted" do
+    u = UnitWithAttrAccessible.new()
+    u.update_attributes(:name => "Name en", :name_pl => "Name pl", :title => "Title en", :title_pl => "Title pl")
+
+    assert_equal "Name en",  u.name
+    assert_equal "Name pl",  u.name_pl
+    assert_nil  u.title
+    assert_nil  u.title_pl
+  end
+
+  test "globalize locales on class without locales specified in options" do
+    assert_equal [:en, :pl], Unit.globalize_locales
+  end
+
+  test "globalize locales on class with locales specified in options" do
+    assert_equal [:pl], UnitTranslatedWithOptions.globalize_locales
+  end
+
+  test "read and write on class with dashed locales" do
+    u = UnitWithDashedLocales.new()
+
+    assert u.respond_to?(:name_pt_br)
+    assert u.respond_to?(:name_pt_br=)
+
+    assert u.respond_to?(:name_en_au)
+    assert u.respond_to?(:name_en_au=)
+
+    u.name = "Name en"
+    u.name_pt_br = "Name pt-BR"
+    u.name_en_au = "Name en-AU"
+
+    assert_equal "Name en",  u.name
+    assert_equal "Name pt-BR",  u.name_pt_br
+    assert_equal "Name en-AU",  u.name_en_au
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'i18n'
+I18n.available_locales = [:en, :pl]
+
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+require 'logger'
+
+require 'globalize-accessors'
+
+plugin_test_dir = File.dirname(__FILE__)
+
+ActiveRecord::Base.logger = Logger.new(File.join(plugin_test_dir, "debug.log"))
+ActiveRecord::Base.configurations = YAML::load(  IO.read( File.join(plugin_test_dir, 'db', 'database.yml')  ) )
+ActiveRecord::Base.establish_connection("sqlite3mem")
+ActiveRecord::Migration.verbose = false
+load(File.join(plugin_test_dir, "db", "schema.rb"))

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: globalize-accessors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Stachewicz
+- Wojciech Pietrzak
+- Steve Verlinden
+- Robert Pankowecki
+- Chris Salzberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: globalize3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Define methods for accessing translated attributes
+email:
+- tomekrs@o2.pl
+- steve.verlinden@gmail.com
+- robert.pankowecki@gmail.com
+- rpa@gavdi.com
+- chrissalzberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- globalize-accessors.gemspec
+- lib/globalize-accessors.rb
+- lib/globalize-accessors/version.rb
+- test/db/database.yml.example
+- test/db/schema.rb
+- test/globalize_accessors_test.rb
+- test/test_helper.rb
+homepage: http://rubygems.org/gems/globalize-accessors
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: globalize-accessors
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Define methods for accessing translated attributes
+test_files: []