gettext_json 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Simon COURTOSI
+
+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.markdown

@@ -0,0 +1,55 @@
+# GettextJson
+
+Rails plugin that make possible to use GetText ranslations in javascipt.
+
+## Installation
+
+GettextJson can be installed as a gem :
+
+    gem install gettext_json
+
+Or directly as a Rails plugin :
+
+    ./script/plugin install git://github.com/simonc/rails_gettext_json.git
+
+## Usage
+
+### Initialization
+
+To install the GettextJson files in your application use the following generator :
+
+    ./script/generate gettext_json
+
+It will create two files :
+
+    public/javascripts/gettext_json.js
+    lib/js_parser.rb
+
+`gettext_json.js` is the GetText micro library for javascript. To use gettext_json you have to call this file from your layout.  
+
+`lib/js_parser.rb` is a Javascript gettext parser. To use it, require the file inn your rake tasks for gettext.
+
+For more informations, see [GetText micro library](http://wiki.github.com/simonc/rails_gettext_json/gettext-micro-library)
+and [Javascript parser](http://wiki.github.com/simonc/rails_gettext_json/javascript-parser) in the wiki.
+
+### Getting the translations
+
+To create the translations file, use the following rake task :
+
+    rake makemo:json
+
+It will generate the `public/javascripts/gettext_json_translations.js` file that contains the translated strings for all languages.
+To make the GetText translations work, you need to call this file in your layout.
+
+### Use it in your scripts
+
+To translate strings in your scripts, simply use the GetText micro library API :
+
+    GetText.locale = 'fr'; // To set the current locale (default is 'en')
+    
+    var str = GetText.t('Hello World');
+    //=> "Bonjour le Monde"
+ 
+## Copyright
+
+Copyright (c) 2009 Simon COURTOIS, released under the MIT license

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the gettext_json plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the gettext_json plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GettextJson'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "gettext_json"
+  s.version = "0.0.1"
+  s.author = "Simon COURTOIS"
+  s.email = "happynoff@free.fr"
+  s.homepage = "http://github.com/simonc/rails_gettext_json"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Rails plugin that make possible to use GetText ranslations in javascipt."
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+  s.has_rdoc = false
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/generators/gettext_json/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create the GetText javascript library
+
+Example:
+    ./script/generate gettext_json
+
+    This will create:
+        public/javascript/gettext_json.js

data/generators/gettext_json/gettext_json_generator.rb

@@ -0,0 +1,33 @@
+def colorize(text)
+  "\e[33m#{text}\e[0m"
+end
+
+class GettextJsonGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'public/javascripts'
+      m.template 'gettext_json.js', File.join('public/javascripts', 'gettext_json.js')
+      m.directory 'lib'
+      m.template 'js_parser.rb', File.join('lib', 'js_parser.rb')
+    end
+  end
+
+  def after_generate
+      puts <<-ALERT
+
+                            ATTENTION !
+
+In order to use the gettext_json library, add the following line in your layout :
+    #{colorize("javascript_include_tag 'gettext_json.js'")}
+
+To add JavaScript files parser in your updatepo rake task, add this in the task code :
+    #{colorize("require 'js_parser'")}
+
+To generate the translations json file use the following rake task :
+    #{colorize("rake makemo:json")}
+And then add the following line in your layout :
+    #{colorize("javascript_include_tag 'gettext_json_translations.js'")}
+
+ALERT
+  end
+end

data/generators/gettext_json/templates/gettext_json.js

@@ -0,0 +1,34 @@
+// The GetText main class
+function GetTextJson() {
+  this.default_locale = 'en'; // The default locale to use
+  this.locale         = null; // Can be set by the user
+  this.translations   = null; // List of all translations
+
+  // Returns the locale currently in use.
+  // Returns default_locale if locale is null.
+  this.current_locale = function() {
+    if (typeof(this._current_locale) == 'undefined') {
+      this._current_locale = (this.locale || this.default_locale);
+    }
+    return this._current_locale;
+  };
+
+  // Returns the translation of a string if it exists.
+  // Otherwise the string itself is returned.
+  this.translate = function(msgid) {
+    var msgstr = msgid;
+    var locale = this.current_locale();
+
+    if (this.translations[locale] != undefined) {
+       if (this.translations[locale][msgid] != undefined) {
+         msgstr = this.translations[locale][msgid];
+       }
+    }
+    return msgstr;
+  };
+  // Aliasing translate() to t()
+  this.t = this.translate;
+}
+
+// Creating the GetText instance
+var GetText = new GetTextJson();

data/generators/gettext_json/templates/js_parser.rb

@@ -0,0 +1,17 @@
+require 'gettext_rails/tools'
+
+module JsParser
+  module_function
+
+  def target?(file)
+    File.extname(file) == ".js"
+  end
+
+  def parse(file, ary = [])
+    js = File.read(file)
+    code = js.scan(/GetText.t(?:ranslate)? ?\(['"].*?['"]\)/).map { |s| s.gsub(/GetText.t(?:ranslate)? ?/, '_') }
+    GetText::RubyParser.parse_lines(file, code, ary)
+  end
+end
+
+GetText::RGetText.add_parser(JsParser)

data/init.rb

@@ -0,0 +1,9 @@
+begin
+  require File.join(File.dirname(__FILE__), 'lib', 'gettext_json')
+rescue LoadError
+  begin
+    require 'gettext_json'
+  rescue LoadError => e
+    raise e unless defined?(Rake) && Rake.application.top_level_tasks.include?('gems:install')
+  end
+end

data/tasks/gettext_json_tasks.rake

@@ -0,0 +1,22 @@
+desc "Generate json file for gettext translations"
+task :"makemo:json" do
+  translations = {}
+
+  Dir.glob("po/*/") do |folder|
+    lang = File.basename(folder)
+    translations[lang] = {}
+
+    Dir.glob(File.join(folder, '*.po')) do |file|
+      code = File.read(file)
+      msgs = code.scan(/^msgid "(.*?)"\nmsgstr "(.*?)"\n(?:\n|$)/m).each do |msg|
+        translations[lang][msg[0]] = msg[1].gsub(/["\n]/, '') unless msg[0].empty?
+      end
+    end
+  end
+
+  File.open('public/javascripts/gettext_json_translations.js', 'w') do |f|
+    f.write 'GetText.translations = '
+    f.write translations.to_json
+    f.write ";"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: gettext_json
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simon COURTOIS
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: happynoff@free.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- uninstall.rb
+- generators/gettext_json/gettext_json_generator.rb
+- generators/gettext_json/templates/gettext_json.js
+- generators/gettext_json/templates/js_parser.rb
+- generators/gettext_json/USAGE
+- lib/gettext_json.rb
+- tasks/gettext_json_tasks.rake
+has_rdoc: true
+homepage: http://github.com/simonc/rails_gettext_json
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Rails plugin that make possible to use GetText ranslations in javascipt.
+test_files: []
+