ndd-rspec-rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fdeed587f4e9c6e3f07ee32e556e327d98a45ba
-  data.tar.gz: 11a74da50a412f8a3fe174af4c95b72431a2beaa
+  metadata.gz: fb94dd2da1098be2a2f3d48c83368ff5f1602926
+  data.tar.gz: df64d93cc0963f6e481a63825354cfd3560d83a6
 SHA512:
-  metadata.gz: e00104c957bb678794811759e82beea6c4954edd08348a5f8b1e6b65c47e1fbaa7a64a31d57fbb618debac176a33d1e6bd783f1295f9eb577263d468722200f8
-  data.tar.gz: 39656673e2e03d69bb350582cfee512482116a66f924edd112a1818577f7686d128350acaa34ce7e8fad8fc0ff917b4edfcb188c07664eaa2faa233a229c8104
+  metadata.gz: 4d662d5a3ebb2700794504f5fc15b8c24fee69e0a6e3ad929926df404e595affa908b8129ffaf4be74352a048714187d09274d599da7b8365898f3e09cb1f8c7
+  data.tar.gz: 405873989113b8c9ea54ded246968ff8433359a3252c8066c1c9ed926d38169e239457c00e81ede37e1736723df75797fc3aaaa34e0788d570db897fd33318c8

data/CHANGELOG.md

@@ -1,5 +1,12 @@
-# NDD RSpec Rails
+# NDD RSpec Rails changelog
+
+## Version 0.2.0
+
+- add `have_a_translated_flash` matcher
 
 ## Version 0.1.0
 
-- initial commit
+- initial commit with matchers:
+    - `have_a_translated_attribute`
+    - `have_a_translated_error`
+    - `have_a_translated_model`

data/README.md

