priora 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b201552054fb05af631621353382d07913a23fcd
+  data.tar.gz: 50da40ed3a3c0f41984332f1d2b90422288e52ea
+SHA512:
+  metadata.gz: 804d38a846743aa25d93e25bb41058882778980b8b8442d27fb851186531f2fe328c341121d30b76dc86b381d4b90dd0654543921d1c475543ec1899568ec3a9
+  data.tar.gz: 4e61cfd500b941a3cc7988145c9f8cf6bee9dfb467309b4bc205da3475af89dbea0e6f643b3b14ffdc504131ea0addd10b069198f256cfed8e4a47ca81741c37

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in priora.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    priora (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  priora!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eliav Lavi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+# Priora: An Object Prioritization Utility for Ruby
+
+Priora supplies an easy and intuitive way to prioritize a collection of objects in Ruby.
+It serves as a useful utility for working with a collection of several instances of some data class.
+Often, we would like to get that collection arranged according to some prioritization logic.  
+Instead of writing custom sorting blocks or implementing the spaceship operator (`<=>`) in your class,
+Priora offers a declarative style in order to obtain ready-for-consumption collections.
+
+For example, let's assume we have a simple `Post` class, holding data regarding the author name,
+how many likes did it receive and whether this post is sponsored:
+
+```ruby
+class Post
+  attr_reader :author, :like_count, :is_sponsored
+
+  def initialize(author:, like_count:, is_sponsored:)
+    @author = author
+    @like_count = like_count
+    @is_sponsored = is_sponsored
+  end
+end
+``` 
+
+Then, in a given scenario, we have three instances at hand (these examples will be used throughout this README):
+
+```ruby
+low_like_count_sponsored = Post.new(author: 'Jay C.', like_count: 10, is_sponsored: true)
+high_like_count_unsponsored = Post.new(author: 'Aaron R.', like_count: 90, is_sponsored: false)
+high_like_count_sponsored = Post.new(author: 'Don Y.', like_count: 90, is_sponsored: true)
+```
+
+Using Priora, we can easily get the collection prioritized according to our needs:
+
+```ruby
+unprioritized_array = [high_like_count_unsponsored, low_like_count_sponsored, high_like_count_sponsored]
+prioritized_array =  [high_like_count_sponsored, high_like_count_unsponsored, low_like_count_sponsored]
+Priora.prioritize(unprioritized_array, by: [:like_count, :is_sponsored]) == prioritized_array
+=> true
+```
+
+In case we can commit to the prioritization between `Post` objects - i.e. we do not need the flexibility of
+changing the priorities each time - we can include the `Priora` module in our class and
+declare the priorities using the `prioritize_by` class macro and gain shorter invocation.
+Our class would then read like this:
+ 
+```ruby
+class Post
+  include Priora
+  prioritize_by :like_count, :is_sponsored
+
+  attr_reader :author, :like_count, :is_sponsored
+
+  def initialize(author:, like_count:, is_sponsored:)
+    @author = author
+    @like_count = like_count
+    @is_sponsored = is_sponsored
+  end
+end
+``` 
+
+And getting the prioritized array would read like this:
+
+```ruby
+Priora.prioritize(unprioritized_array) == prioritized_array
+=> true
+```
+
+Using the `prioritize_by` class macro increases the readability of your code for the cost of flexibility.
+By adopting this usage, priorities are declared in-class and Priora can fetch it implicitly.
+For some cases this might be the right choice while for others the explicit style is more suitable.
+
+### Advantages Over Using Custom `sort` Or Implementing `<=>` 
+One might come up with the following snippet as an equivalent solution:
+
+```ruby
+unprioritized_array.sort { |a, b| [a.like_count, a.is_sponsored ? 1 : 0 ] <=> [b.like_count, b.is_sponsored ? 1 : 0] }.reverse == prioritized_array
+=> true
+```
+
+Which is, of course, correct. However, I find several issues with this code:
+* It is more verbose and prone to errors.
+* It declares the prioritization logic twice.
+* It handles the conversion of a boolean value (`true` / `false`) into a sortable value (`1` / `0`) inline,
+thus mixing levels of abstractions and confusing the potential reader.
+
+Another possible alternative is implementing the spaceship operator (`<=>`) for `Post` instances,
+and then simply employ reverse sorting.
+I regard this approach as somewhat more elegant, but its main problem is that it assumes our sorting logic is always the same
+for a given class, which is not always true.
+Priora solves this problem by supporting the explicit `by` parameter.
+
+I created Priora after having encountered a few scenarios in which I needed to get some collections prioritized in some
+specific manner, and having to supply these explicit blocks again and again was quite annoying.
+I figured out a modest library solving this problem could be nice to have.  
+
+### Reverse Sorting, Extended: An Agenda
+
+Priora is based on the presumption that when we talk about a prioritized collection,
+we often refer to the outcome of sorting it and then reversing the result.
+This is because we naturally think about sorting in an ascending fashion, from small to large,
+while when we talk about "top priorities" we usually think of the largest items first.
+
+#### Directional Priorities
+
+Obviously, this is not always true and some prioritization processes should give precedence to smaller items first;
+Priora supports this scenario as well.
+You may change the prioritization direction for a specific priority:
+
+```ruby
+Priora.prioritize(unprioritized_array, by: [[like_count: :asc], :is_sponsored])
+=> [low_like_count_sponsored, high_like_count_sponsored, high_like_count_unsponsored]
+```
+
+We can see that the `Post` with the low `like_count` comes up first,
+however the two high `like_count` posts are prioritized by `is_sponsored`, so the sponsored `Post` comes up first.
+
+If you have several priorities for which you wish to specify direction, you need to do so for each separately:
+```ruby
+Priora.prioritize(unprioritized_array, by: [[like_count: :asc], [is_sponsored: :asc]])
+=> [low_like_count_sponsored, high_like_count_unsponsored, high_like_count_sponsored]
+```
+
+### Implicit Conversions
+
+As you might have noted, Priora also takes care of converting non-sortable values,
+such as `true`, `false` or `nil`, into sortable values.
+By default, it assumes that `true` is larger than `false` and that `nil` evaluates to `0`.  
+
+You may override these implicit conversions with your own lambdas,
+as well as supply your own custom lambdas for other classes (and perhaps override their sorting logic!).
+
+For example, if we wished to sort attributes of class `String` by their length,
+we could configure `Priora` accordingly beforehand:
+
+```ruby
+Priora.configuration.add_conversion_lambda(String, lambda { |value| value.length })
+```
+
+Conversion lambdas are also removable, should that need arise:
+
+```ruby
+Priora.configuration.remove_conversion_lambda(String)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'priora'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install priora
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/[USERNAME]/priora.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "priora"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/priora.rb

@@ -0,0 +1,38 @@
+require_relative 'priora/version'
+require_relative 'priora/configuration'
+require_relative 'priora/class_methods'
+require_relative 'priora/collection'
+require_relative 'priora/priority_builder'
+require_relative 'priora/errors'
+
+module Priora
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def included(base_class)
+      base_class.extend ClassMethods
+    end
+
+    def prioritize(collection, by: nil)
+      raw_priorities = by
+      priorities = priorities_from_call(collection, raw_priorities)
+      Collection.new(collection).prioritize_by(priorities)
+    end
+
+    private
+
+    def priorities_from_call(collection, raw_priorities)
+      if raw_priorities
+        raw_priorities.map { |raw_priority| Priora::PriorityBuilder.build(raw_priority) }
+      else
+        begin
+          collection.map { |item| item.class.priorities }.uniq.first
+        rescue StandardError => e
+          raise UnsuppliedPrioritiesError
+        end
+      end
+    end
+  end
+end

data/lib/priora/class_methods.rb

@@ -0,0 +1,9 @@
+module Priora
+  module ClassMethods
+    attr_reader :priorities
+
+    def prioritize_by(*raw_priorities)
+      @priorities = raw_priorities.map { |raw_priority| Priora::PriorityBuilder.build(raw_priority) }
+    end
+  end
+end

data/lib/priora/collection.rb

@@ -0,0 +1,28 @@
+module Priora
+  class Collection
+    def initialize(collection)
+      @collection = collection
+      @comparison_ready_objects = {}
+    end
+
+    def prioritize_by(priorities)
+      sorted_collection_by(priorities).reverse
+    end
+
+    private
+
+    def sorted_collection_by(priorities)
+      @collection.sort do |object_a, object_b|
+        comparison_ready(object_a, priorities) <=> comparison_ready(object_b, priorities)
+      end
+    end
+
+    def comparison_ready(object, priorities)
+      @comparison_ready_objects[[object, priorities]] ||= begin
+        priorities.map do |priority|
+          priority.comparable_value_from(object)
+        end
+      end
+    end
+  end
+end

data/lib/priora/configuration.rb

@@ -0,0 +1,24 @@
+module Priora
+  class Configuration
+    def initialize
+      @conversion_lambdas = {
+          TrueClass: lambda { |_| 1 },
+          FalseClass: lambda { |_| 0 },
+          NilClass: lambda { |_| 0 }
+      }
+    end
+
+    def conversion_lambda_for(klass)
+      @conversion_lambdas[klass.to_s.to_sym]
+    end
+
+    def add_conversion_lambda(klass, lambda)
+      raise InvalidConversionLambda if lambda.arity > 1
+      @conversion_lambdas[klass.to_s.to_sym] = lambda
+    end
+
+    def remove_conversion_lambda(klass)
+      @conversion_lambdas.delete_if { |k, _| k == klass.to_s.to_sym }
+    end
+  end
+end

data/lib/priora/errors.rb

@@ -0,0 +1,19 @@
+module Priora
+  class UnsuppliedPrioritiesError < StandardError
+    def initialize
+      super('prioritization attributes must be declared in class or supplied manually!')
+    end
+  end
+
+  class InvalidPrioritySyntaxError < StandardError
+    def initialize(msg = 'priorities must be a symbol or an array/hash for directional priorities!')
+      super
+    end
+  end
+
+  class InvalidConversionLambda < StandardError
+    def initialize
+      super('conversion lambdas may take only 0 or 1 arguments!')
+    end
+  end
+end

data/lib/priora/priority.rb

@@ -0,0 +1,35 @@
+module Priora
+  class Priority
+    DIRECTION_DESC = :desc
+    DIRECTION_ASC = :asc
+
+    DIRECTIONAL_METHODS = {
+        DIRECTION_DESC => :+,
+        DIRECTION_ASC => :-
+    }
+
+    attr_reader :attribute, :direction
+
+    def initialize(attribute:, direction: DIRECTION_DESC)
+      @attribute = attribute
+      @direction = direction
+    end
+
+    def comparable_value_from(object)
+      raw_value = object.send(@attribute)
+      numeric_value = numeric_value_from(raw_value)
+      directional_value_from(numeric_value)
+    end
+
+    private
+
+    def numeric_value_from(raw_value)
+      conversion_lambda = Priora.configuration.conversion_lambda_for(raw_value.class)
+      conversion_lambda ? conversion_lambda.call(raw_value) : raw_value
+    end
+
+    def directional_value_from(numeric_value)
+      0.send(DIRECTIONAL_METHODS[@direction], numeric_value)
+    end
+  end
+end

data/lib/priora/priority_builder.rb

@@ -0,0 +1,36 @@
+require_relative 'priority'
+
+module Priora
+  class PriorityBuilder
+    class << self
+      def build(raw_priority)
+        case raw_priority
+        when Symbol
+          Priority.new(attribute: raw_priority)
+        when Array
+          priority_hash = raw_priority.reduce(:merge)
+          build_from_hash(priority_hash)
+        when Hash
+          build_from_hash(raw_priority)
+        else
+          raise InvalidPrioritySyntaxError
+        end
+      rescue => e
+        raise InvalidPrioritySyntaxError
+      end
+
+      private
+
+      def build_from_hash(priority_hash)
+        unless priority_hash.one?
+          raise InvalidPrioritySyntaxError, 'directional priority declaration takes only a single priority at a time!'
+        end
+
+        attribute = priority_hash.keys.first
+        direction = priority_hash[attribute]
+
+        Priority.new(attribute: attribute, direction: direction)
+      end
+    end
+  end
+end

data/lib/priora/version.rb

@@ -0,0 +1,3 @@
+module Priora
+  VERSION = '0.1.0'.freeze
+end

data/priora.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'priora/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'priora'
+  spec.version       = Priora::VERSION
+  spec.authors       = ['Eliav Lavi']
+  spec.email         = ['eliavlavi@gmail.com']
+
+  spec.summary       = %q{An object prioritization helper}
+  spec.description   = %q{Priora helps in prioritizing a collection of objects according to your needs.}
+  spec.homepage      = 'http://www.github.com/eliavlavi/priora'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: priora
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eliav Lavi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: Priora helps in prioritizing a collection of objects according to your
+  needs.
+email:
+- eliavlavi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/priora.rb
+- lib/priora/class_methods.rb
+- lib/priora/collection.rb
+- lib/priora/configuration.rb
+- lib/priora/errors.rb
+- lib/priora/priority.rb
+- lib/priora/priority_builder.rb
+- lib/priora/version.rb
+- priora.gemspec
+homepage: http://www.github.com/eliavlavi/priora
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: An object prioritization helper
+test_files: []