order_already 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c26d17f72e31fe01a89459e031b394237dfe163d8c5548307cc7b00308115175
-  data.tar.gz: 0c1b6a4e25e973ff90a2dcd05cc21b9b3267a9110f762c15707cee9d4b7e10a8
+  metadata.gz: 1dab15b63f8b14d65dbbcb5f6fe968a03330e88ef48d8104233a90fa374a5087
+  data.tar.gz: fd1f5a1f2d9895c5012e280f40405b07c7c7729a98aa433b9ba9460f1bf0bd90
 SHA512:
-  metadata.gz: 640aae2c6f8f6c678afe164aa37044afad6192f88ea042e7aa50b431e62258cd267a95368ab82bbcb2a28845e57be939d7a663f8e8995bb532dc038d5d8c0c54
-  data.tar.gz: 6400c35df376c1767b59d7a8bbab52a8554917c51c84fdd4592a09b6bdf703d344e2765824d6a7f1ab24d1d96b37a62045a74bd03906ab981ae302c9a2e53719
+  metadata.gz: 7b06788255b18b24895117f7ff9dfd605ac67e85c5d60fb934dbb79fdcecea09b399510d74fc2327d0b0fbd9bd5b8643186940e3488d52c86c4593391084c8d4
+  data.tar.gz: '09010bdfeae1a452fb97c178c44f9ea0143f3df3b532f7684c3baf113edbb36295a51bf611f8066ebd38a95b7f3d782a4fc260a805f76b6161014348e4a32468'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    order_already (0.1.0)
+    order_already (0.2.0)
       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.2.1"
 end

data/lib/order_already.rb

@@ -17,9 +17,10 @@ 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!
   #
   # @note In testing, you need to use `prepend` instead of `include`; but that may be a function of
   #       my specs.
@@ -34,7 +35,13 @@ 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)
     # By creating a module, we have access to `super`.
     Module.new do
       attributes.each do |attribute|
@@ -49,10 +56,14 @@ module OrderAlready
     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 +75,8 @@ module OrderAlready
       end
     end
 
+    # @api public
+    #
     # Serialize a normal array of values to an array of ordered values
     #
     # @param arr [Array]
@@ -93,7 +106,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.2.1
 platform: ruby
 authors:
 - Jeremy Friesen