@@ -1,4 +1,4 @@
-# Ndd RSpec Rails
+# NDD RSpec Rails
 
 [![Build Status](https://secure.travis-ci.org/ddidier/ndd-rspec-rails.png)](http://travis-ci.org/ddidier/ndd-rspec-rails)
 [![Dependency Status](https://gemnasium.com/ddidier/ndd-rspec-rails.png)](https://gemnasium.com/ddidier/ndd-rspec-rails)

data/bin/yard-server

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+APPLICATION_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
+
+function _yard_server() {
+    yard server --reload
+}
+
+_yard_server $@

data/lib/ndd/rspec/rails/matchers/controller/have_a_translated_flash.rb

@@ -0,0 +1,100 @@
+require 'ndd/rspec/rails/matchers/translation_matcher'
+
+module Ndd
+  module RSpec
+    module Rails
+      module Matchers
+        module Controller
+
+          # Implements {#have_a_translated_flash}.
+          class HaveATranslatedFlash < TranslationMatcher
+
+            # @param message [String|Symbol] the message to test.
+            def initialize(message)
+              super()
+              @message = message
+            end
+
+            # Set the action of the message to test.
+            # @param action [String|Symbol] the action associated to the message to test.
+            # @return self
+            def on_action(action)
+              @action = action
+              self
+            end
+
+            # @param controller [Object] the controller being tested.
+            # @return [Boolean] true if the message has an associated translation, false otherwise.
+            def matches?(controller)
+              @controller = controller
+              @failed_locales = []
+              @tested_locales.each do |tested_locale|
+                @failed_locales << tested_locale unless translated_in?(tested_locale)
+              end
+              @failed_locales.empty?
+            end
+
+            # @return [String] a description of this matcher.
+            def description
+              description = "have a translated flash message for '#{@message}'"
+              description << " on '#{@action}'" if @action.present?
+              description << " in #{locales_as_string(@tested_locales)}"
+              description
+            end
+
+            # @return [String] details about the failure of this matcher.
+            def failure_message
+              message = "expected '#{subject_as_string}' to have a translated flash message for '#{@message}'\n"
+              message << "but none of the following keys was found:\n"
+              message << "#{translation_keys.map { |l| "  - #{l}" }.join("\n")}\n"
+              message << "for the locales: #{locales_as_string(@failed_locales)}"
+              message
+            end
+
+            # -------------------- private
+            private
+
+            # @return [String] a human readable string of the subject of the error.
+            def subject_as_string
+              @action.present? ? "#{@controller.class}##{@action}" : @controller.class.to_s
+            end
+
+            def translation_keys
+              @action.present? ? translation_keys_with_action : translation_keys_without_action
+            end
+
+            def translation_keys_with_action
+              controller_key = @controller.class.name.underscore
+              message_key = @message.to_s
+              action_key = @action.to_s
+              %W[
+                actioncontroller.#{controller_key}.#{action_key}.flash.#{message_key}
+                actioncontroller.#{controller_key}.flash.#{message_key}
+                actioncontroller.#{action_key}.flash.#{message_key}
+                actioncontroller.flash.#{message_key}
+              ]
+            end
+
+            def translation_keys_without_action
+              controller_key = @controller.class.name.underscore
+              message_key = @message.to_s
+              %W[
+                actioncontroller.#{controller_key}.flash.#{message_key}
+                actioncontroller.flash.#{message_key}
+              ]
+            end
+
+            def translated_in?(tested_locale)
+              translation_keys.each do |translation_key|
+                return true if translated?(tested_locale, translation_key)
+              end
+              false
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ndd/rspec/rails/matchers/controller.rb

@@ -0,0 +1,52 @@
+require_relative 'controller/have_a_translated_flash'
+
+module Ndd
+  module RSpec
+    module Rails
+      module Matchers
+        # RSpec matchers for Rails controllers.
+        module Controller
+
+          # Ensure that a controller has a translated flash message for the given key.
+          #
+          # More precisely, ensure that (with all parameters being snake case) one of
+          #   I18n.t(locale, "actioncontroller.#{controller_key}.#{action_key}.flash.#{message_key}")
+          #   I18n.t(locale, "actioncontroller.#{controller_key}.flash.#{message_key}")
+          #   I18n.t(locale, "actioncontroller.#{action_key}.flash.#{message_key}")
+          #   I18n.t(locale, "actioncontroller.flash.#{message_key}")
+          # returns a value for the default locale (i.e. +I18n.default_locale+)
+          # or all the available locales (i.e. +I18n.available_locales+).
+          #
+          # @example
+          #
+          #   RSpec.describe MyController, type: :controller do
+          #
+          #     # both are equivalent
+          #     it { is_expected.to have_a_translated_flash(:out_of_range) }
+          #     it { is_expected.to have_a_translated_flash(:out_of_range).in_available_locales }
+          #
+          #     it { is_expected.to have_a_translated_flash(:out_of_range).in_default_locale }
+          #
+          #     # both are equivalent
+          #     it { is_expected.to have_a_translated_flash(:out_of_range).on_action(:index) }
+          #     it { is_expected.to have_a_translated_flash(:out_of_range).on_action(:index).in_available_locales }
+          #
+          #     it { is_expected.to have_a_translated_flash(:out_of_range).on_action(:index).in_default_locale }
+          #   end
+          #
+          # @param message [String|Symbol] the message to test.
+          # @return [Ndd::RSpec::Rails::Matchers::Controller::HaveATranslatedFlash]
+          #
+          def have_a_translated_flash(message) # rubocop:disable Style/PredicateName
+            HaveATranslatedFlash.new(message)
+          end
+
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Ndd::RSpec::Rails::Matchers::Controller, type: :controller
+end

data/lib/ndd/rspec/rails/matchers/model/have_a_translated_attribute.rb

@@ -1,37 +1,12 @@
-require 'active_support/core_ext/string/inflections'
-require 'i18n'
-require 'ndd/rspec/rails/matchers/model/translation_matcher'
+require 'ndd/rspec/rails/matchers/translation_matcher'
 
 module Ndd
   module RSpec
     module Rails
       module Matchers
-        module Model #:nodoc:
+        module Model
 
-          # Ensure that an attribute has an associated translation.
-          #
-          # More precisely, ensure that
-          #   I18n.t(locale, "activerecord.attributes.{snake_case_class_name}.{snake_case_attribute_name}")
-          # returns a value for the default locale (i.e. +I18n.default_locale+)
-          # or all the available locales (i.e. +I18n.available_locales+).
-          #
-          # For example:
-          #
-          #   RSpec.describe MyModel, type: :model do
-          #     # both are equivalent
-          #     it { is_expected.to have_a_translated_attribute(:comment) }
-          #     it { is_expected.to have_a_translated_attribute(:comment).in_available_locales }
-          #
-          #     it { is_expected.to have_a_translated_attribute(:comment).in_default_locale }
-          #   end
-          #
-          def have_a_translated_attribute(attribute) # rubocop:disable Style/PredicateName
-            HaveATranslatedAttribute.new(attribute)
-          end
-
-          # ------------------------------------------------------------------------------------------------------------
           # Implements {#have_a_translated_attribute}.
-          #
           class HaveATranslatedAttribute < TranslationMatcher
 
             # @param attribute [String|Symbol] the attribute to test.

data/lib/ndd/rspec/rails/matchers/model/have_a_translated_error.rb

@@ -1,47 +1,12 @@
-require 'active_support/core_ext/string/inflections'
-require 'i18n'
-require 'ndd/rspec/rails/matchers/model/translation_matcher'
+require 'ndd/rspec/rails/matchers/translation_matcher'
 
 module Ndd
   module RSpec
     module Rails
       module Matchers
-        module Model #:nodoc:
+        module Model
 
-          # Ensure that an error on a model or an attribute has an associated translation.
-          #
-          # More precisely, ensure that (with all parameters being snake case) one of
-          #   I18n.t(locale, "activerecord.errors.models.{class_name}.attributes.{attribute_name}.{error_key}")
-          #   I18n.t(locale, "activerecord.errors.models.{class_name}.{error_key}")
-          #   I18n.t(locale, "activerecord.errors.messages.{error_key}")
-          #   I18n.t(locale, "errors.attributes.{attribute_name}.{error_key}")
-          #   I18n.t(locale, "errors.messages.{error_key}")
-          # returns a value for the default locale (i.e. +I18n.default_locale+)
-          # or all the available locales (i.e. +I18n.available_locales+).
-          #
-          # For example:
-          #
-          #   RSpec.describe MyModel, type: :model do
-          #     # both are equivalent
-          #     it { is_expected.to have_a_translated_error(:duplicate) }
-          #     it { is_expected.to have_a_translated_error(:duplicate).in_available_locales }
-          #
-          #     it { is_expected.to have_a_translated_error(:duplicate).in_default_locale }
-          #
-          #     # both are equivalent
-          #     it { is_expected.to have_a_translated_error(:duplicate).on_attribute(:comments) }
-          #     it { is_expected.to have_a_translated_error(:duplicate).on_attribute(:comments).in_available_locales }
-          #
-          #     it { is_expected.to have_a_translated_error(:duplicate).on_attribute(:comments).in_default_locale }
-          #   end
-          #
-          def have_a_translated_error(message) # rubocop:disable Style/PredicateName
-            HaveATranslatedError.new(message)
-          end
-
-          # ------------------------------------------------------------------------------------------------------------
           # Implements {#have_a_translated_error}.
-          #
           class HaveATranslatedError < TranslationMatcher
 
             # @param error [String|Symbol] the error to test.
@@ -51,6 +16,7 @@ module Ndd
             end
 
             # Set the attribute of the error to test.
+            # @param attribute [String|Symbol] the attribute associated to the error to test.
             # @return self
             def on_attribute(attribute)
               @attribute = attribute
@@ -99,24 +65,24 @@ module Ndd
 
             def translation_keys_with_attribute
               model_key = @model.class.name.underscore
-              message_key = @error.to_s
+              error_key = @error.to_s
               attribute_key = @attribute.to_s
               %W[
-                activerecord.errors.models.#{model_key}.attributes.#{attribute_key}.#{message_key}
-                activerecord.errors.models.#{model_key}.#{message_key}
-                activerecord.errors.messages.#{message_key}
-                errors.attributes.#{attribute_key}.#{message_key}
-                errors.messages.#{message_key}
+                activerecord.errors.models.#{model_key}.attributes.#{attribute_key}.#{error_key}
+                activerecord.errors.models.#{model_key}.#{error_key}
+                activerecord.errors.messages.#{error_key}
+                errors.attributes.#{attribute_key}.#{error_key}
+                errors.messages.#{error_key}
               ]
             end
 
             def translation_keys_without_attribute
               model_key = @model.class.name.underscore
-              message_key = @error.to_s
+              error_key = @error.to_s
               %W[
-                activerecord.errors.models.#{model_key}.#{message_key}
-                activerecord.errors.messages.#{message_key}
-                errors.messages.#{message_key}
+                activerecord.errors.models.#{model_key}.#{error_key}
+                activerecord.errors.messages.#{error_key}
+                errors.messages.#{error_key}
               ]
             end
 

data/lib/ndd/rspec/rails/matchers/model/have_a_translated_model.rb

@@ -1,37 +1,12 @@
-require 'active_support/core_ext/string/inflections'
-require 'i18n'
-require 'ndd/rspec/rails/matchers/model/translation_matcher'
+require 'ndd/rspec/rails/matchers/translation_matcher'
 
 module Ndd
   module RSpec
     module Rails
       module Matchers
-        module Model #:nodoc:
+        module Model
 
-          # Ensure that a model has an associated translation.
-          #
-          # More precisely, ensure that
-          #   I18n.t(locale, "activerecord.models.{snake_case_class_name}")
-          # returns a value for the default locale (i.e. +I18n.default_locale+)
-          # or all the available locales (i.e. +I18n.available_locales+).
-          #
-          # For example:
-          #
-          #   RSpec.describe MyModel, type: :model do
-          #     # both are equivalent
-          #     it { is_expected.to have_a_translated_model }
-          #     it { is_expected.to have_a_translated_model.in_available_locales }
-          #
-          #     it { is_expected.to have_a_translated_model.in_default_locale }
-          #   end
-          #
-          def have_a_translated_model # rubocop:disable Style/PredicateName
-            HaveATranslatedModel.new
-          end
-
-          # ------------------------------------------------------------------------------------------------------------
           # Implements {#have_a_translated_model}.
-          #
           class HaveATranslatedModel < TranslationMatcher
 
             # @param model [Object] the model being tested.

data/lib/ndd/rspec/rails/matchers/model.rb

@@ -2,6 +2,100 @@ require_relative 'model/have_a_translated_attribute'
 require_relative 'model/have_a_translated_error'
 require_relative 'model/have_a_translated_model'
 
+module Ndd
+  module RSpec
+    module Rails
+      module Matchers
+        # RSpec matchers for Rails models.
+        module Model
+
+          # Ensure that an attribute has an associated translation.
+          #
+          # More precisely, ensure that
+          #   I18n.t(locale, "activerecord.attributes.{snake_case_class_name}.{snake_case_attribute_name}")
+          # returns a value for the default locale (i.e. +I18n.default_locale+)
+          # or all the available locales (i.e. +I18n.available_locales+).
+          #
+          # @example
+          #
+          #   RSpec.describe MyModel, type: :model do
+          #     # both are equivalent
+          #     it { is_expected.to have_a_translated_attribute(:comment) }
+          #     it { is_expected.to have_a_translated_attribute(:comment).in_available_locales }
+          #
+          #     it { is_expected.to have_a_translated_attribute(:comment).in_default_locale }
+          #   end
+          #
+          # @param attribute [String|Symbol] the attribute to test.
+          # @return [Ndd::RSpec::Rails::Matchers::Model::HaveATranslatedAttribute]
+          #
+          def have_a_translated_attribute(attribute) # rubocop:disable Style/PredicateName
+            HaveATranslatedAttribute.new(attribute)
+          end
+
+          # Ensure that an error on a model or an attribute has an associated translation.
+          #
+          # More precisely, ensure that (with all parameters being snake case) one of
+          #   I18n.t(locale, "activerecord.errors.models.{class_name}.attributes.{attribute_name}.{error_key}")
+          #   I18n.t(locale, "activerecord.errors.models.{class_name}.{error_key}")
+          #   I18n.t(locale, "activerecord.errors.messages.{error_key}")
+          #   I18n.t(locale, "errors.attributes.{attribute_name}.{error_key}")
+          #   I18n.t(locale, "errors.messages.{error_key}")
+          # returns a value for the default locale (i.e. +I18n.default_locale+)
+          # or all the available locales (i.e. +I18n.available_locales+).
+          #
+          # @example
+          #
+          #   RSpec.describe MyModel, type: :model do
+          #     # both are equivalent
+          #     it { is_expected.to have_a_translated_error(:duplicate) }
+          #     it { is_expected.to have_a_translated_error(:duplicate).in_available_locales }
+          #
+          #     it { is_expected.to have_a_translated_error(:duplicate).in_default_locale }
+          #
+          #     # both are equivalent
+          #     it { is_expected.to have_a_translated_error(:duplicate).on_attribute(:comments) }
+          #     it { is_expected.to have_a_translated_error(:duplicate).on_attribute(:comments).in_available_locales }
+          #
+          #     it { is_expected.to have_a_translated_error(:duplicate).on_attribute(:comments).in_default_locale }
+          #   end
+          #
+          # @param error [String|Symbol] the error to test.
+          # @return [Ndd::RSpec::Rails::Matchers::Model::HaveATranslatedError]
+          #
+          def have_a_translated_error(error) # rubocop:disable Style/PredicateName
+            HaveATranslatedError.new(error)
+          end
+
+          # Ensure that a model has an associated translation.
+          #
+          # More precisely, ensure that
+          #   I18n.t(locale, "activerecord.models.{snake_case_class_name}")
+          # returns a value for the default locale (i.e. +I18n.default_locale+)
+          # or all the available locales (i.e. +I18n.available_locales+).
+          #
+          # @example
+          #
+          #   RSpec.describe MyModel, type: :model do
+          #     # both are equivalent
+          #     it { is_expected.to have_a_translated_model }
+          #     it { is_expected.to have_a_translated_model.in_available_locales }
+          #
+          #     it { is_expected.to have_a_translated_model.in_default_locale }
+          #   end
+          #
+          # @return [Ndd::RSpec::Rails::Matchers::Model::HaveATranslatedModel]
+          #
+          def have_a_translated_model # rubocop:disable Style/PredicateName
+            HaveATranslatedModel.new
+          end
+
+        end
+      end
+    end
+  end
+end
+
 RSpec.configure do |config|
   config.include Ndd::RSpec::Rails::Matchers::Model, type: :model
 end

data/lib/ndd/rspec/rails/matchers/translation_matcher.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/string/inflections'
+require 'i18n'
+
+module Ndd
+  module RSpec
+    module Rails
+      module Matchers
+
+        # Base class for matchers dealing with translation.
+        class TranslationMatcher
+
+          # Set the locales to test to +I18n.available_locales+.
+          def initialize
+            @tested_locales = I18n.available_locales
+          end
+
+          # Set the locales to test to all the available locales (i.e. +I18n.available_locales+).
+          # @return self
+          def in_available_locales
+            @tested_locales = I18n.available_locales
+            self
+          end
+
+          # Set the locales to test to the default locale (i.e. +I18n.default_locale+) only.
+          # @return self
+          def in_default_locale
+            @tested_locales = [I18n.default_locale]
+            self
+          end
+
+          # -------------------------------------------------------------------------------------------- private -----
+          private
+
+          # Convert an array of locales to a human readable list, i.e. ':en, :fr, :jp'.
+          # @param locales [Array<String|Symbol>] the locales to convert.
+          # @return [String] the converted locales.
+          def locales_as_string(locales)
+            locales.map { |locale| ":#{locale}" }.join(', ')
+          end
+
+          # Check that a translation exists for the given key in the given locale.
+          # @param locale [Symbol] the locale of the translation to lookup.
+          # @param key [String] the key of the translation to lookup.
+          # @return [Boolean] true if a translation exists for the given key in the given locale, false otherwise.
+          def translated?(locale, key)
+            I18n.with_locale(locale) { I18n.t(key, raise: true) }
+            return true
+          rescue I18n::MissingTranslationData
+            return false
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/ndd/rspec/rails/matchers.rb

@@ -1 +1,14 @@
+require_relative 'matchers/controller'
 require_relative 'matchers/model'
+
+module Ndd
+  module RSpec
+    module Rails
+
+      # RSpec matchers for Rails.
+      module Matchers
+      end
+
+    end
+  end
+end

data/lib/ndd/rspec/rails/version.rb

@@ -1,7 +1,7 @@
 module Ndd
   module RSpec
     module Rails
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.2.0'.freeze
     end
   end
 end

data/lib/ndd/rspec/rails.rb

@@ -1,2 +1,12 @@
 require 'ndd/rspec/rails/version'
 require 'ndd/rspec/rails/matchers'
+
+module Ndd #:nodoc:
+  module RSpec #:nodoc:
+
+    # RSpec extensions for Rails.
+    module Rails
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndd-rspec-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David DIDIER
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -205,13 +205,16 @@ files:
 - bin/console
 - bin/rubocop
 - bin/setup
+- bin/yard-server
 - lib/ndd/rspec/rails.rb
 - lib/ndd/rspec/rails/matchers.rb
+- lib/ndd/rspec/rails/matchers/controller.rb
+- lib/ndd/rspec/rails/matchers/controller/have_a_translated_flash.rb
 - lib/ndd/rspec/rails/matchers/model.rb
 - lib/ndd/rspec/rails/matchers/model/have_a_translated_attribute.rb
 - lib/ndd/rspec/rails/matchers/model/have_a_translated_error.rb
 - lib/ndd/rspec/rails/matchers/model/have_a_translated_model.rb
-- lib/ndd/rspec/rails/matchers/model/translation_matcher.rb
+- lib/ndd/rspec/rails/matchers/translation_matcher.rb
 - lib/ndd/rspec/rails/version.rb
 homepage: http://github.com/ddidier/ndd-rspec-rails
 licenses:

data/lib/ndd/rspec/rails/matchers/model/translation_matcher.rb

@@ -1,59 +0,0 @@
-require 'active_support/core_ext/string/inflections'
-require 'i18n'
-
-module Ndd
-  module RSpec
-    module Rails
-      module Matchers
-        module Model #:nodoc:
-
-          # Base class for matchers dealing with translation.
-          class TranslationMatcher
-
-            # Set the locales to test to +I18n.available_locales+.
-            def initialize
-              @tested_locales = I18n.available_locales
-            end
-
-            # Set the locales to test to all the available locales (i.e. +I18n.available_locales+).
-            # @return self
-            def in_available_locales
-              @tested_locales = I18n.available_locales
-              self
-            end
-
-            # Set the locales to test to the default locale (i.e. +I18n.default_locale+) only.
-            # @return self
-            def in_default_locale
-              @tested_locales = [I18n.default_locale]
-              self
-            end
-
-            # -------------------------------------------------------------------------------------------- private -----
-            private
-
-            # Convert an array of locales to a human readable list, i.e. ':en, :fr, :jp'.
-            # @param locales [Array<String|Symbol>] the locales to convert.
-            # @return [String] the converted locales.
-            def locales_as_string(locales)
-              locales.map { |locale| ":#{locale}" }.join(', ')
-            end
-
-            # Check that a translation exists for the given key in the given locale.
-            # @param locale [Symbol] the locale of the translation to lookup.
-            # @param key [String] the key of the translation to lookup.
-            # @return [Boolean] true if a translation exists for the given key in the given locale, false otherwise.
-            def translated?(locale, key)
-              I18n.with_locale(locale) { I18n.t(key, raise: true) }
-              return true
-            rescue I18n::MissingTranslationData
-              return false
-            end
-
-          end
-
-        end
-      end
-    end
-  end
-end