haml-magic-translations 0.1.1 → 0.2.0

data/README.rdoc

@@ -2,11 +2,12 @@
 
 This plugin provides "magical translations" in your .haml files. What does it
 mean? It's mean that all your raw texts in templates will be automatically
-translated by Gettext backend from I18n. No more complicated translation keys
-and ugly translation methods in views. Now you can only write in your language,
-nothing more. At the end of your work you can easy find all phrases to translate
-and generate .po files for it. This type of files are also more readable and 
-easier to translate, thanks to it you save your time with translations.     
+translated by GetText, FastGettext or Gettext backend from I18n. No more 
+complicated translation keys and ugly translation methods in views. Now you can
+only write in your language, nothing more. At the end of your work you can easy 
+find all phrases to translate and generate .po files for it. This type of files 
+are also more readable and easier to translate, thanks to it you save your 
+time with translations.
 
 === Installation
 
@@ -22,20 +23,20 @@ or
 
 === Gettings started with Gettext
 
-To use automatical translations you have to using new I18n with Gettext backend.
-Magic translations plugin will automatically enable it for you, so you have to 
-only define somewhere you path to .po files with your translations. 
-  
-  I18n.load_path += Dir["path/to/your/locales/*.{po}")]
-
-=== Time for translations
+To use automatical translations you have to using new I18n with Gettext backend, 
+GetText or FastGettext, properly installed and configured. To enable plugin
+you have to do following things:
 
