algebrick 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df5b658188ef94835725f056d1872942a1f10fe3
-  data.tar.gz: 5ac342bdfaaa354e8bf9575c25f1e06105170d18
+  metadata.gz: c10eb07ed10cdcc7fd01fda3b2dccf42786db60f
+  data.tar.gz: 72b0ecfd3d3ce1bc20c5683adeabb3d2b5915bfe
 SHA512:
-  metadata.gz: 1207c3040b5d32c3d64cc47c29f9bccb83a979600cc9dc169d1424b6514297bc3c844bfa12e5d851663f08382019cdf948a85397e4363f21b4f835756c92235a
-  data.tar.gz: af70a94f628feb94b59995adc5d6740cafdddf655a4c560f25e788c31f758138e21a6617abff047fc7d195176cf5357b7e9a65decb25916c0176d240b0f0eeb8
+  metadata.gz: 3d1dfceee22b44ed971953d37d3cb9e8e5caf03a2cdbda3be251c9e778f1a5e3ae7be41f2dfc17f3ea1ba7dc63f5a908ff481571957fe18b6267d4670f8d8be7
+  data.tar.gz: a0ed769069be44d01001a2657a07db0aa3ad3d184afb290d38bc2a82c0c72237737867f972380cc496689f4ee9169f1b3b6081eea7a6a792976c1a10b1621f7c

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/pitr-ch/algebrick.png?branch=master)](https://travis-ci.org/pitr-ch/algebrick)
 
-Typed structs on steroids based on algebraic types and pattern matching seamlessly integrating with standard Ruby features.
+It's a gem providing **algebraic types** and **pattern matching** seamlessly integrates with standard features Ruby.
 
 -   Documentation: <http://blog.pitr.ch/algebrick>
 -   Source: <https://github.com/pitr-ch/algebrick>
@@ -10,11 +10,8 @@ Typed structs on steroids based on algebraic types and pattern matching seamless
 
 ## What is it good for?
 
--   Well defined data structures.
--   Actor messages see [new Actor implementation](http://rubydoc.info/gems/concurrent-ruby/Concurrent/Actress) 
-    in [concurrent-ruby](concurrent-ruby.com).
--   Describing message protocols in message-based cross-process communication. 
-    Algebraic types play nice with JSON de/serialization.
+-   Defining data structures.
+-   Algebraic types play nice with JSON serialization and deserialization. It is ideal for defining message-based cross-process communication.
 -   and more...
 
 ## Quick example

data/README_FULL.md

@@ -1,6 +1,6 @@
 # Algebrick
 
-Typed structs on steroids based on algebraic types and pattern matching seamlessly integrating with standard Ruby features.
+It's a gem providing **algebraic types** and **pattern matching** and seamlessly integrating with standard features of Ruby.
 
 -   Documentation: <http://blog.pitr.ch/algebrick>
 -   Source: <https://github.com/pitr-ch/algebrick>

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/doc/format.rb

@@ -3,8 +3,9 @@ require 'bundler/setup'
 require 'pry'
 require 'pp'
 
+root        = File.dirname(File.expand_path(Process.argv0))
 input_paths = if ARGV.empty?
-                Dir.glob("#{File.dirname(__FILE__)}/*.in.rb")
+                Dir.glob("#{root}/*.in.rb")
               else
                 ARGV
               end.map { |p| File.expand_path p }
@@ -12,7 +13,7 @@ input_paths = if ARGV.empty?
 input_paths.each_with_index do |input_path, i|
 
   pid = fork do
-    require_relative 'init.rb'
+    require File.join(root, 'init.rb')
 
     begin
       output_path = input_path.gsub /\.in\.rb$/, '.out.rb'

data/doc/json.out.rb

@@ -20,7 +20,7 @@ require 'algebrick/serializer'                     # => true
 require 'multi_json'                               # => true
 
 # Prepare a message for sending.
-serializer   = Algebrick::Serializer.new           # => #<Algebrick::Serializer:0x007fab42bdf6d8>
+serializer   = Algebrick::Serializer.new           # => #<Algebrick::Serializer:0x007fafcc96f6a8>
 request      = CreateUser[User['root', 'lajDh4']]
     # => CreateUser[User[login: root, password: lajDh4]]
 raw_request  = MultiJson.dump serializer.dump(request)

data/doc/pattern_matching.in.rb

@@ -107,6 +107,34 @@ match BTree[0, Empty, BTree[1, Empty, Empty]],
         { left: left, value: value, right: right }
       end)
 
+# It also supports matching against Ruby Arrays
+Array.() === []
+Array.() === [1]
+Array.(*any) === []
+Array.(*any) === [1]
+Array.(*any) === [1, 2]
+Array.(1, *any) === []
+Array.(1, *any) === [1]
+Array.(1, *any) === [1, 2]
+
+match [],
+      on(~Array.to_m) { |v| v }
+match [],
+      on(~Array.()) { |v| v }
+match [1, 2],
+      on(~Array.(*any)) { |v| v }
+match [1, 2],
+      on(~Array.(*any)) { |(v, _)| v }
+match [1, 2, 3],
+      on(Array.(any, *~any)) { |v| v }
+match [:first, 1, 2, 3],
+      on(Array.(:first, ~any, *any)) { |v| v }
+match [:+, 1, 2, :foo, :bar],
+      (on Array.(:+, ~Integer.to_m, ~Integer.to_m, *~any) do |int1, int2, rest|
+        { sum: int1 + int2, rest: rest }
+      end)
+
+
 # There is also a more funky syntax for matching
 # using #>, #>> and Ruby 1.9 syntax for lambdas `-> {}`.
 match Leaf[1],

data/doc/pattern_matching.out.rb

@@ -113,6 +113,34 @@ match BTree[0, Empty, BTree[1, Empty, Empty]],
         { left: left, value: value, right: right }
       end)                                         # => {:left=>nil, :value=>0, :right=>1}
 
