decorator_dryer 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5615f9000e21335ada498331dd1fe229958e961492c4cd2221190fafa7ffa6
-  data.tar.gz: 288f3aace43467fad8b93afc54334101fbe669ab98992fdb00c86a7f978d05da
+  metadata.gz: b2b5ffec7f0a9d0ed8372f6a8ab3433a2daab3ea6fc1068ad79b1ba36061e990
+  data.tar.gz: 2cebca175fc5e36be748707c2bae014d20678df21d1d6add37762e58acfef3f8
 SHA512:
-  metadata.gz: 55e39f52c71bf22f394ba9c2c8581c99b8cd741c1329340999e58f0d175d584e14881d306b2def6981d144f8ac1cb650d3e5c1a5ba9b4ca4c092a685adc711e8
-  data.tar.gz: 1498d7d0e999640d81bee64c36920ee1727d4f297e8a5cfa31c25e02edc02c7a383d21bceba9d63d4657ed391a5e3bdca3f8d7b2b9df64ffdceda21afa442d80
+  metadata.gz: 769b19aedb2d3d7b617bbbd7b1bd473c5b371a8fb0afb520134c20b5af9b926d1130441e008697e4072ad5fb535bfca2392503215959c2ac194792f02f896c96
+  data.tar.gz: fc53714bc8a1c60a28adc349e5f2afe6d9989aeb9750b29271cb8da83980e3fb91e18c7741557f7ab4da5699fdeaff47380c22a93e19255061a72d42f4ccb4a3

data/README.md

