typed_attr 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+-f d --color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typed_attr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kurt Stephens
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# TypedAttr
+
+Typed Attributes and Composite Types for Functional Programming in Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'typed_attr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typed_attr
+
+## Usage
+
+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.
+
+We introduce a class macro "typed_attr".  It constructs an #initialize method
+given a list of attributes and their expected types.
+
+Example:
+
+    require 'typed_attr'
+    class Account
+      typed_attr name: String, amount: Money
+    end
+    Account.new("Foo", Money.new(1234))
+
+Methods can use "typecheck" to perform checks on arguments:
+
+    def m x, y
+      typecheck x, Positive, Integer
+      typecheck y, String
+      y * x
+    end
+    m(-1, "string") # => raise TypeError
+    m(2, "string")  # => "stringstring"
+
+Composite Types can be constructed to match deeper data structures:
+
+    h = { "a" => 1, "b" => :symbol }
+    typecheck h, Hash.of(String.with(Integer|Symbol))
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/typed_attr/composite_type.rb

@@ -0,0 +1,88 @@
+class Module
+  class CompositeType < self
+    def initialize a, b
+      @a = a
+      @b = b
+    end
+    def to_s
+      @to_s ||= "#{@a}.#{op}(#{@b})".freeze
+    end
+  end
+
+  class ContainerType < CompositeType
+    def === x
+      @a === x and x.all?{|e| @b === e }
+    end
+    def op; 'of'; end
+  end
+
+  # Constructs a type of Enumeration of an element type.
+  #
+  # Array.of(String)
+  def of t
+    ContainerType.new(self, t)
+  end
+
+  class PairType < CompositeType
+    def === x
+      Enumerable === x and @a === x[0] and @b === x[1]
+    end
+    def op; 'with'; end
+  end
+
+  # Constructs a type of Pairs.
+  #
+  # Hash.of(String.with(Integer))
+  def with t
+    PairType.new(self, t)
+  end
+
+  class AlternateType < CompositeType
+    def === x
+       @a === x or @b === x
+    end
+    def to_s
+      @to_s ||= "#{@a}|#{@b}".freeze
+    end
+  end
+
+  # Constructs a type of Pairs.
+  #
+  # Array.of(String|Integer)
+  def | t
+    AlternateType.new(self, t)
+  end
+end
+
+
+module Numericlike
+  def self.=== x
+    case
+    when Numeric === x
+      x
+    when x.respond_to?(:to_numeric)
+      x.to_numeric
+    end
+  end
+end
+
+module Positive
+  def self.=== x
+    n = Numericlike === x and n > 0
+  end
+end
+
+module Negative
+  def self.=== x
+    n = Numericlike == x and n < 0
+  end
+end
+
+# Note: IO and StringIO do not share a common ancestor Module
+# that distingushes them as being capable of "IO".
+# So we create one here -- devdriven.com 2013/11/14
+require 'stringio'
+module IOable
+  ::IO.send(:include, self)
+  ::StringIO.send(:include, self)
+end

data/lib/typed_attr/enumerable.rb

@@ -0,0 +1,9 @@
+module Enumerable
+  # Not sure why this doesn't exist or
+  # where to put it.
+  def map_with_index
+    i = -1
+    map { | e | yield e, i += 1 }
+  end
+end
+

data/lib/typed_attr/version.rb

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

data/lib/typed_attr.rb

@@ -0,0 +1,72 @@
+require 'typed_attr/enumerable' # map_with_index
+
+  # 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
+
+    module ModuleMethods
+      OPTIONS = { }
+      def typed_attr_option opts
+        OPTIONS.update(opts)
+      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"
+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}"
+  end * "\n  "}
+  #{"binding.pry if #{OPTIONS[:pry_if] || true}" if OPTIONS[:pry]}
+  #{names.map_with_index do | name, i |
+    type = name_to_type[name]
+    "typecheck @#{name}, #{type} if __args.size > #{i}"
+  end * "\n  "}
+end
+attr_reader #{names.map(&:to_sym).map(&:inspect) * ', '}
+END
+        $stderr.puts "#{self}\n#{expr}" if OPTIONS[:debug]
+        class_eval expr
+      end
+    end
+  end
+
+
+# Pollute Object.
+Object.send(:include, TypedAttr)
+
+require 'typed_attr/composite_type'

