object_scoped_i18n 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -0,0 +1,62 @@
+= object_scoped_i18n
+
+Translate using i18n and scope accoring to the object's place in Ruby's
+hierarchial structure.
+
+To use, extend the class:
+
+  class Admin < User
+    extend ObjectScopedI18n
+  end
+
+You can now call translations on the object:
+
+  Admin.translate(:name)
+
+Which calls I18n like this:
+
+  I18n.translate(:"admin.name", :default => [:"user.name", :"object.name"])
+
+Which looks up "admin.name" first; if it didn't found that, it looks up
+"user.name", including any included modules, all way up.
+
+Namespaces are introduced as extra scope.
+
+  class SomeModule::SomeClass
+  end
+
+  SomeModule::SomeClass.translate(:name)
+
+Will be the same as:
+
+  I18n.translate(:"some_module.some_class.name", :default => {...})
+
+You can off course use all the options you would normally use with I18n.
+
+== Why?
+
+Because I wanted something that was like ActiveRecord's human_attribute_name,
+but consitently over other objects too.
+
+== So what about human_attribute_name?
+
+You can override it, so it's use object_scoped_i18n:
+
+  class ActiveRecord::Base
+    extend ObjectScopedI18n
+    def self.human_attribute_name(key, options = {})
+      translate(key, {:default => key.to_s.humanize, :scope => [:activerecord, :attributes]}.merge(options))
+    end
+  end
+
+You now change the scope if you like. Also, you'll get global translations for
+free, for columns like "created_at" and "updated_at".
+
+== Installation
+
+Just gem install object_scoped_i18n and require it in your project, like you're used to.
+
+
+== Copyright
+
+Copyright (c) 2009 Iain Hecker. Released under the MIT license.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "object_scoped_i18n"
+    gem.summary = %Q{Translate using i18n and scope it according to the object's place in Ruby's hierarchial structure}
+    gem.description = %Q{Translate using i18n and scope it according to the object's place in Ruby's hierarchial structure.
+      Using ancestors to build up the default option of I18n.translate. Works in much the same way as ActiveRecords human_attribute_name}
+    gem.email = "iain@iain.nl"
+    gem.homepage = "http://github.com/iain/object_scoped_i18n"
+    gem.authors = ["Iain Hecker"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "i18n"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "object_scoped_i18n #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/object_scoped_i18n.rb

@@ -0,0 +1,69 @@
+require 'i18n' unless Object.const_defined?(:I18n)
+
+# Translate using i18n and scope accoring to the object's place in Ruby's
+# hierarchial structure.
+#
+# To use, extend the class:
+#
+#   class Admin < User
+#     extend ObjectScopedI18n
+#   end
+#
+# You can now call translations on the object:
+#
+#   Admin.translate(:name)
+#
+# Which calls I18n like this:
+#
+#   I18n.translate(:"admin.name", :default => [:"user.name", :"object.name"])
+#
+# Which looks up "admin.name" first; if it didn't found that, it looks up
+# "user.name", including any included modules, all way up.
+#
+# Namespaces are introduced as extra scope.
+#
+#   class SomeModule::SomeClass
+#   end
+#
+#   SomeModule::SomeClass.translate(:name)
+#
+# Will be the same as:
+#
+#   I18n.translate(:"some_module.some_class.name", :default => {...})
+#
+# You can off course use all the options you would normally use with I18n.
+module ObjectScopedI18n
+
+  # Perform a basic translation, depending on the object it was called on.
+  def translate(key, options = {}, &block)
+    I18n.translate(*object_scoped_i18n_options(key, options.dup), &block)
+  end
+  alias t translate
+
+  # Same as 'translate' but raises an exception if no translation was found.
+  def translate!(key, options = {}, &block)
+    I18n.translate!(*object_scoped_i18n_options(key, options.dup), &block)
+  end
+  alias t! translate!
+
+  def object_scoped_i18n_options(key, options = {})
+    separator = options[:separator] || I18n.default_separator
+    translation_tree = self.ancestors.map do |mod|
+      # Yes, this looks like the ActiveSupport#underscore method, but it's
+      # a bit different. I needed to have the namespace separator after
+      # the downcase method, because I don't want to downcase that.
+      # Besides, now this gem doesn't have an ActiveSupport dependency.
+      scope_name = mod.to_s.
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase.
+      gsub(/::/, separator)
+      :"#{scope_name}#{separator}#{key}"
+    end
+    translation_key = translation_tree.shift
+    options[:default] = (options[:default] || []) + translation_tree
+    [ translation_key, options ]
+  end
+
+end

data/spec/locale.yml

@@ -0,0 +1,4 @@
+en:
+  translation_scope:
+    animal:
+      something: some nice translation

data/spec/object_scoped_i18n_spec.rb

@@ -0,0 +1,77 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ObjectScopedI18n" do
+
+  describe "#translate" do
+
+    it "should send a i18n call" do
+      I18n.should_receive(:translate).with(:foo, :bar)
+      Monkey.should_receive(:object_scoped_i18n_options).with(:some_method, {}).and_return([:foo, :bar])
+      Monkey.translate(:some_method)
+    end
+
+    it "should alias to 't'" do
+      I18n.should_receive(:translate).with(:foo, :bar)
+      Monkey.should_receive(:object_scoped_i18n_options).with(:some_method, {}).and_return([:foo, :bar])
+      Monkey.t(:some_method)
+    end
+
+  end
+
+  describe "#translate!" do
+
+    it "should send a i18n call" do
+      I18n.should_receive(:translate!).with(:foo, :bar)
+      Monkey.should_receive(:object_scoped_i18n_options).with(:some_method, {}).and_return([:foo, :bar])
+      Monkey.translate!(:some_method)
+    end
+
+    it "should alias to 't!'" do
+      I18n.should_receive(:translate!).with(:foo, :bar)
+      Monkey.should_receive(:object_scoped_i18n_options).with(:some_method, {}).and_return([:foo, :bar])
+      Monkey.t!(:some_method)
+    end
+
+  end
+
+  describe "#object_scoped_i18n_options" do
+
+    it "should scope properly" do # Look at locale.yml to see what happened
+      Monkey.t!(:something, :scope => "translation_scope")
+    end
+
+    it "should translate scoped" do
+      subject = Scoped::SomeClass.object_scoped_i18n_options(:my_method)
+      subject[0].should == :"scoped.some_class.my_method"
+    end
+
+    it "should know an included module" do
+      subject = Scoped::SomeClass.object_scoped_i18n_options(:my_method)
+      subject[1][:default][0].should == :"scoped.included_module.my_method"
+    end
+
+    it "should know super class" do
+      subject = Scoped::SomeClass.object_scoped_i18n_options(:my_method)
+      subject[1][:default][1].should == :"scoped.super_class.my_method"
+    end
+
+    it "should override separator" do
+      subject = Monkey.object_scoped_i18n_options(:my_method, :separator => "X")
+      subject[0].should == :"monkeyXmy_method"
+    end
+
+    it "should use I18n's default separator" do
+      old_separator, I18n.default_separator = I18n.default_separator, "Y"
+      subject = Monkey.object_scoped_i18n_options(:my_method)
+      subject[0].should == :"monkeyYmy_method"
+      I18n.default_separator = old_separator
+    end
+
+    it "should leave other options untouched" do
+      subject = Monkey.object_scoped_i18n_options(:my_method, :my_options => "x")
+      subject[1][:my_options].should == "x"
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'object_scoped_i18n'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+I18n.load_path << File.dirname(__FILE__) + '/locale.yml'
+
+module Scoped
+  module IncludedModule
+  end
+  class SuperClass
+  end
+  class SomeClass < SuperClass
+    extend ObjectScopedI18n
+    include IncludedModule
+  end
+end
+
+class Animal
+  extend ObjectScopedI18n
+end
+
+class Monkey < Animal
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: object_scoped_i18n
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Iain Hecker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |-
+  Translate using i18n and scope it according to the object's place in Ruby's hierarchial structure.
+        Using ancestors to build up the default option of I18n.translate. Works in much the same way as ActiveRecords human_attribute_name
+email: iain@iain.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/object_scoped_i18n.rb
+- spec/locale.yml
+- spec/object_scoped_i18n_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/iain/object_scoped_i18n
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Translate using i18n and scope it according to the object's place in Ruby's hierarchial structure
+test_files: 
+- spec/object_scoped_i18n_spec.rb
+- spec/spec_helper.rb