decorator_dryer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57534e692dcdc6bfc6a30bf1ba81d3392acd5aa9970c61c4a301ac680f8cbb35
+  data.tar.gz: 26e905c85521618775dc1276e9e9435f7839d003cc99137719b40d4f673b7c2d
+SHA512:
+  metadata.gz: 8e0f3540a44117a74423b51b30d871303d61bfc8f48bfd874c915fe8c2b40ecbaae19180adf5c824dd4013ec6c365487f1fefbcdcacd5fca7a3548e1ae408285
+  data.tar.gz: 445f24bce804cf151f0967f18bd6edeabb37769390dcf2720655d51f9eb10ee8c369781ad10d2a93b6363ba804ddf956dae66cf922b62f92e821057853d2446f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 40
+  Exclude:
+    - spec/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - spec/**/*
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mark@tyne-solutions.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in decorator_dryer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    decorator_dryer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  decorator_dryer!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.4.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mark Harbison
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,248 @@
+# Decorator Dryer
+
+Welcome to Decorator Dryer! The aim of this gem is to help you write smaller, DRYer, easier to maintain, decorators.
+
+Decorator Dryer contains a collection of formatters that cover some of the more common things that developers do in their decorators. On top of those formatters is a layer of shortcuts to help you reduce the amount of code in your decorator classes.
+
+This is not a fully-formed decorator framework. Decorator Dryer is intended as a companion for Draper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'draper'
+gem 'decorator_dryer'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Configuration
+
+### Formatters
+
+The formatters in Decorator Dryer use a set of default formats for things like dates and times.
+
+If you are happy with the defaults, you can skip this section. However, if you would like to set your own defaults, you can do so with an initializer.
+
+```ruby
+DecoratorDryer.configure do |config|
+  config.date_format = "%Y-%m-%d"
+  config.humanized_date_format = "%d/%m/%Y"
+  config.datetime_format = "%Y-%m-%d %H:%M"
+  config.humanized_datetime_format = "%H:%M %d/%m/%Y"
+  config.time_format = "%H:%M"
+end
+```
+
+### Attachments
+
+Decorator Dryer also provides shortcuts for attachments. There will be more detail on these shortcuts in later sections.
+
+This can also be configured via an initializer.
+
+```ruby
+DecoratorDryer.configure do |config|
+  config.attachment_shortcuts.mode = :none
+  config.attachment_shortcuts.default_preview_transform = :none
+end
+```
+
+Attachment shortcuts are disabled by default. To enable them, you can set `config.attachment_shortcuts.mode = :active_storage` Please note that this gem currently only provides shortcuts for Active Storage attachments.
+
+You can also set a default transform for your attachment previews.
+
+This could either be a variant, with something like:
+    `config.attachment_shortcuts.default_preview_transform = :thumb`
+Or, a representation with something like:
+    `config.attachment_shortcuts.default_preview_transform = { resize: "400x" }`
+
+## Usage
+
+Decorator Dryer is not a complete decorator library. It is intended for use alongside Draper. Why reinvent the wheel when there is already such a good option out there?
+
+You can use Decorator Dryer by either adding the shortcuts to your decorator classes or by directly calling the formatters from within your decorator methods.
+
+### Shortcuts
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  to_date_format :date_of_birth
+  to_datetime_format :moment_of_birth
+  to_time_format :lunch_time
+  to_precision_number :salary, precision: 2
+  to_attachment :profile_picture
+end
+```
+
+#### to_date_format
+
+This shortcut adds a method to your decorator that returns the formatted date. It can accept 1 or more attributes of type Date, DateTime, or Time.
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  to_date_format :date_of_birth, :date_of_graduation
+end
+
+date_of_birth = Date.new(2000, 1, 1)
+date_of_graduation = Date.new(2018, 6, 6)
+person = Person.create(date_of_birth: date_of_birth, date_of_graduation: date_of_graduation)
+person.decorate.date_of_birth # ==> '2000-01-01'
+person.decorate.date_of_graduation # ==> '2018-06-06'
+```
+
+This shortcut uses the gem's default date format (%Y-%m-%d), or the format set in your initializer.
+
+You could also provide a context when initializing your decorator, and tell it to return dates in a humanized format. The humanized format can also be set in your initializer.
+
+```ruby
+date_of_birth = Date.new(2000, 1, 1)
+person = Person.create(date_of_birth: date_of_birth)
+person.decorate(context: { humanize: true }).date_of_birth # ==> '01/01/2000'
+```
+
+#### to_datetime_format
+
+This shortcut adds a method to your decorator that returns the formatted datetime. It can accept 1 or more attributes of type DateTime or Time.
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  to_datetime_format :moment_of_birth, :moment_of_graduation
+end
+
+moment_of_birth = DateTime.new(2000, 1, 1, 12, 30, 59)
+moment_of_graduation = DateTime.new(2018, 6, 6, 17, 00, 03)
+person = Person.create(moment_of_birth: moment_of_birth, moment_of_graduation: moment_of_graduation)
+person.decorate.moment_of_birth # ==> '2000-01-01 12:30'
+person.decorate.moment_of_graduation # ==> '2018-06-06 17:00'
+```
+
+This shortcut uses the gem's default datetime format (%Y-%m-%d %H:%M), or the format set in your initializer.
+
+You could also provide a context when initializing your decorator, and tell it to return datetimes in a humanized format. The humanized format can also be set in your initializer.
+
+```ruby
+moment_of_birth = DateTime.new(2000, 1, 1, 12, 30, 59)
+person = Person.create(moment_of_birth: moment_of_birth)
+person.decorate(context: { humanize: true }).moment_of_birth # ==> '12:30 01/01/2000'
+```
+
+#### to_time_format
+
+This shortcut adds a method to your decorator that returns the formatted time. It can accept 1 or more attributes of type DateTime or Time.
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  to_time_format :moment_of_birth, :moment_of_graduation
+end
+
+moment_of_birth = Time.new(2000, 1, 1, 12, 30, 59)
+moment_of_graduation = Time.new(2018, 6, 6, 17, 00, 03)
+person = Person.create(moment_of_birth: moment_of_birth, moment_of_graduation: moment_of_graduation)
+person.decorate.moment_of_birth # ==> '12:30'
+person.decorate.moment_of_graduation # ==> '17:00'
+```
+
+This shortcut uses the gem's default time format (%H:%M), or the format set in your initializer. This shortcut does not have an option for a humanized format.
+
+#### to_precision_number
+
+This shortcut adds a method to your decorator that returns the provided numbers as strings with a specific number of decimal places. It can accept 1 or more number attributes and a precision. If you would like to use different precisions for different attributes, you can use the shortcut multiple times.
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  to_precision_number :salary, :coffee_budget, precision: 2
+  to_precision_number :height_in_meters, precision: 3
+end
+
+person = Person.create(salary: 1000, coffee_budget: 20, height_in_meters: 1.8516)
+person.decorate.salary # ==> '1000.00'
+person.decorate.coffee_budget # ==> '20.00'
+person.decorate.height_in_meters # ==> '1.852'
+```
+
+#### to_attachment
+
+To use this shortcut, you need to enable it in your initializer (see details above).
+
+This shortcut adds 4 methods to your decorator for each of the specified attachments. Those methods return the attachment's URL, filename, signed-id, and preview-URL.
+
+The preview is based on the gem's default preview-transform, or the transform set in your initializer. If you would like to override the transform in your decorator, you can provide a `preview_transform` option along with the attachment attributes. If you would like to use different transforms for different attributes, you can use the shortcut multiple times.
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  to_attachment :profile_picture, :resume
+  to_attachment :birth_certificate, preview_transform: :thumbnail
+end
+
+person = Person.create(profile_picture: ..., resume: ..., birth_certificate: ...)
+person.decorate.profile_picture_url
+person.decorate.profile_picture_name
+person.decorate.profile_picture_preview
+person.decorate.profile_picture_signed_id
+...
+```
+
+### Formatters
+
+It is also possible to use the formatters directly, without the shortcuts. This gives you the flexibility to set different method names or use additional logic.
+
+```ruby
+class PersonDecorator < Draper::Decorator
+  include DecoratorDryer
+
+  def first_birthday
+    format_date(object.date_of_birth)
+  end
+
+  def birth_datetime
+    format_datetime(moment_of_birth)
+  end
+
+  def when_is_lunch
+    format_time(lunch_time)
+  end
+
+  def income
+    format_precision_number(salary, precision: 2)
+  end
+end
+```
+
+## 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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `spec` to run the tests.
+
+To release a new version of this gem, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CodeTectonics/decorator_dryer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/CodeTectonics/decorator_dryer/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DecoratorDryer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/CodeTectonics/decorator_dryer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "decorator_dryer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/decorator_dryer.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "lib/decorator_dryer/version"
+
+Gem::Specification.new do |s|
+  s.name = "decorator_dryer"
+  s.version = DecoratorDryer::VERSION
+  s.authors = ["Mark Harbison"]
+  s.email = ["mark@tyne-solutions.com"]
+
+  s.summary = "Shortcuts for concise view models."
+  s.description = "Shortcuts for concise view models."
+  s.homepage = "https://github.com/CodeTectonics/decorator_dryer"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 2.6.0"
+
+  s.metadata["homepage_uri"]    = s.homepage
+  s.metadata["source_code_uri"] = s.homepage
+  s.metadata["changelog_uri"]   = "#{s.homepage}/blob/main/CHANGELOG.md"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake", "~> 13.0"
+  s.add_development_dependency "rspec", "~> 3.12"
+  s.add_development_dependency "rubocop", "~> 1.7"
+end

