closest_neighbours 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c924621de30b545235ce5ee7eaf16f3a22f642355d61284b4a5a3550e195075
-  data.tar.gz: a4511b796aa75101d38059eb960f610ce06ab87d22625dab7af2ea805f81ec5f
+  metadata.gz: 1dc9ec134c754981b57d69366f513ec4768678472b18d5cf79c61513bd625b12
+  data.tar.gz: 27c1a7596b2708fab789d7e695d39455d104b7de76f00e0271bd6c3a4d3dec46
 SHA512:
-  metadata.gz: 1586442b671d00ff96f54bdce79419eebd21b29ab760524ea98454483cf191265e374c7a263351f37d22dd846ee0f78077432ac58c14f00c8d9c518e9dabbf42
-  data.tar.gz: e828070ebd738c968ad971d29680b689993796e5c690b1b764648a6a9e990b504ce6a65b981b89c97a8c8f08cd7adddb641bd384efbc78936ed935ca9d3ba76e
+  metadata.gz: c01f230fb3bc47584b249804c216d55bb16a2cff8dceecb187dd6a82d0bb7d860a6032a08c278f0a5ecaf1910100a36c3e7df5a3dc849d0bd2a34a29b5fd1b7b
+  data.tar.gz: 2bf2f4574fc4b2f0db9fbd36a7485bc790418b3e9b67c87570f827694ce5e0ab5fb9cf87343c663b6ddc8866abaf13fea9e16b6768c501531e368e63c2f54fef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    closest_neighbours (0.1.0)
+    closest_neighbours (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,8 @@
 # ClosestNeighbours
 
+[![Gem Version](https://badge.fury.io/rb/closest_neighbours.svg)](https://badge.fury.io/rb/closest_neighbours)
+[![Build Status](https://app.travis-ci.com/aussiDavid/closest_neighbours.svg?branch=main)](https://app.travis-ci.com/aussiDavid/closest_neighbours)
+
 This gem takes an array of elements, groups them by their ordered closest neighbors into `n` groups.
 
 **Origin Story:**
@@ -69,11 +72,17 @@ require 'closest_neighbours'
 Use the module:
 
 ```ruby
-ClosestNeighbours.group(2, [1, 2, 3, 4])
+ClosestNeighbours.group(2, [1, 4, 3, 2])
 # => [[1, 2], [3, 4]]
-ClosestNeighbours.group(3, [10.days.ago, 9.days.ago, 1.day.ago])
+ClosestNeighbours.group(2, [10.days.ago, 9.days.ago, 1.day.ago])
 # => [[10.days.ago, 9.days.ago], [1.day.ago]]
+```
+
+`ClosestNeighbours.ordered_group` allows you to squeeze additional performance out of the module by providing an ordered set of inputs. If in doubt, use `ClosestNeighbours.group`.
 
+```ruby
+ClosestNeighbours.ordered_group(2, [1, 2, 3, 4])
+# => [[1, 2], [3, 4]]
 ```
 
 ## Development

data/lib/closest_neighbours/errors/incomparable_element_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ClosestNeighbours
+  # Error when an 1 or more element in an enumerable are not comparable with each other
+  class IncomparableElementError < StandardError
+  end
+end

data/lib/closest_neighbours/{ordered.rb → grouper.rb}

@@ -1,35 +1,38 @@
 # frozen_string_literal: true
 
 module ClosestNeighbours
-  # Match array of times up into groups that are the closest to each other
-  class Ordered
-    def initialize(groups = 1, data = [])
+  # Split an Enumerable into specified number of groups containing the closest elements in each group.
+  class Grouper
+    def initialize(orderer: DefaultOrder.new)
+      @orderer = orderer
+    end
+
+    def call(groups = 1, data = [])
       @groups = groups
       @data = data
-    end
 
-    def call
       validate!
 
       if groups >= size
         wraped_data + blanks
       else
-        ranges.map { |range| sorted_data[range] }
+        ranges.map { |range| ordered_data[range] }
       end
     end
 
     private
 
-    attr_reader :groups, :data
+    attr_reader :groups, :data, :orderer
 
     def validate!
       raise NonIntegerGroupsError unless groups.is_a? Integer
       raise NonEnumberableArgumentError unless data.is_a? Enumerable
       raise InsufficientGroupsError if groups < 1
+      raise IncomparableElementError unless comparable_elements?
     end
 
     def size
-      data.to_a.size
+      data.count
     end
 
     def blanks
@@ -41,7 +44,7 @@ module ClosestNeighbours
     end
 
     def wraped_data
-      sorted_data.map { |x| [x] }
+      ordered_data.map { |x| [x] }
     end
 
     def ranges
@@ -59,7 +62,7 @@ module ClosestNeighbours
     end
 
     def differences_between_each_pair
-      sorted_data.each_cons(2).map { |(a, b)| b - a }
+      ordered_data.each_cons(2).map { |(a, b)| b - a }
     end
 
     def differences_with_indices
@@ -69,8 +72,12 @@ module ClosestNeighbours
         .reverse
     end
 
-    def sorted_data
-      @sorted_data ||= data.sort
+    def ordered_data
+      @ordered_data ||= orderer.call(data)
+    end
+
+    def comparable_elements?
+      data.all? { |e| data.first <=> e }
     end
   end
 end

data/lib/closest_neighbours/orderers/default_order.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ClosestNeighbours
+  # The default order of enumberales
+  class DefaultOrder
+    def call(data = [])
+      data.to_a
+    end
+  end
+end

data/lib/closest_neighbours/orderers/sorted_order.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ClosestNeighbours
+  # Sort an enumerator
+  class SortedOrder
+    def call(data = [])
+      data.sort
+    end
+  end
+end

data/lib/closest_neighbours/version.rb

@@ -1,3 +1,3 @@
 module ClosestNeighbours
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/closest_neighbours.rb

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
 require 'closest_neighbours/version'
-require 'closest_neighbours/ordered'
+require 'closest_neighbours/grouper'
+
+# Plugable Roles
+require 'closest_neighbours/orderers/sorted_order'
+require 'closest_neighbours/orderers/default_order'
 
 # Errors
 require 'closest_neighbours/errors/non_enumberable_argument_error'
 require 'closest_neighbours/errors/insufficient_groups_error'
 require 'closest_neighbours/errors/non_integer_groups_error'
+require 'closest_neighbours/errors/incomparable_element_error'
 
-# Takes an array of elements, groups them by their ordered closest neighbors into n groups
+# Top level model for Closest Neighbours gem
 module ClosestNeighbours
   #
-  # Split an Enumerable into specified number of groups containing the closest elements in each group.
+  # Split an Enumerable into specified number of groups containing the closest elements in each group using the most general purpose algorithm.
   #
   # @example
   #
@@ -19,11 +24,28 @@ module ClosestNeighbours
   #   # => [[2, 5], [10, 11]]
   #
   # @param [Integer] groups The number of groups to create
-  # @param [Array|Set|Enumerable] data The data set of items to group
+  # @param [Enumerable] data The data set of items to group
   #
   # @return [Array] An array of `groups` groups
   #
   def self.group(groups, data)
-    Ordered.new(groups, data).call
+    Grouper.new(orderer: SortedOrder.new).call(groups, data)
+  end
+
+  #
+  # Split a sorted Enumerable into specified number of groups containing the closest elements in each group.
+  #
+  # @example
+  #
+  #   ClosestNeighbours.ordered_group(2, [2, 5, 10, 11])
+  #   # => [[2, 5], [10, 11]]
+  #
+  # @param [Integer] groups The number of groups to create
+  # @param [Enumerable] ordered_data The data set of items to group
+  #
+  # @return [Array] An array of `groups` groups
+  #
+  def self.ordered_group(groups, ordered_data)
+    Grouper.new(orderer: DefaultOrder.new).call(groups, ordered_data)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: closest_neighbours
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Milanese
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,10 +132,13 @@ files:
 - bin/setup
 - closest_neighbours.gemspec
 - lib/closest_neighbours.rb
+- lib/closest_neighbours/errors/incomparable_element_error.rb
 - lib/closest_neighbours/errors/insufficient_groups_error.rb
 - lib/closest_neighbours/errors/non_enumberable_argument_error.rb
 - lib/closest_neighbours/errors/non_integer_groups_error.rb
-- lib/closest_neighbours/ordered.rb
+- lib/closest_neighbours/grouper.rb
+- lib/closest_neighbours/orderers/default_order.rb
+- lib/closest_neighbours/orderers/sorted_order.rb
 - lib/closest_neighbours/version.rb
 homepage: https://github.com/aussidavid/closest_neighbours
 licenses: