haml-magic-translations 0.2.2 → 0.3.1

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2010 Kriss Kowalik
+Copyright (c) 2012 potager.org
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -27,9 +27,9 @@ 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:
 
-  Haml::Template.enable_magic_translations(:i18n) # this backend is used by default
+  Haml::MagicTranslations.enable(:i18n) # this backend is used by default
   
-Available backends are `:i18n`, `:gettext and `:fast_gettext`
+Available backends are +:i18n+, +:gettext+ and +:fast_gettext+
 
 Now you have to add path to all your .po files with locales. Eg. for i18n backend
 it will be something like:    
@@ -79,7 +79,23 @@ Generator for .po files also includes information where your phrases are placed
 in filesystem. Thanks to it you don't forget about any even small word to 
 translate. 
 
+=== Extracting strings and merging translations
+
+In order to extract translatable strings and merge with existing translation,
+this gem provides an Haml parser for RGetText. You can either use it directly
+or through the provided Rake task. Here's an example on how to use the later:
+
+  Haml::MagicTranslations::Tasks::UpdatePoFiles.new do |t|
+    t.text_domain = 'my_project'
+    t.files = Dir.glob("views/**/*.{rb,haml}") << "lib/my_project.rb"
+    t.app_version = 'my_project 0.1'
+  end
+
+This will add a +update_pofiles+ task that will update PO files that can be
+found in the +po+ directory.
+
 === Copyrights
 
 Kriss Kowalik (kriss.kowalik@gmail.com)
 
+potager.org (jardiniers@potager.org)

data/Rakefile

@@ -15,33 +15,37 @@ 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.email = "jardiniers@potager.org"
+    gem.homepage = "http://github.com/potager/haml-magic-translations"
+    gem.authors = ["Kriss Kowalik", "potager.org"]
+    gem.add_dependency "haml", ">= 3.1.0"
+    gem.add_development_dependency "actionpack"
+    gem.add_development_dependency "gettext"
+    gem.add_development_dependency "fast_gettext"
+    gem.add_development_dependency "rspec", ">= 2"
+    gem.add_development_dependency "rdoc", ">= 2.4.2"
+    gem.add_development_dependency "maruku"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
 
 desc 'Default: run specs.'
 task :default => :spec
 
 desc 'Run the specs'
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = Dir['spec/**/*_spec.rb']
-  t.spec_opts  = %w(-fs --color)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts  = %w(-fs --color)
 end
 
 namespace :spec do
   desc "Run all specs with RCov"
-  Spec::Rake::SpecTask.new(:rcov) do |t|
-    t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
-    t.spec_files = FileList['spec/**/*_spec.rb']
+  RSpec::Core::RakeTask.new(:rcov) do |t|
+    t.rspec_opts = ['--colour --format progress --loadby mtime --reverse']
     t.rcov = true
     t.rcov_opts = ['--exclude', 'spec,/Users/']
   end
@@ -52,6 +56,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'SimpleNavigation'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
 end

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.1

data/haml-magic-translations.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{haml-magic-translations}
-  s.version = "0.2.2"
+  s.version = "0.3.1"
 
   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.authors = ["Kriss Kowalik", "potager.org"]
+  s.date = %q{2012-04-09}
   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, FastGettext or Gettext backend from I18n. No more 
@@ -19,48 +19,63 @@ 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.email = %q{jardiniers@potager.org}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc",
-     "TODO"
+    "README.rdoc"
   ]
   s.files = [
     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "TODO",
-     "VERSION",
-     "haml-magic-translations.gemspec",
-     "init.rb",
-     "lib/haml-magic-translations.rb",
-     "lib/haml/magic_translations.rb",
-     "spec/locales/en.po",
-     "spec/locales/pl.po",
-     "spec/magic_translations/i18n_spec.rb",
-     "spec/spec_helper.rb"
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "haml-magic-translations.gemspec",
+    "init.rb",
+    "lib/haml-magic-translations.rb",
+    "lib/haml/magic_translations.rb",
+    "lib/haml/magic_translations/rgettext/haml_parser.rb",
+    "lib/haml/magic_translations/tasks.rb",
+    "spec/haml/magic_translations/rgettext/haml_parser_spec.rb",
+    "spec/haml/magic_translations/tasks_spec.rb",
+    "spec/haml/magic_translations_spec.rb",
+    "spec/locales/en.po",
+    "spec/locales/pl.po",
+    "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/kriss/haml-magic-translations}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.homepage = %q{http://github.com/potager/haml-magic-translations}
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Provides automaticaly translations in haml templates}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/magic_translations/i18n_spec.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<haml>, [">= 3.0.0"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<haml>, [">= 3.1.0"])
+      s.add_development_dependency(%q<actionpack>, [">= 0"])
+      s.add_development_dependency(%q<gettext>, [">= 0"])
+      s.add_development_dependency(%q<fast_gettext>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2"])
+      s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_development_dependency(%q<maruku>, [">= 0"])
     else
-      s.add_dependency(%q<haml>, [">= 3.0.0"])
+      s.add_dependency(%q<haml>, [">= 3.1.0"])
+      s.add_dependency(%q<actionpack>, [">= 0"])
+      s.add_dependency(%q<gettext>, [">= 0"])
+      s.add_dependency(%q<fast_gettext>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2"])
+      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_dependency(%q<maruku>, [">= 0"])
     end
   else
-    s.add_dependency(%q<haml>, [">= 3.0.0"])
+    s.add_dependency(%q<haml>, [">= 3.1.0"])
+    s.add_dependency(%q<actionpack>, [">= 0"])
+    s.add_dependency(%q<gettext>, [">= 0"])
+    s.add_dependency(%q<fast_gettext>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2"])
+    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    s.add_dependency(%q<maruku>, [">= 0"])
   end
 end
 

data/lib/haml/magic_translations.rb

@@ -1,5 +1,7 @@
+# -*- coding: UTF-8 -*-
+
 require 'haml'
-require 'haml/template'
+require 'json'
 
 ##
 # This plugin provides "magical translations" in your .haml files. What does it
@@ -42,116 +44,161 @@ require 'haml/template'
 module Haml::MagicTranslations
   def self.included(haml) # :nodoc:
     haml.send(:include, EngineMethods)
-    Haml::Template.send(:extend, TemplateMethods)
+    if defined? Haml::Template
+      Haml::Template.send(:extend, TemplateMethods)
+    end
   end
-  
-  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)      
+
+  # 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 self.prepare_i18n_interpolation(str, escape_html = nil)
+    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
-        raise ArgumentError, "Backend #{which.to_s} is not available in Haml::MagicTranslations"
+        content = eval('"' + Haml::Shared.balance(scan, ?{, ?}, 1)[0][0...-1] + '"')
+        content = "Haml::Helpers.html_escape(#{content.to_s})" if escape_html
+        args << content
+        res  << '%s'
       end
-      Haml::Template.options[:magic_translations] = true
+    end
+    value = res+rest.gsub(/\\(.)/, '\1').chomp
+    value = value[1..-2] unless value.to_s == ''
+    args  = "[#{args.join(', ')}]"
+    [value, args]
+  end
+
+  def self.enabled?
+    @enabled
+  end
+
+  # Enable magic translations using the given backend
+  #
+  # Supported backends:
+  #
+  # +:i18n+:: Use I18n::Backend::GetText and I18n::GetText::Helpers
+  #           from the 'i18n'
+  # +:gettext+:: Use GetText from 'gettext'
+  # +:fast_gettext+:: Use FastGettext::Translation from 'fast_gettext'
+  def self.enable(backend = :i18n)
+    case backend
+    when :i18n
+      require 'i18n'
+      require 'i18n/backend/gettext'
+      require 'i18n/gettext/helpers'
+      I18n::Backend::Simple.send(:include, I18n::Backend::Gettext)
+      EngineMethods.magic_translations_helpers = I18n::Gettext::Helpers
+    when :gettext
+      require 'gettext'
+      EngineMethods.magic_translations_helpers = GetText
+    when :fast_gettext
+      require 'fast_gettext'
+      EngineMethods.magic_translations_helpers = FastGettext::Translation
+    else
+      @enabled = false
+      raise ArgumentError, "Backend #{backend.to_s} is not available in Haml::MagicTranslations"
+    end
+    @enabled = true
+  end
+
+  # Disable magic translations
+  def self.disable
+    EngineMethods.magic_translations_helpers = nil
+    @enabled = false
+  end
+
+  module TemplateMethods # :nodoc:all
+    # backward compatibility with versions < 0.3
+    def enable_magic_translations(backend = :i18n)
+      Haml::MagicTranslations.enable backend
     end
   end
-  
-  module EngineMethods
+
+  module EngineMethods # :nodoc:all
+    class << self
+      attr_accessor :magic_translations_helpers
+    end
+
+    def magic_translations?
+      return self.options[:magic_translations] unless self.options[:magic_translations].nil?
+
+      Haml::MagicTranslations.enabled?
+    end
+
     # 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)
+
+      if magic_translations? && !value.empty?
+        unless action && action == '=' || action == '!' && value[0] == ?= || action == '&' && value[0] == ?=
+          value, interpolation_arguments = Haml::MagicTranslations.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])
+    # Magical translations will be also used for plain text.
+    def plain(text, escape_html = nil)
+      if magic_translations?
+        value, interpolation_arguments = Haml::MagicTranslations.prepare_i18n_interpolation(text, escape_html)
         value = "_('#{value.gsub(/'/, "\\\\'")}') % #{interpolation_arguments}\n"
-        push_script(value, :escape_html => false)
+        script(value, !:escape_html)
       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)
-        else
-          push_text text
-        end
+        super
       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(/\\/, '\\\\')
-        
-      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
+
+    def compile_filter
+      super unless magic_translations?
+
+      case @node.value[:name]
+        when 'markdown'
+          @node.value[:text] = "\#{_(<<-'END_OF_TRANSLATABLE_MARKDOWN'.rstrip
+#{@node.value[:text].rstrip.gsub(/\n/, '\n')}
+END_OF_TRANSLATABLE_MARKDOWN
+)}"
+        when 'javascript'
+          @node.value[:text].gsub!(/_\(('(([^']|\\')+)'|"(([^"]|\\")+)")\)/) do |m|
+            to_parse = $1[1..-2].gsub(/"/, '\"')
+            parsed_string = JSON.parse("[\"#{to_parse}\"]")[0]
+            parsed_string.gsub!(/'/, "\\\\'")
+            "\#{_('#{parsed_string}').to_json}"
+          end
+      end
+      super
+    end
+
+    def compile_root
+      if magic_translations?
+        @precompiled << "extend #{EngineMethods.magic_translations_helpers};"
       end
-      value = res+rest.gsub(/\\(.)/, '\1').chomp
-      value = value[1..-2] unless value.to_s == ''
-      args  = "[#{args.join(', ')}]"
-      [value, args]
+      super
     end
   end
 end