jgomo3-func 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b6cfecdff107f74516b252a00057ff4490239b21d3ca56eead0e75d1448ffef
-  data.tar.gz: a6e22e6ad37289340d286dd27e297d5a0a1c259f216a7257005084995d7f79f7
+  metadata.gz: a9f0b16949f99318dbcb8a0439d9c441178b7858bc6c341be8a86e4b2c52e64e
+  data.tar.gz: c982c140130a959f36b2fc3e93a228bea440a648938c8ba430d24d11a6c01e1c
 SHA512:
-  metadata.gz: 8019ec224ad628cb8a3696a2e42e1b09a0fbffdf12f7a54f33d0157a425beb04028d7262c78361639016201c741a30d6332376b7470a24034a9ebf1bde6c91c0
-  data.tar.gz: 721de13bbbcde4d5fadeac3e05109718e6c1ef65e751df13ea4369005ea0903da9181908c08a0599e3a84fe6b9ce98185372df7846d2b8457f1d46f2ed37d69f
+  metadata.gz: c92f1538e10821e7101510372b23886b59d351da6bfb49ab70794657f022867d9300d9504fdb83b7c2638b9777341142d8b807fbb7bd6a76170462ac9343b7a0
+  data.tar.gz: 74d4541b3fefe3aba9cc95b3dd5321d1f6902e2527f878513ea46bbab5b9022cb55281c4fdf3a3a2c7bcaeb2a671cb6f7821d6d2521f8fb96e65b807dd7f6edd

data/.mailmap

@@ -0,0 +1 @@
+Jesús Gómez <jgomo3@gmail.com>

data/CHANGELOG.md

@@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 1.0.1 - 2023-04-07
+### Fixed
+- Bump the number just to force use of new artifact from Rubygems. I made a mistake publishing the previous version
+
+---
+## 1.0.0 - 2023-04-07
+### Changed
+- `then_if` accept non callable values and interpret them by their truth value
+- `then_unless` accept non callable values and interpret them by their truth value
+- `complement` will negate the receiver's values directly if it is not a callable
+
+### Removed
+- `complement` doesn't rais an ArgumentError when it's receiver was not a callable
+
+---
 ## 0.1.0 - 2022-11-15
 ### Added
 - Object extensions

data/Gemfile

@@ -3,7 +3,3 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in jgomo3-func.gemspec
 gemspec
 
