functional-ruby 0.7.7 → 1.0.0

data/spec/functional/record_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+require_relative 'abstract_struct_shared'
+
+module Functional
+
+  describe Record do
+
+    let!(:expected_fields){ [:a, :b, :c] }
+    let!(:expected_values){ [42, nil, nil] }
+
+    let(:struct_class) { Record.new(*expected_fields) }
+    let(:struct_object) { struct_class.new(struct_class.fields.first => 42) }
+    let(:other_object) { struct_class.new(struct_class.fields.first => Object.new) }
+
+    it_should_behave_like :abstract_struct
+
+    context 'definition' do
+
+      it 'registers the new class with Record when given a string name' do
+        Record.new('Foo', :foo, :bar, :baz)
+        expect(defined?(Record::Foo)).to eq 'constant'
+      end
+
+      it 'default all fields values to nil' do
+        fields = [:foo, :bar, :baz]
+        clazz = Record.new(*fields)
+        
+        record = clazz.new
+
+        fields.each do |field|
+          expect(record.send(field)).to be_nil
+        end
+      end
+
+      it 'sets initial values based on values given at object construction' do
+        clazz = Record.new(:foo, :bar, :baz)
+        record = clazz.new(foo: 1, bar: 2, baz: 3)
+
+        expect(record.foo).to eq 1
+        expect(record.bar).to eq 2
+        expect(record.baz).to eq 3
+      end
+
+      it 'defaults fields to values given during class creation' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          default :foo, 42
+          default :bar, 'w00t!'
+        end
+
+        record = clazz.new
+        expect(record.foo).to eq 42
+        expect(record.bar).to eq 'w00t!'
+        expect(record.baz).to be_nil
+      end
+
+      it 'overrides default values with values provided at object construction' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          default :foo, 42
+          default :bar, 'w00t!'
+          default :baz, :bogus
+        end
+
+        record = clazz.new(foo: 1, bar: 2)
+
+        expect(record.foo).to eq 1
+        expect(record.bar).to eq 2
+        expect(record.baz).to eq :bogus
+      end
+
+      it 'duplicates default values when assigning to a new object' do
+        original = 'Foo'
+        clazz = Record.new(:foo, :bar, :baz) do
+          default :foo, original
+        end
+
+        record = clazz.new
+        expect(record.foo).to eq original
+        expect(record.foo.object_id).to_not eql original.object_id
+      end
+
+      it 'does not conflate defaults across record classes' do
+        clazz_foo = Record.new(:foo, :bar, :baz) do
+          default :foo, 42
+        end
+
+        clazz_matz = Record.new(:foo, :bar, :baz) do
+          default :foo, 'Matsumoto'
+        end
+
+        expect(clazz_foo.new.foo).to eq 42
+        expect(clazz_matz.new.foo).to eq 'Matsumoto'
+      end
+
+      it 'raises an exception when values for requred field are not provided' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          mandatory :foo
+        end
+
+        expect {
+          clazz.new(bar: 1)
+        }.to raise_exception(ArgumentError)
+      end
+
+      it 'raises an exception when required values are nil' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          mandatory :foo
+        end
+
+        expect {
+          clazz.new(foo: nil, bar: 1)
+        }.to raise_exception(ArgumentError)
+      end
+
+      it 'allows a field to be required and have a default value' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          mandatory :foo
+          default :foo, 42
+        end
+
+        expect {
+          clazz.new
+        }.to_not raise_exception
+
+        expect(clazz.new.foo).to eq 42
+      end
+
+      it 'allows multiple required fields to be specified together' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          mandatory :foo, :bar, :baz
+        end
+
+        expect {
+          clazz.new(foo: 1, bar: 2)
+        }.to raise_exception(ArgumentError)
+
+        expect {
+          clazz.new(bar: 2, baz: 3)
+        }.to raise_exception(ArgumentError)
+
+        expect {
+          clazz.new(foo: 1, bar: 2, baz: 3)
+        }.to_not raise_exception
+      end
+
+      it 'raises an exception if the default value for a require field is nil' do
+        clazz = Record.new(:foo, :bar, :baz) do
+          mandatory :foo
+          default :foo, nil
+        end
+
+        expect {
+          clazz.new
+        }.to raise_exception(ArgumentError)
+      end
+
+      it 'does not conflate default values across record classes' do
+        clazz_foo = Record.new(:foo, :bar, :baz) do
+          mandatory :foo
+        end
+
+        clazz_baz = Record.new(:foo, :bar, :baz) do
+          mandatory :baz
+        end
+
+        expect {
+          clazz_foo.new(foo: 42)
+        }.to_not raise_error
+
+        expect {
+          clazz_baz.new(baz: 42)
+        }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/functional/type_check_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+module Functional
+
+  describe TypeCheck do
+
+    context 'Type?' do
+
+      it 'returns true when value is of any of the types' do
+        target = 'foo'
+        expect(TypeCheck.Type?(target, String, Array, Hash)).to be true
+      end
+
+      it 'returns false when value is not of any of the types' do
+        target = 'foo'
+        expect(TypeCheck.Type?(target, Fixnum, Array, Hash)).to be false
+      end
+    end
+
+    context 'Type!' do
+
+      it 'returns the value when value is of any of the types' do
+        target = 'foo'
+        expect(TypeCheck.Type!(target, String, Array, Hash)).to be target
+      end
+
+      it 'raises an exception when value is not of any of the types' do
+        target = 'foo'
+        expect {
+          TypeCheck.Type!(target, Fixnum, Array, Hash)
+        }.to raise_error(TypeError)
+      end
+    end
+
+    context 'Match?' do
+
+      it 'returns true when value is an exact match for at least one of the types' do
+        target = 'foo'
+        expect(TypeCheck.Match?(target, String, Array, Hash)).to be true
+      end
+
+      it 'returns false when value is not an exact match for at least one of the types' do
+        target = 'foo'
+        expect(TypeCheck.Match?(target, Fixnum, Array, Hash)).to be false
+      end
+    end
+
+    context 'Match!' do
+
+      it 'returns the value when value is an exact match for at least one of the types' do
+        target = 'foo'
+        expect(TypeCheck.Match!(target, String, Array, Hash)).to eq target
+      end
+
+      it 'raises an exception when value is not an exact match for at least one of the types' do
+        target = 'foo'
+        expect {
+          expect(TypeCheck.Match!(target, Fixnum, Array, Hash)).to eq target
+        }.to raise_error(TypeError)
+      end
+    end
+
+    context 'Child?' do
+
+      it 'returns true if value is a class and is also a match or subclass of one of types' do
+        target = String
+        expect(TypeCheck.Child?(target, Comparable, Array, Hash)).to be true
+      end
+
+      it 'returns false if value is not a class' do
+        target = 'foo'
+        expect(TypeCheck.Child?(target, Comparable, Array, Hash)).to be false
+      end
+
+      it 'returns false if value is not a subclass/match for any of the types' do
+        target = Fixnum
+        expect(TypeCheck.Child?(target, Symbol, Array, Hash)).to be false
+      end
+    end
+
+    context 'Child!' do
+
+      it 'returns the value if value is a class and is also a match or subclass of one of types' do
+        target = String
+        expect(TypeCheck.Child!(target, Comparable, Array, Hash)).to eq target
+      end
+
+      it 'raises an exception if value is not a class' do
+        target = 'foo'
+        expect {
+          TypeCheck.Child!(target, Comparable, Array, Hash)
+        }.to raise_error(TypeError)
+      end
+
+      it 'raises an exception if value is not a subclass/match for any of the types' do
+        target = Fixnum
+        expect {
+          TypeCheck.Child!(target, Symbol, Array, Hash)
+        }.to raise_error(TypeError)
+      end
+    end
+  end
+end