+# It also supports matching against Ruby Arrays
+Array.() === []                                    # => true
+Array.() === [1]                                   # => false
+Array.(*any) === []                                # => true
+Array.(*any) === [1]                               # => true
+Array.(*any) === [1, 2]                            # => true
+Array.(1, *any) === []                             # => false
+Array.(1, *any) === [1]                            # => true
+Array.(1, *any) === [1, 2]                         # => true
+
+match [],
+      on(~Array.to_m) { |v| v }                    # => []
+match [],
+      on(~Array.()) { |v| v }                      # => []
+match [1, 2],
+      on(~Array.(*any)) { |v| v }                  # => [1, 2]
+match [1, 2],
+      on(~Array.(*any)) { |(v, _)| v }             # => 1
+match [1, 2, 3],
+      on(Array.(any, *~any)) { |v| v }             # => [2, 3]
+match [:first, 1, 2, 3],
+      on(Array.(:first, ~any, *any)) { |v| v }     # => 1
+match [:+, 1, 2, :foo, :bar],
+      (on Array.(:+, ~Integer.to_m, ~Integer.to_m, *~any) do |int1, int2, rest|
+        { sum: int1 + int2, rest: rest }
+      end)                                         # => {:sum=>3, :rest=>[:foo, :bar]}
+
+
 # There is also a more funky syntax for matching
 # using #>, #>> and Ruby 1.9 syntax for lambdas `-> {}`.
 match Leaf[1],

data/lib/algebrick/matchers/abstract.rb

@@ -34,11 +34,13 @@ module Algebrick
 
       alias_method :>>, :>
 
-      def ~
+      def assign!
         @assign = true
         self
       end
 
+      alias_method :~, :assign!
+
       def &(matcher)
         And.new self, matcher
       end
@@ -55,6 +57,10 @@ module Algebrick
         @assign
       end
 
+      def assigned?
+        !!@value
+      end
+
       def matched?
         @matched
       end

data/lib/algebrick/matchers/any.rb

@@ -27,6 +27,15 @@ module Algebrick
         other.kind_of? self.class
       end
 
+      # transforms *any to many
+      def to_a
+        if assigned?
+          super
+        else
+          [Matchers::Many.new.tap { |m| m.assign! if assign? }]
+        end
+      end
+
       protected
 
       def matching?(other)

data/lib/algebrick/matchers/array.rb

@@ -24,6 +24,7 @@ module Algebrick
       def initialize(*matchers)
         super()
         @matchers = matchers
+        raise ArgumentError, 'many can be only last' if @matchers[0..-2].any? { |v| v.is_a?(Many) }
       end
 
       def children
@@ -39,12 +40,21 @@ module Algebrick
             self.matchers == other.matchers
       end
 
+      def rest?
+        matchers.last.is_a?(Many)
+      end
+
       protected
 
       def matching?(other)
-        other.kind_of? ::Array and
-            matchers.size == other.size and
-            matchers.each_with_index.all? { |m, i| m === other[i] }
+        return false unless other.kind_of? ::Array
+        if rest?
+          matchers[0..-2].zip(other).all? { |m, v| m === v } and
+              matchers.last === other[(matchers.size-1)..-1]
+        else
+          matchers.size == other.size and
+              matchers.zip(other).all? { |m, v| m === v }
+        end
       end
     end
 
