haml-magic-translations 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kriss Kowalik
+
+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.rdoc

@@ -0,0 +1,84 @@
+== Magic Translations
+
+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.     
+
+=== Installation
+
+You can install haml-magic-translations directly from rubygems:
+
+  gem install haml-magic-translations
+  
+...or as Ruby on Rails plugin:
+
+  script/plugin install git://github.com/kriss/haml-magic-translations
+or
+  rails plugin install git://github.com/kriss/haml-magic-translations 
+
+=== 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
+
+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.options[:magic_translations] = true
+  
+And that's all. 
+
+=== Examples
+
+Now you can write what you want, and at the end of work you 
+will easy found all phrases to translate. Check out following example:
+
+  %p This is my simple dummy text.
+  %p And more lorem ipsum...
+  %p= link_to _("This will be also translated"), "#"
+  
+Those translations are allso allowing you to use standard Haml interpolation. 
+You can easy write: 
+  
+  %p This is my text with #{"interpolation".upcase}... Great, isn't it?
+  %p
+    This multiline string
+    Will be also translated
+    
+And text from codes above will be stored in .po files as:
+
+  # File test1.haml, line 1
+  msgid "This is my simple dummy text"
+  msgstr "This is my dummy translation of dummy text"
+  
+  # File test2.haml, line 1
+  msgid "This is my text with %s... Great, isn't it?"
+  msgstr "Next one %s translation!"
+  
+  # File test4.haml, line 3
+  msgid "This multiline string"
+  msgstr ""
+  
+  # File test2.haml, line 4
+  msgid "Will be also translated"
+  msgstr ""
+  
+Notice that in multiline strings each line is translated separatelly. 
+  
+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. 
+
+=== Copyrights
+
+Kriss Kowalik (kriss.kowalik@gmail.com)
+

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "haml-magic-translations"
+    gem.summary = "Provides automaticaly translations in haml templates"
+    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. 
+    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
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+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)
+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']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,/Users/']
+  end
+end
+
+desc 'Generate documentation for the simple_navigation plugin.'
+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')
+end

data/TODO

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

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/haml-magic-translations.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{haml-magic-translations}
+  s.version = "0.1.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.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. 
+}
+  s.email = %q{kriss.kowalik@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  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_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kriss/haml-magic-translations}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Provides automaticaly translations in haml templates}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/magic_translations_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"])
+      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/init.rb

@@ -0,0 +1 @@
+require 'haml-magic-translations'

data/lib/haml-magic-translations.rb

@@ -0,0 +1,3 @@
+require 'haml/magic_translations'
+
+

data/lib/haml/magic_translations.rb

@@ -0,0 +1,137 @@
+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. 
+#
+# === Examples
+#
+# Now you can write what you want, and at the end of work you 
+# will easy found all phrases to translate. Check out following example:
+# 
+#   %p This is my simple dummy text.
+#   %p And more lorem ipsum...
+#   %p= link_to _("This will be also translated"), "#"
+#   
+# Those translations are allso allowing you to use standard Haml interpolation. 
+# You can easy write: 
+#   
+#   %p This is my text with #{"interpolation".upcase}... Great, isn't it?
+#   
+# And text from codes above will be stored in .po files as:
+# 
+#   # File test1.haml, line 1
+#   msgid "This is my simple dummy text"
+#   msgstr "This is my dummy translation of dummy text"
+#   
+#   # File test2.haml, line 1
+#   msgid "This is my text with %s... Great, isn't it?"
+#   msgstr "Next one %s translation!"
+#   
+# 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. 
+# 
+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]
+  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)
+      else
+        push_text text
+      end
+    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
+    end
+    value = res+rest.gsub(/\\(.)/, '\1').chomp
+    value = value[1..-2] unless value.blank?
+    args  = "[#{args.join(', ')}]"
+    [value, args]
+  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/locales/en.po

@@ -0,0 +1,7 @@
+
+msgid "Magic translations works!"
+msgstr ""
+
+msgid "Here with interpolation, and everything thanks to %s and %s"
+msgstr ""
+

data/spec/locales/pl.po

@@ -0,0 +1,16 @@
+
+msgid "Magic translations works!"
+msgstr "Magiczne tłumaczenie działa!"
+
+msgid "Here with interpolation, and everything thanks to %s and %s"
+msgstr "A tutaj razem z interpolacją, a to wszystko dzięki połączeniu %s i %s"
+
+msgid "Now we will check multiline strings,"
+msgstr "Kolejny wieloliniowy tekst,"
+
+msgid "which should be also translated,"  
+msgstr "który powinien zostać przetłumaczony,"
+
+msgid "with interpolation %s"
+msgstr "interpolacja %s też działa!"
+

data/spec/magic_translations_spec.rb

@@ -0,0 +1,68 @@
+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
+
+describe 'Haml magic translations' do 
+
+  it 'should allow to set :magic_translations option in Haml::Template' do
+    Haml::Template.options.key?(:magic_translations).should be_true
+  end
+
+  it 'should translate text using existing locales' do 
+    Haml::Template.options[:magic_translations] = true
+    I18n.locale = :pl
+    <<HTML.should == render(<<HAML)
+<p>Magiczne tłumaczenie działa!</p>
+<p>A tutaj razem z interpolacją, a to wszystko dzięki połączeniu I18n i GetText</p>
+HTML
+%p Magic translations works!
+%p Here with interpolation, and everything thanks to \#{I18n.name} and \#{GetText.name}
+HAML
+  end
+
+  it 'should leave text without changes when translation was not found' do
+    Haml::Template.options[:magic_translations] = true
+    I18n.locale = :en
+    <<HTML.should == render(<<HAML)
+<p>Magic translations works!</p>
+<p>And this one does not exist</p>
+<p>Here with interpolation, and everything thanks to I18n and GetText</p>
+HTML
+%p Magic translations works!
+%p And this one does not exist
+%p Here with interpolation, and everything thanks to \#{I18n.name} and \#{GetText.name}
+HAML
+  end
+  
+  it 'should translate text with multiline plain text' do 
+    Haml::Template.options[:magic_translations] = true
+    I18n.locale = :pl
+    <<HTML.should == render(<<HAML)
+<p>Magiczne tłumaczenie działa!</p>
+<p>
+  Kolejny wieloliniowy tekst,
+  który powinien zostać przetłumaczony,
+  interpolacja INTERPOLATION też działa!
+</p>
+HTML
+%p Magic translations works!
+%p 
+  Now we will check multiline strings,
+  which should be also translated,
+  with interpolation \#{'Interpolation'.upcase}
+HAML
+  end
+  
+  it 'should leave text without changes when :magic_translations option is off' do 
+    Haml::Template.options[:magic_translations] = false
+    <<HTML.should == render(<<HAML)
+<p>Text without changes</p>
+HTML
+%p Text without changes
+HAML
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+ENV["RAILS_ENV"] = "test"
+require 'rubygems'
+require 'spec'
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), '../lib')
+
+require 'action_controller'
+require 'action_view'
+
+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}")]
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: haml-magic-translations
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Kriss Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        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. 
+
+email: kriss.kowalik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+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_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kriss/haml-magic-translations
+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: Provides automaticaly translations in haml templates
+test_files: 
+- spec/spec_helper.rb
+- spec/magic_translations_spec.rb