ramda-ruby 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9c61500382b8a30650338a2359340adaa39ed58
-  data.tar.gz: b80d5832f21113ddb52436deecdde3971a44f2b4
+  metadata.gz: 6f28ea9a5acc282047805422a96e187bd6b97791
+  data.tar.gz: fde8d4617b4d1d43ba9ac481505a046abbe5c6b0
 SHA512:
-  metadata.gz: 11b0927aa3a7d6170bebbf1f5e337d8df033701fa71261c01a55d5e9cbfb31cc72c2a78c7019dcdad7e503368a37165a1bae2cb15681a7f16027ed37f4347fe1
-  data.tar.gz: ef83e01457589590d595e90d78c1a67b283489fd33a4532c21d10f497471994d7660d24868b604767d2cecd5a3b7b65add056cf57d80111448e2314e95d00389
+  metadata.gz: 61fb7fd43a5912c651d4f26441c2267530cf55f1b6473b91693fc8f7ba99eafc01cb739006d6d89c59cc1278e02d1464e5b95603e4c99c9e26af4bd1975af834
+  data.tar.gz: 208dbb9efa07a6c5b6a00609c410fb81ad98245a5b7b1158b09579cb6531e13acb6d5e30752227153fc28ff4ecf53410b052446cf330367a2ec63a5126d0e5ad

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 Not Released
 ---------------
 
