typed_attr 0.0.1 → 0.1.0

data/.rspec

@@ -1 +1 @@
--f d --color
+--color

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch('.rspec')               { "spec" }
+end
+

data/README.md

@@ -21,9 +21,9 @@ Or install it yourself as:
 TypedAttr simplifies typed functional programming in Ruby.
 
 The creation of data types is critical to functional programming.
-Ruby does not enforce any typing of attributes or parameters.
+Ruby does not enforce any typing of object attributes or method parameters.
 
-We introduce a class macro "typed_attr".  It constructs an #initialize method
+TypedAttr introduces a class macro "typed_attr".  It constructs an #initialize method
 given a list of attributes and their expected types.
 
 Example:
@@ -44,11 +44,21 @@ Methods can use "typecheck" to perform checks on arguments:
     m(-1, "string") # => raise TypeError
     m(2, "string")  # => "stringstring"
 
+The type assertions use the #=== matching operator.
+
 Composite Types can be constructed to match deeper data structures:
 
     h = { "a" => 1, "b" => :symbol }
     typecheck h, Hash.of(String.with(Integer|Symbol))
 
+Composite types create dynamic Modules that redefine the #=== pattern matching operator.
+Thus composite types can be used in "case when" clauses:
+
+    case h
+    when Hash.of(String.with(Users))  ...
+    when Hash.of(Symbol.with(Object)) ...
+    end
+
 ## Contributing
 
 1. Fork it

data/lib/typed_attr/composite_type.rb

@@ -1,9 +1,11 @@
 class Module
   class CompositeType < self
-    def initialize a, b
+    def initialize a, b = nil
       @a = a
       @b = b
     end
+    def _a; @a; end
+    def _b; @b; end
     def to_s
       @to_s ||= "#{@a}.#{op}(#{@b})".freeze
     end
@@ -37,20 +39,57 @@ class Module
     PairType.new(self, t)
   end
 
-  class AlternateType < CompositeType
+  class DisjunctiveType < CompositeType
     def === x
        @a === x or @b === x
     end
     def to_s
-      @to_s ||= "#{@a}|#{@b}".freeze
+      @to_s ||= "(#{@a}|#{@b})".freeze
     end
   end
 
-  # Constructs a type of Pairs.
+  # Constructs a type which can be A OR B.
   #
   # Array.of(String|Integer)
   def | t
-    AlternateType.new(self, t)
+    DisjunctiveType.new(self, t)
+  end
+
+  class ConjunctiveType < CompositeType
+    def === x
+       @a === x and @b === x
+    end
+    def to_s
+      @to_s ||= "(#{@a}&#{@b})".freeze
+    end
+  end
+
+  # Constructs a type which must be A AND B.
+  #
+  # Array.of(Positive&Integer)
+  def & t
+    ConjunctiveType.new(self, t)
+  end
+
+  class NegativeType < CompositeType
+    def === x
+       ! @a === x
+    end
+    def to_s
+      @to_s ||= "(~#{@a})".freeze
+    end
+  end
+
+  # Constructs a type which must not be A.
+  #
+  # Array.of(~NilClass)
+  def ~@
+    case self
+    when NegativeType
+      self.a
+    else
+      NegativeType.new(self)
+    end
   end
 end
 
@@ -74,7 +113,7 @@ end
 
 module Negative
   def self.=== x
-    n = Numericlike == x and n < 0
+    n = Numericlike === x and n < 0
   end
 end
 

data/lib/typed_attr/version.rb

@@ -1,3 +1,3 @@
 module TypedAttr
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/typed_attr.rb

@@ -1,55 +1,56 @@
+require 'typed_attr/version'
 require 'typed_attr/enumerable' # map_with_index
 