data/lib/decorator_dryer/active_storage_shortcuts.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module DecoratorDryer
+  module ActiveStorageShortcuts
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.include(Rails.application.routes.url_helpers)
+    end
+
+    module ClassMethods
+      def to_attachment(*attrs, preview_transform: nil)
+        to_attachment_url(*attrs)
+        to_attachment_name(*attrs)
+        to_attachment_preview(*attrs, transform: preview_transform)
+        to_attachment_signed_id(*attrs)
+      end
+
+      def to_attachment_url(*attrs)
+        attrs.each do |attr|
+          method_name = "#{attr}_url".to_sym
+
+          define_method(method_name) do
+            attachment = object.send(attr)
+
+            url_for(attachment) if attachment.attached?
+          end
+        end
+      end
+
+      def to_attachment_name(*attrs)
+        attrs.each do |attr|
+          method_name = "#{attr}_name".to_sym
+
+          define_method(method_name) do
+            attachment = object.send(attr)
+
+            attachment.blob.filename.as_json if attachment.attached?
+          end
+        end
+      end
+
+      def to_attachment_preview(*attrs, transform: nil)
+        transform ||= DecoratorDryer.configuration.attachment_shortcuts.default_preview_transform
+
+        attrs.each do |attr|
+          method_name = "#{attr}_preview".to_sym
+
+          define_method(method_name) do
+            return if transform.blank? || transform == :none
+
+            attachment = object.send(attr)
+            return unless attachment.attached?
+
+            if transform.is_a? Symbol
+              url_for attachment.variant(transform)
+            else
+              return unless attachment.representable?
+
+              url_for attachment.representation(transform).processed
+            end
+          end
+        end
+      end
+
+      def to_attachment_signed_id(*attrs)
+        attrs.each do |attr|
+          method_name = "#{attr}_signed_id".to_sym
+
+          define_method(method_name) do
+            attachment = object.send(attr)
+            attachment.signed_id if attachment.attached?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decorator_dryer/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DecoratorDryer
+  class Configuration
+    attr_accessor :date_format, :humanized_date_format,
+                  :datetime_format, :humanized_datetime_format, :time_format,
+                  :extensions
+
+    attr_reader :attachment_shortcuts
+
+    def initialize
+      @date_format = "%Y-%m-%d"
+      @humanized_date_format = "%d/%m/%Y"
+      @datetime_format = "%Y-%m-%d %H:%M"
+      @humanized_datetime_format = "%H:%M %d/%m/%Y"
+      @time_format = "%H:%M"
+      @attachment_shortcuts = AttachmentShortcutsConfig.new
+      @extensions = []
+    end
+
+    class AttachmentShortcutsConfig
+      attr_accessor :mode, :default_preview_transform
+
+      def initialize
+        @mode = :none
+        @default_preview_transform = :none
+      end
+    end
+  end
+end

