order_already 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c26d17f72e31fe01a89459e031b394237dfe163d8c5548307cc7b00308115175
-  data.tar.gz: 0c1b6a4e25e973ff90a2dcd05cc21b9b3267a9110f762c15707cee9d4b7e10a8
+  metadata.gz: 06d0792edcb48d855dd6d7fe7f7e7bd28ee198f6144a816e4b7594f49ea7fe32
+  data.tar.gz: bc0bb4eafc7c7f01bdbb90e3a5ab20b59abc74f797509f0da4f592ba946ca628
 SHA512:
-  metadata.gz: 640aae2c6f8f6c678afe164aa37044afad6192f88ea042e7aa50b431e62258cd267a95368ab82bbcb2a28845e57be939d7a663f8e8995bb532dc038d5d8c0c54
-  data.tar.gz: 6400c35df376c1767b59d7a8bbab52a8554917c51c84fdd4592a09b6bdf703d344e2765824d6a7f1ab24d1d96b37a62045a74bd03906ab981ae302c9a2e53719
+  metadata.gz: 57752a7bf98a638194b27db452a8028e30cfe94e2490972ee3b9164e72c3e20e6fbb3db4db9c1b6e3a1987259daf29e69b78657578a42342d68377d11e127a50
+  data.tar.gz: 16d4471e24105b2641ff0640963e3de6a2eff56dc84e0ea104415b1b4cbbe77ab146fcb71df6938f60f4bf1158b5fcf0bdee2d7e2c22939a8209669c83455d29

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    order_already (0.1.0)
+    order_already (0.2.1)
       rails-html-sanitizer (~> 1.4)
 
 GEM

data/README.md

@@ -47,6 +47,8 @@ class GenericWork < ActiveFedora::Base
 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
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/order_already/version.rb

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

data/lib/order_already.rb

@@ -17,9 +17,11 @@ module OrderAlready
   #
   # @param attributes [Array<Symbol>] the name of the attributes/properties you want to order.
   # @param serializer [#serialize, #deserialize] the service class responsible for serializing the
-  #        data.  Want to auto-alphabetize?  Inject a new serializer.
+  #        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.
+  # @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!  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.
@@ -34,10 +36,20 @@ module OrderAlready
   #     end
   #     prepend OrderAlready.for(:creators)
   #   end
-  def self.for(*attributes, serializer: StringSerializer)
+  #
+  #   class OtherRecord
+  #     attr_accessor :subjects
+  #     # Assumes there's an Alphabetizer constant that responds to .serialize and .deserialize
+  #     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
@@ -46,13 +58,21 @@ module OrderAlready
           super(serializer.serialize(values))
         end
       end
+
+      define_method(:attribute_is_ordered_already?) do |attribute|
+        ordered_attributes.include?(attribute.to_sym)
+      end
     end
   end
 
-  module StringSerializer
-    # defaults
+  # This serializer preserves the input order regardless of underlying persistence order.
+  #
+  # The two public methods are {.deserialize} and {.serialize}.
+  module InputOrderSerializer
     TOKEN_DELIMITER = '~'
 
+    # @api public
+    #
     # Convert a serialized array to a normal array of values.
     # @param arr [Array]
     # @return [Array]
@@ -64,6 +84,8 @@ module OrderAlready
       end
     end
 
+    # @api public
+    #
     # Serialize a normal array of values to an array of ordered values
     #
     # @param arr [Array]
@@ -93,7 +115,8 @@ module OrderAlready
 
     # Sort an array of serialized values using the index token to determine the order
     def self.sort(arr)
-      # Hack to force a stable sort; see https://stackoverflow.com/questions/15442298/is-sort-in-ruby-stable
+      # Hack to force a stable sort; see
+      # https://stackoverflow.com/questions/15442298/is-sort-in-ruby-stable
       n = 0
       arr.sort_by { |val| [get_index(val), n += 1] }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: order_already
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 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-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails-html-sanitizer