-  # Typed Attributes.
-  module TypedAttr
-    def self.included target
-      super
-      target.extend(ModuleMethods)
+# Typed Attributes.
+module TypedAttr
+  def self.included target
+    super
+    target.extend(ModuleMethods)
+  end
+
+  # typecheck value, pattern, ...
+  #
+  # Check that every pattern === value.
+  # Raise TypeError if any do not.
+  # Returns value.
+  def typecheck value, *checks
+    unless checks.all? { | check | check === value }
+      raise TypeError, "expected (#{checks * ', '}), given #{value}"
     end
+    value
+  end
 
-    # typecheck value, pattern, ...
-    #
-    # Check that every pattern === value.
-    # Raise TypeError if any do not.
-    # Returns value.
-    def typecheck value, *checks
-      unless checks.all? { | check | check === value }
-        raise TypeError, "expected (#{checks * ', '}), given #{value}"
-      end
-      value
+  module ModuleMethods
+    OPTIONS = { }
+    def typed_attr_option opts
+      OPTIONS.update(opts)
     end
 
-    module ModuleMethods
-      OPTIONS = { }
-      def typed_attr_option opts
-        OPTIONS.update(opts)
+    # typed_attr name: Type, ...
+    # typed_attr Type, :name, ...
+    #
+    # Generates an initialize method that will accept each :name as a typechecked positional argument.
+    # Unspecified arguments are undefined and not typechecked.
+    # Additional arguments are ignored.
+    def typed_attr *types_and_names
+      if h = types_and_names.first and Hash === h and types_and_names.size == 1
+        names = h.keys
+        name_to_type = h
+      else
+      name_to_type = Hash[*types_and_names.reverse]
+      names =
+        (0 .. types_and_names.size).to_a.
+        keep_if(&:odd?).
+        map { | i | types_and_names[i] }
       end
-
-      # typed_attr name: Type, ...
-      # typed_attr Type, :name, ...
-      #
-      # Generates an initialize method that will accept each :name as a typechecked positional argument.
-      # Unspecified arguments are undefined and not typechecked.
-      # Additional arguments are ignored.
-      def typed_attr *types_and_names
-        if h = types_and_names.first and Hash === h and types_and_names.size == 1
-          names = h.keys
-          name_to_type = h
-        else
-        name_to_type = Hash[*types_and_names.reverse]
-        names =
-          (0 .. types_and_names.size).to_a.
-          keep_if(&:odd?).
-          map { | i | types_and_names[i] }
-        end
-        expr = <<"END"
+      expr = <<"END"
 def initialize *__args
   initialize_typed_attrs *__args
 end
 
 def initialize_typed_attrs *__args
   #{names.map_with_index do | name, i |
-    "@#{name} = __args[#{i}] if __args.size > #{i}"
+  "@#{name} = __args[#{i}] if __args.size > #{i}"
   end * "\n  "}
   #{"binding.pry if #{OPTIONS[:pry_if] || true}" if OPTIONS[:pry]}
   #{names.map_with_index do | name, i |
@@ -59,12 +60,11 @@ def initialize_typed_attrs *__args
 end
 attr_reader #{names.map(&:to_sym).map(&:inspect) * ', '}
 END
-        $stderr.puts "#{self}\n#{expr}" if OPTIONS[:debug]
-        class_eval expr
-      end
+      $stderr.puts "#{self}\n#{expr}" if OPTIONS[:debug]
+      class_eval expr
     end
   end
-
+end
 
 # Pollute Object.
 Object.send(:include, TypedAttr)

data/spec/lib/typed_attr/composite_type_spec.rb

@@ -74,7 +74,7 @@ describe Class::CompositeType do
     end
   end
 
-  context "AlternateType" do
+  context "DisjunctiveType" do
     it "should not fail when empty" do
       v = [ ]
       (Array.of(String|Integer) === v).should === true
@@ -91,6 +91,28 @@ describe Class::CompositeType do
     end
   end
 
