canal 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d161ce583930471d7dd171b918f8a69dc115296
-  data.tar.gz: adf0e0d7b4702a0fa840984bcc3035721747883d
+SHA256:
+  metadata.gz: 10c686c0e62cfb803619452f989fc677bd28530a6090ea39c02dcb90971371a7
+  data.tar.gz: 373ef203136ab8ee0e5df4ea3d8bb2e98a53be7e985e464f84e016661b1dc87b
 SHA512:
-  metadata.gz: b8b3f48cea170db0439d30ac59a6368b96760c7f602ed4e7cf24dbc9e1dc865efa6b02a7f7b3d8b9214cabe86910a419205fdeb7bf48e8366450a75c422250b0
-  data.tar.gz: 666bb3ab504b3030ef073bb4bd14a4015d6824c6fe4629ef0bd4eade0d4293ee1c168f472fa018eb29e602aa2eea533ae67f63754e6a1473e938889cd7ed99ac
+  metadata.gz: f741eaab09ce3d78b1e615c2a23e0c9624c556c7d46ba1bc146f3721280a7c060091690ba1da5b46fe8b0b482074521b01f0c92e185990e3f6c507536de49ff7
+  data.tar.gz: 1150364b84c6484457c094b112082e5167e7e6d35d3a5572fa72cb6968e5c43fe27edf529566fdb5b6815e28c970caa48a8b72a580317cb75330f19b84a88d7a

data/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+on:
+  workflow_dispatch:
+
+permissions: {}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      with:
+        persist-credentials: false
+    - uses: ruby/setup-ruby@2a18b06812b0e15bb916e1df298d3e740422c47e # v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: false
+    - run: bundle install
+    - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3']
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@2a18b06812b0e15bb916e1df298d3e740422c47e # v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    canal (0.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  canal!
+  minitest
+  rake
+
+BUNDLED WITH
+   2.5.23

data/README.md

@@ -1,42 +1,37 @@
 # Canal
 
-Build functions out of methods.
+[![Gem Version](https://badge.fury.io/rb/canal.svg)](https://badge.fury.io/rb/canal)
 
-## Examples
+Canal is an utility that builds callable objects out of a chain of method calls. It can be used to write simpler and shorter code that avoids using blocks or lambdas.
 
-Canal can allow point-free expressions. For example, when using `map`:
+## Usage
+
+Include the `canal` gem and expose the `canal` method:
 
 ```ruby
-%w{10010101 11100 10110}.map(&canal.to_i(2).to_s.reverse.to_i.to_s(2))
+require 'canal'
 ```
 
-is equivalent to
+### Using canals instead of lambdas
 
 ```ruby
-%w{10010101 11100 10110}.map do |x|
-  x.to_i(2).to_s.reverse.to_i.to_s(2)
-end
+lambda { |x| x.to_s(2) }
+canal.to_s(2)
 ```
 
-### Identity
-
-An empty canal is the identity function.
+### Using canals instead of blocks
 
 ```ruby
-[1, 2, 3].map(&canal)
-=> [1, 2, 3]
+[1, 2, 3].map { |value| value + 1 }
+[1, 2, 3].map(&canal + 1)
 ```
 
-Exemple: Count truthy values.
-
 ```ruby
-[true, false, nil, "hey", 4].count(&canal)
-=> 3
+[1, 2, 3].select { |value| value > 1 }
+[1, 2, 3].select(&canal > 1)
 ```
 
-### Operators
-
-Fetch key in list of hash.
+### Using hashes
 
 ```ruby
 people = [{ name: "Alice" }, { name: "Bob" }]
@@ -44,11 +39,14 @@ people.map(&canal[:name])
 => ["Alice", "Bob"]
 ```
 
-Multiply list of number by 2.
+### Nesting canals
 
 ```ruby
-(0..5).map(&canal * 2)
-=> [0, 2, 4, 6, 8, 10]
+# Format a 2D array into a grid
+rows = [[1, 2], [31, 4]]
+puts rows.map(&canal.map(&canal.to_s.ljust(3, ' ')).join).join("\n")
+1  2
+31 4
 ```
 
 ## Installation

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+desc "Run tests"
+
+task default: [:test]

data/canal.gemspec

@@ -6,11 +6,11 @@ require 'canal/version'
 Gem::Specification.new do |spec|
   spec.name          = "canal"
   spec.version       = Canal::VERSION
-  spec.authors       = ["Benoit Cote-Jodoin"]
+  spec.authors       = ["becojo"]
   spec.email         = ["benoit@bcj.io"]
-  spec.summary       = %q{Partial application of a chain of methods.}
+  spec.summary       = %q{Utility that builds callable objects out of a chain of method calls}
   # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/becojo/canal"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/canal/version.rb

@@ -1,3 +1,3 @@
 module Canal
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/lib/canal.rb

@@ -2,22 +2,18 @@ require "canal/version"
 
 module Canal
   class Context
-    def initialize
-      @functions = []
+    def initialize(functions=[])
+      @functions = functions.freeze
     end
 
-    def method_missing(name, *args, &block)
-      functions = @functions
-      Canal::Context.new.instance_eval {
-        @functions = functions + [[name, args, block]]
-        self
-      }
+    def method_missing(name, *args, **kwargs, &block)
+      Canal::Context.new(@functions + [[name, args, kwargs, block]])
     end
 
     def call(object)
       @functions.reduce(object) do |object, function|
-        name, args, block = function
-        object.send(name, *args, &block)
+        name, args, kwargs, block = function
+        object.send(name, *args, **kwargs, &block)
       end
     end
 

data/test/canal_test.rb

@@ -0,0 +1,55 @@
+require_relative 'test_helper'
+
+class CanalTest < Minitest::Test
+  def test_identity
+    f = canal
+    value = Object.new
+
+    assert_equal(value.object_id, f.(value).object_id)
+  end
+
+  def test_hash
+    f = canal[:foo]
+    value = { foo: :bar }
+
+    assert_equal(:bar, f.(value))
+  end
+
+  def test_operators
+    operators = %w(+ - * / % ** == === != < > <= >=)
+
+    operators.each do |operator|
+      a = 123
+      b = 65
+
+      assert_equal(a.send(operator, b), canal.send(operator, b).(a))
+    end
+  end
+
+  def test_immutability
+    f = canal[:foo]
+    g = f[:bar]
+
+    assert_equal(123, f.({ foo: 123 }))
+    assert_equal(456, g.({ foo: { bar: 456 } }))
+    refute_equal(f.object_id, g.object_id)
+  end
+
+  def test_kwargs
+    f = canal.foo(bar: 123)
+    cls = Class.new do
+      def foo(bar:)
+        bar
+      end
+    end
+
+    assert_equal(123, f.(cls.new))
+  end
+
+  def test_block
+    f = canal.map(&canal + 1) + [:foo]
+    value = [0, 1, 2]
+
+    assert_equal([1,2,3,:foo], f.(value))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require 'canal'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canal
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
-- Benoit Cote-Jodoin
+- becojo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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:
 - benoit@bcj.io
@@ -45,15 +59,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - canal.gemspec
 - lib/canal.rb
 - lib/canal/version.rb
-homepage: ''
+- test/canal_test.rb
+- test/test_helper.rb
+homepage: https://github.com/becojo/canal
 licenses:
 - MIT
 metadata: {}
@@ -72,9 +91,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
-summary: Partial application of a chain of methods.
-test_files: []
+summary: Utility that builds callable objects out of a chain of method calls
+test_files:
+- test/canal_test.rb
+- test/test_helper.rb