i18n-js-assets 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78c741d86f015320458cb78019e8f5a6ca44e2d7
-  data.tar.gz: 90d676655f84726715c724edb2406d05f04548fa
+  metadata.gz: 2c6d712311554b9b92fe35729c5f85fb9fbc43c2
+  data.tar.gz: b5cee8412e9b9177c9921634011a18691e206b66
 SHA512:
-  metadata.gz: 69dbcd6f49b5bfa248a4ebce6267b159356c1a8e068d9b6e9ca9c39c8ff9c9834605723206c6bc264138f211a1c6d21f7dc598beea24167c84900e0f46f1ef1e
-  data.tar.gz: e07c7e212dfe1e39851b4b79261df1660aa703e07d766e15edca2cfb7d72f3091299ebb93f361cdf3a05f034ea03c7d7e730d547fccdbd5355bde25b7813f43f
+  metadata.gz: 4ef2178640e4efc982cfd8cd39e86a933f2e9c837dadb9f8d3656ea6a5dadd5fd810c7f0b3f914cf22cc32bfd5b75ace91262aa21c4468a49719f251e04e5c5a
+  data.tar.gz: e7815df62bc8b14f314f1bcd6f98b3165e47bfc2b13354515e360db95d32b9059939cd520686a93c5cd4a21f0e5f502fa1bf0a36a6e5f5f87b9266436d15bec5

data/README.md

@@ -53,6 +53,10 @@ Require these files as you normally would. For example in your app's main `appli
 
 Voilà! The translations should now be available in your Javascript code just as if you'd used i18n-js and its rake tasks.
 
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
 ## Authors
 
 * Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -5,10 +5,12 @@ $:.unshift File.join(File.dirname(__FILE__), 'lib')
 require 'rubygems' unless ENV['NO_RUBYGEMS']
 
 require 'bundler'
+require 'pry-nav'
 require 'rspec/core/rake_task'
 require 'rubygems/package_task'
 
 require 'rails'
+require 'sprockets/railtie'
 require 'i18n-js-assets'
 
 Bundler::GemHelper.install_tasks
@@ -19,3 +21,10 @@ desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
   t.pattern = './spec/**/*_spec.rb'
 end
+
+# for dummy app
+Dir.chdir('spec') do
+  require File.expand_path('../spec/config/application', __FILE__)
+  I18nJsAssets::DummyApplication.initialize!
+  I18nJsAssets::DummyApplication.load_tasks
+end

data/i18n-js-assets.gemspec

@@ -13,11 +13,17 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
 
+  if ENV['RAILS_VERSION']
+    s.add_dependency 'railties', "~> #{ENV['RAILS_VERSION']}"
+  else
+    s.add_dependency 'railties', '>= 3.2.0', '< 5'
+  end
+
+  s.add_dependency 'generated-assets', '~> 1.0'
   s.add_dependency 'i18n-js'
-  s.add_dependency 'railties', ENV['RAILS_VERSION'] || '>= 3.2.0', '< 5'
-  s.add_dependency 'tzinfo'
   s.add_dependency 'sprockets-rails'
   s.add_dependency 'tilt'
+  s.add_dependency 'tzinfo'
 
   s.require_path = 'lib'
   s.files = Dir["{lib,spec}/**/*", "Gemfile", "README.md", "Rakefile", "i18n-js-assets.gemspec"]

data/lib/i18n-js-assets.rb

@@ -1,7 +1,23 @@
 # encoding: UTF-8
 
+require 'generated-assets'
 require 'i18n-js-assets/railtie'
+require 'fileutils'
+require 'tmpdir'
 
 module I18nJsAssets
-  autoload :Processor, 'i18n-js-assets/processor'
+  autoload :Entry,      'i18n-js-assets/entry'
+  autoload :I18nJsFile, 'i18n-js-assets/i18njs_file'
+  autoload :Manifest,   'i18n-js-assets/manifest'
+  autoload :Processor,  'i18n-js-assets/processor'
+
+  class << self
+    def asset_dir
+      @asset_dir ||= begin
+        dir = File.join(Dir.tmpdir, SecureRandom.hex)
+        FileUtils.mkdir_p(dir)
+        dir
+      end
+    end
+  end
 end