-gem 'codelog'
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem 'yard'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jgomo3-func (0.1.0)
+    jgomo3-func (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,6 +3,10 @@
 By requiring this Gem, some extensions will be applied to Ruby core
 classes (similar to what Activesupport does).
 
+```
+require 'jgomo3/func'
+```
+
 The extensions is a collection of methods I find useful for any
 project. This is a quick list:
 

data/changelogs/releases/1.0.0.md

@@ -0,0 +1,10 @@
+## 1.0.0 - 2023-04-07
+### Changed
+- `then_if` accept non callable values and interpret them by their truth value
+- `then_unless` accept non callable values and interpret them by their truth value
+- `complement` will negate the receiver's values directly if it is not a callable
+
+### Removed
+- `complement` doesn't rais an ArgumentError when it's receiver was not a callable
+
+---

data/changelogs/releases/1.0.1.md

@@ -0,0 +1,5 @@
+## 1.0.1 - 2023-04-07
+### Fixed
+- Bump the number just to force use of new artifact from Rubygems. I made a mistake publishing the previous version
+
+---

data/jgomo3-func.gemspec

@@ -26,4 +26,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "codelog"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'yard'
 end

data/lib/jgomo3/func/core_ext/object.rb

@@ -10,49 +10,70 @@ class Object
     Proc.new { self }
   end
 
-  # Returns a Proc which negates the result of calling the argumented
-  # callable object.
+  # If the receiver object is callabale, returns a Proc which negates
+  # the result of calling the argumented callable object.
+  #
+  # If it is not a callable, it returns it's negated value
   #
   #   :positive?.complement.call(1) => false
   #   :nil?.complement.call(nil) => false
+  #   false.complement => true
   def complement
     callable = case
                when respond_to?(:call)
                  self
-               else
+               when respond_to?(:to_proc)
                  self.to_proc
                end
-    ->(*args, **kwargs, &blk) { !callable.call(*args, **kwargs, &blk) }
-  rescue NoMethodError => error
-    case error.name
-    when :to_proc
-      raise ArgumentError, "Object is not 'Callable' so it can't have a complement function", caller
+    if callable
+      ->(*args, **kwargs, &blk) { !callable.call(*args, **kwargs, &blk) }
     else
-      raise
+      !self
     end
   end
 
-  # Applies the given block to the object if the condition applied on
+  # Applies the given block to the object if the criteria applied on
   # it holds true.  If not, it defaults to the object as if `then_if`
   # was not called.
   #
+  # The criteria can be a callable predicate, in which case the
+  # criteria is evaluated with the object as argument. It not, then
+  # the criteria will be interpreted by it's truth value.
+  #
   #   +1.then_if(:positive?) { _1 * 1000 } => 1_000
   #   -1.then_if(:positive?) { _1 * 1000 } => -1
-  def then_if(condition)
-    if condition.to_proc.call(self)
+  #   +1.then_if(true)       { _1 * 1000 } => 1_000
+  #   +1.then_if(false)      { _1 * 1000 } => 1
+  def then_if(criteria)
+    callable = case
+               when criteria.respond_to?(:call)
+                 criteria
+               when criteria.respond_to?(:to_proc)
+                 criteria.to_proc
+               end
+
+    condition = callable ? callable.call(self) : criteria
+    
+    if condition
       yield self
     else
       self
     end
   end
 
-  # Applies the given block to the object if the condition applied on
+  # Applies the given block to the object if the criteria applied on
   # it doesn't hold true.  If not, it defaults to the object as if
   # `then_unless` was not called.
   #
-  #   +1.then_if(:positive?) { _1 * 1000 } => 1_000
-  #   -1.then_if(:positive?) { _1 * 1000 } => -1
-  def then_unless(condition, &block)
-    then_if(condition.complement, &block)
+  # The criteria can be a callable predicate, in which case the
+  # criteria is evaluated with the object as argument. It not, then
+  # the criteria will be interpreted by it's truth value.
+  #
+  #   +1.then_unless(:positive?) { _1 * 1000 } => 1
+  #   -1.then_unless(:positive?) { _1 * 1000 } => -1_000
+  #   +1.then_unless(false)      { _1 * 1000 } => 1_000
+  #   +1.then_unless(true)       { _1 * 1000 } => 1
+  def then_unless(criteria, &block)
+    then_if(criteria.complement, &block)
   end
 end

data/lib/jgomo3/func/version.rb

@@ -1,5 +1,5 @@
 module Jgomo3
   module Func
-    VERSION = "0.1.0"
+    VERSION = "1.0.1"
   end
 end

data/todo.org

@@ -0,0 +1,86 @@
+#+title: Potential changes
+#+author: Jesús Gómez <jgomo3@gmail.com>
+* TODO Define alias yield_self_if of then_if (and for unless case too)
+* TODO Explain in API and README that for cases with both ~if~ and ~else~ clauses, it is better to just avoid these functions
+* TODO Define nil_if and nil_unless
+For the pattern ~object.then_if(condition){ nil }~, this could be used
+instead: ~object.nil_if(condition)~.
+
+This pattern appears when chaining with the "safe navigation operator" (&.). E.g:
+
+#+begin_ruby
+object.tx_1.nil_if(condition)&.tx_2&._&._&.tx_3
+#+end_ruby
+* TODO Define map_if and map_unless
+Applies the block to the processed element only if the condition is
+true.
+
+~data.map_if(condition){ f(_1) }~ would be equivalent to:
+
+#+begin_ruby
+data.map{ condition(_1) ? f(_1) : _1 }
+#+end_ruby
+
+Not the same to neither of the following patterns:
+
+#+begin_ruby
+data.filter{ condition(_1) }.map{ f_1 }
+data.map{ f_1 }.filter{ condition(_1) }
+#+end_ruby
+
+~map_if~ and ~map~ will produce collection of the same
+cardinality. ~filter{}.map{}~ or ~map{}.filter{}~ can produce
+collection with lower cardinality of ~map~.
+
+* TODO Define each_if and each_unless
+In the same spirit as the other functions of this gem,
+~data.each_if(condition) { f(_1) }~ should be the same as:
+
+#+begin_ruby
+data.each do
+  if condition(_1)
+    f(_1)
+  else
+    _1
+  end
+end
+#+end_ruby
+
+It should also support the other forms of ~each~ where it receives
+arguments that will be "appended" to the enumerator call, and the form
+where it doesn't receive nor arguments neither block.
+
+In all cases, it should be in a way that "makes sense".
+
+* TODO Define tap_if and tap_unless
+
+This one is the easiest to "understand" as it can be read as "make
+side effect if ...".
+
+* TODO Merge procer default to_proc implementation as an explicit call
+
+[[../procer/ge][../proce.gemspec]] defines a default =to_proc= to all objects. If you
+don't want to add that behaviour to your system, you can use this
+proposed method to explicitly as for the default procer propose.
+
+The idea... With procer, you can do:
+
+#+begin_ruby
+['1', 2, 3 '4', '5'].filter(&Numeric) # => [2, 3]
+#+end_ruby
+
+Because *procer* defines a default ~to_proc~ method for classes, which
+is to compare the class with it's argument using the "Case Equality
+(~===~)" operator.
+
+But without procer, this new method, let's say it is called =procer=,
+we could do:
+
+#+begin_ruby
+# Option 1
+['1', 2, 3 '4', '5'].filter(&procer(Numeric)) # => [2, 3]
+
+# Option 2
+['1', 2, 3 '4', '5'].filter(&Numeric.procer) # => [2, 3]
+#+end_ruby
+

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: jgomo3-func
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jesús Gómez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-15 00:00:00.000000000 Z
-dependencies: []
+date: 2023-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jgomo3@gmail.com
@@ -18,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".mailmap"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
@@ -33,12 +90,15 @@ files:
 - changelogs/header.txt
 - changelogs/releases/.gitkeep
 - changelogs/releases/0.1.0.md
+- changelogs/releases/1.0.0.md
+- changelogs/releases/1.0.1.md
 - changelogs/template.yml
 - changelogs/unreleased/.gitkeep
 - jgomo3-func.gemspec
 - lib/jgomo3/func.rb
 - lib/jgomo3/func/core_ext/object.rb
 - lib/jgomo3/func/version.rb
+- todo.org
 homepage: https://github.com/jgomo3/jgomo3-func
 licenses:
 - MIT
@@ -61,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Library of functions I find useful enough to be included always