put 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535145ee17f2f25a68d80ed7afa1e58cb2edd1d261c2b0f976cd9706c4304049
-  data.tar.gz: 4551a7ac241dc9d0b6fc7b975ae0a7d10c87b1dadf35c3832128ecaf563b1b2d
+  metadata.gz: ed8c542e17e5ecbc293a508843be66ab105238b761ed40e585980a2402ec6124
+  data.tar.gz: f7fef7196819fe61112639c965a4f5eca999dc0c72c94f6360574f02c94242f1
 SHA512:
-  metadata.gz: 7cd640fd7da59ca4ad28472284addf6df5db063dba76a1e98f9de4c44e6a243818f8366f1b79ebc345010e0cfc454c5a03c7030449710967f945f9504419937c
-  data.tar.gz: e8217fdfbe3fb805bd31bc5632c227c2b9265fc176004a94b41943c33a8b24b06399868026fdb8e8098e4c32162db4a4ff03006a9db7668675af8ac04615bde5
+  metadata.gz: 1b19851583cc9248409052e468a9bd913731eb04fe93ba16358965634740bbba5260626478fc6f7b5c7f4e2180c46e9fd6bdebbb6b6b19722a67209bfa020d23
+  data.tar.gz: 8c6216e264c6abe21db898b59c880f5aaa7276032a2f9b5c0db623f2496268f632b81e041b9e9fff2cd970c3158104f3b36881ae432de79088fb2c5f4ccbbffb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.3.0] - 2026-09-22
+
+- Add Put.enum [#2](https://github.com/testdouble/put/issues/2)
+
 ## [0.2.0] - 2026-09-22
 
 - **[Breaking]** Drop support for Ruby 2.6; require Ruby >= 3.1

data/Gemfile.lock

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

data/README.md

@@ -205,6 +205,31 @@ As you might be able to guess, `Put.nils_last` puts the nils last:
 } # => [:every, :counts, nil]
 ```
 
+### Put.enum(value, order:, nils_first: false)
+
+When you're sorting by a discrete attribute — a role, a status, a tier — that
+doesn't have a natural order of its own, `Put.enum` sorts a value by its
+position in a list you provide, instead of you writing a `case`/`when`
+translation table by hand:
+
+```ruby
+[:director, :staff, :manager].sort_by { |role|
+  [Put.enum(role, order: [:staff, :manager, :director])]
+} # => [:staff, :manager, :director]
+```
+
+A value that isn't in `order` sorts after every value that is, rather than
+raising:
+
+```ruby
+[:manager, :contractor, :staff].sort_by { |role|
+  [Put.enum(role, order: [:staff, :manager, :director])]
+} # => [:staff, :manager, :contractor]
+```
+
+Like `Put.asc` and `Put.desc`, `Put.enum` also takes a `nils_first` keyword
+argument (defaulting to `false`) for where `nil` values should sort.
+
 ### Put.debug(sorting_arrays)
 
 If you see "comparison of Array with Array failed" and you don't have any idea

data/lib/put/puts_thing/enum.rb

@@ -0,0 +1,10 @@
+module Put
+  class PutsThing
+    class Enum < InOrder
+      def initialize(value, order:, nils_first: false)
+        rank = value.nil? ? nil : (order.index(value) || Float::INFINITY)
+        super(rank, nils_first: nils_first)
+      end
+    end
+  end
+end

data/lib/put/version.rb

@@ -1,3 +1,3 @@
 module Put
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/put.rb

@@ -6,6 +6,7 @@ require_relative "put/puts_thing/anywhere"
 require_relative "put/puts_thing/first"
 require_relative "put/puts_thing/last"
 require_relative "put/puts_thing/in_order"
+require_relative "put/puts_thing/enum"
 require_relative "put/puts_thing/ascending"
 require_relative "put/puts_thing/descending"
 require_relative "put/puts_thing/nil_order"
@@ -29,6 +30,10 @@ module Put
     PutsThing::Ascending.new(value, nils_first: nils_first)
   end
 
+  def self.enum(value, order:, nils_first: false)
+    PutsThing::Enum.new(value, order: order, nils_first: nils_first)
+  end
+
   def self.nils_first(value)
     PutsThing::NilsFirst.new(value)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: put
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Searls
@@ -29,6 +29,7 @@ files:
 - lib/put/puts_thing/anywhere.rb
 - lib/put/puts_thing/ascending.rb
 - lib/put/puts_thing/descending.rb
+- lib/put/puts_thing/enum.rb
 - lib/put/puts_thing/first.rb
 - lib/put/puts_thing/in_order.rb
 - lib/put/puts_thing/last.rb