core 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 550649438a79452183f1641126bdb0e1a66fec5562ba85ddac55ff9c2964c76a
-  data.tar.gz: 8c49c211d08d6383b76f3b3027b09b393ef305564e32febf71eedfaa0ffc4a17
+  metadata.gz: 34e053097ae6807acaccbceda960d36c0fab5727d1c4fd44b27d920a38d04e17
+  data.tar.gz: 0e8e8efa4f28893e6fe3b2319287ca999c5cf8551d13d9533b009b67c51f5863
 SHA512:
-  metadata.gz: 5233ea35a55b2923e00140869a3fab08e9ddd9529d3194214c8fe7861f2b6baf5a18549f6f3af4149a56db93474cac57eaf93692f8803cf6f913af7f5dbf5134
-  data.tar.gz: 00021ad5c7c443d7fd0650d4c53005c4f9bad396076e707d3dcfcad0ec2702a2dec700e788b22a6fb60cfe79ea00b618f034077c75ec2cd333a7f03fa171a09d
+  metadata.gz: a1a1899d72683603248cb2a5690e3bd228352ea6f891a2e51f757ff2b1c01179178448c33be10c9218d24241b70ce1e9e9e6b3e5b8015281e912fefd0b1ed563
+  data.tar.gz: 7c1d341c9fdddc3e407e8d4aaec01e3e8b1cb2281bb9082922af73740acfbb2a5b4a93724b827f8400ceb75f6c5175e686d7c9b032558c90b3b8ff016f14d54e

data/README.adoc

@@ -2,9 +2,13 @@
 :toclevels: 5
 :figure-caption!:
 
+:ruby_link: link:https://www.ruby-lang.org[Ruby]
+:function_composition_link: link:https://alchemists.io/articles/ruby_function_composition[Function Composition]
+:pipeable_link: link:https://alchemists.io/projects/pipeable[Pipeable]
+
 = Core
 
-Provides a collection of core objects missing from the standard Ruby distribution. This is meant to provide common objects for engineering advanced architctures in order to reduce duplication, improve performance, and improve memory usage.
+Provides a collection of common objects missing from core {ruby_link}. This allows you to reduce duplication, improve performance, and improve memory usage in order to engineer advanced architectures.
 
 toc::[]
 
@@ -14,7 +18,7 @@ toc::[]
 
 == Requirements
 
-. link:https://www.ruby-lang.org[Ruby].
+. {ruby_link}.
 
 == Setup
 
@@ -42,13 +46,52 @@ The following _empty_ constants are frozen by default and available for use as c
 
 === Functions
 
-The following identity function (lambda) is available as a neutral value in link:https://alchemists.io/articles/ruby_function_composition[function composition]:
+The following identity function (lambda) is available as a neutral value in {function_composition_link}:
 
 [source,ruby]
 ----
 Core::Identity.call "example"  # "example"
 ----
 
+=== Modules
+
+A `Composable` module is available to you should you need to use {function_composition_link} in order to make your objects composable via procs, lambdas, methods, and/or classes. Pairs well with the {pipeable_link} gem. The module provides the following methods for you:
+
+* `+>>+`: Forward composition.
+* `+<<+`: Backward composition.
+* `+#call+`: The primary method to implement in order to be composable. Fails with a `NoMethodError` if not implemented.
+
+To use, include `Composable` and implement `#call` as follows:
+
+[source,ruby]
+----
+class Greeter
+  include Core::Composable
+
+  def initialize salutation: "Heya"
+    @salutation = salutation
+  end
+
+  def call(text) = "#{salutation} #{text}"
+
+  private
+
+  attr_reader :salutation
+end
+----
+
+The above then allows you to compose your objects as functional pipelines:
+
+[source,ruby]
+----
+appender = -> text { "#{text} -- An example of function composition."}
+greeter = Greeter.new
+
+(greeter >> appender).call "visitor"
+
+# "Heya visitor -- An example of function composition."
+----
+
 == Development
 
 To contribute, run:

data/core.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "core"
-  spec.version = "3.3.0"
+  spec.version = "3.4.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/core"

data/lib/core/composable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Core
+  # Allows objects to be functionally composable.
+  module Composable
+    def >>(other) = method(:call) >> other
+
+    def <<(other) = method(:call) << other
+
+    def call = fail NoMethodError, "`#{self.class.name}##{__method__}` must be implemented."
+  end
+end

data/lib/core.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "core/composable"
 require "core/identity"
 
 # Main namespace.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: core
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -47,6 +47,7 @@ files:
 - README.adoc
 - core.gemspec
 - lib/core.rb
+- lib/core/composable.rb
 - lib/core/identity.rb
 homepage: https://alchemists.io/projects/core
 licenses:
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.15
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A collection of foundational objects.
 test_files: []