haml-i18n 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in haml-i18n.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Clemens Helm
+
+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.md

@@ -0,0 +1,39 @@
+# haml-i18n
+
+Haml-i18n provides basic functionality to translate [haml](https://github.com/nex3/haml) templates. Instead of writing `%p= I18n.translate('.user_name')` from now on you can just write `%p User name`.
+
+Note that this is a very early version of the plugin. I just developed it to fit one project’s needs. If you find any errors please write an issue or provide a fix directly. Please take a look at _Contributing to haml-i18n_ on how to write a fix.
+
+## Installation
+
+Add `gem "haml-i18n"` to your project’s `GEMFILE` and run `bundle` to install haml-i18n and its dependencies.
+
+## Usage
+
+You can put your keys in plain text into your haml template:
+
+    %p User name
+  
+This will try to
+
+  * retrieve `[view_folder].[template_name].user_name`
+  * retrieve `user_name` if the template-scoped translation doesn’t exist.
+  
+## Contributing to haml-i18n
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Clemens Helm. See LICENSE.txt for
+further details.
+
+## Thanks to…
+
+[Cail](https://github.com/cail) for giving me the inspiration and a starting point with [haml\_i18n](https://github.com/cail/haml_i18n) for developing this gem.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/haml-i18n.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "haml-i18n/version"
+
+Gem::Specification.new do |s|
+  s.name        = "haml-i18n"
+  s.homepage = "http://github.com/clemenshelm/haml-i18n"
+  s.license = "MIT"
+  s.version     = Haml::I18n::VERSION
+  s.authors     = ["Clemens Helm"]
+  s.email       = ["clemens.helm@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Easy translation of haml templates.}
+  s.description = %q{This gem automatically retrieves translations from the I18n backend without reqiring explicit calls to I18n.translate from the haml templates.}
+  
+  s.add_development_dependency "rspec"
+  
+  s.add_dependency 'haml'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'i18n'
+
+  s.rubyforge_project = "haml-i18n"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/haml-i18n/version.rb

@@ -0,0 +1,5 @@
+module Haml
+  module I18n
+    VERSION = "0.0.3"
+  end
+end

data/lib/haml-i18n.rb

@@ -0,0 +1,47 @@
+require 'haml'
+require 'active_support/all'
+
+module HamlI18n
+  module Internationalizer
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :plain, :i18n
+        alias_method_chain :parse_tag, :i18n
+      end
+    end
+    
+    private
+    
+    def plain_with_i18n(text, escape_html = nil)
+      i18n_text = translate(text)
+      plain_without_i18n(i18n_text, escape_html)
+    end
+    
+    def parse_tag_with_i18n(line)
+      tag_name, attributes, attributes_hash, object_ref, nuke_outer_whitespace, nuke_inner_whitespace, action, value = parse_tag_without_i18n(line)
+      
+      i18n_value = action || value.blank? ? value : translate(value)
+      
+      [tag_name, attributes, attributes_hash, object_ref, nuke_outer_whitespace, nuke_inner_whitespace, action, i18n_value]
+    end
+    
+    def translate(text)
+      simple_key = text.parameterize.underscore
+      
+      filename_components = options[:filename].match(/\/views\/([^\/]+)\/([^\/]+).html.haml/)
+      key = filename_components ? "#{filename_components[1]}.#{filename_components[2]}.#{simple_key}" : simple_key
+      
+      begin
+        I18n.translate(key, raise: true)
+      rescue I18n::MissingTranslationData
+        I18n.translate(simple_key)
+      end
+    end
+  end
+end
+
+module Haml
+  class Engine
+    include HamlI18n::Internationalizer
+  end
+end

data/spec/haml-i18n_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path("../../lib/haml-i18n.rb", __FILE__)
+require 'i18N'
+require 'haml'
+
+describe HamlI18n do
+  after { I18n.backend.reload! }
+  
+  it "looks up 'key' as 'key'" do
+    I18n.backend.store_translations :en, key: 'Cheers'
+    template = Haml::Engine.new 'key'
+    template.render.should =~ /Cheers/
+  end
+  
+  it "looks up 'Key' as 'key'" do
+    I18n.backend.store_translations :en, key: 'Bless you'
+    template = Haml::Engine.new 'Key'
+    template.render.should =~ /Bless you/
+  end
+  
+  it "looks up 'User name' as 'user_name'" do
+    I18n.backend.store_translations :en, user_name: 'Kevin'
+    template = Haml::Engine.new 'User name'
+    template.render.should =~ /Kevin/
+  end
+  
+  context "within a tag" do
+    it "looks up 'key' as 'key'" do
+      I18n.backend.store_translations :en, key: 'Cheers'
+      template = Haml::Engine.new '%p key'
+      template.render.should =~ /<p>Cheers<\/p>/
+    end
+    
+    context "that is nested" do
+      it "looks up 'key' as 'key'" do
+        I18n.backend.store_translations :en, key: 'Cheers'
+        template = Haml::Engine.new "%div\n\t%p key"
+        template.render.should =~ /<p>Cheers<\/p>/
+      end
+    end
+    
+    context "within a ruby block" do
+      it "doesn't look up anything" do
+        template = Haml::Engine.new '%p= "Cheers"'
+        template.render.should =~ /<p>Cheers<\/p>/
+      end
+    end
+  end
+  
+  context "when there is a template path" do
+    it "looks up 'key' as '[view_folder].[template_name].key'" do
+      I18n.backend.store_translations :en, users: {index: {key: 'Cheers'}}
+      template = Haml::Engine.new 'key', filename: '/long/path/to/views/users/index.html.haml'
+      template.render.should =~ /Cheers/
+    end
+    
+    it "looks up 'Key' as '[view_folder].[template_name].key'" do
+      I18n.backend.store_translations :en, users: {index: {key: 'Cheers'}}
+      template = Haml::Engine.new 'Key', filename: '/long/path/to/views/users/index.html.haml'
+      template.render.should =~ /Cheers/
+    end
+    
+    context "when there is no translation for the template path" do
+      it "looks up 'key' as 'key'" do
+        I18n.backend.store_translations :en, key: 'Cheers'
+        template = Haml::Engine.new 'key', filename: '/long/path/to/views/users/index.html.haml'
+        template.render.should =~ /Cheers/
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: haml-i18n
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Clemens Helm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153666160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153666160
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &2153665740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153665740
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153665320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153665320
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2153664900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153664900
+description: This gem automatically retrieves translations from the I18n backend without
+  reqiring explicit calls to I18n.translate from the haml templates.
+email:
+- clemens.helm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- haml-i18n.gemspec
+- lib/haml-i18n.rb
+- lib/haml-i18n/version.rb
+- spec/haml-i18n_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: haml-i18n
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Easy translation of haml templates.
+test_files:
+- spec/haml-i18n_spec.rb