rails-timeago 1.2.0.rc3 → 1.3.0

data/README.md

@@ -74,14 +74,12 @@ longer the application runs.
 
 ## I18n
 
-**Note:** Available since version *1.2.0.rc1*. I18n features are still untested.
-
 **rails-timeago** provides additional localization features and includes locale
 files for the following locales taken from [jQuery Timeago](https://github.com/rmm5t/jquery-timeago).
 
 > ar, bg, bs, ca, cy, cz, da, de, el, en, es, fa, fi, fr,
 > he, hr, hu, hy, id, it, ja, ko, nl, no, pl, pt, ro, ru,
-> sv, tr, uk, zh-CN, zh-TW
+> sv, tr, uk, uz, zh-CN, zh-TW
 
 **rails-timeago** will automatically include the locale file for your current
 locale if it is available. You only have to include the following method into
@@ -97,10 +95,12 @@ list to allow precompilation. By default all locale files will be included but
 you can specify a list by adding a initializer similar to:
 
 ```ruby
-Rails::Timeago.locales = [:en, :de]
+Rails::Timeago.locales = [:en, :de, "zh-CN", :sjn]
 ```
 
-This will only add English and German locale files to precompiled assets.
+This will only add English, German, Chinese and Sindarin locale files to
+precompiled assets. *rails-timeago* will also only use these locales for
+locale file lookup for `timeago_script_tag`.
 To add your own locales add a file in JavaScript assets directory named
 `locales/jquery.timeago.<locale>.js` and add your locale to `Rails::Timeago.locales`.
 

data/lib/rails-timeago/helper.rb

@@ -56,58 +56,12 @@ module Rails
       end
 
       # Return a JavaScript tag to include jQuery timeago
-      # locale file for current locale.
-      def timeago_script_tag
-        if ::Rails::Timeago.has_locale_file(I18n.locale) and I18n.locale != :en
-          return javascript_include_tag 'locales/jquery.timeago.' + I18n.locale.to_s + '.js'
-        end
+      # locale file for current or given locale.
+      def timeago_script_tag(locale = nil)
+        locale = ::Rails::Timeago.lookup_locale locale
+        return javascript_include_tag 'locales/' + ::Rails::Timeago.locale_file_name(locale) if locale != "en"
         ''
       end
     end
-
-    # Read or write global rails-timeago default options. If no options are given
-    # the current defaults will be returned.
-    #
-    # Available options:
-    # [:+nojs+]
-    #   Add time ago in words as time tag content instead of absolute time.
-    #   (default: false)
-    #
-    # [:+date_only+]
-    #   Only print date as tag content instead of full time.
-    #   (default: true)
-    #
-    # [:+format+]
-    #   A time format for localize method used to format static time.
-    #   (default: :default)
-    #
-    # [:+limit+]
-    #   Set a limit for time ago tags. All dates before given limit will not be converted.
-    #   Global limit should be given as a block to reevaluate limit each time timeago_tag is called.
-    #   (default: proc { 4.days.ago })
-    #
-    # [:+force+]
-    #   Force time ago tag ignoring limit option.
-    #   (default: false)
-    #
-    # [:+default+]
-    #   String that will be returned if time is nil.
-    #   (default: '-')
-    #
-    def self.default_options(opts = nil)
-      @defaults ||= {
-        :nojs      => false,
-        :force     => false,
-        :format    => :default,
-        :limit     => proc { 4.days.ago },
-        :date_only => true,
-        :default   => '-'
-      }
-      if opts
-        @defaults.merge! opts.extract!(*@defaults.keys.select{|k| opts.include?(k)})
-      else
-        @defaults
-      end
-    end
   end
 end

data/lib/rails-timeago/version.rb

@@ -2,9 +2,9 @@ module Rails
   module Timeago
     module VERSION
       MAJOR = 1
-      MINOR = 2
+      MINOR = 3
       PATCH = 0
-      STAGE = 'rc3'
+      STAGE = nil
 
       def self.to_s
         [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join '.'

data/lib/rails-timeago.rb

@@ -38,27 +38,104 @@ module Rails
       end
     end
 
+    # Read or write global rails-timeago default options. If no options are given
+    # the current defaults will be returned.
+    #
+    # Available options:
+    # [:+nojs+]
+    #   Add time ago in words as time tag content instead of absolute time.
+    #   (default: false)
+    #
+    # [:+date_only+]
+    #   Only print date as tag content instead of full time.
+    #   (default: true)
+    #
+    # [:+format+]
+    #   A time format for localize method used to format static time.
+    #   (default: :default)
+    #
+    # [:+limit+]
+    #   Set a limit for time ago tags. All dates before given limit will not be converted.
+    #   Global limit should be given as a block to reevaluate limit each time timeago_tag is called.
+    #   (default: proc { 4.days.ago })
+    #
+    # [:+force+]
+    #   Force time ago tag ignoring limit option.
+    #   (default: false)
+    #
+    # [:+default+]
+    #   String that will be returned if time is nil.
+    #   (default: '-')
+    #
+    def self.default_options(opts = nil)
+      @defaults ||= {
+        :nojs      => false,
+        :force     => false,
+        :format    => :default,
+        :limit     => proc { 4.days.ago },
+        :date_only => true,
+        :default   => '-'
+      }
+      if opts
+        @defaults.merge! opts.extract!(*@defaults.keys.select{|k| opts.include?(k)})
+      else
+        @defaults
+      end
+    end
+
     def self.locale_path
       File.dirname(__FILE__) + '/../vendor/assets/javascripts/locales/'
     end
 
     def self.locale_file(locale)
-      locale_path + 'jquery.timeago.' + locale.to_s + '.js'
+      locale_path + locale_file_name(locale)
+    end
+
+    def self.locale_file_name(locale)
+      'jquery.timeago.' + locale + '.js'
     end
 
     def self.has_locale_file(locale)
-      File.exist? locale_file(I18n.locale)
+      File.exist? locale_file(locale)
+    end
+
+    # Look up a timeago locale. If no locale is given I18n's
+    # default locale will be used. Lookup follows the given
+    # order:
+    #   1) ll-CC     (language and country)
+    #   2) ll        (only language)
+    #   3) I18n default locale
+    #   4) "en"
+    def self.lookup_locale(locale = nil)
+      locale = I18n.locale.to_s unless locale
+
+      if locale =~ /^(\w+)(\-(\w+))?$/
+        lang = $1.downcase
+        if $3
+          ctry = $3.upcase
+          return "#{lang}-#{ctry}" if has_locale "#{lang}-#{ctry}"
+        end
+        return lang if has_locale lang
+      end
+
+      return I18n.default_locale.to_s if has_locale I18n.default_locale.to_s
+      "en"
+    end
+
+    def self.has_locale(locale)
+      return locales.include? locale if locales.any?
+      return has_locale_file locale
     end
 
     def self.locales
-      @locales
+      @locales ||= []
     end
 
     def self.locales=(*attrs)
       if attrs[0].kind_of?(Array)
-        @locales = attrs[0].map(&:to_sym)
+        @locales = attrs[0].map(&:to_s)
       else
-        @locales = attrs.map(&:to_sym)
+        @locales = attrs.map(&:to_s)
       end
     end
   end

data/spec/support/stub.rb

@@ -11,4 +11,8 @@ class TimeagoStub
   def time_ago_in_words(time)
     "%time_ago_in_words%"
   end
+
+  def javascript_include_tag(path)
+    "<script src=\"#{path}\"></script>"
+  end
 end

data/spec/timeago/helper_spec.rb

@@ -0,0 +1,143 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Rails::Timeago::Helper do
+  before { @stub = TimeagoStub.new }
+
+  context "#timeago_tag" do
+    it 'should create a time tag' do
+      @stub.timeago_tag(Time.now).should =~ /<time.*>.*<\/time>/
+    end
+
+    it 'should have title attribute' do
+      @stub.timeago_tag(Time.now).should =~ /<time.*title=".*".*>.*<\/time>/
+    end
+
+    it 'should have data-time-ago attribute' do
+      @stub.timeago_tag(Time.now).should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it 'should not have data-time-ago attribute for times before limit' do
+      @stub.timeago_tag(5.days.ago).should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it 'should have data-time-ago attribute for times after given limit' do
+      @stub.timeago_tag(5.days.ago, :limit => 6.days.ago).
+        should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it 'should have not data-time-ago attribute for times before given limit' do
+      @stub.timeago_tag(6.days.ago, :limit => 5.days.ago).
+        should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it 'should have data-time-ago attribute for times before limit if forced' do
+      @stub.timeago_tag(6.days.ago, :force => true).
+        should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it 'should have localized date as content' do
+      time = 3.days.ago
+      @stub.timeago_tag(time).should include(">#{I18n.l time.to_date}<")
+    end
+
+    it 'should have localized time as content if date_only is false' do
+      time = 3.days.ago
+      @stub.timeago_tag(time, :date_only => false).should include(">#{I18n.l time}<")
+    end
+
+    it 'should have time ago in words as content if nojs is true' do
+      time = 3.days.ago
+      @stub.timeago_tag(time, :nojs => true).should =~ /<time.*>%time_ago_in_words%<\/time>/
+    end
+
+    it 'should pass format option to localize method' do
+      time = 3.days.ago
+      @stub.timeago_tag(time, :format => :short).
+        should include(">#{I18n.l time.to_date, :format => :short}<")
+    end
+
+    it 'should pass html option to tag helper' do
+      @stub.timeago_tag(Time.now, :myattr => 'abc').should =~ /<time.*myattr="abc".*>.*<\/time>/
+    end
+
+    it "should allow to set global options" do
+      Rails::Timeago.default_options :format => :short, :limit => proc { 8.days.ago }
+      time = 7.days.ago
+
+      @stub.timeago_tag(time).
+        should include(">#{I18n.l time.to_date, :format => :short}<")
+      @stub.timeago_tag(time).
+        should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it "should allow to override global options" do
+      Rails::Timeago.default_options :format => :short, :limit => proc { 8.days.ago }
+      time = 7.days.ago
+
+      @stub.timeago_tag(time, :format => :long).
+        should include(">#{I18n.l time.to_date, :format => :long}<")
+      @stub.timeago_tag(time, :limit => 4.days.ago).
+        should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+    end
+
+    it "should return default string if time is nil" do
+      @stub.timeago_tag(nil).should == '-'
+    end
+  end
+
+  context "#timeago_script_tag" do
+    it "should not return anything if locale is 'en'" do
+      I18n.locale = "en"
+      @stub.timeago_script_tag.should == ""
+    end
+
+    it "should return javascript tag with locale file" do
+      I18n.locale = "de"
+      @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.de.js"></script>'
+    end
+
+    it "should return javascript tag with full locale file if available" do
+      I18n.locale = "zh-CN"
+      @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.zh-CN.js"></script>'
+    end
+
+    it "should return javascript tag with lang locale file if available" do
+      I18n.locale = "nl-NL"
+      @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.nl.js"></script>'
+    end
+
+    it "should return javascript tag with formatted locale file" do
+      I18n.locale = "zh-cn"
+      @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.zh-CN.js"></script>'
+    end
+
+    context "with global locale configuration" do
+      before { Rails::Timeago.locales = [:de, :en, "zh-CN", "tlh", "nl"] }
+      after  { Rails::Timeago.locales = [] }
+
+      it "should include full locale if available" do
+        I18n.locale = "zh-CN"
+        @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.zh-CN.js"></script>'
+      end
+
+      it "should include lang locale if available" do
+        I18n.locale = "nl-NL"
+        @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.nl.js"></script>'
+      end
+
+      it "should include default locale for not specified locales" do
+        I18n.locale = :ar
+        I18n.default_locale = :de
+        @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.de.js"></script>'
+
+        I18n.default_locale = :en
+      end
+
+      it "should find added locales that does not have a locale file in gem" do
+        I18n.locale = "tlh"
+        @stub.timeago_script_tag.should == '<script src="locales/jquery.timeago.tlh.js"></script>'
+    end
+    end
+  end
+end

data/spec/timeago_spec.rb

@@ -1,86 +1,66 @@
 
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe Rails::Timeago::Helper do
-  before { @stub = TimeagoStub.new }
-
-  it 'should create a time tag' do
-    @stub.timeago_tag(Time.now).should =~ /<time.*>.*<\/time>/
-  end
-
-  it 'should have title attribute' do
-    @stub.timeago_tag(Time.now).should =~ /<time.*title=".*".*>.*<\/time>/
-  end
-
-  it 'should have data-time-ago attribute' do
-    @stub.timeago_tag(Time.now).should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it 'should not have data-time-ago attribute for times before limit' do
-    @stub.timeago_tag(5.days.ago).should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it 'should have data-time-ago attribute for times after given limit' do
-    @stub.timeago_tag(5.days.ago, :limit => 6.days.ago).
-      should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it 'should have not data-time-ago attribute for times before given limit' do
-    @stub.timeago_tag(6.days.ago, :limit => 5.days.ago).
-      should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it 'should have data-time-ago attribute for times before limit if forced' do
-    @stub.timeago_tag(6.days.ago, :force => true).
-      should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it 'should have localized date as content' do
-    time = 3.days.ago
-    @stub.timeago_tag(time).should include(">#{I18n.l time.to_date}<")
-  end
-
-  it 'should have localized time as content if date_only is false' do
-    time = 3.days.ago
-    @stub.timeago_tag(time, :date_only => false).should include(">#{I18n.l time}<")
-  end
-
-  it 'should have time ago in words as content if nojs is true' do
-    time = 3.days.ago
-    @stub.timeago_tag(time, :nojs => true).should =~ /<time.*>%time_ago_in_words%<\/time>/
-  end
-
-  it 'should pass format option to localize method' do
-    time = 3.days.ago
-    @stub.timeago_tag(time, :format => :short).
-      should include(">#{I18n.l time.to_date, :format => :short}<")
-  end
-
-  it 'should pass html option to tag helper' do
-    @stub.timeago_tag(Time.now, :myattr => 'abc').should =~ /<time.*myattr="abc".*>.*<\/time>/
-  end
-
-  it "should allow to set global options" do
-    Rails::Timeago.default_options :format => :short, :limit => proc { 8.days.ago }
-    time = 7.days.ago
-
-    @stub.timeago_tag(time).
-      should include(">#{I18n.l time.to_date, :format => :short}<")
-    @stub.timeago_tag(time).
-      should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it "should allow to override global options" do
-    Rails::Timeago.default_options :format => :short, :limit => proc { 8.days.ago }
-    time = 7.days.ago
-
-    @stub.timeago_tag(time, :format => :long).
-      should include(">#{I18n.l time.to_date, :format => :long}<")
-    @stub.timeago_tag(time, :limit => 4.days.ago).
-      should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
-  end
-
-  it "should return default string if time is nil" do
-    @stub.timeago_tag(nil).should == '-'
+describe Rails::Timeago do
+  context "#lookup_locale" do
+    it "should return full locale if available" do
+      Rails::Timeago.lookup_locale("zh-CN").should == "zh-CN"
+    end
+
+    it "should return formatted locale" do
+      Rails::Timeago.lookup_locale("zh-cn").should == "zh-CN"
+    end
+
+    it "should return lang locale if available" do
+      Rails::Timeago.lookup_locale("nl-NL").should == "nl"
+    end
+
+    it "should return locale if available" do
+      Rails::Timeago.lookup_locale("de").should == "de"
+    end
+
+    it "should lookup default locale if nothing given" do
+      I18n.locale = "ar"
+
+      Rails::Timeago.lookup_locale.should == "ar"
+    end
+
+    it "should return english locale if locale does not
+      match and default locale is not available" do
+
+      I18n.locale = "sjn"
+      Rails::Timeago.lookup_locale("tlh").should == "en"
+    end
+
+    context "with global locale configuration" do
+      before { Rails::Timeago.locales = [:de, :en, "zh-CN", "tlh"] }
+      after  { Rails::Timeago.locales = [] }
+
+      it "should return full locale if available" do
+        Rails::Timeago.lookup_locale("zh-CN").should == "zh-CN"
+      end
+
+      it "should return lang locale if available" do
+        Rails::Timeago.lookup_locale("en-US").should == "en"
+      end
+
+      it "should return use default locale if available" do
+        I18n.locale = "en"
+        Rails::Timeago.lookup_locale.should == "en"
+      end
+
+      it "should return default locale for not specified locales" do
+        I18n.locale = "ar"
+        I18n.default_locale = :de
+        Rails::Timeago.lookup_locale.should == "de"
+
+        I18n.default_locale = :en
+      end
+
+      it "should find added locales that does not have a locale file in gem" do
+        I18n.locale = "tlh"
+        Rails::Timeago.lookup_locale.should == "tlh"
+      end
+    end
   end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rails-timeago
 version: !ruby/object:Gem::Version
-  version: 1.2.0.rc3
-  prerelease: 6
+  version: 1.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &4970440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *4970440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &4969820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *4969820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &4969300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *4969300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: jQuery Timeago helper for Rails 3
 email:
 - jan.graichen@altimos.de
@@ -63,6 +78,7 @@ files:
 - rails-timeago.gemspec
 - spec/spec_helper.rb
 - spec/support/stub.rb
+- spec/timeago/helper_spec.rb
 - spec/timeago_spec.rb
 - vendor/assets/javascripts/jquery.timeago.js
 - vendor/assets/javascripts/locales/jquery.timeago.ar.js
@@ -113,12 +129,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A Rails Helper to create time tags usable for jQuery Timeago plugin