funkr 0.0.25 → 0.0.40

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5649962b565534f862b38ae383b658c1a5488822f5827ec87c1eb811d5c3037
+  data.tar.gz: e56a95ae98fd9d7d58d8da6243f4788ef078727a46af8ddd230be2ff926bd5fd
+SHA512:
+  metadata.gz: 9f18403815d1715943156f2298babd16436a6979f75f86edbc8bb72e09e4b8f2a3d543a7c798ee61a4d21c42489afffad84cbba7d9a215dfaccc4da086d0f3a5
+  data.tar.gz: 8e82ba816b2a0b9fab4c1764a670364d137fbdf813699f5627448863a1565d8625a59b40f0273a5a265bc81fef6749afc4bfaaeefd9b22f415b0e5c4cd6c2f03

data/README

@@ -1,13 +1,16 @@
 Funkr brings some common functional programming constructs to ruby.
 
-In particular, it offers a simple mechanism to create Algebraïc Data
-Types and do pattern matching on them. For an exemple
-implementation, {Funkr::Types see provided classes}.
+In particular, it offers a simple mechanism to create Algebraic Data
+Types and do pattern matching on them. For an exemple implementation,
+see provided classes.
 
 It also provide modules for common categories (Monoid, Monad,
 Functor, Applicative ...), and extends common types to support
 categories they belongs to (Array, Hash ...). Categories can also be
-used with custom types, {Funkr::Types see provided classes}.
+used with custom types,  see provided classes.
 
 To get started, we recommand you to read the tests, and get feets wet
-with provided Algebraic Data Types (like Maybe).
+with provided Algebraic Data Types (like Maybe).
+
+Funkr is heavily used by its authors in production at
+http://www.atikteam.com/en to ensure better code reliability.

data/funkr.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "funkr/version"
 
@@ -9,8 +8,27 @@ Gem::Specification.new do |s|
   s.authors     = ["Paul Rivier"]
   s.email       = ["paul (dot) r (dot) ml (at) gmail (dot) com"]
   s.homepage    = "http://github.com/paul-r-ml/funkr"
-  s.summary     = %q{[EXPERIMENTAL] Some functionnal constructs for ruby}
-  s.description = %q{[EXPERIMENTAL] Some functionnal constructs for ruby, like ADT, functors, monads}
+  s.summary     = %q{Functionnal toolbox for Ruby}
+  s.description = <<EOF
+Funkr is a functionnal toolbox for the Ruby language.
+
+In particular, it offers a simple mechanism to create Algebraic Data
+Types and do pattern matching on them.
+
+-
+
+It also provide modules for common categories (Monoid, Monad,
+Functor, Applicative ...), and extends common types to support
+categories they belongs to (Array, Hash ...). Categories can also be
+used with custom types,  see provided classes.
+
+-
+
+Array and Hash classes are extended with methods providing correct
+behaviour with respect to categories. Enumerable module comes with
+a lot of useful functions for working with lists and sets. See the
+module documentation and the test suite for examples.
+EOF
 
   s.rubyforge_project = "funkr"
 
@@ -18,5 +36,5 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'rake', '~> 12.3'
 end

data/lib/funkr/adt/adt.rb

@@ -41,11 +41,20 @@ module Funkr
              @data.map(&:inspect).join(", ") )
     end
     
+    
+    def ==(o)
+      case o
+      when ADT then self.normal_form == o.normal_form
+      else false
+      end
+    end
+
+    def normal_form; [@const, *@data]; end
+
     private
 
     attr_reader :const, :data
     
-    def normal_form; [@const, *@data]; end
     
     def self.build_adt(constructs)
       constructs.each do |c,*d|

data/lib/funkr/adt/matcher.rb

@@ -14,7 +14,7 @@ module Funkr
       def self.build_matchers(constructs)
         @constructs = constructs
         constructs.each do |c|
-          name, *data = c
+          name, *_ = c
           define_method(name) do |&b|
             @undefined.delete(name)
             if @const == name then

data/lib/funkr/categories/applicative.rb

@@ -39,10 +39,6 @@ module Funkr
         proxy_comp(other){|a,b| a <=> b}
       end
        
-      def ==(other)
-        proxy_comp(other){|a,b| a == b}
-      end
-
       def <(other)
         proxy_comp(other){|a,b| a < b}
       end
@@ -59,6 +55,9 @@ module Funkr
         proxy_comp(other){|a,b| a >= b}
       end
 
+      def applicative_equal?(other)
+        proxy_comp(other){|a,b| a == b}
+      end
 
       private
 

data/lib/funkr/extensions.rb

@@ -1,4 +1,4 @@
-require 'funkr/extensions/fixnum'
+require 'funkr/extensions/integer'
 require 'funkr/extensions/array'
 require 'funkr/extensions/enumerable'
 require 'funkr/extensions/hash'

data/lib/funkr/extensions/array.rb

@@ -17,9 +17,10 @@ class Array
 
 
   # Array can be made an applicative functor, for example :
-  # f = Array.curry_lift_proc{|x,y| x + y}
-  # f.apply([0,4]).apply([5,7]) => [5, 7, 9, 11]
-  # f.apply([0,4]).apply([]) => []
+  #
+  #   f = Array.curry_lift_proc{|x,y| x + y}
+  #   f.apply([0,4]).apply([5,7]) => [5, 7, 9, 11]
+  #   f.apply([0,4]).apply([]) => []
   include Applicative
   extend Applicative::ClassMethods
 
@@ -49,10 +50,12 @@ class Array
   end
 
 
-  # Array is also a monad
   include Monad
   extend Monad::ClassMethods
 