data/spec/functional/union_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require_relative 'abstract_struct_shared'
+
+module Functional
+
+  describe Union do
+
+    let!(:expected_fields){ [:a, :b, :c] }
+    let!(:expected_values){ [42, nil, nil] }
+
+    let(:struct_class) { Union.new(*expected_fields) }
+    let(:struct_object) { struct_class.send(struct_class.fields.first, 42) }
+    let(:other_object) { struct_class.send(struct_class.fields.first, Object.new) }
+
+    it_should_behave_like :abstract_struct
+
+    context 'definition' do
+
+      it 'registers the new class with Record when given a string name' do
+        Union.new('Foo', :foo, :bar, :baz)
+        expect(defined?(Union::Foo)).to eq 'constant'
+      end
+    end
+
+    context 'factories' do
+
+      specify 'exist for each field' do
+        expected_fields.each do |field|
+          expect(struct_class).to respond_to(field)
+        end
+      end
+
+      specify 'require a value' do
+        expected_fields.each do |field|
+          expect(struct_class.method(field).arity).to eq 1
+        end
+      end
+
+      specify 'set the field appropriately' do
+        clazz = Union.new(:foo, :bar)
+        obj = clazz.foo(10)
+        expect(obj.field).to eq :foo
+      end
+
+      specify 'set the value appropriately' do
+        clazz = Union.new(:foo, :bar)
+        obj = clazz.foo(10)
+        expect(obj.value).to eq 10
+      end
+
+      specify 'return a frozen union' do
+        clazz = Union.new(:foo, :bar)
+        expect(clazz.foo(10)).to be_frozen
+      end
+
+      specify 'force #new to be private' do
+        clazz = Union.new(:foo, :bar)
+        expect {
+          clazz.new
+        }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'readers' do
+
+      specify '#field returns the appropriate field' do
+        clazz = Union.new(:foo, :bar)
+        expect(clazz.foo(10).field).to eq :foo
+      end
+
+      specify '#value returns the appropriate field' do
+        clazz = Union.new(:foo, :bar)
+        expect(clazz.foo(10).value).to eq 10
+      end
+
+      specify 'return the appropriate value for the set field' do
+        clazz = Union.new(:foo, :bar)
+        expect(clazz.foo(10).foo).to eq 10
+      end
+
+      specify 'return nil for the unset field' do
+        clazz = Union.new(:foo, :bar, :baz)
+        expect(clazz.foo(10).bar).to be_nil
+        expect(clazz.foo(10).baz).to be_nil
+      end
+    end
+
+    context 'predicates' do
+
+      specify 'exist for each field' do
+        expected_fields.each do |field|
+          predicate = "#{field}?".to_sym
+          expect(struct_object).to respond_to(predicate)
+          expect(struct_object.method(predicate).arity).to eq 0
+        end
+      end
+
+      specify 'return true for the set field' do
+        clazz = Union.new(:foo, :bar)
+        expect(clazz.foo(10).foo?).to be true
+      end
+
+      specify 'return false for the unset fields' do
+        clazz = Union.new(:foo, :bar, :baz)
+        expect(clazz.foo(10).bar?).to be false
+        expect(clazz.foo(10).baz?).to be false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,13 +7,15 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 
 SimpleCov.start do
