ruby-lambdas 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdd09393827cb1cfa7166f4c9390c500b45cb6e374ea1e7fff85d6e8d1023444
-  data.tar.gz: ea9faa37417a2abf246d9049e40f09247faacf1908550e84b7bb98d3b342f404
+  metadata.gz: b8d0f6978b6dddacda782f2d7451c3fca0da1c4403d7fa5cf4f048b028fad117
+  data.tar.gz: 0ecccceb696c038d2b0b0ad310ff5701343f4d39cffae56058d8d2abb3f8f48b
 SHA512:
-  metadata.gz: 72b50b42fcebeb42306809114066e946783bc6bfd33e23eea1acd256adc70634de56de2d9fe83bbd0a63c1116733c2db13a3887fa9163352176d8643c05ef62f
-  data.tar.gz: b06bea15c208280081a98fa62bb3d2d9521e41e94e359ba4d05bdad09ac0ff922fc5179a3215265e26c043d34df6964dabe53686d7e457f32838d7a1f2bbe4e4
+  metadata.gz: 1a271644761b887b3d61e427613a01a96bc53e8a454e25e8ae767639eb56e9b437211e202fae1994bf8540fa0979b606a0acec4e169b4efe3c1a28207a24ca77
+  data.tar.gz: 65169f13404161ae161d4c41f74fd409a2c2afebe6c7ff1375f87b570368f988aaf8706cf879a87ed83a8620ad86d9c269ff24f18b4721947d55a73b3a2cf058

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    ruby-lambdas (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  ruby-lambdas!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -1,8 +1,6 @@
 # RubyLambdas
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby/lambdas`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Expose Ruby object methods as lambdas (functions).
 
 ## Installation
 
@@ -109,20 +107,25 @@ Slugify =                       # Slugify =
     .>> Strings::Downcase       #     >> Strings::LowerCase \
     .>> Strings::GSub[' ', '-'] #     >> Strings::ReplaceAll[' ', '-']
 
-# Reading the previous composition (Step by step)
-# 1. Convert a given object (first input) as a String
-# 2. Remove all whitespaces from both sides of a string.
-# 3. Convert a string to all lower case.
-# 4. Replace all occurrences of " " by "-".
-
-# Usage
+# Reading the previous composition (Step by step):
+#   1. Convert a given object (first input) as a String
+#   2. Remove all whitespaces from both sides of a string.
+#   3. Convert a string to all lower case.
+#   4. Replace all occurrences of " " by "-".
 
+#########
+# Usage #
+#########
 Slugify.(nil)                        # => ""
 Slugify.(1)                          # => "1"
 Slugify.(1.0)                        # => "1.0"
 Slugify.(' I WILL be a url slug   ') # => "i-will-be-a-url-slug"
 ```
 
+### Do you like it?
+
+So, look in [examples folder](https://github.com/serradura/ruby-lambdas/tree/master/examples) to see more ideas and benchmarks.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/01.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+raise 'Wrong Ruby version!' unless RUBY_VERSION >= '2.6.0'
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'ruby-lambdas', require: 'ruby/lambdas'
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+end
+
+############
+# Examples #
+############
+
+#
+# Using common Method Chaining
+#
+def slugify2(value)
+  value.strip.downcase.gsub(' ', '-')
+end
+
+#
+# Using Composable Lambdas
+#
+                                # -- Alternative syntax --
+Slugify =                       # Slugify =
+  Strings::Strip                #   Strings::Trim           \
+    .>> Strings::Downcase       #     >> Strings::LowerCase \
+    .>> Strings::GSub[' ', '-'] #     >> Strings::ReplaceAll[' ', '-']
+
+                                            # -- Alternative syntax --
+slug = Slugify.(' I WILL be a url slug   ') # Slugify.call(' I WILL be a url slug   ')
+                                            # Slugify[' I WILL be a url slug   ']
+p slug # => "i-will-be-a-url-slug"
+
+#
+# Using Data Pipeline with the `then` method & `ruby/lambdas`
+#
+def slugify(value)
+  value
+    .then(&Strings::Trim)
+    .then(&Strings::LowerCase)
+    .then(&Strings::ReplaceAll[' ', '-'])
+end
+
+p slugify('    I will be a url SLUG ') # => "i-will-be-a-url-slug"
+
+##############
+# Benchmarks #
+##############
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report('method chaining') { slugify2(' I WILL be a url slug   ') }
+
+  x.report('compose (.>>)') { Slugify.(' I WILL be a url slug   ') }
+
+  x.report('pipeline (.then)') { slugify(' I WILL be a url slug   ') }
+
+  x.compare!
+end
+
+# ruby -v examples/01.rb
+# ruby 2.6.0p0 (2018-12-25 revision 66547) [x86_64-darwin17]
+# Warming up --------------------------------------
+#      method chaining    41.639k i/100ms
+#        compose (.>>)    41.931k i/100ms
+#     pipeline (.then)    32.379k i/100ms
+# Calculating -------------------------------------
+#      method chaining    464.961k (± 1.9%) i/s -      2.332M in   5.016985s
+#        compose (.>>)    470.854k (± 1.6%) i/s -      2.390M in   5.077433s
+#     pipeline (.then)    351.887k (± 2.2%) i/s -      1.781M in   5.063616s
+
+# Comparison:
+#        compose (.>>):   470853.9 i/s
+#      method chaining:   464960.6 i/s - same-ish: difference falls within error
+#     pipeline (.then):   351887.1 i/s - 1.34x  slower

data/examples/02.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+raise 'Wrong Ruby version!' unless RUBY_VERSION >= '2.6.0'
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'ruby-lambdas', require: 'ruby/lambdas'
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+end
+
+############
+# Examples #
+############
+
+#
+# Using Data Pipeline with the `then` method & `ruby/lambdas`
+#
+class Slugifier1
+  def initialize(sub, new_sub)
+    @sub = sub
+    @new_sub = new_sub
+  end
+
+  def call(value)
+    value
+      .then(&Strings::Strip)
+      .then(&Strings::Downcase)
+      .then(&Strings::GSub[@sub, @new_sub])
+  end
+end
+
+Slugify1 = Slugifier1.new(' ', '-')
+
+                                        # -- Alternative syntax --
+p Slugify1.(' I will Be a urL slug   ') # Slugify.call(' I will Be a urL slug   ')
+
+#
+# Using Data Pipeline with the `then` method & `ruby/lambdas`
+#                                            & generates only once the replace function.
+#
+class Slugifier2
+  def initialize(sub, new_sub)
+    @replace = Strings::GSub[sub, new_sub]
+  end
+
+  def call(value)
+    value
+      .then(&Strings::Strip)
+      .then(&Strings::Downcase)
+      .then(&@replace)
+  end
+end
+
+Slugify2 = Slugifier2.new(' ', '-')
+
+                                        # -- Alternative syntax --
+p Slugify2.(' I will Be a urL slug   ') # Slugify.call(' I will Be a urL slug   ')
+
+#
+# The code below is similar to the first implementation.
+# It also uses the data pipeline with the `then` method.
+# But instead of the `ruby/lambdas`, it defines instance private methods.
+#
+class Slugifier3
+  def initialize(sub, new_sub)
+    @sub = sub
+    @new_sub = new_sub
+  end
+
+  def call(value)
+    value
+      .then(&method(:trim))
+      .then(&method(:lower_case))
+      .then(&method(:replace))
+  end
+
+  private
+
+  def trim(str)
+    str.strip
+  end
+
+  def lower_case(str)
+    str.downcase
+  end
+
+  def replace(str)
+    str.gsub(@sub, @new_sub)
+  end
+end
+
+Slugify3 = Slugifier3.new(' ', '-')
+
+p Slugify3.(' I will be a URL slug   ')
+
+#
+# Use composition instead of pipeline.
+#
+class Slugifier4
+  def initialize(sub, new_sub)
+    @function =
+      Strings::Strip >> Strings::Downcase >> Strings::GSub[sub, new_sub]
+  end
+
+  def call(value)
+    @function.call(value)
+  end
+end
+
+Slugify4 = Slugifier4.new(' ', '-')
+
+p Slugify4.(' I will be a URL slug   ')
+
+#
+# Use only Lambdas instead of classes
+#
+Slugifier5 = -> (sub, new_sub) do
+  Strings::Strip >> Strings::Downcase >> Strings::GSub[sub, new_sub]
+end
+
+Slugify5 = Slugifier5.call(' ', '-')
+
+p Slugify5.(' I will be a URL slug   ')
+
+#
+# Using common Method Chaining
+#
+class Slugifier6
+  def initialize(sub, new_sub)
+    @sub = sub
+    @new_sub = new_sub
+  end
+
+  def call(value)
+    value.strip.downcase.gsub(@sub, @new_sub)
+  end
+end
+
+Slugify6 = Slugifier6.new(' ', '-')
+
+p Slugify6.(' I will be a URL slug   ')
+
+##############
+# Benchmarks #
+##############
+
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report('Slugify1') { Slugify1.(' I WILL be a url slug   ') }
+
+  x.report('Slugify2') { Slugify2.(' I WILL be a url slug   ') }
+
+  x.report('Slugify3') { Slugify3.(' I WILL be a url slug   ') }
+
+  x.report('Slugify4') { Slugify4.(' I WILL be a url slug   ') }
+
+  x.report('Slugify5') { Slugify5.(' I WILL be a url slug   ') }
+
+  x.report('Slugify6') { Slugify6.(' I WILL be a url slug   ') }
+
+  x.compare!
+end
+
+# ruby -v examples/02.rb
+# ruby 2.6.0p0 (2018-12-25 revision 66547) [x86_64-darwin17]
+# Warming up --------------------------------------
+#             Slugify1    32.149k i/100ms
+#             Slugify2    42.850k i/100ms
+#             Slugify3    18.885k i/100ms
+#             Slugify4    41.644k i/100ms
+#             Slugify5    42.273k i/100ms
+#             Slugify6    42.046k i/100ms
+# Calculating -------------------------------------
+#             Slugify1    353.043k (± 1.1%) i/s -      1.768M in   5.009066s
+#             Slugify2    478.121k (± 1.2%) i/s -      2.400M in   5.019572s
+#             Slugify3    198.989k (± 1.7%) i/s -      1.001M in   5.031499s
+#             Slugify4    467.207k (± 1.4%) i/s -      2.374M in   5.081706s
+#             Slugify5    463.900k (± 5.0%) i/s -      2.325M in   5.026941s
+#             Slugify6    463.345k (± 1.5%) i/s -      2.355M in   5.082800s
+
+# Comparison:
+#             Slugify2:   478121.3 i/s
+#             Slugify4:   467207.4 i/s - same-ish: difference falls within error
+#             Slugify5:   463900.4 i/s - same-ish: difference falls within error
+#             Slugify6:   463345.1 i/s - 1.03x  slower
+#             Slugify1:   353043.2 i/s - 1.35x  slower
+#             Slugify3:   198989.5 i/s - 2.40x  slower

data/examples/03.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'ruby-lambdas', require: 'ruby/lambdas'
+end
+
+############
+# Examples #
+############
+
+p [2, 4, 8].map(&Numerics + 2) # => [4, 6, 10]
+p [2, 4, 8].map(&Numerics - 2) # => [0, 2, 6]
+p [2, 4, 8].map(&Numerics / 2) # => [1, 2, 4]
+p [2, 4, 8].map(&Numerics * 2) # => [4, 8, 16]
+
+# ---
+
+p [2, 4, 8].select(&Numerics > 2)  # => [4, 8]
+p [2, 4, 8].select(&Numerics >= 2) # => [2, 4, 8]
+p [2, 4, 8].select(&Numerics < 2)  # => []
+p [2, 4, 8].select(&Numerics <= 2) # => [2]

data/examples/04.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+raise 'Wrong Ruby version!' unless RUBY_VERSION >= '2.6.0'
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'ruby-lambdas', require: 'ruby/lambdas'
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+end
+
+############
+# Examples #
+############
+
+Student = Struct.new(:name, :grade, keyword_init: true)
+
+STUDENTS = [
+  { name: 'Rodrigo', grade: 6 },
+  { name: 'Talita' , grade: 9 },
+  { name: 'Bella'  , grade: 10 },
+  { name: 'Lara'   , grade: 10 }
+].map &Student.method(:new)
+
+ByName = -> student { student.name }
+FetchGrade = -> student { student.grade }
+IsApproved = FetchGrade >> (Numerics >= 9)
+
+#
+# Declarative approach (using functions instead of blocks)
+#
+p STUDENTS.select(&IsApproved).map(&ByName)
+
+#
+# An Imperative version from the previous example
+#
+p STUDENTS.select{ |student| student.grade >= 9 }
+          .map{ |student| student.name }
+
+##############
+# Benchmarks #
+##############
+
+require 'benchmark/ips'
+
+IsApproved2 = -> student { student.grade >= 9 }
+
+Benchmark.ips do |x|
+  x.report('Imperative') do
+    STUDENTS.select { |student| student.grade >= 9 }
+  end
+
+  x.report('Declarative (with composition)') do
+    STUDENTS.select(&IsApproved)
+  end
+
+  x.report('Declarative (without composition)') do
+    STUDENTS.select(&IsApproved2)
+  end
+
+  x.compare!
+end
+
+# ruby -v examples/02.rb
+# ruby 2.6.0p0 (2018-12-25 revision 66547) [x86_64-darwin17]
+# Warming up --------------------------------------
+#           Imperative   155.896k i/100ms
+# Declarative (with composition)
+#                         58.468k i/100ms
+# Declarative (without composition)
+#                        153.103k i/100ms
+# Calculating -------------------------------------
+#           Imperative      2.542M (± 1.3%) i/s -     12.783M in   5.029394s
+# Declarative (with composition)
+#                         690.140k (± 1.6%) i/s -      3.508M in   5.084486s
+# Declarative (without composition)
+#                           2.408M (± 1.5%) i/s -     12.095M in   5.024628s
+
+# Comparison:
+#           Imperative:  2542164.1 i/s
+# Declarative (without composition):  2407753.3 i/s - 1.06x  slower
+# Declarative (with composition):   690140.5 i/s - 3.68x  slower

data/lib/ruby/lambdas/numerics/to_export.rb

@@ -0,0 +1,34 @@
+module RubyLambdas
+  module Numerics
+    module ToExport
+      #
+      # Operators
+      #
+      Add = -> (a, b) { a + b }
+
+      Divide = -> (a, b) { a / b }
+
+      Subtract = -> (a, b) { a - b }
+
+      Multiply = -> (a, b) { a * b }
+
+      #
+      # Comparables
+      #
+      GreaterThan = -> (a, b) { a > b }
+
+      GreaterThanOrEqual = -> (a, b) { a >= b }
+
+      LessThan = -> (a, b) { a < b }
+
+      LessThanOrEqual = -> (a, b) { a <= b }
+    end
+
+    ALIASES = {
+      GreaterThan: :Gt,
+      GreaterThanOrEqual: :Gte,
+      LessThan: :Lt,
+      LessThanOrEqual: :Lte,
+    }.freeze
+  end
+end

data/lib/ruby/lambdas/numerics.rb

@@ -0,0 +1,44 @@
+module Numerics
+  require_relative "import"
+  require_relative "numerics/to_export"
+
+  RubyLambdas::Import.(from: RubyLambdas::Numerics, to: self)
+
+  #
+  # Operators
+  #
+  def self.+(a)
+    Add[a]
+  end
+
+  def self./(b)
+    -> a { Divide[a, b] }
+  end
+
+  def self.-(b)
+    -> a { Subtract[a, b] }
+  end
+
+  def self.*(a)
+    Multiply[a]
+  end
+
+  #
+  # Comparables
+  #
+  def self.>(b)
+    -> a { GreaterThan[a, b] }
+  end
+
+  def self.>=(b)
+    -> a { GreaterThanOrEqual[a, b] }
+  end
+
+  def self.<(b)
+    -> a { LessThan[a, b] }
+  end
+
+  def self.<=(b)
+    -> a { LessThanOrEqual[a, b] }
+  end
+end

data/lib/ruby/lambdas/version.rb

@@ -1,3 +1,3 @@
 module RubyLambdas
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/ruby/lambdas.rb

@@ -2,5 +2,6 @@ require "ruby/lambdas/version"
 
 module RubyLambdas
   require_relative "lambdas/strings"
+  require_relative "lambdas/numerics"
   require_relative "lambdas/objects"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lambdas
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-29 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,13 +63,20 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- examples/01.rb
+- examples/02.rb
+- examples/03.rb
+- examples/04.rb
 - lib/ruby/lambdas.rb
 - lib/ruby/lambdas/import.rb
+- lib/ruby/lambdas/numerics.rb
+- lib/ruby/lambdas/numerics/to_export.rb
 - lib/ruby/lambdas/objects.rb
 - lib/ruby/lambdas/objects/to_export.rb
 - lib/ruby/lambdas/strings.rb