order_already 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58bbcf6f098dfc3b905837315feb9634415f5ffd97402acb4ff0aaf783d3fb94
-  data.tar.gz: 97c0f11482e7c1170b737a9fcb556c7f2a6825b61f562f9bd655c72be39fa3d6
+  metadata.gz: c26d17f72e31fe01a89459e031b394237dfe163d8c5548307cc7b00308115175
+  data.tar.gz: 0c1b6a4e25e973ff90a2dcd05cc21b9b3267a9110f762c15707cee9d4b7e10a8
 SHA512:
-  metadata.gz: 83034c9a260068af690abff7de0d4a92cd0fae477e10b9428f6a71a296fd2af9b8246c43c85549e9994800e609f23c2d393c6890f4579b561477e30f300d0c5c
-  data.tar.gz: b008abc0792f025b468a875d41021797cfa708bd3d28782aa27487e1225736a52fc7e93cbeca85db54b0481c4cb0793d5161509983ea0687013532b6c815f01b
+  metadata.gz: 640aae2c6f8f6c678afe164aa37044afad6192f88ea042e7aa50b431e62258cd267a95368ab82bbcb2a28845e57be939d7a663f8e8995bb532dc038d5d8c0c54
+  data.tar.gz: 6400c35df376c1767b59d7a8bbab52a8554917c51c84fdd4592a09b6bdf703d344e2765824d6a7f1ab24d1d96b37a62045a74bd03906ab981ae302c9a2e53719

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/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,7 +43,7 @@ class GenericWork < ActiveFedora::Base
   # schema (by adding accepts_nested_attributes)
   include ::Hyrax::BasicMetadata
 
-  include OrderAlready.for(:creator, :contributor)
+  prepend OrderAlready.for(:creator, :contributor)
 end
 ```
 

data/lib/order_already/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrderAlready
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 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,6 +16,9 @@ module OrderAlready
   # @api public
   #
   # @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.
+  #
   # @return [Module] a module that wraps the attr_accessor methods for the given :attributes.
   #
   # @note In testing, you need to use `prepend` instead of `include`; but that may be a function of
@@ -34,16 +34,16 @@ module OrderAlready
   #     end
   #     prepend OrderAlready.for(:creators)
   #   end
-  def self.for(*attributes)
+  def self.for(*attributes, serializer: StringSerializer)
     # 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

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.0
 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: []