dm_ruby_extensions 1.0.8 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ef89479e99db1c9f1aec46b1e5cd35b0a32b66bc
-  data.tar.gz: 796817a8a3db9ab1778400f2d8f91455f034f2e4
+SHA256:
+  metadata.gz: a52656d8cd06524cb3619c98f8ee54221bbe7099bd8583ac3f6635a3fca73ad1
+  data.tar.gz: 8563dfd8ae1a2d76e5d07fbc6d4b09ce84f01f0970de0344ed6da46bb69f3819
 SHA512:
-  metadata.gz: 97d7c140af39371f7cd050f8cbe70690916eb9d6f6c0694e23fd5855590fa3031cda396d3afb6fbb995dbe503b2ef48f8791b6a1703d733f26e919b198a35d64
-  data.tar.gz: '025885950263f3cb3601b194190a3c2556acafe262d67e914d1e5300bdb6ad2276288793d2aaa2aa12356c0fbf5afebdbd83f6d5101be4e1183c8a31a15af509'
+  metadata.gz: 58dc5a359f374ca974e993472c29ea2649a0855856f03335bd276f5aed0bedb490dee6ea34309e714cbdbce9253c54fdb5ca5c02fa3115b0acf64d681b689b83
+  data.tar.gz: 7e9f70201a41ac2f623214e27af7cd1549984174e4f5bea5e578a8f8898a18f931a546799293feba8449918402f77ac51ea4f2e5ca100f3124fb3d5499f862dd

data/.github/workflow/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  pull_request:
+
+jobs:
+  rspec:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+        ruby-version: [3.0, 3.1, 3.2, 'ruby-head']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # 'bundle install' and cache
+
+      - name: Run ${{ matrix.os }} tests
+        run: bundle install
+        run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+      - name: Run rubocop
+        run: bundle install
+        run: bundle exec rubocop

data/.gitignore

@@ -15,6 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
-/.ruby-version
-/.ruby-gemset

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  Exclude:
+    - '**/tmp/**/*'
+  CacheRootDirectory: tmp
+  UseCache: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+gem 'pry-byebug'
 gem 'rake'
-gem 'byebug'
 gem 'rspec'
+gem 'rubocop', '~> 1.36'
+gem 'rubocop-rspec', '~> 2.13'

data/README.md

