niceties 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a344de89699dbdc123ebe5cd16c0457e0b35b7ef3717db07348415b752b6b75
-  data.tar.gz: 3a4f87520eb6808cc9998720aa283f84a6841f9f5505f1d4d6faf02773314441
+  metadata.gz: a864755de9a566ad580394e72820ea1f9d824b5f5a54997494198ad984b50c7b
+  data.tar.gz: 1dad3eb338a74c7ea1eef8b486a5dac9d188ca0483fde5c2cac12abeb06d7c0e
 SHA512:
-  metadata.gz: d05d3be08f1576176537516acedead938c049985e81a5e6ac143d90b3b1af477e2a95110da8209355630ecef5a9dd360f2c34e4bd12c0d2de5c3a28b7a4e53dd
-  data.tar.gz: e21eb52f1c78b876fb340f3b276eb210c1c96dacea0491f23d700e13e20e777e0fd98f4a5652c5f84f9433c5cf2711533283f6588a5b4ac44ca89b53e4ca0272
+  metadata.gz: 7adf9811df2dc492c67768bb5b20076f6651c543231ce94794174b765d88d32e259af2867397ebcf4dcd9c7cada88d892522325045dc38dc7b6bfa2658988052
+  data.tar.gz: ea59ade372a556e0455b5847f0c905816f908ea0cc206d0034e1c6159cf2cc912ae48f97ddf1a01e11c2c4b4eadeeda68c491ad40ac174f82af83d3bd9e6ca68

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+Gemfile.lock

data/README.md

@@ -21,6 +21,53 @@ You should be able to drop Niceties into your app and feel like it’s always be
 
 ---
 
+## What's on the Menu
+
+Niceties provides the following methods so far:
+
+### Object
+
+```rb
+# Object.try_each
+@user.try_each(:full_name, :nickname, :username) # instead of @user&.full_name || @user&.nickname || @user&.username
+
+# Object.coalesce
+@user.coalesce(:full_name, :nickname, "Valued Customer") # instead of @user&.full_name || @user&.nickname || "Valued Customer"
+
+# Object.not_a?
+@user.not_a? Widget # instead of !@user.is_a? Widget
+```
+
+### Array
+
+```rb
+# Array.tidy
+["", nil, 4].tidy => [4] # instead of ["", nil, 4].select { it.present? } 
+```
+
+### Numerics (Integer and Float)
+
+```rb
+# Integer.percent_of
+25.percent_of(200) => 50 # instead of (200 / 100.0) * 25
+
+# Float.percent_of
+16.6.percent_of(1000) => 166 # instead of (1000 / 100.0) * 16.6
+
+# Numeric.plus_or_minus
+5.plus_or_minus(2) => 3..7 # instead of (5-2)..(5+2)
+```
+
+### Time
+
+```rb
+User.where(created_at: Time.current.minus_upto(1.hour))
+```
+
+More methods will be coming soon and contributions are very much welcomed!
+
+---
+
 ## 🫂 Contributing
 
 Niceties is open to anyone with an idea that makes Ruby or Rails feel better to use.

data/lib/niceties/not_a.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Niceties
+  # Niceties for determining object classes
+  module NotA
+    def not_a?(klass)
+      !is_a?(klass)
+    end
+  end
+end

data/lib/niceties/percent_of.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Niceties
+  # Niceties for calculating percentages
+  module PercentOf
+    def percent_of(other)
+      (other / 100.0) * to_f
+    end
+  end
+end

data/lib/niceties/plus_or_minus.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Niceties
+  # Niceties for creating ranges
+  module PlusOrMinus
+    def plus_or_minus(amount)
+      (self - amount)..(self + amount)
+    end
+
+    def plus_upto(amount)
+      self..(self + amount)
+    end
+
+    def minus_upto(amount)
+      (self - amount)..self
+    end
+  end
+end

data/lib/niceties/tidy.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Niceties
+  # Niceties for removing blanks from Arrays
+  module Tidy
+    def tidy
+      select { it.present? }
+    end
+  end
+end

data/lib/niceties/try_each.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Niceties
+  # Niceties for trying multiple methods
+  module TryEach
+    def try_each(*methods)
+      methods.each do |method|
+        result = try(method)
+        return result unless result.nil?
+      end
+
+      nil
+    end
+
+    def coalesce(*messages)
+      *methods, fallback = messages
+
+      methods.each do |method|
+        result = try(method)
+        return result if result.present?
+      end
+
+      fallback.is_a?(Symbol) ? try(fallback) : fallback
+    end
+  end
+end

data/lib/niceties/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Niceties
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/niceties.rb

@@ -1,9 +1,41 @@
 # frozen_string_literal: true
 
+require "date"
 require "active_support/core_ext/object/try"
 require "active_support/core_ext/object/blank"
 require_relative "niceties/version"
-require_relative "niceties/object"
+require_relative "niceties/plus_or_minus"
+require_relative "niceties/not_a"
+require_relative "niceties/try_each"
+require_relative "niceties/percent_of"
+require_relative "niceties/tidy"
 
+# See included modules for implementations
 module Niceties
 end
+
+class Object
+  include Niceties::NotA
+  include Niceties::TryEach
+end
+
+class Array
+  include Niceties::Tidy
+end
+
+class Numeric
+  include Niceties::PlusOrMinus
+  include Niceties::PercentOf
+end
+
+class Time
+  include Niceties::PlusOrMinus
+end
+
+class Date
+  include Niceties::PlusOrMinus
+end
+
+class DateTime
+  include Niceties::PlusOrMinus
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: niceties
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Carl Dawson
@@ -23,8 +23,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-description: Niceties is a carefully curated set of ergonomic Ruby and Rails extensions—small,
-  expressive methods that make code feel more natural and joyful to write.
+description: Niceties is a curated set of small, ergonomic and expressive methods
+  for Ruby and Rails.
 email:
 - email@carldaws.com
 executables: []
@@ -40,7 +40,11 @@ files:
 - bin/console
 - bin/setup
 - lib/niceties.rb
-- lib/niceties/object.rb
+- lib/niceties/not_a.rb
+- lib/niceties/percent_of.rb
+- lib/niceties/plus_or_minus.rb
+- lib/niceties/tidy.rb
+- lib/niceties/try_each.rb
 - lib/niceties/version.rb
 - sig/niceties.rbs
 homepage: https://github.com/carldaws/niceties

data/lib/niceties/object.rb

@@ -1,25 +0,0 @@
-class Object
-  def not_a?(klass)
-    !is_a?(klass)
-  end
-
-  def try_all(*methods)
-    methods.each do |method|
-      result = try(method)
-      return result unless result.nil?
-    end
-
-    nil
-  end
-
-  def coalesce(*messages)
-    *methods, fallback = messages
-
-    methods.each do |method|
-      result = try(method)
-      return result if result.present?
-    end
-
-    fallback.is_a?(Symbol) ? try(fallback) : fallback
-  end
-end