rapporteur 3.0.0 → 3.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjZhNjRmZjgwNmMyZjAxMWMzNTAyYTZlYzYxNzI4NmI5ZDFkZWRiMQ==
+    MTAyZTdjMDkwMWE2NDczOTE5OTMxOGY2MTg0MDRlYTRmZGUyODQ3Yg==
   data.tar.gz: !binary |-
-    Zjg4ZDViM2IwOTg3OTc3OWU5MmNkYTlmNjVhMjgxNDg5YWZlZWJiYg==
+    ODNkYzI0ZWVjN2E1MDc3MTIwZDQ0NTNlMTJjMmVmODNiNzlhMDRjMw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ODMxNTQ2ZjY1MjlmMTE1NDY2OTM3ZGZlYzIxMDY0MDE0ZGE3NDBhY2NmZWVl
-    YjFlMWU2Zjg5ZmMwNDZhNjBmODc4YTFlMDNlODhmZDI2Yjg3MmEwNjRkOGFm
-    ODkxZTM1MTJhMWJjMjI5NTU0MjU5ZWNlMzI1MmJkZjM0NjY0MzU=
+    NjBjOTBlYzU1NmU5ZDBhMzIxZjU1NTAxN2Q2NGZjNWY3YjU5YTVmNjliZGVj
+    YjkyY2IzOWIzMzRiYzQyM2RiZTU5MDQ2N2ZjZjhhZGI1OTM4YTg3YWQwMGMy
+    MWYwZWFmMTc3MDY4YmMyMWU2YTM2MGJlYzNlN2U4ZmJmNDZkNDU=
   data.tar.gz: !binary |-
-    ZjU5MWUwNzA5YjYwNmE1OTc3NmQ1MTM0ZmYxMjNhYjdlN2NjY2JlMDYxODU1
-    YWJkMWU4YmRmZmE3ODJhZWYyZmE1ZjIwOWU5MDBiNmEwMTNjMDI2MjIwNWRj
-    YjU4MGU0ZmVmYTA5ODg4MzZlNzI5MjQwMGI0ODA2NTA5YjljZmE=
+    NmNjZGY0Y2YwOGVkYzMzYmQ1MmYwZWRhMjNhMTJjNTJhZjk2NTU2ZGM0ZTg0
+    NDk2NjdhNzg5YjJjZTE2NGY2ZDkxYThjYWJjMGEzODhjZGZiMjM2ZjE4MWM1
+    ODNhNGViZTFiMTU3YWU1YzllYzM1YWRmZDI1ZGYxNmE3NmFjNTQ=

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * No significant changes.
 
+## [3.0.1][v3.0.1] / 2013-08-23
+
+* Add back missing support for I18n interpolated values which was lost with the
+  customized message lists.
+
 ## [3.0.0][v3.0.0] / 2013-08-23
 
 * Fix/add Ruby 1.8 compatibility. Because this library was built to work with
@@ -72,7 +77,9 @@
 * Initial public release.
 
 
-[unreleased]: https://github.com/codeschool/rapporteur/compare/v2.1.0...master
+[unreleased]: https://github.com/codeschool/rapporteur/compare/v3.0.1...master
+[v3.0.1]: https://github.com/codeschool/rapporteur/compare/v3.0.0...v3.0.1
+[v3.0.0]: https://github.com/codeschool/rapporteur/compare/v2.1.0...v3.0.0
 [v2.1.0]: https://github.com/codeschool/rapporteur/compare/v2.0.1...v2.1.0
 [v2.0.1]: https://github.com/codeschool/rapporteur/compare/v2.0.0...v2.0.1
 [v2.0.0]: https://github.com/codeschool/rapporteur/compare/v1.1.0...v2.0.0

data/lib/rapporteur/checker.rb

@@ -90,21 +90,34 @@ module Rapporteur
     # is done with the pre-built checks. If you're using I18n, you'll need to
     # define `rapporteur.errors.<your key>.<your message>`.
     #