+  context "ConjunctiveType" do
+    it "should not fail when empty" do
+      v = [ ]
+      (Array.of(Positive & Integer) === v).should === true
+    end
+
+    it "should not fail" do
+      v = [ 1, 2 ]
+      (Array.of(Positive & Integer) === v).should === true
+    end
+
+    it "should fail" do
+      v = [ 0, 1 ]
+      (Array.of(Positive & Integer) === v).should === false
+    end
+
+    it "should fail" do
+      v = [ 1, :symbol ]
+      (Array.of(Positive & Integer) === v).should === false
+    end
+  end
+
   context "Positive" do
     it "should be true for Numeric" do
       v = 1234
@@ -108,6 +130,23 @@ describe Class::CompositeType do
     end
   end
 
+  context "Negative" do
+    it "should be true for negative Numeric" do
+      v = -1234
+      (Negative === v).should == true
+    end
+
+    it "should be false for positive" do
+      v = 1234
+      (Negative === v).should be_false
+    end
+
+    it "should be false for non-Numeric" do
+      v = "a String"
+      (Negative === v).should be_false
+    end
+  end
+
   context "misc" do
     it "example 1" do
       h = { "a" => 1, "b" => :symbol }
@@ -120,7 +159,7 @@ describe Class::CompositeType do
     end
 
     it "should handle to_s" do
-      Hash.of(String.with(Integer|Symbol)).to_s.should == "Hash.of(String.with(Integer|Symbol))"
+      Hash.of(String.with(Integer|Symbol)).to_s.should == "Hash.of(String.with((Integer|Symbol)))"
     end
 
   end

data/spec/lib/typed_attr_spec.rb

@@ -29,15 +29,15 @@ describe TypedAttr do
   end
 
   context "typed_attr" do
-    Old = Class.new do
+    HashSyntax = Class.new do
       typed_attr String, :a, Numeric, :b
     end
-    New = Class.new do
+    ArraySyntax = Class.new do
       typed_attr a: String, b: Numeric
     end
 
-    [ Old, New ].each do | cls |
-      context "#{cls} syntax" do
+    [ HashSyntax, ArraySyntax ].each do | cls |
+      context "#{cls}" do
         it "should handle ()" do
           obj = cls.new
           obj.a.should == nil

data/typed_attr.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "simplecov", "~> 0.8"
   spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: typed_attr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Kurt Stephens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,10 +86,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Typed Attributes and Composite Types for Functional Programming in Ruby
 email:
 - ks.github@kurtstephens.com
@@ -90,6 +117,7 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -104,26 +132,33 @@ files:
 homepage: https://github.com/kstephens/typed_attr
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 891152326626141261
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 891152326626141261
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: ! 'typed_attr name: String, ...'
 test_files:
 - spec/lib/typed_attr/composite_type_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTlhNzIwY2U5N2E1ZDMyNzYwOWJlYWU3ODY5NDJiNjY4NWJhMjdjZA==
-  data.tar.gz: !binary |-
-    MGNiZTk2YTJhNzIyZjA1NGUzY2NkMGFhYjFmOTY4M2I1Yjk4ODFlMQ==
-SHA512:
-  metadata.gz: !binary |-
-    NTZiZWIyZmM4ZjZjZGNkMjMxZTdlODMyNTQwMzFhMjU1NDNhMDQwNDAxNmE0
-    MGU2MjU0ZWY5YjgwMzQyMjg3MTIxNDU5NTlmMTQzZWViOWE5YTAyOWNkOWYx
-    ODM4NTE3NjMzYWQ5MTg1MmM3ZTA1ODM0ZTk4NjRhNTY2ZDUyNGQ=
-  data.tar.gz: !binary |-
-    ODk0MTI3NWM0N2JlNGNiNDgzYWZkOWM1MTc3MmNhNGMxMTYwOTVjODQzN2Mx
-    OTNkYTdjM2FkMTJlZTU3ZmZhNzAyZjQ5M2ZhNzY1NjRmMGVjZDhkZjhlNDRh
-    OGJlNjY2NDQ2YWMzMDVmNDlkZTFjYTRiYjA4NWUxYzZkZGZhNjk=