-When gem is installed, then magic translations are enabled by default. But when 
-somehow you will not be able to use it, set one of Haml options - `:magic_translations`
+  Haml::Template.enable_magic_translations(:i18n) # this backend is used by default
+  
+Available backends are `:i18n`, `:gettext and `:fast_gettext`
 
-  Haml::Template.options[:magic_translations] = true
+Now you have to add path to all your .po files with locales. Eg. for i18n backend
+it will be something like:    
+  
+  I18n.load_path += Dir["path/to/your/locales/*.{po}")]
   
-And that's all. 
+And that's all. Now you can enjoy automatically translations in your .haml files!
 
 === Examples
 

data/Rakefile

@@ -8,18 +8,17 @@ begin
     gem.description = <<-DESCR
 This plugin provides "magical translations" in your .haml files. What does it
 mean? It's mean that all your raw texts in templates will be automatically
-translated by Gettext backend from I18n. No more complicated translation keys
-and ugly translation methods in views. Now you can only write in your language,
-nothing more. At the end of your work you can easy find all phrases to translate
-and generate .po files for it. This type of files are also more readable and 
-easier to translate, thanks to it you save your time with translations. 
+translated by GetText, FastGettext or Gettext backend from I18n. No more 
+complicated translation keys and ugly translation methods in views. Now you can
+only write in your language, nothing more. At the end of your work you can easy 
+find all phrases to translate and generate .po files for it. This type of files 
+are also more readable and easier to translate, thanks to it you save your 
+time with translations.
     DESCR
     gem.email = "kriss.kowalik@gmail.com"
     gem.homepage = "http://github.com/kriss/haml-magic-translations"
     gem.authors = ["Kriss Kowalik"]
     gem.add_development_dependency "haml", ">= 3.0.0"
-    gem.add_development_dependency "i18n", ">= 0.4.1"
-    gem.add_development_dependency "gettext", ">= 2.0.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/TODO

@@ -1,3 +1,3 @@
 * More info about .po files generator
 * Basic examples of usage .po files generator for Rails
-
+* Tests for GetText and FastGettext

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/haml-magic-translations.gemspec

@@ -5,18 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{haml-magic-translations}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kriss Kowalik"]
   s.date = %q{2010-07-21}
   s.description = %q{This plugin provides "magical translations" in your .haml files. What does it
 mean? It's mean that all your raw texts in templates will be automatically
-translated by Gettext backend from I18n. No more complicated translation keys
-and ugly translation methods in views. Now you can only write in your language,
-nothing more. At the end of your work you can easy find all phrases to translate
-and generate .po files for it. This type of files are also more readable and 
-easier to translate, thanks to it you save your time with translations. 
+translated by GetText, FastGettext or Gettext backend from I18n. No more 
+complicated translation keys and ugly translation methods in views. Now you can
+only write in your language, nothing more. At the end of your work you can easy 
+find all phrases to translate and generate .po files for it. This type of files 
+are also more readable and easier to translate, thanks to it you save your 
+time with translations.
 }
   s.email = %q{kriss.kowalik@gmail.com}
   s.extra_rdoc_files = [
@@ -36,7 +37,7 @@ easier to translate, thanks to it you save your time with translations.
      "lib/haml/magic_translations.rb",
      "spec/locales/en.po",
      "spec/locales/pl.po",
-     "spec/magic_translations_spec.rb",
+     "spec/magic_translations/i18n_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kriss/haml-magic-translations}
@@ -46,7 +47,7 @@ easier to translate, thanks to it you save your time with translations.
   s.summary = %q{Provides automaticaly translations in haml templates}
   s.test_files = [
     "spec/spec_helper.rb",
-     "spec/magic_translations_spec.rb"
+     "spec/magic_translations/i18n_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -55,17 +56,11 @@ easier to translate, thanks to it you save your time with translations.
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<haml>, [">= 3.0.0"])
-      s.add_development_dependency(%q<i18n>, [">= 0.4.1"])
-      s.add_development_dependency(%q<gettext>, [">= 2.0.0"])
     else
       s.add_dependency(%q<haml>, [">= 3.0.0"])
-      s.add_dependency(%q<i18n>, [">= 0.4.1"])
-      s.add_dependency(%q<gettext>, [">= 2.0.0"])
     end
   else
     s.add_dependency(%q<haml>, [">= 3.0.0"])
-    s.add_dependency(%q<i18n>, [">= 0.4.1"])
-    s.add_dependency(%q<gettext>, [">= 2.0.0"])
   end
 end
 

data/lib/haml/magic_translations.rb

@@ -1,18 +1,15 @@
 require 'haml'
 require 'haml/template'
 
-require 'i18n'
-require 'i18n/backend/gettext'
-require 'i18n/gettext/helpers'
-
 ##
 # This plugin provides "magical translations" in your .haml files. What does it
 # mean? It's mean that all your raw texts in templates will be automatically
-# translated by Gettext backend from I18n. No more complicated translation keys
-# and ugly translation methods in views. Now you can only write in your language,
-# nothing more. At the end of your work you can easy find all phrases to translate
-# and generate .po files for it. This type of files are also more readable and 
-# easier to translate, thanks to it you save your time with translations. 
+# translated by GetText, FastGettext or Gettext backend from I18n. No more 
+# complicated translation keys and ugly translation methods in views. Now you can
+# only write in your language, nothing more. At the end of your work you can easy 
+# find all phrases to translate and generate .po files for it. This type of files 
+# are also more readable and easier to translate, thanks to it you save your 
+# time with translations.
 #
 # === Examples
 #
@@ -43,95 +40,120 @@ require 'i18n/gettext/helpers'
 # translate. 
 # 
 module Haml::MagicTranslations
-  # Overriden function that parses Haml tags. Injects gettext call for all plain
-  # text lines.
-  def parse_tag(line)
-    tag_name, attributes, attributes_hashes, object_ref, nuke_outer_whitespace,
-      nuke_inner_whitespace, action, value, last_line = super(line)
-    
-    magic_translations = self.options[:magic_translations]
-    magic_translations = Haml::Template.options[:magic_translations] if magic_translations.nil?
-    
-    if magic_translations
-      unless action && action != '!' || action == '!' && value[0] == '=' || value.empty?
-        value, interpolation_arguments = prepare_i18n_interpolation(value)
-        value = "\#{_('#{value.gsub(/'/, "\\\\'")}') % #{interpolation_arguments}\}\n"
-      end
-    end
-    [tag_name, attributes, attributes_hashes, object_ref, nuke_outer_whitespace,
-       nuke_inner_whitespace, action, value, last_line]
+  def self.included(haml) # :nodoc:
+    haml.send(:include, EngineMethods)
+    Haml::Template.send(:extend, TemplateMethods)
   end
   
-  # Magical translations will be also used for plain text. 
-  def push_plain(text, options = {})
-    if block_opened?
-      raise SyntaxError.new("Illegal nesting: nesting within plain text is illegal.", @next_line.index)
-    end
-
-    options[:magic_translations] = self.options[:magic_translations] if options[:magic_translations].nil?
-    options[:magic_translations] = Haml::Template.options[:magic_translations] if options[:magic_translations].nil?
-    
-    if options[:magic_translations]
-      value, interpolation_arguments = prepare_i18n_interpolation(text, 
-        :escape_html => options[:escape_html])
-      value = "_('#{value.gsub(/'/, "\\\\'")}') % #{interpolation_arguments}\n"
-      push_script(value, :escape_html => false)
-    else
-      if contains_interpolation?(text)
-        options[:escape_html] = self.options[:escape_html] if options[:escape_html].nil?
-        push_script(
-          unescape_interpolation(text, :escape_html => options[:escape_html]),
-          :escape_html => false)
+  module TemplateMethods
+    def enable_magic_translations(backend = :i18n)
+      case backend
+      when :i18n
+        require 'i18n'
+        require 'i18n/backend/gettext'
+        require 'i18n/gettext/helpers'
+        I18n::Backend::Simple.send(:include, I18n::Backend::Gettext)
+        Haml::Helpers.send(:include, I18n::Gettext::Helpers)
+      when :gettext
+        require 'gettext'
+        Haml::Helpers.send(:include, GetText)      
+      when :fast_gettext
+        require 'fast_gettext'
+        Haml::Helpers.send(:include, FastGettext::Translation)      
       else
-        push_text text
+        raise ArgumentError, "Backend #{which.to_s} is not available in Haml::MagicTranslations"
       end
+      Haml::Template.options[:magic_translations] = true
     end
   end
   
-  # It discovers all fragments of code embeded in text and replacing with 
-  # simple string interpolation parameters. 
-  # 
-  # ==== Example: 
-  #
-  # Following line...
-  # 
-  #   %p This is some #{'Interpolated'.upcase'} text
-  #
-  # ... will be translated to:
-  #
-  #   [ "This is some %s text", "['Interpolated'.upcase]" ]
-  #
-  def prepare_i18n_interpolation(str, opts = {})
-    args = []
-    res  = ''
-    str = str.
-      gsub(/\n/, '\n').
-      gsub(/\r/, '\r').
-      gsub(/\#/, '\#').
-      gsub(/\"/, '\"').
-      gsub(/\\/, '\\\\')
+  module EngineMethods
+    # Overriden function that parses Haml tags. Injects gettext call for all plain
+    # text lines.
+    def parse_tag(line)
+      tag_name, attributes, attributes_hashes, object_ref, nuke_outer_whitespace,
+        nuke_inner_whitespace, action, value, last_line = super(line)
       
-    rest = Haml::Shared.handle_interpolation '"' + str + '"' do |scan|
-      escapes = (scan[2].size - 1) / 2
-      res << scan.matched[0...-3 - escapes]
-      if escapes % 2 == 1
-        res << '#{'
+      magic_translations = self.options[:magic_translations]
+      magic_translations = Haml::Template.options[:magic_translations] if magic_translations.nil?
+      
+      if magic_translations
+        unless action && action != '!' || action == '!' && value[0] == '=' || value.empty?
+          value, interpolation_arguments = prepare_i18n_interpolation(value)
+          value = "\#{_('#{value.gsub(/'/, "\\\\'")}') % #{interpolation_arguments}\}\n"
+        end
+      end
+      [tag_name, attributes, attributes_hashes, object_ref, nuke_outer_whitespace,
+         nuke_inner_whitespace, action, value, last_line]
+    end
+    
+    # Magical translations will be also used for plain text. 
+    def push_plain(text, options = {})
+      if block_opened?
+        raise SyntaxError.new("Illegal nesting: nesting within plain text is illegal.", @next_line.index)
+      end
+
+      options[:magic_translations] = self.options[:magic_translations] if options[:magic_translations].nil?
+      options[:magic_translations] = Haml::Template.options[:magic_translations] if options[:magic_translations].nil?
+      
+      if options[:magic_translations]
+        value, interpolation_arguments = prepare_i18n_interpolation(text, 
+          :escape_html => options[:escape_html])
+        value = "_('#{value.gsub(/'/, "\\\\'")}') % #{interpolation_arguments}\n"
+        push_script(value, :escape_html => false)
       else
-        content = eval('"' + balance(scan, ?{, ?}, 1)[0][0...-1] + '"')
-        content = "Haml::Helpers.html_escape(#{content.to_s})" if opts[:escape_html]
-        args << content
-        res  << '%s'
+        if contains_interpolation?(text)
+          options[:escape_html] = self.options[:escape_html] if options[:escape_html].nil?
+          push_script(
+            unescape_interpolation(text, :escape_html => options[:escape_html]),
+            :escape_html => false)
+        else
+          push_text text
+        end
       end
     end
-    value = res+rest.gsub(/\\(.)/, '\1').chomp
-    value = value[1..-2] unless value.blank?
-    args  = "[#{args.join(', ')}]"
-    [value, args]
+    
+    # It discovers all fragments of code embeded in text and replacing with 
+    # simple string interpolation parameters. 
+    # 
+    # ==== Example: 
+    #
+    # Following line...
+    # 
+    #   %p This is some #{'Interpolated'.upcase'} text
+    #
+    # ... will be translated to:
+    #
+    #   [ "This is some %s text", "['Interpolated'.upcase]" ]
+    #
+    def prepare_i18n_interpolation(str, opts = {})
+      args = []
+      res  = ''
+      str = str.
+        gsub(/\n/, '\n').
+        gsub(/\r/, '\r').
+        gsub(/\#/, '\#').
+        gsub(/\"/, '\"').
+        gsub(/\\/, '\\\\')
+        
+      rest = Haml::Shared.handle_interpolation '"' + str + '"' do |scan|
+        escapes = (scan[2].size - 1) / 2
+        res << scan.matched[0...-3 - escapes]
+        if escapes % 2 == 1
+          res << '#{'
+        else
+          content = eval('"' + balance(scan, ?{, ?}, 1)[0][0...-1] + '"')
+          content = "Haml::Helpers.html_escape(#{content.to_s})" if opts[:escape_html]
+          args << content
+          res  << '%s'
+        end
+      end
+      value = res+rest.gsub(/\\(.)/, '\1').chomp
+      value = value[1..-2] unless value.blank?
+      args  = "[#{args.join(', ')}]"
+      [value, args]
+    end
   end
 end
 
-I18n::Backend::Simple.send(:include, I18n::Backend::Gettext)
 Haml::Engine.send(:include, Haml::MagicTranslations)
-Haml::Helpers.send(:include, I18n::Gettext::Helpers)
-Haml::Template.options[:magic_translations] = true
-

data/spec/{magic_translations_spec.rb → magic_translations/i18n_spec.rb}

@@ -1,12 +1,9 @@
-require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+require File.join(File.dirname(__FILE__), '../spec_helper.rb')
 
-def render(text, options = {}, &block)
-  scope  = options.delete(:scope)  || Object.new
-  locals = options.delete(:locals) || {}
-  Haml::Engine.new(text, options).to_html(scope, locals, &block)
-end
+Haml::Template.enable_magic_translations(:i18n)
+I18n.load_path += Dir[File.join(File.dirname(__FILE__), "../locales/*.{po}")]
 
-describe 'Haml magic translations' do 
+describe 'Haml magic translations with I18n' do 
 
   it 'should allow to set :magic_translations option in Haml::Template' do
     Haml::Template.options.key?(:magic_translations).should be_true

data/spec/spec_helper.rb

@@ -13,6 +13,8 @@ require 'haml/magic_translations'
 Haml::Template.options[:ugly] = false
 Haml::Template.options[:format] = :xhtml
 
-I18n::Backend::Simple.send(:include, I18n::Backend::Gettext)
-I18n.load_path += Dir[File.join(File.dirname(__FILE__), "locales/*.{po}")]
-
+def render(text, options = {}, &block)
+  scope  = options.delete(:scope)  || Object.new
+  locals = options.delete(:locals) || {}
+  Haml::Engine.new(text, options).to_html(scope, locals, &block)
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kriss Kowalik
@@ -31,42 +31,15 @@ dependencies:
         version: 3.0.0
   type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: i18n
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 1
-        version: 0.4.1
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: gettext
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 0
-        version: 2.0.0
-  type: :development
-  version_requirements: *id003
 description: |
   This plugin provides "magical translations" in your .haml files. What does it
   mean? It's mean that all your raw texts in templates will be automatically
-  translated by Gettext backend from I18n. No more complicated translation keys
-  and ugly translation methods in views. Now you can only write in your language,
-  nothing more. At the end of your work you can easy find all phrases to translate
-  and generate .po files for it. This type of files are also more readable and 
-  easier to translate, thanks to it you save your time with translations. 
+  translated by GetText, FastGettext or Gettext backend from I18n. No more 
+  complicated translation keys and ugly translation methods in views. Now you can
+  only write in your language, nothing more. At the end of your work you can easy 
+  find all phrases to translate and generate .po files for it. This type of files 
+  are also more readable and easier to translate, thanks to it you save your 
+  time with translations.
 
 email: kriss.kowalik@gmail.com
 executables: []
@@ -89,7 +62,7 @@ files:
 - lib/haml/magic_translations.rb
 - spec/locales/en.po
 - spec/locales/pl.po
-- spec/magic_translations_spec.rb
+- spec/magic_translations/i18n_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/kriss/haml-magic-translations
@@ -123,4 +96,4 @@ specification_version: 3
 summary: Provides automaticaly translations in haml templates
 test_files: 
 - spec/spec_helper.rb
-- spec/magic_translations_spec.rb
+- spec/magic_translations/i18n_spec.rb