data/spec/lib/typed_attr/composite_type_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+require 'typed_attr'
+
+describe Class::CompositeType do
+  context "Numericlike" do
+    let(:numeric_like) do
+      Class.new do
+        def to_numeric; -1234; end
+      end
+    end
+
+    it "should be true for Numeric" do
+      v = 1234
+      x = Numericlike === v
+      x.should == v
+    end
+
+    it "should be true for anything that responds to :to_numeric" do
+      v = numeric_like.new
+      x = Numericlike === v
+      x.should == -1234
+    end
+
+    it "should be false for non-Numeric" do
+      v = "a String"
+      v.respond_to?(:to_numeric).should be_false
+      (Numericlike === v).should be_false
+    end
+  end
+
+  context "ContainerType" do
+    it "should not fail when empty" do
+      typecheck [ ], Array.of(String)
+    end
+    it "should not fail with a matching element" do
+      typecheck [ "String" ], Array.of(String)
+    end
+    it "should fail when contains unmatching element" do
+      expect do
+        typecheck [ "String", 1234 ], Array.of(String)
+      end.to raise_error
+    end
+    it "should not fail when is not an Enumerable" do
+      expect do
+        typecheck 1234, Array.of(String)
+      end.to raise_error
+    end
+    it "should not fail when is not equvalent" do
+      expect do
+        typecheck [ ], Hash.of(String)
+      end.to raise_error
+    end
+  end
+
+  context "PairType" do
+    it "should not fail when empty" do
+      v = { }
+      typecheck v, Hash.of(String.with(Integer))
+    end
+
+    it "should not fail" do
+      v = { "foo" => 1 }
+      typecheck v, Hash.of(String.with(Integer))
+    end
+
+    it "should fail" do
+      v = { "foo" => :symbol }
+      (Hash.of(String.with(Integer)) === v).should == false
+    end
+
+    it "should fail" do
+      v = { :symbol => 2 }
+      (Hash.of(String.with(Integer)) === v).should == false
+    end
+  end
+
+  context "AlternateType" do
+    it "should not fail when empty" do
+      v = [ ]
+      (Array.of(String|Integer) === v).should === true
+    end
+
+    it "should not fail" do
+      v = [ "String", 1234 ]
+      (Array.of(String|Integer) === v).should === true
+    end
+
+    it "should fail" do
+      v = [ "String", 1234, :symbol ]
+      (Array.of(String|Integer) === v).should === false
+    end
+  end
+
+  context "Positive" do
+    it "should be true for Numeric" do
+      v = 1234
+      (Positive === v).should == true
+    end
+
+    it "should be false for negative" do
+      v = -1234
+      (Positive === v).should be_false
+    end
+
+    it "should be false for non-Numeric" do
+      v = "a String"
+      (Positive === v).should be_false
+    end
+  end
+
+  context "misc" do
+    it "example 1" do
+      h = { "a" => 1, "b" => :symbol }
+      typecheck h, Hash.of(String.with(Integer|Symbol))
+    end
+
+    it "example 2" do
+      h = { "a" => 1, "b" => "string" }
+      (Hash.of(String.with(Integer|Symbol)) === h).should == false
+    end
+
+    it "should handle to_s" do
+      Hash.of(String.with(Integer|Symbol)).to_s.should == "Hash.of(String.with(Integer|Symbol))"
+    end
+
+  end
+
+end

data/spec/lib/typed_attr_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'typed_attr'
+
+describe TypedAttr do
+  context "typecheck" do
+    it "should not raise if it does match" do
+      typecheck "1234", String
+    end
+
+    it "should raise TypeError if it does not match" do
+      expect do
+        typecheck 1234, String
+      end.to raise_error(TypeError)
+    end
+
+    it "should handle multiple checks" do
+      expect do
+        typecheck 1234, Integer, Positive
+      end.to_not raise_error
+
+      expect do
+        typecheck 1234, Integer, Negative
+      end.to raise_error(TypeError)
+
+      expect do
+        typecheck 1234, String, Positive
+      end.to raise_error(TypeError)
+    end
+  end
+
+  context "typed_attr" do
+    Old = Class.new do
+      typed_attr String, :a, Numeric, :b
+    end
+    New = Class.new do
+      typed_attr a: String, b: Numeric
+    end
+
+    [ Old, New ].each do | cls |
+      context "#{cls} syntax" do
+        it "should handle ()" do
+          obj = cls.new
+          obj.a.should == nil
+          obj.b.should == nil
+        end
+
+        it "should handle (String)" do
+          obj = cls.new("String")
+          obj.a.should == "String"
+          obj.b.should == nil
+        end
+
+        it "should handle (String, Fixnum)" do
+          obj = cls.new("String", 123)
+          obj.a.should == "String"
+          obj.b.should == 123
+        end
+
+        it "should handle (String, Fixnum, ANYTHING)" do
+          obj = cls.new("String", 123, Object.new)
+          obj.a.should == "String"
+          obj.b.should == 123
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+gem 'pry'
+require 'pry'
+
+gem 'simplecov'
+require 'simplecov'
+SimpleCov.start do
+  add_filter "spec/"
+end
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  config.mock_with :rspec
+  config.order = "random"
+end

data/typed_attr.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typed_attr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "typed_attr"
+  spec.version       = TypedAttr::VERSION
+  spec.authors       = ["Kurt Stephens"]
+  spec.email         = ["ks.github@kurtstephens.com"]
+  spec.description   = %q{Typed Attributes and Composite Types for Functional Programming in Ruby}
+  spec.summary       = %q{typed_attr name: String, ...}
+  spec.homepage      = "https://github.com/kstephens/typed_attr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "simplecov", "~> 0.8"
+  spec.add_development_dependency "pry", "~> 0.9"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: typed_attr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kurt Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Typed Attributes and Composite Types for Functional Programming in Ruby
+email:
+- ks.github@kurtstephens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typed_attr.rb
+- lib/typed_attr/composite_type.rb
+- lib/typed_attr/enumerable.rb
+- lib/typed_attr/version.rb
+- spec/lib/typed_attr/composite_type_spec.rb
+- spec/lib/typed_attr_spec.rb
+- spec/spec_helper.rb
+- typed_attr.gemspec
+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
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: ! 'typed_attr name: String, ...'
+test_files:
+- spec/lib/typed_attr/composite_type_spec.rb
+- spec/lib/typed_attr_spec.rb
+- spec/spec_helper.rb