order_already 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58bbcf6f098dfc3b905837315feb9634415f5ffd97402acb4ff0aaf783d3fb94
-  data.tar.gz: 97c0f11482e7c1170b737a9fcb556c7f2a6825b61f562f9bd655c72be39fa3d6
+  metadata.gz: 1dab15b63f8b14d65dbbcb5f6fe968a03330e88ef48d8104233a90fa374a5087
+  data.tar.gz: fd1f5a1f2d9895c5012e280f40405b07c7c7729a98aa433b9ba9460f1bf0bd90
 SHA512:
-  metadata.gz: 83034c9a260068af690abff7de0d4a92cd0fae477e10b9428f6a71a296fd2af9b8246c43c85549e9994800e609f23c2d393c6890f4579b561477e30f300d0c5c
-  data.tar.gz: b008abc0792f025b468a875d41021797cfa708bd3d28782aa27487e1225736a52fc7e93cbeca85db54b0481c4cb0793d5161509983ea0687013532b6c815f01b
+  metadata.gz: 7b06788255b18b24895117f7ff9dfd605ac67e85c5d60fb934dbb79fdcecea09b399510d74fc2327d0b0fbd9bd5b8643186940e3488d52c86c4593391084c8d4
+  data.tar.gz: '09010bdfeae1a452fb97c178c44f9ea0143f3df3b532f7684c3baf113edbb36295a51bf611f8066ebd38a95b7f3d782a4fc260a805f76b6161014348e4a32468'

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v0.2.0
+
+- Adding `:serializer` keyword to `OrderAlready.for`.  This allows for you to specify a custom serializer (e.g. did someone say alphabetizer?)
+
+# v0.1.0
+
+- Initial release.

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

@@ -24,7 +24,7 @@ With a plain old Ruby object (PORO):
 class MyModel
   attr_accessor :author, :subject
 
-  include OrderAlready.for(:author, :subject)
+  prepend OrderAlready.for(:author, :subject)
 end
 ```
 
@@ -43,10 +43,12 @@ class GenericWork < ActiveFedora::Base
   # schema (by adding accepts_nested_attributes)
   include ::Hyrax::BasicMetadata
 
-  include OrderAlready.for(:creator, :contributor)
+  prepend OrderAlready.for(: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
 
 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.1.0"
+  VERSION = "0.2.1"
 end

data/lib/order_already.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "order_already/version"
-# require "set"
-# require "loofah"
 require "rails-html-sanitizer"
-# require "rails/html/scrubbers"
 
 # In the spirit of Browse Everything and Questioning Authority, the Order Already module provides a
 # simple interface for ordering properties that have an indeterminate persistence order (looking at
@@ -19,7 +16,11 @@ module OrderAlready
   # @api public
   #
   # @param attributes [Array<Symbol>] the name of the attributes/properties you want to order.
-  # @return [Module] a module that wraps the attr_accessor methods for the given :attributes.
+  # @param serializer [#serialize, #deserialize] the service class responsible for serializing the
+  #        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!
   #
   # @note In testing, you need to use `prepend` instead of `include`; but that may be a function of
   #       my specs.
@@ -34,25 +35,35 @@ module OrderAlready
   #     end
   #     prepend OrderAlready.for(:creators)
   #   end
-  def self.for(*attributes)
+  #
+  #   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|
         define_method(attribute) do
-          StringSerializer.deserialize(super())
+          serializer.deserialize(super())
         end
 
         define_method("#{attribute}=") do |values|
-          super(StringSerializer.serialize(values))
+          super(serializer.serialize(values))
         end
       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 +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

data/order_already.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Jeremy Friesen", "Rob Kaufman"]
   spec.email = ["jeremy.n.friesen@gmail.com", "rob@notch8.com"]
 
-  spec.summary = "A tiny gem to provide naive sorting for Fedora Commons objects."
-  spec.description = "A tiny gem to provide naive sorting for Fedora Commons objects."
+  spec.summary = "A tiny gem to provide naive sorting for Fedora Commons properties."
+  spec.description = "A tiny gem to provide naive sorting for Fedora Commons properties."
   spec.homepage = "https://github.com/scientist-softserv/order_already"
   spec.required_ruby_version = ">= 2.6.0"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: order_already
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jeremy Friesen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails-html-sanitizer
@@ -59,7 +59,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.2
-description: A tiny gem to provide naive sorting for Fedora Commons objects.
+description: A tiny gem to provide naive sorting for Fedora Commons properties.
 email:
 - jeremy.n.friesen@gmail.com
 - rob@notch8.com
@@ -69,6 +69,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -102,5 +103,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A tiny gem to provide naive sorting for Fedora Commons objects.
+summary: A tiny gem to provide naive sorting for Fedora Commons properties.
 test_files: []