data/lib/decorator_dryer/formatters.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DecoratorDryer
+  module Formatters
+    include ActionView::Helpers::NumberHelper
+
+    def format_date(date)
+      if context[:humanize]
+        date_format = DecoratorDryer.configuration.humanized_date_format
+      else
+        date_format = DecoratorDryer.configuration.date_format
+      end
+      date.try(:strftime, date_format)
+    end
+
+    def format_time(time)
+      time_format = DecoratorDryer.configuration.time_format
+      time.try(:strftime, time_format)
+    end
+
+    def format_datetime(datetime)
+      if context[:humanize]
+        datetime_format = DecoratorDryer.configuration.humanized_datetime_format
+      else
+        datetime_format = DecoratorDryer.configuration.datetime_format
+      end
+      datetime.try(:strftime, datetime_format)
+    end
+
+    def format_precision_number(number, precision = 0)
+      return 0.0 if number.blank?
+      return number.to_d if precision < 1
+
+      number_with_precision(number, precision: precision)
+    end
+
+    def to_name(association)
+      association.try(:name)
+    end
+  end
+end

data/lib/decorator_dryer/shortcuts.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DecoratorDryer
+  module Shortcuts
+    include DecoratorDryer::Formatters
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def to_date_format(*attrs)
+        attrs.each do |attr|
+          define_method(attr) do
+            format_date object.send(attr)
+          end
+        end
+      end
+
+      def to_time_format(*attrs)
+        attrs.each do |attr|
+          define_method(attr) do
+            format_time object.send(attr)
+          end
+        end
+      end
+
+      def to_datetime_format(*attrs)
+        attrs.each do |attr|
+          define_method(attr) do
+            format_datetime object.send(attr)
+          end
+        end
+      end
+
+      def to_precision_number(*attrs, precision: 0)
+        attrs.each do |attr|
+          define_method(attr) do
+            format_precision_number object.send(attr), precision
+          end
+        end
+      end
+
+      def to_name(*attrs, suffix: "name")
+        attrs.each do |attr|
+          method_name = "#{attr}_#{suffix}".to_sym
+
+          define_method(method_name) do
+            to_name object.send(attr)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decorator_dryer/version.rb

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

data/lib/decorator_dryer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "action_view"
+
+require_relative "decorator_dryer/formatters"
+require_relative "decorator_dryer/shortcuts"
+require_relative "decorator_dryer/active_storage_shortcuts"
+require_relative "decorator_dryer/configuration"
+
+module DecoratorDryer
+  def self.included(klass)
+    klass.include(DecoratorDryer::Formatters)
+    klass.include(DecoratorDryer::Shortcuts)
+
+    if DecoratorDryer.configuration.attachment_shortcuts.mode == :active_storage
+      klass.include(DecoratorDryer::ActiveStorageShortcuts)
+    end
+
+    DecoratorDryer.configuration.extensions.each do |extension|
+      klass.include(extension)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= DecoratorDryer::Configuration.new
+  end
+
+  def self.configure
+    yield DecoratorDryer.configuration
+  end
+end

data/sig/decorator_dryer.rbs

@@ -0,0 +1,4 @@
+module DecoratorDryer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/decorator_dryer_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "decorator_dryer"
+require "dummy/dummy_model"
+require "dummy/dummy_model_decorator"
+
+RSpec.describe DecoratorDryer do
+  describe "::Formatters" do
+    it "returns formatted dates" do
+      decorator = DummyModelDecorator.new({})
+      result = decorator.format_date(Date.new(2023, 11, 1))
+      expect(result).to eq("2023-11-01")
+    end
+
+    it "returns humanized dates" do
+      decorator = DummyModelDecorator.new({}, { humanize: true })
+      result = decorator.format_date(Date.new(2023, 11, 1))
+      expect(result).to eq("01/11/2023")
+    end
+
+    it "returns formatted times" do
+      decorator = DummyModelDecorator.new({})
+      result = decorator.format_time(Time.new(2023, 11, 1, 11, 30, 0))
+      expect(result).to eq("11:30")
+    end
+
+    it "returns formatted datetimes" do
+      decorator = DummyModelDecorator.new({})
+      result = decorator.format_datetime(Time.new(2023, 11, 1, 11, 30, 0))
+      expect(result).to eq("2023-11-01 11:30")
+    end
+
+    it "returns humanized datetimes" do
+      decorator = DummyModelDecorator.new({}, { humanize: true })
+      result = decorator.format_datetime(Time.new(2023, 11, 1, 11, 30, 0))
+      expect(result).to eq("11:30 01/11/2023")
+    end
+
+    it "returns number with precision" do
+      decorator = DummyModelDecorator.new({})
+      result = decorator.format_precision_number(5, 3)
+      expect(result).to eq("5.000")
+    end
+
+    it "returns association names" do
+      decorator = DummyModelDecorator.new({})
+      association = DummyModel.new
+      association.name = "John Smith"
+      result = decorator.to_name(association)
+      expect(result).to eq("John Smith")
+    end
+  end
+
+  describe "::Shortcuts" do
+    let(:dummy_record) do
+      association1 = DummyModel.new
+      association1.name = "John Smith"
+
+      association2 = DummyModel.new
+      association2.name = "Joe Bloggs"
+
+      dummy_record = DummyModel.new
+      dummy_record.date1 = Date.new(2023, 11, 1)
+      dummy_record.date2 = Date.new(2023, 11, 2)
+      dummy_record.time1 = Time.new(2023, 11, 1, 11, 30, 0)
+      dummy_record.time2 = Time.new(2023, 11, 1, 12, 59, 0)
+      dummy_record.datetime1 = Time.new(2023, 11, 1, 13, 49, 0)
+      dummy_record.datetime2 = Time.new(2023, 11, 1, 15, 23, 0)
+      dummy_record.number1 = 5.321
+      dummy_record.number2 = 77.888888
+      dummy_record.association1 = association1
+      dummy_record.association2 = association2
+      dummy_record
+    end
+
+    it "returns formatted dates" do
+      decorator = DummyModelDecorator.new(dummy_record)
+      expect(decorator.date1).to eq("2023-11-01")
+      expect(decorator.date2).to eq("2023-11-02")
+    end
+
+    it "returns humanized dates" do
+      decorator = DummyModelDecorator.new(dummy_record, { humanize: true })
+      expect(decorator.date1).to eq("01/11/2023")
+      expect(decorator.date2).to eq("02/11/2023")
+    end
+
+    it "returns formatted times" do
+      decorator = DummyModelDecorator.new(dummy_record, { humanize: true })
+      expect(decorator.time1).to eq("11:30")
+      expect(decorator.time2).to eq("12:59")
+    end
+
+    it "returns formatted datetimes" do
+      decorator = DummyModelDecorator.new(dummy_record)
+      expect(decorator.datetime1).to eq("2023-11-01 13:49")
+      expect(decorator.datetime2).to eq("2023-11-01 15:23")
+    end
+
+    it "returns humanized datetimes" do
+      decorator = DummyModelDecorator.new(dummy_record, { humanize: true })
+      expect(decorator.datetime1).to eq("13:49 01/11/2023")
+      expect(decorator.datetime2).to eq("15:23 01/11/2023")
+    end
+
+    it "returns number with precision" do
+      decorator = DummyModelDecorator.new(dummy_record)
+      expect(decorator.number1).to eq("5.32")
+      expect(decorator.number2).to eq("77.89")
+    end
+
+    it "returns association names" do
+      decorator = DummyModelDecorator.new(dummy_record)
+      expect(decorator.association1_name).to eq("John Smith")
+      expect(decorator.association2_name).to eq("Joe Bloggs")
+    end
+  end
+end