+  # Array is also a monad
+  #
+  # [1,2].bind{|x| [3,4].bind{|y| x + y}} # => [4,5,5,6]
   def bind(&block)
     self.map(&block).flatten(1)
   end

data/lib/funkr/extensions/enumerable.rb

@@ -40,26 +40,27 @@ module Enumerable
     return [ inc, [] ]
   end
 
-  # Constitue des groupes disjoints de n éléments au plus
+  # builds up disjoint groups of n elements or less
   def groups_of(n)
     g = self.take(n)
     return [] if g.empty?
     [g] + self.drop(n).groups_of(n)
   end
 
-  # constitue des groupes de n éléments exactement, décalés de 1
+  # builds up sliding groups of exactly n elements
   def sliding_groups_of(n)
     return [] if self.size < n
     [ self.take(n) ] + self.drop(1).sliding_groups_of(n)
   end
 
-  # trouve l'index d'une séquence
+  # find the position of a sequence
+  #  [1,2,3,4,5,4,3,2,1].seq_index([4,3])  # => 5
   def seq_index(seq)
     self.sliding_groups_of(seq.size).index(seq)
   end
 
-  # Prend un prédicat p(x,y), et construit un tableau dans lequel tous
-  # les couples (a,b), tels que 'a' précède 'b', vérifient p(a,b).
+  # Takes a block predicate p(x,y) and builds an array of elements so
+  # that for any (a,b), a being before b in the list, p(a,b) holds.
   def make_uniq_by(&block)
     result = []
     self.each do |e|
@@ -68,8 +69,7 @@ module Enumerable
     return result
   end
 
-  # difference entre 2 tableaux, retourne le triplet [ [missing] , [intersection], [added] ]
-  # codé en impératif parce que inject est trop lent :(
+  # compare 2 enumerables, and returns [ [missing] , [intersection], [added] ]
   def diff_with(other, &block)
     m, i, a = [], [], []
     u_s = self.make_uniq_by(&block)

data/lib/funkr/extensions/{fixnum.rb → integer.rb}

@@ -1,6 +1,6 @@
 require "funkr/categories/monoid"
 
-class Fixnum
+class Integer
 
   include Funkr::Categories
   
@@ -10,6 +10,9 @@ class Fixnum
   def mplus(y)
     self + y
   end
+
+  def self.mzero
+    0
+  end
   
 end
-

data/lib/funkr/version.rb

@@ -1,3 +1,3 @@
 module Funkr
-  VERSION = "0.0.25"
+  VERSION = "0.0.40"
 end

data/test/test_extensions.rb

@@ -66,4 +66,9 @@ class TestExtensions < Test::Unit::TestCase
                  a.make_uniq_by{|x,y| x[:v] == y[:v]})
   end
 
+
+  def test_mconcat_integer
+    assert_equal(6, Integer.mconcat([1,2,3]))
+  end
+
 end

data/test/test_maybe.rb

@@ -16,7 +16,6 @@ class TestMaybe < Test::Unit::TestCase
 
   def test_map
     assert_equal(j(6), j(5).map{|v| v+1 })
-    assert_equal(n, j(5).map{|v| v+1})
   end
 
   def test_curry_lift
@@ -57,8 +56,10 @@ class TestMaybe < Test::Unit::TestCase
     assert_equal(j(true), j(3) < j(7))
     assert_equal(n, j(4) <=> n)
     assert_equal(n, n <=> j(2))
+    assert_equal(j(false), j(5).applicative_equal?(j(7)))
   end
 
+
   def test_unbox
     assert_equal(5, j(5).unbox)
     assert_equal(5, j(5).unbox(2))

metadata

@@ -1,49 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: funkr
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 25
-  version: 0.0.25
+version: !ruby/object:Gem::Version
+  version: 0.0.40
 platform: ruby
-authors: 
+authors:
 - Paul Rivier
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-06 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2020-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 2
-        version: 0.9.2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
   type: :development
-  version_requirements: *id001
-description: "[EXPERIMENTAL] Some functionnal constructs for ruby, like ADT, functors, monads"
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: |
+  Funkr is a functionnal toolbox for the Ruby language.
+
+  In particular, it offers a simple mechanism to create Algebraic Data
+  Types and do pattern matching on them.
+
+  -
+
+  It also provide modules for common categories (Monoid, Monad,
+  Functor, Applicative ...), and extends common types to support
+  categories they belongs to (Array, Hash ...). Categories can also be
+  used with custom types,  see provided classes.
+
+  -
+
+  Array and Hash classes are extended with methods providing correct
+  behaviour with respect to categories. Enumerable module comes with
+  a lot of useful functions for working with lists and sets. See the
+  module documentation and the test suite for examples.
+email:
 - paul (dot) r (dot) ml (at) gmail (dot) com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .travis.yml
+files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README
 - Rakefile
@@ -61,8 +68,8 @@ files:
 - lib/funkr/extensions.rb
 - lib/funkr/extensions/array.rb
 - lib/funkr/extensions/enumerable.rb
-- lib/funkr/extensions/fixnum.rb
 - lib/funkr/extensions/hash.rb
+- lib/funkr/extensions/integer.rb
 - lib/funkr/types.rb
 - lib/funkr/types/container.rb
 - lib/funkr/types/failable.rb
@@ -74,37 +81,27 @@ files:
 - test/test_hash.rb
 - test/test_maybe.rb
 - test/test_simple_records.rb
-has_rdoc: true
 homepage: http://github.com/paul-r-ml/funkr
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: funkr
-rubygems_version: 1.3.7
+rubygems_version: 2.7.6.2
 signing_key: 
-specification_version: 3
-summary: "[EXPERIMENTAL] Some functionnal constructs for ruby"
+specification_version: 4
+summary: Functionnal toolbox for Ruby
 test_files: []
-