-  project_name 'functional-ruby'
-  add_filter '/md/'
-  add_filter '/pkg/'
+  project_name 'Functional Ruby'
   add_filter '/spec/'
-  add_filter '/tasks/'
 end
 
+#require 'coveralls'
+#Coveralls.wear!
+#require 'codeclimate-test-reporter'
+#CodeClimate::TestReporter.start
+
 require 'functional'
 
 # import all the support files

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: functional-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Jerry D'Antonio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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: |2
@@ -32,41 +32,47 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
+- doc/memo.txt
+- doc/pattern_matching.txt
+- doc/protocol.txt
+- doc/record.txt
+- doc/thread_safety.txt
 files:
 - LICENSE
 - README.md
+- doc/memo.txt
+- doc/pattern_matching.txt
+- doc/protocol.txt
+- doc/record.txt
+- doc/thread_safety.txt
 - lib/functional.rb
-- lib/functional/behavior.rb
-- lib/functional/behaviour.rb
-- lib/functional/catalog.rb
-- lib/functional/collection.rb
-- lib/functional/inflect.rb
+- lib/functional/abstract_struct.rb
+- lib/functional/delay.rb
+- lib/functional/either.rb
+- lib/functional/memo.rb
+- lib/functional/method_signature.rb
+- lib/functional/option.rb
 - lib/functional/pattern_matching.rb
-- lib/functional/platform.rb
-- lib/functional/search.rb
-- lib/functional/sort.rb
-- lib/functional/utilities.rb
+- lib/functional/protocol.rb
+- lib/functional/protocol_info.rb
+- lib/functional/record.rb
+- lib/functional/type_check.rb
+- lib/functional/union.rb
 - lib/functional/version.rb
 - lib/functional_ruby.rb
-- md/behavior.md
-- md/catalog.md
-- md/collection.md
-- md/inflect.md
-- md/pattern_matching.md
-- md/platform.md
-- md/search.md
-- md/sort.md
-- md/utilities.md
-- spec/functional/behavior_spec.rb
-- spec/functional/catalog_spec.rb
-- spec/functional/collection_spec.rb
-- spec/functional/inflect_spec.rb
-- spec/functional/integration_spec.rb
+- spec/functional/abstract_struct_shared.rb
+- spec/functional/complex_pattern_matching_spec.rb
+- spec/functional/configuration_spec.rb
+- spec/functional/delay_spec.rb
+- spec/functional/either_spec.rb
+- spec/functional/memo_spec.rb
+- spec/functional/option_spec.rb
 - spec/functional/pattern_matching_spec.rb
-- spec/functional/platform_spec.rb
-- spec/functional/search_spec.rb
-- spec/functional/sort_spec.rb
-- spec/functional/utilities_spec.rb
+- spec/functional/protocol_info_spec.rb
+- spec/functional/protocol_spec.rb
+- spec/functional/record_spec.rb
+- spec/functional/type_check_spec.rb
+- spec/functional/union_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jdantonio/functional-ruby/
 licenses:
@@ -78,29 +84,33 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Erlang and Clojure inspired functional programming tools for Ruby.
+summary: Erlang, Clojure, and Haskell inspired functional programming tools to Ruby.
 test_files:
-- spec/functional/behavior_spec.rb
-- spec/functional/catalog_spec.rb
-- spec/functional/collection_spec.rb
-- spec/functional/inflect_spec.rb
-- spec/functional/integration_spec.rb
+- spec/functional/abstract_struct_shared.rb
+- spec/functional/complex_pattern_matching_spec.rb
+- spec/functional/configuration_spec.rb
+- spec/functional/delay_spec.rb
+- spec/functional/either_spec.rb
+- spec/functional/memo_spec.rb
+- spec/functional/option_spec.rb
 - spec/functional/pattern_matching_spec.rb
-- spec/functional/platform_spec.rb
-- spec/functional/search_spec.rb
-- spec/functional/sort_spec.rb
-- spec/functional/utilities_spec.rb
+- spec/functional/protocol_info_spec.rb
+- spec/functional/protocol_spec.rb
+- spec/functional/record_spec.rb
+- spec/functional/type_check_spec.rb
+- spec/functional/union_spec.rb
 - spec/spec_helper.rb
+has_rdoc: