powertools 0.0.7 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed198bbbfd3e8c93142048362c85abd75951d7a0a0faf95921cff8d28338078d
-  data.tar.gz: 9bbeeadac664dffd079b1f1c1e259508807aebe694c09feb5e69890f45d6fe43
+  metadata.gz: 9bcd41100572beb93a11d58824fc071ea5fdf680fc56f0b5c747d5233a4e73fd
+  data.tar.gz: 52fe1e4acd2de1331c214e2a2575e6d94672172e459303b93fe528daa4ce79ab
 SHA512:
-  metadata.gz: '0091acf40578b33fbf35c7a38c8816d1e1fcf9543b298e8ab95ede575e4b443a17acee729ed0a40c1a917d58ec728cbcb315a4442d6488894d945a0a7233e71d'
-  data.tar.gz: d9d61c01d78960bcc6a096271a4b532d436db527b1610a6230c7846d0d1d1471577fb2c9f77555944d133476e66f4bdc5665ae4590562a985c197fff524c6542
+  metadata.gz: a63ab6c525bf83c21a6d6374bf720b389c88483fa6e9620b97ed2faf033fbd68b077f8f1d42b4a97754818fb837844eded29ea197a5e83ba283fc9cf04d3a1ee
+  data.tar.gz: 42d65c8ab48f60abbcb0604a2604ff7221df1d4bd12dd1e96b7d680c2e2e68c2f90662c2ecfe140f81ff2aab5ed879cae694683660ba51e0bfe927df3fe0c678

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 C.J.Kinniburgh
+
+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,75 @@
+# Powertools
+
+This gem provides some extensions to Ruby classes that make my life a lot easier.
+
+It doesn't aim to be a comprehensive list of improvements, but rather a curated
+list of things I find myself encountering frequently.
+
+# Usage
+
+Install Powertools with `gem install powertools`.
+
+Then, you can add `require 'powertools'` to your Ruby file to access all the
+features provided by Powertools.
+
+You may also want to only use certain features.
+
+You can currently also use the following to selectively add features:
+
+- `require 'powertool/maybe_chain'`
+- `require 'powertool/range'`
+- `require 'powertool/set'`
+
+# Warning about Breaking Changes
+
+Some features may introduce breaking changes to the Ruby standard library.
+These 'breaking changes' are generally minor changes which in my opinion
+conform to my expectations about how the language should work.
+
+Still, I'll make an effor to list any changes that break a potential assumption
+about the Ruby standard library here.
+
+## `Range#each`
+
+If you are relying on `(4..1).each { |_| ... }` to do nothing,
+because it's going from a higher number to a lower number, you should not use
+the `powertool/range` package.
+
+# Range Improvements
+
+`#sort` is provided as a helper method to ensure your range is from smallest
+to largest.
+
+`#each` now works backwards for all classes that include a `#pred` method.
+This is only enabled when a range is between two elements of the same class.
+(For example, `(date.today..100000000)` is a valid Ruby range. We fallback
+to the default `#each` implementation for these.)
+
+# Maybe Chains
+
+`#maybe_chain` is added to `Array` and `Hash`.  It takes an array as an argument,
+and attempts to access nested data based on the elements of the argument. If at
+any point it cannot access an element, it will return nil without throwing an
+error. This can be very useful for accessing deeply nested data structures, like
+parsed JSON objects, which may have nil elements.
+
+E.g.
+
+```ruby
+a = [1,2,3,{d:[9]}]
+a.maybe_chain [0]
+=> 1
+a.maybe_chain [3]
+=> {:d=>[1]}
+a.maybe_chain [3, :d, 0]
+=> 9
+a.maybe_chain [4]
+=> nil
+a.maybe_chain [4, :missing_element]
+=> nil
+```
+
+# Popable Sets
+
+`#pop` has been added to `Set`.  This returns a random
+element from the set, and removes it from the set.

data/lib/powertool/maybe_chain.rb

@@ -1,27 +1,31 @@
-class Hash
-    def maybe_chain(args = [])
-      return nil unless self
-  
-      r = self
-      args.each_with_index do |a, _i|
-        return nil if r[a].nil? || (r.class != Hash && r.class != Array)
-  
-        r = a.instance_of?(Range) ? a.map { |i| r[i] } : r[a]
-      end
-      r
+# frozen_string_literal: true
+
+# A private helper for MaybeChain
+class PowertoolMaybeChain
+  def self.maybe_chain(caller, args)
+    args.each_with_index do |a, _i|
+      return nil if caller[a].nil? || ![Hash, Array, Range].include?(caller.class)
+
+      caller = a.instance_of?(Range) ? a.map { |i| caller[i] } : caller[a]
     end
+    caller
+  end
+end
+
+# Ruby's Hash class
+class Hash
+  def maybe_chain(args = [])
+    return nil unless self
+
+    PowertoolMaybeChain.maybe_chain(self, args)
+  end
 end
 
+# Ruby's Array class
 class Array
-    def maybe_chain(args = [])
-        return nil unless self
-    
-        r = self
-        args.each_with_index do |a, _i|
-          return nil if r[a].nil? || (r.class != Hash && r.class != Array)
-    
-          r = a.instance_of?(Range) ? a.map { |i| r[i] } : r[a]
-        end
-        r
-    end
-end
+  def maybe_chain(args = [])
+    return nil unless self
+
+    PowertoolMaybeChain.maybe_chain(self, args)
+  end
+end

data/lib/powertool/range.rb

@@ -1,47 +1,38 @@
+# frozen_string_literal: true
+
+# Extensions to Ruby's Range class
 module RangeExtensions
-    def each
-        return super if self.first <= self.last
-        
-        position = self.first
-        while position >= self.last
-            yield(position)
-            position = position.pred
-        end
-    end
-    
-    def each(warn_on_order_error: true)
-        return super() if self.first <= self.last
-        
-        position = self.first
-        prev_position = nil
-        while position >= self.last
-            # We always attempt pred before yielding.
-            prev_position = position.clone
-            begin
-                position = position.pred
-            rescue NoMethodError
-                if warn_on_order_error
-                    raise ArgumentError.new "#{self.first.class}s do not support backwards iteration."
-                else
-                    return super()
-                end
-            end
+  def each(warn_on_order_error: true)
+    return super() if first <= last || first.class != last.class
 
-            yield(prev_position)
-        end
-    end
+    position = first
+    while position >= last
+      # We always attempt pred before yielding.
+      prev_position = position.clone
+      begin
+        position = position.pred
+      rescue NoMethodError
+        raise ArgumentError, "#{first.class}s do not support backwards iteration." if warn_on_order_error
 
-    def sort
-        begin
-            return self if self.first <= self.last
-        rescue NoMethodError
-            raise "#{self.first.class}s cannot be sorted"
-        end
+        return super()
+      end
 
-        (self.last..self.first)
+      yield(prev_position)
     end
+  end
+
+  def sort
+    begin
+      return self if first <= last
+    rescue NoMethodError
+      raise "#{first.class}s cannot be sorted"
+    end
+
+    (last..first)
+  end
 end
 
+# Ruby's Range class
 class Range
-    prepend RangeExtensions
-end
+  prepend RangeExtensions
+end

data/lib/powertool/set.rb

@@ -0,0 +1,7 @@
+class Set
+    def pop
+      temp = self.to_a.pop
+      self.delete(temp)
+      temp
+    end
+end

data/lib/powertools.rb

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'powertool/maybe_chain'
-require_relative 'powertool/range'
+require_relative 'powertool/range'
+require_relative 'powertool/set'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: powertools
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.2.2
 platform: ruby
 authors:
 - C. Kinniburgh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-05 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email: powertools@cjkinni.com
@@ -16,13 +16,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/powertool/maybe_chain.rb
 - lib/powertool/range.rb
+- lib/powertool/set.rb
 - lib/powertools.rb
 homepage: http://github.com/cjkinni/powertools
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -31,7 +35,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="