data/spec/dummy/dummy_model.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class DummyModel
+  attr_accessor :date1, :date2, :time1, :time2, :datetime1, :datetime2, :number1, :number2,
+                :association1, :association2, :name
+end

data/spec/dummy/dummy_model_decorator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class DummyModelDecorator
+  include DecoratorDryer
+
+  attr_accessor :object, :context
+
+  to_date_format :date1, :date2
+  to_time_format :time1, :time2
+  to_datetime_format :datetime1, :datetime2
+  to_precision_number :number1, :number2, precision: 2
+  to_name :association1, :association2
+
+  def initialize(object, context = {})
+    self.object = object
+    self.context = context
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: decorator_dryer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Harbison
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Shortcuts for concise view models.
+email:
+- mark@tyne-solutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- decorator_dryer.gemspec
+- lib/decorator_dryer.rb
+- lib/decorator_dryer/active_storage_shortcuts.rb
+- lib/decorator_dryer/configuration.rb
+- lib/decorator_dryer/formatters.rb
+- lib/decorator_dryer/shortcuts.rb
+- lib/decorator_dryer/version.rb
+- sig/decorator_dryer.rbs
+- spec/decorator_dryer_spec.rb
+- spec/dummy/dummy_model.rb
+- spec/dummy/dummy_model_decorator.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CodeTectonics/decorator_dryer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CodeTectonics/decorator_dryer
+  source_code_uri: https://github.com/CodeTectonics/decorator_dryer
+  changelog_uri: https://github.com/CodeTectonics/decorator_dryer/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Shortcuts for concise view models.
+test_files:
+- spec/decorator_dryer_spec.rb
+- spec/dummy/dummy_model.rb
+- spec/dummy/dummy_model_decorator.rb
+- spec/spec_helper.rb