data/lib/i18n-js-assets/entry.rb

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+
+require 'fileutils'
+
+module I18nJsAssets
+  class Entry
+    attr_reader :app, :source_path, :target_path, :options
+
+    def initialize(app, source_path, target_path, options)
+      @app = app
+      @source_path = source_path
+      @target_path = target_path
+      @options = options
+    end
+
+    def apply!
+      each_file do |locale, interpolated_target_path|
+        path = "#{interpolated_target_path}.i18njs"
+        app.config.assets.generated.add(path, options) do
+          source.overwrite('locales' => [locale]).dump
+        end
+      end
+    end
+
+    private
+
+    def source
+      @source ||= I18nJsFile.load_file(absolute_source_path.to_s)
+    end
+
+    def each_file
+      if block_given?
+        locales.each do |locale|
+          interpolated_target_path = target_path % { locale: locale }
+          yield locale, interpolated_target_path
+        end
+      else
+        to_enum(__method__)
+      end
+    end
+
+    def absolute_source_path
+      app.assets.resolve(source_path)
+    end
+
+    def locales
+      if locs = options[:precompile]
+        locs.respond_to?(:call) ? locs.call : locs
+      else
+        if Kernel.const_defined?(:I18n)
+          I18n.available_locales
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/i18n-js-assets/i18njs_file.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+
+require 'yaml'
+
+module I18nJsAssets
+  class I18nJsFile
+    class << self
+      def load(contents)
+        from_hash(YAML.load(contents))
+      end
+
+      def load_file(file)
+        load(File.read(file))
+      end
+
+      def from_hash(hash)
+        new(hash)
+      end
+    end
+
+    attr_reader :attributes
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def only
+      attributes['only']
+    end
+
+    def locales
+      attributes['locales']
+    end
+
+    def overwrite(new_attributes)
+      self.class.from_hash(attributes.merge(new_attributes))
+    end
+
+    def write(path)
+      File.write(path, dump)
+    end
+
+    def dump
+      YAML.dump(attributes)
+    end
+  end
+end

data/lib/i18n-js-assets/manifest.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+require 'yaml'
+
+module I18nJsAssets
+  class Manifest
+    attr_reader :app, :entries
+
+    def initialize(app)
+      @app = app
+      @entries = []
+    end
+
+    def add(source_path, target_path, options = {})
+      entry = Entry.new(app, source_path, target_path, options)
+      entries << entry
+    end
+
+    def apply!
+      entries.each(&:apply!)
+    end
+  end
+end

data/lib/i18n-js-assets/processor.rb

@@ -1,12 +1,15 @@
 # encoding: UTF-8
 
+require 'tilt'
+require 'i18n-js'
+
 module I18nJsAssets
   class Processor < ::Tilt::Template
     def prepare
       # noop
     end
 
-    def evaluate(scope, locals, &block)
+    def evaluate(scope, locals)
       options = (YAML.load(data) || {}).with_indifferent_access
       only = options.fetch(:only, '*')
       exceptions = [options.fetch(:except, [])].flatten
@@ -18,14 +21,17 @@ module I18nJsAssets
         i18n_js.segment_for_scope(only)
       end
 
-      construct_javascript_from(translations)
+      locales = options.fetch(:locales, translations.keys).map(&:to_sym)
+
+      construct_javascript_from(locales, translations)
     end
 
-    protected
+    private
 
-    def construct_javascript_from(translations)
+    def construct_javascript_from(locales, translations)
       %(I18n.translations || (I18n.translations = {});\n).tap do |result|
         translations.each_pair do |locale, locale_translations|
+          next unless locales.include?(locale)
           result << construct_javascript_for_locale(locale, locale_translations)
         end
       end

data/lib/i18n-js-assets/railtie.rb

@@ -2,8 +2,29 @@
 
 module I18nJsAssets
   class Railtie < ::Rails::Railtie
-    initializer :i18n_js_assets, group: :all do |app|
-      app.assets.register_engine('.i18njs', I18nJsAssets::Processor)
+    config.before_configuration do |app|
+      app.config.assets.localized = I18nJsAssets::Manifest.new(app)
+    end
+
+    config.before_initialize do |app|
+      app.config.assets.generated.before_apply do
+        app.config.assets.localized.apply!
+      end
+    end
+
+    # this is for rails 3
+    config.after_initialize do |app|
+      begin
+        app.assets.register_engine('.i18njs', I18nJsAssets::Processor)
+      rescue TypeError
+      end
+    end
+
+    # this is for rails 4
+    initializer :i18n_js_assets, after: 'sprockets.environment' do |app|
+      if app.assets
+        app.assets.register_engine('.i18njs', I18nJsAssets::Processor)
+      end
     end
   end
 end

data/lib/i18n-js-assets/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module I18nJsAssets
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/app/assets/javascripts/application.js

@@ -1 +1 @@
-//= require i18n/translations
+//= require translations/includable

data/spec/app/assets/javascripts/translations/language_specific.js.i18njs

@@ -0,0 +1,3 @@
+only: '*.my_app.*'
+locales:
+  - es

data/spec/app/assets/javascripts/translations/precompilable.js.i18njs

@@ -0,0 +1 @@
+only: '*.my_app.*'

data/spec/config/application.rb

@@ -0,0 +1,10 @@
+module I18nJsAssets
+  class DummyApplication < ::Rails::Application
+    config.eager_load = false
+    config.assets.enabled = true
+    config.assets.compile = true
+    config.assets.allow_debugging = true
+    config.assets.digest = true
+    config.active_support.deprecation = :stderr
+  end
+end

data/spec/entry_spec.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+include I18nJsAssets
+
+describe Entry do
+  let(:entry) do
+    Entry.new(
+      app, source_path, target_path, {
+        precompile: locales
+      }
+    )
+  end
+
+  let(:source_path) do
+    'translations/precompilable.js'
+  end
+
+  let(:target_path) do
+    'translations/precompilable-%{locale}.js'
+  end
+
+  let(:locales) do
+    [:en, :es]
+  end
+
+  describe '#apply!' do
+    it 'adds entries for each locale' do
+      entry.apply!
+
+      paths = app.config.assets
+        .generated.entries.map(&:logical_path)
+        .sort
+
+      expect(paths).to(
+        eq([
+          'translations/precompilable-en.js.i18njs',
+          'translations/precompilable-es.js.i18njs'
+        ])
+      )
+    end
+  end
+end

data/spec/i18njs_file_spec.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'fileutils'
+
+include I18nJsAssets
+
+describe I18nJsFile do
+  let(:file) do
+    I18nJsFile.load(contents)
+  end
+
+  let(:contents) do
+    YAML.dump(
+      'only' => '*.my_app.*',
+      'locales' => %w(en es)
+    )
+  end
+
+  describe '.load' do
+    it 'reads and creates a new file instance' do
+      expect(file).to be_a(I18nJsFile)
+      expect(file.attributes['locales']).to eq(%w(en es))
+    end
+  end
+
+  describe '#only' do
+    it 'retrieves the only filter' do
+      expect(file.only).to eq('*.my_app.*')
+    end
+  end
+
+  describe '#locales' do
+    it 'retrieves the list of locales' do
+      expect(file.locales).to eq(%w(en es))
+    end
+  end
+
+  describe '#overwrite' do
+    it 'replaces attributes and returns a new instance' do
+      new_file = file.overwrite('locales' => %w(ko ja))
+      expect(new_file.locales).to eq(%w(ko ja))
+    end
+  end
+
+  describe '#write' do
+    it 'serializes and writes the contents to the given path' do
+      # store the file in the asset path, which gets destroyed before
+      # every test
+      FileUtils.mkdir_p(asset_path)
+      path = asset_path.join('test.i18njs').to_s
+      file.write(path)
+      expect(File.read(path)).to eq(contents)
+    end
+  end
+
+  describe '#dump' do
+    it 'serializes the file contents' do
+      expect(file.dump).to eq(contents)
+    end
+  end
+end

data/spec/inline_spec.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe 'inline' do
+  it 'requires javascript translations' do
+    asset = Rails.application.assets.find_asset('application.js')
+    expect(unescape_unicode(asset.source)).to include(en_source)
+    expect(unescape_unicode(asset.source)).to include(es_source)
+  end
+
+  it 'only includes translations for the requested locales' do
+    asset = Rails.application.assets.find_asset('translations/language_specific.js')
+    expect(unescape_unicode(asset.source)).to_not include(en_source)
+    expect(unescape_unicode(asset.source)).to include(es_source)
+  end
+end