order_already 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dab15b63f8b14d65dbbcb5f6fe968a03330e88ef48d8104233a90fa374a5087
-  data.tar.gz: fd1f5a1f2d9895c5012e280f40405b07c7c7729a98aa433b9ba9460f1bf0bd90
+  metadata.gz: 53d7a220ae782eabbe029a0e45f909d1b605b07b881e612b09150819b5cafdc6
+  data.tar.gz: 364e044bd3e6b73201f87987cec8f98f09e49d9ef14152bbbdad7c9623bca900
 SHA512:
-  metadata.gz: 7b06788255b18b24895117f7ff9dfd605ac67e85c5d60fb934dbb79fdcecea09b399510d74fc2327d0b0fbd9bd5b8643186940e3488d52c86c4593391084c8d4
-  data.tar.gz: '09010bdfeae1a452fb97c178c44f9ea0143f3df3b532f7684c3baf113edbb36295a51bf611f8066ebd38a95b7f3d782a4fc260a805f76b6161014348e4a32468'
+  metadata.gz: cb6868e1c646a11440e211b90afb49d4662a5312fdd49f75fec4f3cadef7508a72c6af8a99b9f8db46148de56b5be6741a37eddc52af5f39e7dbec8e51571cd7
+  data.tar.gz: 441506b2660ff35e8555e451401ed9ae73db8008a233755f77d6e7d4ec61b903d8244bf54f85e052b99571671c1408316a34c35d89ae2d74f396b787bedb2052

data/README.md

@@ -47,6 +47,19 @@ class GenericWork < ActiveFedora::Base
 end
 ```
 
+Included, as of v0.3.1, is the `order_already/spec_helper`.  This provides the custom matcher: `have_already_ordered_attributes`.
+
+```ruby
+require 'spec_helper'
+require 'order_already/spec_helper'
+
+RSpec.describe GenericWork do
+  subject { described_class.new }
+
+  it { is_expected.to have_already_ordered_attributes(:creator, :contributor) }
+end
+```
+
 As of v0.2.0, the `OrderAlready.for` method takes a `:serializer` keyword.  By default this is the preserve the order of the input serializers.
 
 ## Development

data/lib/order_already/spec_helper.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :have_already_ordered_attributes do |*expected_attributes|
+  match do |actual|
+    actual.already_ordered_attributes.map(&:to_sym).sort == expected_attributes.map(&:to_sym).sort
+  end
+
+  failure_message do |actual|
+    actual_attrs = actual.already_ordered_attributes.map(&:to_sym).sort
+    expected_attrs = expected_attributes.map(&:to_sym).sort
+
+    "Expected that #{actual} would have the following ordered attributes:\n" \
+    "#{expected_attrs.inspect}.\n"
+    "Actual: #{actual_attrs.inspect}\n"
+  end
+end

data/lib/order_already/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrderAlready
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/order_already.rb

@@ -20,7 +20,8 @@ module OrderAlready
   #        data.  Want to auto-alphabetize?  Use a different serializer than the default.
   #
   # @return [Module] a module that wraps the attr_accessor methods for the given :attributes.  In
-  #         using a module, we have access to `super`; which is super convenient!
+  #         using a module, we have access to `super`; which is super convenient!  The module will
+  #         also add a `#attribute_is_ordered_already?` method.
   #
   # @note In testing, you need to use `prepend` instead of `include`; but that may be a function of
   #       my specs.
@@ -42,9 +43,13 @@ module OrderAlready
   #     prepend OrderAlready.for(:subjects, serializer: Alphabetizer)
   #   end
   def self.for(*attributes, serializer: InputOrderSerializer)
+    # Capturing the named attributes to create a local binding; this helps ensure we have that
+    # available in the later :attribute_is_ordered_already? method definition.
+    ordered_attributes = attributes.map(&:to_sym)
+
     # By creating a module, we have access to `super`.
     Module.new do
-      attributes.each do |attribute|
+      ordered_attributes.each do |attribute|
         define_method(attribute) do
           serializer.deserialize(super())
         end
@@ -53,6 +58,14 @@ module OrderAlready
           super(serializer.serialize(values))
         end
       end
+
+      define_method(:attribute_is_ordered_already?) do |attribute|
+        ordered_attributes.include?(attribute.to_sym)
+      end
+
+      define_method(:already_ordered_attributes) do
+        ordered_attributes
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: order_already
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails-html-sanitizer
@@ -71,11 +71,11 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/order_already.rb
+- lib/order_already/spec_helper.rb
 - lib/order_already/version.rb
 - order_already.gemspec
 homepage: https://github.com/scientist-softserv/order_already

data/Gemfile.lock

@@ -1,92 +0,0 @@
-PATH
-  remote: .
-  specs:
-    order_already (0.2.0)
-      rails-html-sanitizer (~> 1.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    bixby (5.0.2)
-      rubocop (= 1.28.2)
-      rubocop-ast
-      rubocop-performance
-      rubocop-rails
-      rubocop-rspec
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.19.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    minitest (5.16.3)
-    nokogiri (1.13.9-arm64-darwin)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.1)
-      ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (3.0.0)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.28.2)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.15.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.15.2)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 1.7.0, < 2.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-
-PLATFORMS
-  arm64-darwin-21
-
-DEPENDENCIES
-  bixby (~> 5.0, >= 5.0.2)
-  order_already!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.3.9