@@ -53,5 +63,7 @@ module Algebrick
         Matchers::Array.new *matchers
       end
     end
+
+    # TODO consider: class Array; def ===(other); zip(other).all? {|m,v| m===v}; end; end
   end
 end

data/lib/algebrick/matchers/many.rb

@@ -0,0 +1,37 @@
+#  Copyright 2013 Petr Chalupa <git+algebrick@pitr.ch>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module Algebrick
+  module Matchers
+    class Many < Abstract
+      def children
+        []
+      end
+
+      def to_s
+        "*#{assign_to_s}any"
+      end
+
+      def ==(other)
+        other.kind_of? self.class
+      end
+
+      protected
+
+      def matching?(other)
+        true
+      end
+    end
+  end
+end

data/lib/algebrick/matchers.rb

@@ -21,6 +21,7 @@ module Algebrick
     require 'algebrick/matchers/or'
     require 'algebrick/matchers/not'
     require 'algebrick/matchers/any'
+    require 'algebrick/matchers/many'
     require 'algebrick/matchers/wrapper'
     require 'algebrick/matchers/array'
     require 'algebrick/matchers/product'

data/lib/algebrick/types.rb

@@ -49,10 +49,10 @@ module Algebrick
         end
       end
 
-      def self.empty
-        LinkedListEmpty
+      def next?
+        self.next != EmptyLinkedList
       end
-    end
+     end
   end
 
   include Types

data/lib/algebrick.rb

@@ -21,6 +21,26 @@
 # TODO gemmify reclude
 # TODO gemmify typecheck
 
+# TODO add default field values
+# Person = Algebrick.type do
+#   fields! age:     Integer,
+#           address: [Maybe[String], None]#,
+#           # address: Maybe[String] >> None
+#
+#   field! :age, Integer
+#   field! :address, Maybe[String], None
+# end
+# Person[1]
+# Person[1, Some['Praha']]
+
+# TODO use benevolent deserializer to allow:
+# Person[address: Address[name: 'asd']]
+# Person[address: { name: 'asd' }]
+
+# TODO maybe should behave as monad
+
+# TODO anonymous types ? missing tests
+
 
 # Provides Algebraic types and pattern matching
 #
@@ -47,4 +67,5 @@ module Algebrick
   require 'algebrick/matchers'
   require 'algebrick/types'
 
+  # require 'algebrick/serializer'
 end

data/spec/algebrick_test.rb

@@ -511,6 +511,8 @@ Named[
        ~Empty.to_m,
        any,
        ~any,
+       Array.(*any),
+       Array.(*~any),
        Leaf.(any),
        ~Leaf.(any),
        Node.(Leaf.(any), any),
@@ -555,6 +557,11 @@ Named[
       Array.(1)                            => [1],
       Array.(Empty, Leaf.(-> v { v > 0 })) => [Empty, Leaf[1]],
       Array.(TrueClass)                    => [true],
+      Array.(1, *any)                      => [1],
+      Array.(1, *any)                      => [1, 2],
+      Array.(1, *any)                      => [1, 2, 3],
+      Array.(*any)                         => [1],
+      Array.(*any)                         => [1, 2],
 
       BTree.(value: any)                   => BTree[1, Empty, Empty],
       BTree.(value: 1)                     => BTree[1, Empty, Empty],
@@ -635,6 +642,26 @@ Named[
           (on ~Leaf do |v|
             v.must_equal Leaf[1]
           end)
+
+    match [1, 2],
+          (on ~Array.(*any) do |(left, right)|
+            [left, right].must_equal [1, 2]
+          end)
+
+    match [1, 2],
+          (on ~Array.to_m do |(left, right)|
+            [left, right].must_equal [1, 2]
+          end)
+
+    match [1, 2],
+          (on ~Array.(*any) do |(left, right)|
+            [left, right].must_equal [1, 2]
+          end)
+
+    match [1, 2],
+          (on (Array.(*~any)) do |(left, right)|
+            [left, right].must_equal [1, 2]
+          end)
   end
 
   describe 'list' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algebrick
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Petr Chalupa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -194,6 +194,7 @@ files:
 - lib/algebrick/matchers/any.rb
 - lib/algebrick/matchers/array.rb
 - lib/algebrick/matchers/atom.rb
+- lib/algebrick/matchers/many.rb
 - lib/algebrick/matchers/not.rb
 - lib/algebrick/matchers/or.rb
 - lib/algebrick/matchers/product.rb