@@ -223,12 +223,79 @@ class PersonDecorator < Draper::Decorator
 end
 ```
 
+## Testing
+
+### RSpec Matchers
+
+Decorator Dryer provides RSpec matchers to help you test your decorators. To use them, require the matchers in your `spec_helper.rb` or `rails_helper.rb`:
+
+```ruby
+require 'decorator_dryer/rspec'
+```
+
+The following matchers are available:
+
+#### format_field_to_name
+
+Verifies that a decorator defines a method to retrieve the name value from an association:
+
+```ruby
+it { should format_field_to_name(:person) }
+```
+
+#### format_field_to_datetime
+
+Verifies that a decorator defines a datetime format method for a given attribute:
+
+```ruby
+it { should format_field_to_datetime(:moment_of_birth) }
+```
+
+#### format_field_to_time
+
+Verifies that a decorator defines a time format method for a given attribute:
+
+```ruby
+it { should format_field_to_time(:lunch_time) }
+```
+
+#### format_field_to_date
+
+Verifies that a decorator defines a date format method for a given attribute:
+
+```ruby
+it { should format_field_to_date(:moment_of_birth) }
+```
+
+#### format_field_to_precision_number
+
+Verifies that a decorator defines a precision number format method for a given attribute:
+
+```ruby
+it { should format_field_to_precision_number(:salary, 2) }
+```
+
+#### delegate_field
+
+Verifies that a decorator defines a method to delegate a given attribute to a given association:
+
+```ruby
+it { should delegate_field(:job_title, :employee) }
+```
+
+#### delegate_field_with_prefix
+
+Verifies that a decorator defines a method to delegate a given attribute to a given association, using the association as the method prefix:
+
+```ruby
+it { should delegate_field_with_prefix(:job_title, :employee) }
+```
+
 ## To Do
 
 * Enable formats to be overridden when calling shortcuts.
 * Add support for additional attachment libraries.
 * Add a more flexible replacement for the `to_name` shortcut.
-* Add test helpers.
 * Add a generator for the initialiser.
 
 ## Development

data/lib/decorator_dryer/rspec/matchers.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module DecoratorDryer
+  module RSpec
+    module Matchers
+      # Matcher to verify that a decorator defines a method to return the name attribute
+      # of a field.
+      #
+      # @example
+      #   expect(user).to format_field_to_name(:role)
+      ::RSpec::Matchers.define :format_field_to_name do |field|
+        match do |subject|
+          subject.decorate.send("#{field}_name") == subject.send(field).try(:name)
+        end
+        description do
+          "format #{field} to display its name attribute"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} decorator to format #{field} with a _name suffix method"
+        end
+      end
+
+      # Matcher to verify that a decorator formats a datetime field with format '%Y-%m-%d %H:%M'.
+      #
+      # @example
+      #   expect(post).to format_field_to_datetime(:published_at)
+      ::RSpec::Matchers.define :format_field_to_datetime do |field|
+        match do |subject|
+          subject.decorate.send(field) == subject.send(field).try(:strftime, '%Y-%m-%d %H:%M')
+        end
+        description do
+          "format #{field} as a datetime with format '%Y-%m-%d %H:%M'"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} decorator to format #{field} as '%Y-%m-%d %H:%M'"
+        end
+      end
+
+      # Matcher to verify that a decorator formats a date field with format '%Y-%m-%d'.
+      #
+      # @example
+      #   expect(event).to format_field_to_date(:start_date)
+      ::RSpec::Matchers.define :format_field_to_date do |field|
+        match do |subject|
+          subject.decorate.send(field) == subject.send(field).try(:strftime, '%Y-%m-%d')
+        end
+        description do
+          "format #{field} as a date with format '%Y-%m-%d'"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} decorator to format #{field} as '%Y-%m-%d'"
+        end
+      end
+
+      # Matcher to verify that a decorator formats a time field with format '%H:%M'.
+      #
+      # @example
+      #   expect(schedule).to format_field_to_time(:start_time)
+      ::RSpec::Matchers.define :format_field_to_time do |field|
+        match do |subject|
+          subject.decorate.send(field) == subject.send(field).try(:strftime, '%H:%M')
+        end
+        description do
+          "format #{field} as a time with format '%H:%M'"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} decorator to format #{field} as '%H:%M'"
+        end
+      end
+
+      # Matcher to verify that a decorator formats a number field with a specific precision.
+      #
+      # @example
+      #   expect(product).to format_field_to_precision_number(:price, 2)
+      ::RSpec::Matchers.define :format_field_to_precision_number do |field, precision|
+        match do |subject|
+          subject.decorate.send(field) == number_with_precision(subject.send(field), precision: precision)
+        end
+        description do
+          "format #{field} as a number with precision #{precision}"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} decorator to format #{field} with precision #{precision}"
+        end
+      end
+
+      # Matcher to verify that a decorator delegates a field to an associated object.
+      #
+      # @example
+      #   expect(order).to delegate_field(:email, :customer)
+      ::RSpec::Matchers.define :delegate_field do |field, association|
+        match do |subject|
+          subject.decorate.send(field) == subject.send(association).decorate.send(field)
+        end
+        description do
+          "delegate #{field} to #{association}"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} to delegate #{field} to #{association}"
+        end
+      end
+
+      # Matcher to verify that a decorator delegates a field to an associated object with
+      # a prefix based on the association name.
+      #
+      # @example
+      #   expect(order).to delegate_field_with_prefix(:email, :customer)
+      ::RSpec::Matchers.define :delegate_field_with_prefix do |field, association|
+        match do |subject|
+          subject.decorate.send("#{association}_#{field}") ==
+            subject.send(association).decorate.send(field)
+        end
+        description do
+          "delegate #{field} to #{association} with prefix"
+        end
+        failure_message do |subject|
+          "expected #{subject.class.name} to delegate #{field} to #{association}"
+        end
+      end
+    end
+  end
+end
+
+# Auto-include matchers when RSpec is loaded
+::RSpec.configure { |config| config.include DecoratorDryer::RSpec::Matchers }

data/lib/decorator_dryer/rspec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+require_relative "rspec/matchers"
+

data/lib/decorator_dryer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DecoratorDryer
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decorator_dryer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Mark Harbison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-25 00:00:00.000000000 Z
+date: 2026-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,6 +76,8 @@ files:
 - lib/decorator_dryer/active_storage_shortcuts.rb
 - lib/decorator_dryer/configuration.rb
 - lib/decorator_dryer/formatters.rb
+- lib/decorator_dryer/rspec.rb
+- lib/decorator_dryer/rspec/matchers.rb
 - lib/decorator_dryer/shortcuts.rb
 - lib/decorator_dryer/version.rb
 - sig/decorator_dryer.rbs