+Release 0.15.0
+---------------
+
+Added:
+
+* [add_index](http://ramdajs.com/docs/#addIndex)
+* [identical](http://ramdajs.com/docs/#identical)
+* [reduced](http://ramdajs.com/docs/#reduced)
+
+
+Release 0.14.0
+---------------
+
 Added:
 
 * (pending) uncurry_n

data/README.md

@@ -4,7 +4,7 @@ Ramda Ruby
 This is a ruby version of [Ramda Js](http://ramdajs.com) library.
 
 [![Gem Version](https://badge.fury.io/rb/ramda-ruby.svg)](http://badge.fury.io/rb/ramda-ruby)
-[![Functions](https://img.shields.io/badge/Functions-184-green.svg)](docs/FUNCTIONS.md)
+[![Functions](https://img.shields.io/badge/Functions-187-green.svg)](docs/FUNCTIONS.md)
 [![Travis badge](https://travis-ci.org/lazebny/ramda-ruby.svg?branch=master)](https://travis-ci.org/lazebny/ramda-ruby)
 [![AppVeyor status](https://ci.appveyor.com/api/projects/status/ponccdax7aj4ufw2?svg=true)](https://ci.appveyor.com/project/lazebny/ramda-ruby)
 [![Coverage Status](https://coveralls.io/repos/lazebny/ramda-ruby/badge.png)](https://coveralls.io/r/lazebny/ramda-ruby)

data/ROADMAP.md

@@ -1,15 +1,3 @@
-Release 0.13.0
----------------
-
-Release 0.14.0
----------------
-
-Releaes 0.15.0
----------------
-* add_index
-* identical
-* reduced
-
 Release 0.16.0
 ---------------
 * compose_k

data/docs/FUNCTIONS.md

@@ -14,6 +14,7 @@ Function
 * [F](http://ramdajs.com/docs/#F)
 * [T](http://ramdajs.com/docs/#T)
 * [`__`](http://ramdajs.com/docs/) - first function call should have all arguments `g(__2, __)(1, 3)`, this means that it doesn't support `g(__, 2)(1)(3)`, `g(__, 2)(1, 3)` and `g(__, 2)(__, 3)(1)`
+* [add_index](http://ramdajs.com/docs/#addIndex)
 * [always](http://ramdajs.com/docs/#always)
 * [ap](http://ramdajs.com/docs/#ap)
 * [apply](http://ramdajs.com/docs/#apply)
@@ -93,6 +94,7 @@ List
 * [range](http://ramdajs.com/docs/#range)
 * [reduce](http://ramdajs.com/docs/#reduce)
 * [reduce_right](http://ramdajs.com/docs/#reduceRight)
+* [reduced](http://ramdajs.com/docs/#reduced)
 * [reject](http://ramdajs.com/docs/#reject)
 * [remove](http://ramdajs.com/docs/#remove)
 * [repeat](http://ramdajs.com/docs/#repeat)
@@ -196,6 +198,7 @@ Relation
 * [equals](http://ramdajs.com/docs/#equals)
 * [gt](http://ramdajs.com/docs/#gt)
 * [gte](http://ramdajs.com/docs/#gte)
+* [identical](http://ramdajs.com/docs/#identical)
 * [intersection](http://ramdajs.com/docs/#intersection)
 * [lt](http://ramdajs.com/docs/#lt)
 * [lte](http://ramdajs.com/docs/#lte)

data/lib/ramda/function.rb

@@ -11,6 +11,29 @@ module Ramda
     extend ::Ramda::Internal::Dispatchable
     extend ::Ramda::Internal::ClassWhichRespondTo
 
+    # Creates a new list iteration function from an existing one by
+    # adding two new parameters to its callback function:
+    # the current index, and the entire list.
+    #
+    # This would turn, for instance, R.map function into one that
+    # more closely resembles Array.prototype.map.
+    # Note that this will only work for functions in which the
+    # iteration callback function is the first parameter, and where
+    # the list is the last parameter. (This latter might be unimportant
+    # if the list parameter is not used.)
+    #
+    # ((a ... -> b) ... -> [a] -> *) -> (a ..., Int, [a] -> b) ... -> [a] -> *)
+    #
+    curried_method(:add_index) do |f|
+      curried_method_body(:add_index, f.arity) do |*args|
+        idx = -1
+        orig_reducer = args[0]
+        xs = args[-1]
+        new_reducer = ->(*reducer_args) { orig_reducer.call(*reducer_args, idx += 1, xs) }
+        f.call(new_reducer, *args[1..-1])
+      end
+    end
+
     # Returns a function that always returns the given value. Note that
     # for non-primitives the value returned is a reference to the original
     # value.

data/lib/ramda/internal/transducers/transducer.rb

@@ -0,0 +1,16 @@
+module Ramda
+  module Internal
+    module Transducers
+      # Container for transducer
+      class Transducer
+        attr_accessor :reduced
+        attr_accessor :value
+
+        # def initialize(reduced: false, value: nil)
+        #   @reduced = reduced
+        #   @value = value
+        # end
+      end
+    end
+  end
+end

data/lib/ramda/list.rb

@@ -507,7 +507,11 @@ module Ramda
     # ((a, b) -> a) -> a -> [b] -> a
     #
     curried_method(:reduce) do |f, acc, xs|
-      xs.reduce(acc, &f)
+      xs.reduce(acc) do |loc_acc, x|
+        res = f.call(loc_acc, x)
+        break res.value if res.is_a?(::Ramda::Internal::Transducers::Transducer) && res.reduced
+        res
+      end
     end
 
     # Returns a single item by iterating through the list, successively
@@ -523,7 +527,28 @@ module Ramda
     # ((a, b) -> a) -> a -> [b] -> a
     #
     curried_method(:reduce_right) do |f, acc_arg, xs|
-      xs.reverse.reduce(acc_arg) { |acc, x| f.call(x, acc) }
+      xs.reverse.reduce(acc_arg) do |acc, x|
+        res = f.call(x, acc)
+        break res.value if res.is_a?(::Ramda::Internal::Transducers::Transducer) && res.reduced
+        res
+      end
+    end
+
+    # Returns a value wrapped to indicate that it is the final value of
+    # the reduce and transduce functions. The returned value should be
+    # considered a black box: the internal structure is not guaranteed
+    # to be stable.
+    #
+    # Note: this optimization is unavailable to functions not explicitly
+    # listed above.
+    #
+    # a -> *
+    #
+    curried_method(:reduced) do |x|
+      t = ::Ramda::Internal::Transducers::Transducer.new
+      t.reduced = true
+      t.value = x
+      t
     end
 
     # Returns a new list or string with the elements or characters in reverse order.
@@ -652,7 +677,12 @@ module Ramda
     # ((a, b) -> a) -> a -> [b] -> a
     #
     curried_method(:transduce) do |xf, rx, acc, xs|
-      xs.reduce(acc, &xf.call(rx))
+      f = xf.call(rx)
+      xs.reduce(acc) do |loc_acc, x|
+        res = f.call(loc_acc, x)
+        break res.value if res.is_a?(::Ramda::Internal::Transducers::Transducer) && res.reduced
+        res
+      end
     end
 
     # Builds a list from a seed value. Accepts an iterator function, which

data/lib/ramda/relation.rb

@@ -57,7 +57,7 @@ module Ramda
     # a -> b -> Boolean
     #
     curried_method(:equals) do |a, b|
-      a == b
+      a.eql?(b)
     end
 
     # Returns true if the first argument is greater than the second; false otherwise.
@@ -77,6 +77,15 @@ module Ramda
       a >= b
     end
 
+    # Returns true if its arguments are identical, false otherwise.
+    # Values are identical if they reference the same memory.
+    #
+    # a -> a -> Boolean
+    #
+    curried_method(:identical) do |a, b|
+      a.equal?(b)
+    end
+
     # Combines two lists into a set (i.e. no duplicates) composed of those elements
     # common to both lists. The order is preserved from the original array.
     #

data/lib/ramda/version.rb

@@ -1,3 +1,3 @@
 module Ramda
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.15.0'.freeze
 end

data/spec/ramda/function_spec.rb

@@ -25,6 +25,84 @@ describe Ramda::Function do
     end
   end
 
+  context '#add_index' do
+    describe 'unary functions like `map`' do
+      let(:times2) { proc { |x| x * 2 } }
+      let(:add_index_param) { proc { |x, idx| x + idx } }
+      let(:square_ends) do
+        proc do |x, idx, xs|
+          idx == 0 || idx == xs.size - 1 ? x * x : x
+        end
+      end
+      let(:map_indexed) { R.add_index(R.map) }
+
+      it 'works just like a normal map' do
+        expect(map_indexed.call(times2, [1, 2, 3, 4])).to eq([2, 4, 6, 8])
+      end
+
+      it 'passes the index as a second parameter to the callback' do
+        expect(map_indexed.call(add_index_param, [8, 6, 7, 5, 3, 0, 9]))
+          .to eq([8, 7, 9, 8, 7, 5, 15]); # [8 + 0, 6 + 1...]
+      end
+
+      it 'passes the entire list as a third parameter to the callback' do
+        expect(map_indexed.call(square_ends, [8, 6, 7, 5, 3, 0, 9])).to eq([64, 6, 7, 5, 3, 0, 81])
+      end
+
+      xit 'acts as a curried function' do
+        make_square_ends = map_indexed.call(square_ends)
+        expect(make_square_ends.call([8, 6, 7, 5, 3, 0, 9])).to eq([64, 6, 7, 5, 3, 0, 81])
+      end
+    end
+
+    describe 'binary functions like `reduce`' do
+      let(:reduce_indexed) { R.add_index(R.reduce); }
+      let(:times_indexed) { proc { |tot, num, idx| tot + (num * idx); }; }
+      let(:objectify) do
+        proc { |acc, elem, idx|
+          acc[elem] = idx
+          acc
+        }
+      end
+
+      it 'passes the index as a third parameter to the predicate' do
+        expect(reduce_indexed.call(times_indexed, 0, [1, 2, 3, 4, 5])).to eq(40)
+        expect(reduce_indexed.call(objectify, {}, [:a, :b, :c, :d, :e]))
+          .to eq(a: 0, b: 1, c: 2, d: 3, e: 4)
+      end
+
+      it 'passes the entire list as a fourth parameter to the predicate' do
+        list = [1, 2, 3]
+        reduce_indexed.call(lambda { |acc, _x, _idx, ls|
+          expect(ls).to eq(list)
+          acc
+        }, 0, list)
+      end
+    end
+
+    describe 'works with functions like `all` that do not typically have index applied' do
+      let(:all_indexed) { R.add_index(R.all) }
+      let(:super_diagonal) { all_indexed.call(R.gt) }
+
+      it 'passes the index as a second parameter' do
+        expect(super_diagonal.call([8, 6, 5, 4, 9]))
+          .to be_truthy # 8 > 0, 6 > 1, 5 > 2, 4 > 3, 9 > 5
+        expect(super_diagonal.call([8, 6, 1, 3, 9]))
+          .to be_falsey # 1 !> 2, 3 !> 3
+      end
+    end
+
+    describe 'works with arbitrary user-defined functions' do
+      let(:map_filter) { proc { |m, f, list| R.filter(R.compose(f, m), list); } }
+      let(:map_filter_indexed) { R.add_index(map_filter) }
+
+      it 'passes the index as an additional parameter' do
+        expect(map_filter_indexed.call(R.multiply, R.gt(R.__, 13), [8, 6, 7, 5, 3, 0, 9]))
+          .to eq([7, 5, 9]); # 2 * 7 > 13, 3 * 5 > 13, 6 * 9 > 13
+      end
+    end
+  end
+
   context '#always' do
     it 'from docs' do
       str = 'Tee'

data/spec/ramda/list_spec.rb

@@ -537,6 +537,34 @@ describe Ramda::List do
     end
   end
 
+  context '#reduced' do
+    it 'wraps a value' do
+      # // white box test.
+      v = {}
+      expect(R.reduced(v).value).to be(v)
+    end
+
+    it 'flags value as reduced' do
+      # // white box test.
+      expect(R.reduced({}).reduced).to be_truthy
+    end
+
+    it 'short-circuits reduce' do
+      # // black box test.
+      expect(
+        R.reduce(
+          lambda { |acc, v|
+            result = acc + v
+            result = R.reduced(result) if result >= 10
+            result
+          },
+          0,
+          [1, 2, 3, 4, 5]
+        )
+      ).to eq(10)
+    end
+  end
+
   context '#reduce_right' do
     def avg
       ->(a, b) { (a + b) / 2 }

data/spec/ramda/relation_spec.rb

@@ -77,6 +77,17 @@ describe Ramda::Relation do
     end
   end
 
+  context '#identical' do
+    it 'from docs' do
+      o = {}
+      expect(R.identical(o, o)).to be_truthy
+      expect(R.identical(1, 1)).to be_truthy
+      expect(R.identical(1, '1')).to be_falsey
+      expect(R.identical([], [])).to be_falsey
+      expect(R.identical(nil, nil)).to be_truthy
+    end
+  end
+
   context '#intersection' do
     it 'from docs' do
       expect(r.intersection([1, 2, 3, 4], [7, 6, 5, 4, 3])).to eq([3, 4])

data/spec/ramda_spec.rb

@@ -17,6 +17,7 @@ describe Ramda do
   r(:T)
   r(:__)
   r(:add)
+  r(:add_index)
   r(:adjust)
   r(:all)
   r(:all_pass)
@@ -80,6 +81,7 @@ describe Ramda do
   r(:has)
   r(:has_in)
   r(:head)
+  r(:identical)
   r(:identity)
   r(:if_else)
   r(:inc)
@@ -154,6 +156,7 @@ describe Ramda do
   r(:props)
   r(:range)
   r(:reduce)
+  r(:reduced)
   r(:reduce_right)
   r(:reject)
   r(:remove)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ramda-ruby
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Vadim Lazebny
@@ -47,6 +47,7 @@ files:
 - lib/ramda/internal/transducers/filter_transdurer.rb
 - lib/ramda/internal/transducers/map_transducer.rb
 - lib/ramda/internal/transducers/take_transducer.rb
+- lib/ramda/internal/transducers/transducer.rb
 - lib/ramda/list.rb
 - lib/ramda/logic.rb
 - lib/ramda/math.rb