+    # name - A Symbol which indicates the attribute, name, or other identifier
+    #        for the check being run.
+    # message - A String/Symbol/Proc to identify the message to provide in a
+    #           check failure situation.
+    #
+    #           A String is presented as given.
+    #           A Symbol will attempt to translate through I18n or default to the String-form of the symbol.
+    #           A Proc which will be called and the return value will be presented as returned.
+    # i18n_options - A Hash of options (likely variable key/value pairs) to
+    #                pass to I18n during translation.
+    #
     # Examples
     #
     #   checker.add_error(:you, "failed.")
     #   checker.add_error(:using, :i18n_key_is_better)
+    #   checker.add_error(:using, :i18n_with_variable, :custom_variable => 'pizza')
     #
     #   en:
     #     rapporteur:
     #       errors:
     #         using:
     #           i18n_key_is_better: 'Look, localization!'
+    #           i18n_with_variable: 'Look, %{custom_variable}!'
     #
     # Returns self.
     #
-    def add_error(key, message, options={})
-      @errors.add(key, message)
+    def add_error(name, message, i18n_options={})
+      @errors.add(name, message, i18n_options)
       self
     end
 
@@ -114,17 +127,24 @@ module Rapporteur
     # name - A String containing the name or identifier for your message. This
     #        is unique and may be overriden by other checks using the name
     #        message name key.
-    # message - A String or Numeric for the value of the message.
+    #
+    # message - A String/Symbol/Proc containing the message to present to the
+    #           user in a successful check sitaution.
+    #
+    #           A String is presented as given.
+    #           A Symbol will attempt to translate through I18n or default to the String-form of the symbol.
+    #           A Proc which will be called and the return value will be presented as returned.
     #
     # Examples
     #
     #   checker.add_message(:repository, 'git@github.com/user/repo.git')
     #   checker.add_message(:load, 0.934)
+    #   checker.add_message(:load, :too_high, :measurement => '0.934')
     #
     # Returns self.
     #
-    def add_message(name, message)
-      @messages.add(name, message)
+    def add_message(name, message, i18n_options={})
+      @messages.add(name, message, i18n_options)
       self
     end
 

data/lib/rapporteur/message_list.rb

@@ -45,17 +45,20 @@ module Rapporteur
     #
     #           If a Proc is given, it is `.call`'d with no parameters. The
     #           return value from the Proc is directly used for the message.
+    # i18n_options - A Hash of optional key/value pairs to pass to the I18n
+    #                translator.
     #
     # Examples
     #
     #     list.add(:time, '2013-08-23T12:34:00Z')
     #     list.add(:time, :too_late)
+    #     list.add(:time, :too_late, :time => 'midnight')
     #     list.add(:time, lambda { Time.now.iso8601 })
     #
     # Returns the MessageList instance.
     #
-    def add(attribute, message)
-      @messages[attribute.to_sym].add(normalize_message(attribute, message))
+    def add(attribute, message, i18n_options = {})
+      @messages[attribute.to_sym].add(normalize_message(attribute, message, i18n_options))
       self
     end
 
@@ -108,17 +111,17 @@ module Rapporteur
     private
 
 
-    def generate_message(key, type)
-      I18n.translate(type, {
+    def generate_message(key, type, i18n_options)
+      I18n.translate(type, i18n_options.merge({
         :default => [type, type.to_s],
         :scope => [:rapporteur, @list_type, key]
-      })
+      }))
     end
 
-    def normalize_message(attribute, message)
+    def normalize_message(attribute, message, i18n_options)
       case message
       when Symbol
-        generate_message(attribute, message)
+        generate_message(attribute, message, i18n_options)
       when Proc
         message.call
       else

data/lib/rapporteur/version.rb

@@ -1,3 +1,3 @@
 module Rapporteur
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/spec/models/message_list_spec.rb

@@ -33,6 +33,12 @@ describe Rapporteur::MessageList do
       expect(list.full_messages).to include('test translated')
     end
 
+    it 'translates and adds recognized I18n keys with named parameters in the #full_messages' do
+      add_translation(:errors, :test, :i18n_message, 'translated %{language}')
+      list.add(:test, :i18n_message, :language => 'French')
+      expect(list.full_messages).to include('test translated French')
+    end
+
     it 'translates based on the initialized list type' do
       add_translation(:string, :test, :i18n_message, 'strings')
       add_translation(:messages, :test, :i18n_message, 'messages')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Envy Labs