rails-asset-localization 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dc894f511f5f871350db99b4f8bdf04136a0c98
+  data.tar.gz: bbba3254df0214acc949a7e68b5a651bac4b5a76
+SHA512:
+  metadata.gz: f952e85c880d5485bb7bd470bd095c3aa432a37d744ac427a6dea5ac8cd95e0c187fd211b065e80b5b31a203854889dee2d108378b2eccafe4578b952926b287
+  data.tar.gz: bdbcdc92113f433319c8a88b7a55546dadf63d11fc097639d8b919477463feb4d67e3ebb8ec2735098203e04acbcb4459af34e956d91f67181797bdc5b2bc415

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011-2013 Raphael Randschau (nicolai86@me.com)
+
+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.md

@@ -0,0 +1,85 @@
+# RailsAssetLocalization
+
+A Rails Engine that allows you to use i18next with the asset pipeline. Locales are served dynamically to allow easy integration with services like [CopyCopter][1].
+
+## Basic Setup
+
+Add this to your `Gemfile`:
+
+    gem 'rails-asset-localization', git: 'git@github.com:nicolai86/rails-asset-localization.git', branch: :master
+
+Your locales are now available under `/locales/:locale`
+
+Now you need to load i18next:
+``` coffeescript
+# inside your application.coffee
+#= require i18next.min # or i18next for development version
+```
+
+and properly configure it to work with your rails locales:
+``` coffeescript
+# inside your app startup code
+locale = "de"
+i18n.init({
+  # change default interpolation from __VARIABLE__ to rails-style %{VARIABLE}
+  interpolationPrefix: '%{'
+  interpolationSuffix: '}'
+
+  # current locale to load
+  lng: locale
+
+  # rails-asset-localization path
+  resGetPath: '/locales/%{lng}.json'
+
+  # store locales for 1 day in localStorage
+  useLocalStorage: true
+  localStorageExpirationTime: 60 * 60 * 24 * 1000
+})
+```
+
+Now you can use it everywhere in your asset pipeline - see [i18next dokumentation][2] for details.
+
+## Advanced Setup: precompiled assets
+
+You might want to serve a static version of your assets to enable users to access your localization without incurring additional network requests.
+
+First, load your latest locales into the asset pipeline:
+``` coffeescript
+# inside your application.coffee
+#= require i18next.min
+#= require i18n/translations
+```
+
+Next, instruct i18next to store the bundled locales locally
+``` coffeescript
+for bundledLocale of bundledLocales
+  storedLocale = window.localStorage.getItem("res_#{bundledLocale}")?
+  unless storedLocale?
+    object = {}
+    object[bundledLocale] = bundledLocales[bundledLocale]
+    i18n.sync._storeLocal object
+```
+
+Lastly, initialize i18next like described above
+
+This way your locales are instantly accessible. The next time the i18next updates all locales (your cached locales need to be older than `localStorageExpirationTime` ms) the locales are updated and voilà. Your user sees new content.
+
+## Advanced Setup: HandlebarsAsset integration
+
+If you are using @leshill awesome [handlebars_assets][3] you might want to use a handlebars helper function to use it inside your views.
+This will get you started:
+
+``` coffeescript
+Handlebars.registerHelper 't', ->
+  args = [].slice.call(arguments)
+  result = i18n.t.apply(i18n,args)
+  return new Handlebars.SafeString(result)
+
+# inside your views
+
+{{t "app.hello", name: "Max Mustermann"}} # => Hello %{name} -> Hello Max Mustermann
+```
+
+[1]:https://github.com/copycopter/copycopter-server
+[2]:http://i18next.com/
+[3]:https://github.com/leshill/handlebars_assets

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JqueryLocalizationEngine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/i18n/translations.coffee.erb

@@ -0,0 +1,13 @@
+locales = {}
+
+<%
+  locales_exporter = ::RailsAssetLocalization::LocalesExporter.new
+  I18n.available_locales.uniq.each do |locale|
+%>
+locales['<%= locale %>'] = {}
+locales['<%= locale %>']['translation'] = <%= locales_exporter.translations[locale.to_sym].to_json %>
+<%
+  end
+%>
+
+window.bundledLocales = locales

data/app/controllers/rails_asset_localization/locales_controller.rb

@@ -0,0 +1,13 @@
+module RailsAssetLocalization
+  class LocalesController < ::ApplicationController
+    respond_to :json
+
+    def locale
+      locale = params.fetch(:locale) { I18n.default_locale.to_s }
+      locale = $1 if locale =~ /(\w+)\-(\w+)/
+
+      locales_exporter = ::RailsAssetLocalization::LocalesExporter.new
+      respond_with (locales_exporter.translations[locale.to_sym] || {}).to_json
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match '/locales/:locale', to: 'rails_asset_localization/locales#locale', via: :get, as: :locales
+end

data/lib/rails-asset-localization.rb

@@ -0,0 +1 @@
+require 'rails_asset_localization'

data/lib/rails_asset_localization.rb

@@ -0,0 +1,9 @@
+module RailsAssetLocalization
+  def self.setup
+    yield self
+  end
+end
+
+require 'rails_asset_localization/engine'
+require 'rails_asset_localization/version'
+require 'rails_asset_localization/locales_exporter'

data/lib/rails_asset_localization/engine.rb

@@ -0,0 +1,4 @@
+module RailsAssetLocalization
+  class Engine < Rails::Engine
+  end
+end

data/lib/rails_asset_localization/locales_exporter.rb

@@ -0,0 +1,20 @@
+module RailsAssetLocalization
+  class LocalesExporter
+    def initialize
+      I18n.backend.send(:init_translations)
+    end
+
+    def translations
+      return @translations ||= HashWithIndifferentAccess.new(extract_translations)
+    end
+
+    private
+    def extract_translations
+      if defined?(CopycopterClient) && I18n.backend.is_a?(CopycopterClient::I18nBackend)
+        YAML.load I18n.backend.send(:cache).export
+      else
+        I18n.backend.send(:translations)
+      end
+    end
+  end
+end

data/lib/rails_asset_localization/version.rb

@@ -0,0 +1,3 @@
+module RailsAssetLocalization
+  VERSION = "0.1.0"
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "jquery-localization-engine"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end