internashunalize-js 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.textile

@@ -0,0 +1,37 @@
+h2. Intro
+
+This gem takes an other approach to Javascript internationalization than most others do. 
+I use this in production but you might want to look at it as a proof of concept.
+The goal is to build a lightweight, unobtrusive and powerful translation solution for Frontend applications by using standard libraries.
+
+Right now, you'll have to manually provide the following depencencies: Rails, jQuery and Mustache.
+
+h2. Installation
+
+h3. Add the gem to your Gemfile
+
+bc. gem 'internashunalize-js'
+    
+h3. Run the generator
+
+bc. rails g internashunalize:js:install
+
+Don't forget to include the javascript in your Html.
+
+h3. Mark translations you want to use in your scripts
+    
+bc. <% t(:yml_key, :javascript => true) %>
+        
+h3. Place the view helper somewhere in your layout / views
+
+bc. <%= javascript_translations %>
+
+h2. Usage
+    
+Start using the marked translations in your Javascript
+
+bc. I18n.t('yml_key')
+
+For interpolating values, you can pass a Json object as second argument
+
+bc. I18n.t('yml_key_with_variable', { your_variable: 'Variable content' })

data/Rakefile

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

data/internashunalize-js.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "internashunalize-js/version"
+
+Gem::Specification.new do |s|
+  s.name        = "internashunalize-js"
+  s.version     = Internashunalize::Js::VERSION
+  s.authors     = ["Christian Felder (masone)"]
+  s.email       = ["ema@rh-productions.ch"]
+  s.homepage    = "http://masone.ch"
+  s.summary     = "I18n for your Javascript."
+  s.description = "Uses the I18n library to provide translated strings to your Javascript."
+
+  #s.add_dependency "railties", "~> 3.0"
+  s.rubyforge_project = "internashunalize-js"
+
+  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 "i18n"
+end

data/lib/generators/internashunalize/install_generator.rb

@@ -0,0 +1,16 @@
+module Internashunalize
+  module Generators
+
+   class InstallGenerator < Rails::Generators::Base
+
+      desc "This generator installs internashunalize.js"
+      source_root File.expand_path('../../../../vendor/assets/javascripts', __FILE__)          
+
+      def copy
+        say_status("copying", "internashunalize.js", :green)
+        copy_file "internashunalize.js", "public/javascripts/internashunalize.js"
+      end
+
+    end
+  end
+end

data/lib/internashunalize-js/i18n.rb

@@ -0,0 +1,32 @@
+module I18n
+
+  class << self
+
+    alias :translate_core :translate
+    alias :t :translate
+
+    def translate(*args)
+      args_core = args.dup
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      javascript = options.delete(:javascript)
+      key = args.shift        
+
+      translation = self.translate_core(*args_core)
+
+      if javascript
+        @javascript_translations ||= {}
+        translation.gsub!(/%\{(\w*)\}/, "{{\\1}}") if translation.is_a? String # TODO: translate can return a hash, eg. when interpolating %{count}
+        @javascript_translations[key] = translation
+      end
+
+      return translation
+    end
+    
+    # TODO: implement localization?
+
+    def javascript_translations
+      @javascript_translations
+    end
+
+  end
+end

data/lib/internashunalize-js/railtie.rb

@@ -0,0 +1,9 @@
+module Internashunalize
+  module Js
+    class Railtie < Rails::Railtie
+      initializer "internashunalize-js.view_helpers" do
+        ActionView::Base.send :include, Internashunalize::Js::ViewHelpers
+      end    
+    end
+  end
+end

data/lib/internashunalize-js/version.rb

@@ -0,0 +1,5 @@
+module Internashunalize
+  module Js
+    VERSION = "0.0.1"
+  end
+end

data/lib/internashunalize-js/view_helpers.rb

@@ -0,0 +1,9 @@
+module Internashunalize
+  module Js
+    module ViewHelpers
+      def internashunalize
+        content_tag(:div, nil, :id => 'internashunalize', :'data-internashunalize' => I18n.javascript_translations.to_json).html_safe
+      end
+    end
+  end
+end

data/lib/internashunalize-js.rb

@@ -0,0 +1,7 @@
+require "internashunalize-js/version"
+require "internashunalize-js/i18n"
+require "internashunalize-js/view_helpers"
+
+if defined?(Rails)
+  require 'internashunalize-js/railtie' 
+end

data/vendor/assets/javascripts/internashunalize.coffee

@@ -0,0 +1,17 @@
+class I18n
+
+  @t: (key, object=undefined) ->
+    @translate(key, object)
+
+  @translate: (key, object=undefined) ->
+    translation = @translations()[key]
+    if object?
+      return Mustache.to_html(translation, object)
+    else
+      return translation
+
+  @translations: ->
+    @translations_json ||= $.parseJSON($('body div#internashunalize').attr('data-internashunalize'))
+    return @translations_json
+
+window.I18n = I18n

data/vendor/assets/javascripts/internashunalize.js

@@ -0,0 +1,30 @@
+(function() {
+  var I18n;
+  I18n = (function() {
+    function I18n() {}
+    I18n.t = function(key, object) {
+      if (object == null) {
+        object = void 0;
+      }
+      return this.translate(key, object);
+    };
+    I18n.translate = function(key, object) {
+      var translation;
+      if (object == null) {
+        object = void 0;
+      }
+      translation = this.translations()[key];
+      if (object != null) {
+        return Mustache.to_html(translation, object);
+      } else {
+        return translation;
+      }
+    };
+    I18n.translations = function() {
+      this.translations_json || (this.translations_json = $.parseJSON($('body div#javascript_translations').attr('data-javascript_translations')));
+      return this.translations_json;
+    };
+    return I18n;
+  })();
+  window.I18n = I18n;
+}).call(this);

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: internashunalize-js
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Felder (masone)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70327439186840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327439186840
+description: Uses the I18n library to provide translated strings to your Javascript.
+email:
+- ema@rh-productions.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.textile
+- Rakefile
+- internashunalize-js.gemspec
+- lib/generators/internashunalize/install_generator.rb
+- lib/internashunalize-js.rb
+- lib/internashunalize-js/i18n.rb
+- lib/internashunalize-js/railtie.rb
+- lib/internashunalize-js/version.rb
+- lib/internashunalize-js/view_helpers.rb
+- vendor/assets/javascripts/internashunalize.coffee
+- vendor/assets/javascripts/internashunalize.js
+homepage: http://masone.ch
+licenses: []
+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: internashunalize-js
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: I18n for your Javascript.
+test_files: []