order_already 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58bbcf6f098dfc3b905837315feb9634415f5ffd97402acb4ff0aaf783d3fb94
+  data.tar.gz: 97c0f11482e7c1170b737a9fcb556c7f2a6825b61f562f9bd655c72be39fa3d6
+SHA512:
+  metadata.gz: 83034c9a260068af690abff7de0d4a92cd0fae477e10b9428f6a71a296fd2af9b8246c43c85549e9994800e609f23c2d393c6890f4579b561477e30f300d0c5c
+  data.tar.gz: b008abc0792f025b468a875d41021797cfa708bd3d28782aa27487e1225736a52fc7e93cbeca85db54b0481c4cb0793d5161509983ea0687013532b6c815f01b

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in order_already.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    order_already (0.1.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

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright 2022 Software Services by Scientist.com
+
+Additional copyright may be held by others, as reflected in the commit history.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,58 @@
+# OrderAlready
+
+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 you Fedora Commons and RDF N-Triples).
+
+To do this, OrderAlready takes liberties with the persistence layer's storage of the ordered values; (e.g. we prepend an index and delimiter to each value then at object reification we sort on that index).  You may not feel comfortable with this solution, because Order Already munges your canonical data.  And that's understandable.
+
+However, the other options for sorting is described in the theoretical in the [Portland Common Data Model's Wiki](https://github.com/duraspace/pcdm/wiki#ordering-extension).  This is rather impractical, and non-performant, for attributes of a pcdm::Object, such as their creators, subjects, etc.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add order_already
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install order_already
+
+## Usage
+
+With a plain old Ruby object (PORO):
+
+```ruby
+class MyModel
+  attr_accessor :author, :subject
+
+  include OrderAlready.for(:author, :subject)
+end
+```
+
+With Samvera Portland Common Data Model (PCDM) object:
+
+```ruby
+class GenericWork < ActiveFedora::Base
+  include ::Hyrax::WorkBehavior
+
+  self.indexer = GenericWorkIndexer
+  # Change this to restrict which works can be added as a child.
+  # self.valid_child_concerns = []
+  validates :title, presence: { message: 'Your work must have a title.' }
+
+  # This must be included at the end, because it finalizes the metadata
+  # schema (by adding accepts_nested_attributes)
+  include ::Hyrax::BasicMetadata
+
+  include OrderAlready.for(:creator, :contributor)
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scientist-softserv/order_already.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/lib/order_already/version.rb

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

data/lib/order_already.rb

@@ -0,0 +1,138 @@
+# 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
+# you Fedora Commons and RDF N-Triples).
+#
+# To do this, we take liberties with the persistence layer's values (e.g. we prepend an index and
+# delimiter to the given value).  You may not feel comfortable with this solution, because you are
+# munging your data's
+module OrderAlready
+  class Error < StandardError; end
+
+  # @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.
+  #
+  # @note In testing, you need to use `prepend` instead of `include`; but that may be a function of
+  #       my specs.
+  #
+  # @example
+  #   class MyRecord
+  #     attr_reader :creators
+  #     def creators=(values)
+  #       # We're going to "persist" these in an "arbitrarily different" way than what the user
+  #       # provided.
+  #       @creators = Array(values).reverse
+  #     end
+  #     prepend OrderAlready.for(:creators)
+  #   end
+  def self.for(*attributes)
+    # By creating a module, we have access to `super`.
+    Module.new do
+      attributes.each do |attribute|
+        define_method(attribute) do
+          StringSerializer.deserialize(super())
+        end
+
+        define_method("#{attribute}=") do |values|
+          super(StringSerializer.serialize(values))
+        end
+      end
+    end
+  end
+
+  module StringSerializer
+    # defaults
+    TOKEN_DELIMITER = '~'
+
+    # Convert a serialized array to a normal array of values.
+    # @param arr [Array]
+    # @return [Array]
+    def self.deserialize(arr)
+      return [] if arr&.empty?
+
+      sort(arr).map do |val|
+        get_value(val)
+      end
+    end
+
+    # Serialize a normal array of values to an array of ordered values
+    #
+    # @param arr [Array]
+    # @return [Array]
+    def self.serialize(arr)
+      return [] if arr&.empty?
+
+      arr = sanitize(arr)
+
+      res = []
+      arr.each_with_index do |val, ix|
+        res << encode(ix, val)
+      end
+
+      res
+    end
+
+    def self.sanitize(values)
+      full_sanitizer = Rails::Html::FullSanitizer.new
+      sanitized_values = Array.new(values.size, '')
+      empty = TOKEN_DELIMITER * 3
+      values.each_with_index do |v, i|
+        sanitized_values[i] = full_sanitizer.sanitize(v) unless v == empty
+      end
+    end
+    private_class_method :sanitize
+
+    # 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
+      n = 0
+      arr.sort_by { |val| [get_index(val), n += 1] }
+    end
+    private_class_method :sort
+
+    #
+    # encode an index and a value into a composite field
+    #
+    def self.encode(index, val)
+      "#{index}#{TOKEN_DELIMITER}#{val}"
+    end
+    private_class_method :encode
+
+    # extract the index attribute from the serialized value; return index '0' if the
+    # field cannot be parsed correctly
+    def self.get_index(val)
+      tokens = val.split(TOKEN_DELIMITER, 2)
+      return tokens[0] if tokens.length == 2
+
+      '0'
+    end
+    private_class_method :get_index
+
+    # extract the value attribute from the serialized value; return the entire value if the
+    # field cannot be parsed correctly
+    #
+    def self.get_value(val)
+      tokens = val.split(TOKEN_DELIMITER, 2)
+      return tokens[1] if tokens.length == 2
+
+      val
+    end
+    private_class_method :get_value
+
+    # @api private
+    #
+    # convert an ActiveTriples::Relation to a standard array (for debugging)
+    def self.relation_to_array(arr)
+      arr.map(&:to_s)
+    end
+  end
+end

data/order_already.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/order_already/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "order_already"
+  spec.version = OrderAlready::VERSION
+  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.homepage = "https://github.com/scientist-softserv/order_already"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.licenses = ["Apache-2.0"]
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "CHANGELOG.md")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.add_dependency "rails-html-sanitizer", "~> 1.4"
+
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bixby', '~> 5.0', '>= 5.0.2' # bixby 5 briefly dropped Ruby 2.5
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: order_already
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Friesen
+- Rob Kaufman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails-html-sanitizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+description: A tiny gem to provide naive sorting for Fedora Commons objects.
+email:
+- jeremy.n.friesen@gmail.com
+- rob@notch8.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/order_already.rb
+- lib/order_already/version.rb
+- order_already.gemspec
+homepage: https://github.com/scientist-softserv/order_already
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/scientist-softserv/order_already
+  source_code_uri: https://github.com/scientist-softserv/order_already
+  changelog_uri: https://github.com/scientist-softserv/order_already/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A tiny gem to provide naive sorting for Fedora Commons objects.
+test_files: []