attribute_localizer 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Deering
+
+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.textile

@@ -0,0 +1,44 @@
+h1. Attribute Localizer
+
+p. I like to keep my Active Record models as strict as possible but I also like the further layer of protection/restriction setting database columns to not allow NULL adds.  Normalizing to nil helps enforce this better by not letting '' slip through the cracks and I can still prevent those who insist on direct DB access from entering in shitty data as much as possible.
+
+h2. Install as a Ruby gem
+
+p. The "attribute_localizer gem":http://gemcutter.org/gems/attribute_localizer is hosted over at "Gemcutter":http://gemcutter.org
+
+h3. Install the Attribute Localizer gem
+
+<pre><code>sudo gem install attribute_localizer</code></pre>
+
+h2. Install for Ruby on Rails
+
+<pre><code lang="ruby"># config/environement.rb
+  config.gem 'attribute_localizer'</code></pre>
+
+h2. Usage
+
+This is eager loaded into Active Record.  It is usable inside of other ruby classes outside of ActiveRecord by just including the module AttributeLocalizer.
+
+<pre><code>
+class Klass < ActiveRecord::Base
+
+  # Can take an array of attributes if you want
+  localize_attributes :name, :description
+
+end
+
+object = Klass.new
+object.locale = :fr
+object.update_attributes(:name => 'french_name', :description => 'french_description')
+object.locale = :en
+object.update_attributes(:name => 'english_name', :description => 'english_description')
+object.reload
+
+object.locale = nil
+object.name # => Will us the Rails I18n.local that has been set at the application level in your controller or I18n.default_locale
+object.locale = :fr
+object.name # => Will return the french name translation pulled from 'config/locales/klasses/fr.yml' if all defaults are used.
+
+h2. Copyright
+
+Copyright (c) 2010 "Michael Deering(Edmonton Ruby on Rails)":http://mdeering.com See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  AUTHOR   = "Michael Deering"
+  EMAIL    = "mdeering@mdeering.com"
+  GEM      = "attribute_localizer"
+  HOMEPAGE = "http://github.com/mdeering/attribute_localizer"
+  SUMMARY  = "Attribute serialization and recall for multilingual model attributes."
+
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.author       = AUTHOR
+    s.email        = EMAIL
+    s.files        = %w(install.rb install.txt MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,spec}/**/*")
+    s.homepage     = HOMEPAGE
+    s.name         = GEM
+    s.require_path = 'lib'
+    s.summary      = SUMMARY
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: spec tests.'
+task :default => :spec
+
+desc 'Test the attribute_localizer plugin.'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ["-c"]
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', '/opt,spec,Library']
+end
+
+desc 'Generate documentation for the attribute_localizer plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AttributeLocalizer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/install.rb

@@ -0,0 +1 @@
+puts IO.read(File.join(File.dirname(__FILE__), 'install.txt'))

data/install.txt

@@ -0,0 +1,3 @@
+-----------------------------------------------------------------------
+  Attribute Localizer Installed:
+-----------------------------------------------------------------------

data/lib/attribute_localizer.rb

@@ -0,0 +1,98 @@
+module AttributeLocalizer
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def localize_attributes(*attributes)
+
+      klass = class << self; self end
+
+      class_eval 'after_save :serialize_localizations'
+      class_eval 'attr_accessor :locale'
+      attributes.each { |attribute| class_eval "attr_accessor :#{attribute}" }
+
+      src = attributes.map do |attribute|
+        str = "def #{attribute}\n"
+        str << "@#{attribute} || I18n.t(\"\#{self.class.send :localization_namespace}.\#{localization_hash_key}.#{attribute}\", :locale => locale, :default => '')\n"
+        str << "end"
+        str
+      end.join("\n")
+
+      module_eval src, __FILE__, __LINE__
+
+      src = <<-end_src
+        def locale
+          @locale || I18n.locale
+        end
+      end_src
+
+      module_eval src, __FILE__, __LINE__
+
+      private
+
+        klass.send :define_method, 'i18n_file' do |locale|
+          "#{RAILS_ROOT}/config/locales/#{localization_namespace}/#{locale}.yml"
+        end
+
+        klass.send :private, 'i18n_file'
+
+        src = <<-end_src
+          def load_locale_data(locale)
+            localized_hash = YAML::load_file(i18n_file(locale))
+            localized_hash[locale][localization_namespace]
+          rescue
+            {}
+          end
+        end_src
+
+        klass.class_eval src, __FILE__, __LINE__
+
+        klass.send :private, 'load_locale_data'
+
+        klass.send :define_method, 'localization_namespace' do
+          to_s.underscore.pluralize
+        end
+
+        klass.send :private, 'localization_namespace'
+
+        klass.send :define_method, 'write_locale_data' do |locale, localized_hash|
+          File.open( i18n_file(locale), File::WRONLY|File::TRUNC|File::CREAT ) do |out|
+            YAML.dump( { locale => {localization_namespace => localized_hash} }, out )
+          end
+        end
+
+        klass.send :private, 'write_locale_data'
+
+        src = <<-end_src
+          private
+            def localization_hash_key
+              "_\#{id}".to_sym
+            end
+
+            def serialize_localizations
+              localized_hash = self.class.send :load_locale_data, locale
+              localized_hash[localization_hash_key] = localized_yaml
+              self.class.send :write_locale_data, locale, localized_hash
+            end
+
+            def localized_yaml
+              {
+              #{attributes.map { |attribute| ":#{attribute} => #{attribute}"}.join(',')}
+              }
+            end
+        end_src
+
+        module_eval src, __FILE__, __LINE__
+
+    end
+
+    alias :localize_attribute :localize_attributes
+
+  end
+
+end
+
+ActiveRecord::Base.send(:include, AttributeLocalizer)

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib attribute_localizer])

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_localizer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Deering
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mdeering@mdeering.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- install.rb
+- install.txt
+- lib/attribute_localizer.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/mdeering/attribute_localizer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Attribute serialization and recall for multilingual model attributes.
+test_files: []
+