@@ -3,7 +3,9 @@
 [![Gem Version](https://badge.fury.io/rb/dm_ruby_extensions.svg)](http://badge.fury.io/rb/dm_ruby_extensions)
 [![Build Status](https://travis-ci.com/digitalmoksha/dm_ruby_extensions.svg?branch=master)](https://travis-ci.com/digitalmoksha/dm_ruby_extensions)
 
-Adds some simple convienence methods to some Ruby classes, for use in the digitalMoksha gems.  Although some of these can be found in other libraries, this includes a small handful and removes the dependency on another large library.
+Adds some simple convenience methods to some Ruby classes, for use in the digitalMoksha gems.
+Although some of these can be found in other libraries, this includes a small handful and
+removes the dependency on another large library.
 
 ## Installation
 

data/Rakefile

@@ -1,7 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dm_ruby_extensions'
+require 'irb'
+
+puts <<~TEXT
+  -------------------
+  Example Usage:
+
+  '1'.as_boolean
+  (Date.today - 12.years).to_age
+  -------------------
+
+TEXT
+
+IRB.start(__FILE__)

data/dm_ruby_extensions.gemspec

@@ -1,21 +1,24 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'dm_ruby_extensions/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "dm_ruby_extensions"
+  gem.name          = 'dm_ruby_extensions'
   gem.version       = DmRubyExtensions::VERSION
-  gem.authors       = ["Brett Walker"]
-  gem.email         = ["github@digitalmoksha.com"]
-  gem.description   = %q{Ruby base class extensions}
-  gem.summary       = %q{Simple Ruby base class extensions}
-  gem.homepage      = "https://github.com/digitalmoksha/dm_ruby_extensions"
+  gem.authors       = ['Brett Walker']
+  gem.email         = ['github@digitalmoksha.com']
+  gem.description   = 'Ruby base class extensions'
+  gem.summary       = 'Simple Ruby base class extensions'
+  gem.homepage      = 'https://github.com/digitalmoksha/dm_ruby_extensions'
   gem.licenses      = ['MIT']
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  
-  gem.add_dependency 'activesupport', '>= 4.0'
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '~> 3.0'
+
+  gem.add_dependency 'activesupport', '>= 6.0'
 end

data/lib/dm_ruby_extensions/extend_array.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 #------------------------------------------------------------------------------
 class Array
-
-  # Extract options from a set of arguments. Removes and returns the last element in the array if it's a hash, otherwise returns a blank hash.
+  # Extract options from a set of arguments. Removes and returns the last element
+  # in the array if it's a hash, otherwise returns a blank hash.
   #
   #   def options(*args)
   #     args.extract_options!
@@ -19,7 +21,7 @@ class Array
   # [0,5,7,8,11,16].closest_max(7) => 7
   #------------------------------------------------------------------------------
   def closest_max(value)
-    self.select{|item| item <= value}.max
+    self.select { |item| item <= value }.max
   end
 
   # able to join safe and unsafe strings
@@ -27,7 +29,7 @@ class Array
   def xss_aware_join(delimiter = '')
     ''.html_safe.tap do |str|
       each_with_index do |element, i|
-        str << delimiter if i > 0
+        str << delimiter if i.positive?
         str << element
       end
     end
@@ -35,12 +37,11 @@ class Array
 
   # given an array of css classes/styles, join them into one string.
   # only join non-nil/non-empty strings, and return nil if the result
-  # is an empty string (rails tag methods will not include the 
+  # is an empty string (rails tag methods will not include the
   # attribute if it is nil, which is desirable for cleaner html)
   #------------------------------------------------------------------------------
-  def css_join(delimiter = '')
-    str = self.flatten.delete_if {|x| x.nil? || x == ''}.join(' ')
+  def css_join(_delimiter = '')
+    str = flatten.delete_if { |x| x.nil? || x == '' }.join(' ')
     str == '' ? nil : str
   end
 end
-

data/lib/dm_ruby_extensions/extend_date.rb

@@ -1,23 +1,22 @@
-class Date
+# frozen_string_literal: true
 
+class Date
   # http://stackoverflow.com/questions/819263/get-persons-age-in-ruby
   #------------------------------------------------------------------------------
   def to_age
     now = Time.now.utc.to_date
-    now.year - self.year - ((now.month > self.month || (now.month == self.month && now.day >= self.day)) ? 0 : 1)
+    now.year - year - (now.month > month || (now.month == month && now.day >= day) ? 0 : 1)
   end
-  
+
   #------------------------------------------------------------------------------
   def localize(options = {})
-    options = {:format => options} if options.class == String      
-    I18n.localize(self, options)
+    options = { format: options } if options.instance_of?(String)
+    I18n.localize(self, **options)
   end
 
   # Create a unique sortable index for this date
   #------------------------------------------------------------------------------
   def to_index
-    yday + (year-2000) * 1000
+    yday + (year - 2000) * 1000
   end
-
 end
-

data/lib/dm_ruby_extensions/extend_datetime.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 #------------------------------------------------------------------------------
 class DateTime
-
   #------------------------------------------------------------------------------
   def to_age
     (DateTime.now - self).to_i / 365
@@ -8,15 +9,13 @@ class DateTime
 
   #------------------------------------------------------------------------------
   def localize(options = {})
-    options = {:format => options} if options.class == String      
-    I18n.localize(self, options)
+    options = { format: options } if options.instance_of?(String)
+    I18n.localize(self, **options)
   end
-  
+
   # Create a unique sortable index for this date
   #------------------------------------------------------------------------------
   def to_index
-    yday + (year-2000) * 1000
+    yday + (year - 2000) * 1000
   end
-
 end
-

data/lib/dm_ruby_extensions/extend_false.rb

@@ -1,8 +1,7 @@
-class FalseClass  #:nodoc:
+# frozen_string_literal: true
 
+class FalseClass # :nodoc:
   def as_boolean
     false
   end
-
 end
-

data/lib/dm_ruby_extensions/extend_hash.rb

@@ -1,30 +1,40 @@
+# frozen_string_literal: true
+
 #------------------------------------------------------------------------------
 class Hash
-  
-  # takes a Hash (like the params hash), and converts the Rails date attributes 
+  # takes a Hash (like the params hash), and converts the Rails date attributes
   # to a real Date object.
-  # {'start_date(1i)' => 2012, 'start_date(2i)' => 11, 'start_date(3i)' => 23}.convert_date(:start_date)   
+  # {'start_date(1i)' => 2012, 'start_date(2i)' => 11, 'start_date(3i)' => 23}.convert_date(:start_date)
   #------------------------------------------------------------------------------
   def convert_date(date_symbol_or_string)
     attribute = date_symbol_or_string.to_s
-    return nil if self[attribute + '(1i)'].nil? || self[attribute + '(2i)'].nil? || self[attribute + '(3i)'].nil? 
-    return Date.new(self[attribute + '(1i)'].to_i, self[attribute + '(2i)'].to_i, self[attribute + '(3i)'].to_i)   
+    return nil if self["#{attribute}(1i)"].nil? || self["#{attribute}(2i)"].nil? || self["#{attribute}(3i)"].nil?
+
+    Date.new(self["#{attribute}(1i)"].to_i, self["#{attribute}(2i)"].to_i, self["#{attribute}(3i)"].to_i)
   end
 
-  # takes a Hash (like the params hash), and converts the Rails datetime attributes 
+  # takes a Hash (like the params hash), and converts the Rails datetime attributes
   # to a real Date object.
   #------------------------------------------------------------------------------
   def convert_datetime(date_symbol_or_string)
     attribute = date_symbol_or_string.to_s
-    return nil if self[attribute + '(1i)'].nil? || self[attribute + '(2i)'].nil? || self[attribute + '(3i)'].nil? || self[attribute + '(4i)'].nil? || self[attribute + '(5i)'].nil? 
-    return Time.local(self[attribute + '(1i)'].to_i, self[attribute + '(2i)'].to_i, self[attribute + '(3i)'].to_i, self[attribute + '(4i)'].to_i, self[attribute + '(5i)'].to_i)   
+    if self["#{attribute}(1i)"].nil? || self["#{attribute}(2i)"].nil? ||
+       self["#{attribute}(3i)"].nil? || self["#{attribute}(4i)"].nil? ||
+       self["#{attribute}(5i)"].nil?
+      return nil
+    end
+
+    Time.local(self["#{attribute}(1i)"].to_i, self["#{attribute}(2i)"].to_i, self["#{attribute}(3i)"].to_i,
+               self["#{attribute}(4i)"].to_i, self["#{attribute}(5i)"].to_i)
   end
 
   # Convert hash of parameters to a query string
   #------------------------------------------------------------------------------
+  # rubocop:disable Style/OptionalBooleanParameter
   def url_query_string(leading_slash = true)
-    (leading_slash ? "/?" : "?") << URI.escape(self.collect{|k,v| "#{k}=#{v}"}.join('&'))
+    "#{leading_slash ? '/?' : '?'}#{to_query}"
   end
+  # rubocop:enable Style/OptionalBooleanParameter
 
   # Borrowed from https://github.com/rubyworks/facets
   #------------------------------------------------------------------------------
@@ -42,7 +52,7 @@ class Hash
   #   foo.rekey(:b=>:x)        #=> { :a =>1, :x=>2 }
   #   foo.rekey('foo'=>'bar')  #=> { :a =>1, :b=>2 }
   #
-  # If a block is given, converts all keys in the Hash accroding to the
+  # If a block is given, converts all keys in the Hash according to the
   # given block procedure.
   #
   #   foo = { :name=>'Gavin', :wife=>:Lisa }
@@ -55,37 +65,36 @@ class Hash
   # Raises an ArgumentError if both a +key_map+ and a block are given.
   # If both are needed just call #rekey twice.
   #
-  # TODO: If `nil` is returned by block should the key be set to `nil` or the orignal key?
+  # TODO: If `nil` is returned by block should the key be set to `nil` or the original key?
   #
   # CREDIT: Trans, Gavin Kistner
+  def rekey(key_map = nil, &block)
+    raise ArgumentError, 'argument or block' if key_map && block
 
-  def rekey(key_map=nil, &block)
-    raise ArgumentError, "argument or block" if key_map && block
-
-    if !(key_map or block)
-      block = lambda{|k| k.to_sym}
+    unless key_map || block
+      block = lambda { |k| k.to_sym } # rubocop:disable Style/SymbolProc, Style/Lambda
     end
 
     if block
       hash = dup.clear
       if block.arity.abs == 1
         each_pair do |k, v|
-          hash[block[k]] = v     #hash[block[k] || k] = v
+          hash[block[k]] = v # hash[block[k] || k] = v
         end
       else
         each_pair do |k, v|
-          hash[block[k,v]] = v   #hash[block[k,v] || k] = v
+          hash[block[k, v]] = v # hash[block[k,v] || k] = v
         end
       end
     else
-      #hash = dup.clear  # to keep default_proc
-      #(keys - key_map.keys).each do |key|
-      #  hash[key] = self[key]
-      #end
-      #key_map.each do |from, to|
-      #  hash[to] = self[from] if key?(from)
-      #end
-      hash = dup  # to keep default_proc
+      # hash = dup.clear  # to keep default_proc
+      # (keys - key_map.keys).each do |key|
+      #   hash[key] = self[key]
+      # end
+      # key_map.each do |from, to|
+      #   hash[to] = self[from] if key?(from)
+      # end
+      hash = dup # to keep default_proc
       key_map.each_pair do |from, to|
         hash[to] = hash.delete(from) if hash.key?(from)
       end
@@ -102,8 +111,7 @@ class Hash
   #
   # CREDIT: Trans, Gavin Kistner
 
-  def rekey!(key_map=nil, &block)
+  def rekey!(key_map = nil, &block)
     replace(rekey(key_map, &block))
   end
-
 end

data/lib/dm_ruby_extensions/extend_integer.rb

@@ -1,16 +1,17 @@
-class Integer
+# frozen_string_literal: true
 
+class Integer
   # Factorial of number
   # 5.factorial == 5 x 4 x 3 x 2 x 1 == 120
   #------------------------------------------------------------------------------
   def factorial
-    return 1 if self.zero?
+    return 1 if zero?
+
     (1..self).inject(:*)
   end
 
   #------------------------------------------------------------------------------
   def as_boolean
-    (self > 0) ? true : false
+    positive? ? true : false
   end
-
-end
+end

data/lib/dm_ruby_extensions/extend_nil.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 # If nil, then return a default string
 #------------------------------------------------------------------------------
-class NilClass #:nodoc:
-
+class NilClass # :nodoc:
   #------------------------------------------------------------------------------
   def to_s_default(default_str = 'n/a')
     default_str
@@ -11,7 +12,7 @@ class NilClass #:nodoc:
   def as_boolean
     false
   end
-  
+
   #------------------------------------------------------------------------------
   def to_age
     0
@@ -19,18 +20,17 @@ class NilClass #:nodoc:
 
   #------------------------------------------------------------------------------
   def sql_wildcard
-    "%"	  
+    '%'
   end
-  
+
   #------------------------------------------------------------------------------
   def utc
-    ""
+    ''
   end
-  
+
   # if nil + something, just return something
   #------------------------------------------------------------------------------
-  def +(y)
-    y
+  def +(other)
+    other
   end
-
-end
+end

data/lib/dm_ruby_extensions/extend_numeric.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 class Numeric
-  
   #------------------------------------------------------------------------------
-  def percent_of(n, precision = 0)
-    n == 0 ? 0 : (self.to_f / n.to_f * 100.0).round(precision)
+  def percent_of(num, precision = 0)
+    num.zero? ? 0 : (to_f / num * 100.0).round(precision)
   end
-
-end
+end