globalize-accessors 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 367386484b2db24a7568c6227d7ed4297cc2c5ee
-  data.tar.gz: 3c123202c983f00e83277d512f21b3c55af51795
+  metadata.gz: ebf9c4a52aea9e8ff546ee109e2ca3cf1a7641e7
+  data.tar.gz: c2ee6386a210d5a63595901e61118ec3be0e9e4d
 SHA512:
-  metadata.gz: 1226e51ce8c7c56608aae8555bf34fd1b5b076f988a9188636d10b3bfd1c18456ef6afb4ab2d5f4679aa7ab963a25cc0ddc36a064c84496240621bd7ce6f10a5
-  data.tar.gz: 329f021d11c44d77b566778b3fa93c0e59e92b77300cc2e2e2b2cf430d6591a108d0d3b7f4ad1896f08b7a5b3b4cb6a3f0e5af7540f57fdf2836ed963d162b1b
+  metadata.gz: 2d0d5c1297a0ecd11cdc3d31c2e142170e06744966c073eebbfbb0caf87b1bfe6ff11e3f64a28689e94bf7e92ece20db164136195890a4ade450a9b05e6d6b46
+  data.tar.gz: 71cc829fdebf3540953aa07fd1c568d9f441edd7309b291f3ac5184111de19402d516f164ea6d8d46cd3ca921d3f079025079aca4119154da4f4662296f10b9a

data/globalize-accessors.gemspec

@@ -15,9 +15,11 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "globalize-accessors"
 
   if ENV['RAILS_3']
-    s.add_dependency "globalize3", "~> 0.3.0"
-  else
+    s.add_dependency "globalize", "~> 3.0.0"
+  elsif ENV['RAILS_4']
     s.add_dependency "globalize", "~> 4.0.0.alpha.1"
+  else
+    s.add_dependency "globalize", ">= 3"
   end
 
   s.add_development_dependency "bundler", "~> 1.3.5"

data/lib/globalize-accessors.rb

@@ -1,11 +1,13 @@
 require 'globalize'
 
-module GlobalizeAccessors
+module Globalize::Accessors
   attr_reader :globalize_locales
+  attr_reader :globalize_attribute_names
 
   def globalize_accessors(options = {})
     options.reverse_merge!(:locales => I18n.available_locales, :attributes => translated_attribute_names)
     @globalize_locales = options[:locales]
+    @globalize_attribute_names = []
 
     each_attribute_and_locale(options) do |attr_name, locale|
       define_accessors(attr_name, locale)
@@ -29,12 +31,15 @@ module GlobalizeAccessors
   end
 
   def define_setter(attr_name, locale)
-    define_method :"#{attr_name}_#{locale.to_s.underscore}=" do |value|
+    localized_attr_name = "#{attr_name}_#{locale.to_s.underscore}"
+
+    define_method :"#{localized_attr_name}=" 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}"
+      attr_accessible :"#{localized_attr_name}"
     end
+    @globalize_attribute_names << localized_attr_name.to_sym
   end
 
   def each_attribute_and_locale(options)
@@ -47,4 +52,4 @@ module GlobalizeAccessors
 
 end
 
-ActiveRecord::Base.extend GlobalizeAccessors
+ActiveRecord::Base.extend Globalize::Accessors

data/lib/globalize-accessors/version.rb

@@ -1,3 +1,3 @@
 module GlobalizeAccessors
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/readme.md

@@ -2,7 +2,7 @@
 
 ## 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.
+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.
 
@@ -11,7 +11,9 @@ This way a single form can be used to edit given model fields with all anticipat
 
 ## Installation
 
-  gem install globalize-accessors
+````ruby
+gem install globalize-accessors
+````
 
 ## Example
 
@@ -24,26 +26,45 @@ class Product
 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).
+Gives you access to methods: `title_pl`, `title_en`, `title_pl=`, `title_en=` (and a similar set of description_* methods). These work seamlessly with Globalize (not even touching the "core" `title`, `title=` methods used by Globalize itself).
 
-`:locales` and `:attributes` are optional. Default values are:
+The `:locales` and `:attributes` options are optional. Their default values are:
 
 ````ruby
-  :locales => I18n.available_locales
-  :attributes => translated_attribute_names
+: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.
+Calling `globalize_accessors` with no options will therefore generate accessor methods for all translated fields and available languages.
 
 You can also get the accessor locales for a class with the `globalize_locales` method:
 
 ````ruby
-  Product.globalize_locales # => [:en, :pl]
+Product.globalize_locales # => [:en, :pl]
+````
+
+You can also get modified attribute names -- ideal for use with strong parameters -- with the `globalize_attribute_names` method:
+
+````ruby
+Product.globalize_attribute_names # => [:title_en, :title_pl]
+````
+
+Example with strong parameters:
+
+````ruby
+params.require(:product).permit(*Product.globalize_attribute_names)
+````
+
+If you need to permit non-translatable attributes as well, you could include them with:
+
+````ruby
+permitted = Product.globalize_attribute_names + [:position]
+params.require(:product).permit(*permitted)
 ````
 
 ## 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:
+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:
 
 ````ruby
 module TranslatesWithAccessors

data/test/globalize_accessors_test.rb

@@ -133,4 +133,12 @@ class GlobalizeAccessorsTest < ActiveSupport::TestCase
     assert_equal "Name pt-BR",  u.name_pt_br
     assert_equal "Name en-AU",  u.name_en_au
   end
+
+  test "globalize attribute names on class without attributes specified in options" do
+    assert_equal [:name_en, :name_pl, :title_en, :title_pl], Unit.globalize_attribute_names
+  end
+
+  test "globalize attribute names on class with attributes specified in options" do
+    assert_equal [:name_pl], UnitTranslatedWithOptions.globalize_attribute_names
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globalize-accessors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tomasz Stachewicz
@@ -12,22 +12,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: globalize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0.alpha.1
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 4.0.0.alpha.1
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement