i18n-js 1.1.0 → 2.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i18n-js (1.1.0)
+    i18n-js (2.0.0)
       i18n
 
 GEM

data/README.rdoc

@@ -2,13 +2,6 @@
 
 It's a small library to provide the Rails I18n translations on the Javascript.
 
-This library has been tested on:
-
-* Safari 4 (Mac)
-* Firefox 3.6 (Mac)
-* Opera 10 (Mac)
-* IE6+ (Mac Parallels)
-
 == Usage
 
 === Installation
@@ -17,28 +10,31 @@ This library has been tested on:
 
 === Setting up
 
+You <b>don't</b> need to set up a thing. The default settings will work just okay. But if you want to split translations into several files or specify specific contexts, you can follow the rest of this setting up section.
+
 ==== Rails <= 3.0
-Run <tt>rake i18n:setup</tt> to copy <tt>i18n.js</tt> to your javascript directory and <tt>i18n-js.yml</tt> to your config folder (if not already present). Then you're ready to go!
+
+Run <tt>rake i18n:js:setup</tt> to copy <tt>i18n.js</tt> to your javascript directory and <tt>i18n-js.yml</tt> to your config folder (if not already present). Then you're ready to go!
 
 ==== Rails >= 3.1
-Run <tt>rake i18n:setup</tt> to copy <tt>i18n-js.yml</tt> to your config folder (if not already present). You should change the path in <tt>i18n.js.yml</tt> to <tt>app/assets/javascripts/i18n</tt> to make full use of the asset pipeline.
+
+Run <tt>rake i18n:js:setup</tt> to copy <tt>i18n-js.yml</tt> to your config folder (if not already present). You should change the path in <tt>i18n.js.yml</tt> to <tt>app/assets/javascripts/i18n</tt> to make full use of the asset pipeline.
+
 Next add the following lines to your application.js to make the javascripts and translations available to your app:
 
   //= require i18n
   //= require i18n/translations
 
-If you don't want to use the asset pipeline, just disable it on your configuration file by setting <tt>asset_pipeline</tt> to <tt>false</tt>.
+If you don't want to use the asset pipeline, just disable it on your Rails application by setting <tt>config.assets.enabled</tt> to +false+ on your <tt>config/application.rb</tt> file.
 
 ==== Exporting translations
 
-You can export the translations file by running `rake i18n:js:export`. Translations will be automatically exported in development mode, but you can set the <tt>auto_export</tt> option
-to <tt>true</tt> on your configuration file if you want to export translations when your app is booted.
+You can export the translations file by running `rake i18n:js:export`.
+Translations will be automatically exported in development mode.
 
 ==== Configuration
 
-The first time you will restart your application when using i18n-js, it will create you the default configuration file at <tt>#{Rails.root}/config/i18n-js.yml</tt>
-
-Messages files can also be customized, you can even get more files generated to different folders and with different translations to best suit your needs.
+Translation files can be customized. You can even get more files generated to different folders and with different translations to best suit your needs.
 
 Examples:
 
@@ -48,7 +44,13 @@ Examples:
   - file: 'public/javascripts/path-to-your-second-file.js'
     only: ['*.activerecord', '*.admin.*.title']
 
-If <tt>only</tt> is omitted all the translations will be saved
+If <tt>only</tt> is omitted all the translations will be saved. Also, make sure you add that initial <tt>*</tt>; it specifies that all languages will be exported. If you want to export only one language, you can do something like this:
+
+  translations:
+  - file: 'public/javascripts/en.js'
+    only: 'en.*'
+  - file: 'public/javascripts/pt-BR.js'
+    only: 'pt-BR.*'
 
 To find more examples on how to use the configuration file please refer to the tests.
 
@@ -120,7 +122,7 @@ You also provide an array as scope.
 
 ==== Number formatting
 
-Similar to Rails helpers, you have localize number and currency formatting.
+Similar to Rails helpers, you have localized number and currency formatting.
 
   I18n.l("currency", 1990.99);
   // $1,990.99
@@ -174,7 +176,6 @@ The +toHumanSize+ function accepts the following options:
   I18n.toHumanSize(1234); // 1KB
   I18n.toHumanSize(1234 * 1024); // 1MB
 
-
 ==== Date formatting
 
   // accepted formats
@@ -230,7 +231,7 @@ The only requirement is that you need to set the +translations+ attribute like f
     message: "Some special message for you"
   }
 
-  I18n.translations["pt"] = {
+  I18n.translations["pt-BR"] = {
     message: "Uma mensagem especial para você"
   }
 
@@ -253,13 +254,9 @@ Please respect the indentation rules. And use 2 spaces, not tabs.
 
 === Running tests
 
-To run Ruby tests, you need to install http://github.com/rspec/rspec
-
-  gem install rspec
-
-To run JavaScript tests, you need to install http://github.com/fnando/spec-js
+First, install all dependencies.
 
-  gem install spec-js --pre
+  bundle install
 
 Then just run `rake spec`.
 

data/config/i18n-js.yml

@@ -1,18 +1,22 @@
-# Find more details about this configuration file
-# at http://github.com/fnando/i18n-js
-
-# Automatically export translations when running in
-# development mode, or once when your app is booted
-# in production mode.
-auto_export: no
-
 # Split context in several files.
-# By default only one file is exported.
-translations:
-  - file: "public/javascripts/translations.js"
-    only: "*"
-
-# Use Rails 3.1 asset pipeline feature.
-# You can disable it by changing the following
-# line to "no".
-asset_pipeline: yes
+# By default only one file with all translations is exported and
+# no configuration is required. Your settings for asset pipeline
+# are automatically recognized.
+#
+# If you want to split translations into several files or specify
+# locale contexts that will be exported, just use this file to do
+# so.
+#
+# If you're going to use the Rails 3.1 asset pipeline, change
+# the following configuration to something like this:
+#
+#   translations:
+#     - file: "app/assets/javascripts/i18n/translations.js"
+#
+# If you're running an old version, you can use something
+# like this:
+#
+#   translations:
+#     - file: "public/javascripts/translations.js"
+#       only: "*"
+#

data/i18n-js.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "ruby-debug19"
   s.add_development_dependency "spec-js", "~> 0.1.0.beta.0"
   s.add_development_dependency "rake", "0.8.7"
+  s.add_development_dependency "ruby-debug19"
 end

data/lib/i18n-js.rb

@@ -6,6 +6,7 @@ module SimplesIdeias
 
     require "i18n-js/railtie" if Rails.version >= "3.0"
     require "i18n-js/engine" if Rails.version >= "3.1"
+    require "i18n-js/middleware"
 
     # deep_merge by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
     MERGER = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &MERGER) : v2 }
@@ -15,7 +16,7 @@ module SimplesIdeias
     end
 
     def export_dir
-      if Rails.version >= "3.1" && config.fetch(:asset_pipeline, true)
+      if Rails.version >= "3.1" && Rails.configuration.assets.enabled
         "app/assets/javascripts/i18n"
       else
         "public/javascripts"
@@ -49,17 +50,12 @@ module SimplesIdeias
     # custom output directory
     def config
       if config?
-        YAML.load_file(config_file).with_indifferent_access
+        (YAML.load_file(config_file) || {}).with_indifferent_access
       else
         {}
       end
     end
 
-    # Check if translations can be automatically exported.
-    def auto_export?
-      Rails.env.development? || (config? && config[:auto_export])
-    end
-
     # Check if configuration file exist
     def config?
       File.file? config_file

data/lib/i18n-js/middleware.rb

@@ -0,0 +1,52 @@
+module SimplesIdeias
+  module I18n
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @cache = nil
+        verify_locale_files!
+        @app.call(env)
+      end
+
+      private
+      def cache_path
+        @cache_path ||= Rails.root.join("tmp/cache/i18n-js.yml")
+      end
+
+      def cache
+        @cache ||= begin
+          if cache_path.exist?
+            YAML.load_file(cache_path) || {}
+          else
+            {}
+          end
+        end
+      end
+
+      def verify_locale_files!
+        valid_cache = []
+        changed_files = []
+
+        valid_cache.push cache_path.exist?
+        valid_cache.push ::I18n.load_path.size == cache.size
+
+        ::I18n.load_path.each do |path|
+          change = File.mtime(path).to_i
+          file_has_changed = change != cache[path]
+          valid_cache.push file_has_changed
+          changed_files << path if file_has_changed
+          cache[path] = change
+        end
+
+        File.open(cache_path, "w+") do |file|
+          file << cache.to_yaml
+        end
+
+        SimplesIdeias::I18n.export! unless valid_cache.all?
+      end
+    end
+  end
+end

data/lib/i18n-js/railtie.rb

@@ -5,10 +5,8 @@ module SimplesIdeias
         require "i18n-js/rake"
       end
 
-      config.to_prepare do
-        SimplesIdeias::I18n.tap do |i18n|
-          i18n.export! if i18n.auto_export?
-        end
+      initializer "i18n-js.initialize" do |app|
+        app.config.middleware.use(Middleware) if Rails.env.development?
       end
     end
   end

data/lib/i18n-js/version.rb

@@ -1,8 +1,8 @@
 module SimplesIdeias
   module I18n
     module Version
-      MAJOR = 1
-      MINOR = 1
+      MAJOR = 2
+      MINOR = 0
       PATCH = 0
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
     end

data/spec/i18n_spec.rb

@@ -50,6 +50,7 @@ describe SimplesIdeias::I18n do
   end
 
   it "loads configuration file" do
+    set_config "default.yml"
     SimplesIdeias::I18n.setup!
 
     SimplesIdeias::I18n.config?.should be_true
@@ -67,12 +68,6 @@ describe SimplesIdeias::I18n do
     Rails.root.join(SimplesIdeias::I18n.export_dir, "translations.js").should be_file
   end
 
-  it "exports messages using the default configuration file" do
-    set_config "default.yml"
-    SimplesIdeias::I18n.should_receive(:save).with(translations, "public/javascripts/translations.js")
-    SimplesIdeias::I18n.export!
-  end
-
   it "exports messages using custom output path" do
     set_config "custom_path.yml"
     SimplesIdeias::I18n.should_receive(:save).with(translations, "public/javascripts/translations/all.js")
@@ -159,33 +154,16 @@ describe SimplesIdeias::I18n do
     File.read(SimplesIdeias::I18n.javascript_file).should == "UPDATED"
   end
 
-  describe "#auto_export?" do
-    it "returns true for development mode" do
-      Rails.env = stub(:development? => true)
-      SimplesIdeias::I18n.should be_auto_export
-    end
-
-    it "returns false for production mode" do
-      Rails.env = stub(:production? => true, :development? => false)
-      SimplesIdeias::I18n.should_not be_auto_export
-    end
-
-    it "returns true for production when configuration is set" do
-      Rails.env = stub(:production? => true, :development? => false)
-      SimplesIdeias::I18n.stub :config? => true, :config => {:auto_export => true}
-      SimplesIdeias::I18n.should be_auto_export
-    end
-  end
-
   describe "#export_dir" do
-    it "detects Rails 3.1" do
+    it "detects Rails 3.1 with asset pipeline enabled" do
       Rails.version = "3.1"
+      Rails.stub_chain(:configuration, :assets, :enabled => true)
       SimplesIdeias::I18n.export_dir == "vendor/assets/javascripts"
     end
 
-    it "acts as older Rails when asset pipeline is disabled" do
+    it "detects Rails 3.1 with asset pipeline disabled" do
       Rails.version = "3.1"
-      SimplesIdeias::I18n.stub :config => {:asset_pipeline => false}
+      Rails.stub_chain(:configuration, :assets, :enabled => false)
       SimplesIdeias::I18n.export_dir == "public/javascripts"
     end
 
@@ -199,8 +177,8 @@ describe SimplesIdeias::I18n do
   # Set the configuration as the current one
   def set_config(path)
     config = HashWithIndifferentAccess.new(YAML.load_file(File.dirname(__FILE__) + "/resources/#{path}"))
-    SimplesIdeias::I18n.should_receive(:config?).and_return(true)
-    SimplesIdeias::I18n.should_receive(:config).and_return(config)
+    SimplesIdeias::I18n.stub(:config? => true)
+    SimplesIdeias::I18n.stub(:config => config)
   end
 
   # Shortcut to SimplesIdeias::I18n.translations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-01 00:00:00.000000000Z
+date: 2011-09-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2154603060 !ruby/object:Gem::Requirement
+  requirement: &70302525717000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154603060
+  version_requirements: *70302525717000
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2154602640 !ruby/object:Gem::Requirement
+  requirement: &70302525716240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154602640
+  version_requirements: *70302525716240
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2154602140 !ruby/object:Gem::Requirement
+  requirement: &70302525715340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *2154602140
+  version_requirements: *70302525715340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154601640 !ruby/object:Gem::Requirement
+  requirement: &70302525708020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2154601640
+  version_requirements: *70302525708020
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2154601260 !ruby/object:Gem::Requirement
+  requirement: &70302525707340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154601260
+  version_requirements: *70302525707340
 - !ruby/object:Gem::Dependency
   name: spec-js
-  requirement: &2154600720 !ruby/object:Gem::Requirement
+  requirement: &70302525706180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.1.0.beta.0
   type: :development
   prerelease: false
-  version_requirements: *2154600720
+  version_requirements: *70302525706180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2154600220 !ruby/object:Gem::Requirement
+  requirement: &70302525705440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -87,7 +87,18 @@ dependencies:
         version: 0.8.7
   type: :development
   prerelease: false
-  version_requirements: *2154600220
+  version_requirements: *70302525705440
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70302525704920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70302525704920
 description: It's a small library to provide the Rails I18n translations on the Javascript.
 email:
 - fnando.vieira@gmail.com
@@ -105,6 +116,7 @@ files:
 - i18n-js.gemspec
 - lib/i18n-js.rb
 - lib/i18n-js/engine.rb
+- lib/i18n-js/middleware.rb
 - lib/i18n-js/railtie.rb
 - lib/i18n-js/rake.rb
 - lib/i18n-js/version.rb
@@ -133,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4305660274068506457
+      hash: 2319593298030607948
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -142,10 +154,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4305660274068506457
+      hash: 2319593298030607948
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: It's a small library to provide the Rails I18n translations on the Javascript.