adts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 488ac93106452d551665d5e7a01015b56fed473c
+  data.tar.gz: d87357f5358c234a2a480e4180aefc76ad43f26b
+SHA512:
+  metadata.gz: a266603d63209ff785eebcb2fa4315b8a4f7716a22572611185b349a6f01a850220d46ab470b13b98f3259616eb38d29d8a6a673f8b55b3ef62e83c30c9fe3aa
+  data.tar.gz: 2cea76a6c954c2afebf85e543b78a7aa934c1b5368902b5c289a559797fb231dcf374c7c6992c8387cfd91bf31a54cff1323821c96ce3ef0ede3e00dc9cde3a1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - rbx-2
+  - ruby-head
+  - jruby-head
+
+script:
+- rake

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Josep M. Bach
+
+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,102 @@
+# ADTs [![Build Status](https://secure.travis-ci.org/txus/adts.png)](http://travis-ci.org/txus/adts)
+
+[Algebraic Data Types][adts] for Ruby.
+
+## Usage
+
+Let's define a Shape data type:
+
+```ruby
+require 'adts'
+
+Shape = ADT do
+  Void() |
+  Square(width: Fixnum) |
+  Rectangle(width: Fixnum, height: Fixnum) |
+  Circle(radius: Fixnum) {
+    def area
+      Math::PI * radius * radius
+    end
+  }
+end
+```
+
+Let's try an instantiate a Shape with our nullary constructor Void:
+
+```ruby
+Shape::Void()
+# => #<Shape::Void ...>
+```
+
+What about a square?
+
+```ruby
+Shape::Square(23)
+# => #<Shape::Square @width=23>
+```
+
+Our type constructors are even **type-checked**:
+
+```ruby
+Shape::Square("foo")
+# raises a TypeError
+```
+
+Our ADT implements equality by type and value:
+
+```ruby
+Shape::Square(23) == Shape::Square(23)
+# => true
+Shape::Circle(23) == Shape::Square(23)
+# => false
+Shape::Square(23) == Shape::Square(99)
+# => false
+```
+
+All its instances expose (read-only) their respective parameters:
+
+```ruby
+Shape::Square(23).width
+# => 23
+```
+
+All instances are a kind of `Shape`:
+
+```ruby
+Shape::Square(23).is_a?(Shape)
+# => true
+```
+
+And finally, our constructors can have their own special methods, just like we
+defined `area` on `Circle`:
+
+```ruby
+Shape::Circle(1).area
+# => 3.141592653589793
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adts
+
+## Who's this
+
+This was made by [Josep M. Bach (Txus)](http://blog.txus.io) under the MIT
+license. I am [@txustice][twitter] on twitter (where you should probably follow
+me!).
+
+[twitter]: https://twitter.com/txustice
+[adts]: http://en.wikipedia.org/wiki/Algebraic_data_type
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/adts.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adts"
+  spec.version       = ADT::VERSION
+  spec.authors       = ["Josep M. Bach"]
+  spec.email         = ["josep.m.bach@gmail.com"]
+  spec.summary       = %q{Abstract Data Types for Ruby}
+  spec.description   = %q{Abstract Data Types for Ruby}
+  spec.homepage      = "http://blog.txus.io/adts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "rspec"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/adt.rb

@@ -0,0 +1,23 @@
+require "adt/version"
+require "adt/constructor"
+
+module ADT
+end
+
+def ADT(&block)
+  Class.new.tap do |klass|
+    o = Object.new
+
+    o.define_singleton_method(:method_missing) do |m, *args, &block|
+      ADT::Constructor.new(klass, m, args.first || {}, &block)
+    end
+
+    first = o.instance_eval(&block)
+    [first, *first.others].each do |tc|
+      klass.const_set(tc.name, tc.klass)
+      klass.singleton_class.send(:define_method, tc.name) do |*args|
+        const_get(tc.name).new(*args)
+      end
+    end
+  end
+end

data/lib/adt/constructor.rb

@@ -0,0 +1,40 @@
+module ADT
+  class Constructor
+    attr_reader :name, :klass, :others
+
+    def initialize(parent, name, parameters, &block)
+      @name = name
+      @klass = Class.new(parent, &block)
+      keys = parameters.keys
+      types = parameters.values
+      @klass.class_eval """
+        attr_reader #{keys.map { |n| ":#{n}" }.join(', ')}
+
+        def initialize(#{keys.join(", ")})
+          types = [#{keys.join(", ")}].map(&:class)
+          raise TypeError, 'Types mismatch: given ' + types.join(', ') + ', expected #{types.join(", ")}' unless types == [#{types.join(", ")}]
+          #{keys.empty? ? "" : keys.map{ |n| "@#{n}" }.join(',') + " = " + keys.join(", ")}
+        end
+
+        def ==(other)
+          other.is_a?(self.class) && #{keys.empty? ? "true" : keys.map { |key| "#{key} == other.#{key}"}.join(" && ")}
+        end
+      "
+      @parameters = parameters
+      @others = []
+    end
+
+    def to_s
+      "#{@name}(#{@parameters})"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def |(other)
+      @others << other
+      self
+    end
+  end
+end

data/lib/adt/version.rb

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

data/spec/adt_spec.rb

@@ -0,0 +1,42 @@
+require 'rspec'
+require 'adt'
+
+Shape = ADT do
+  Void() |
+  Square(width: Fixnum) |
+  Rectangle(width: Fixnum, height: Fixnum) |
+  Circle(radius: Fixnum) {
+    def area
+      Math::PI * radius * radius
+    end
+  }
+end
+
+describe ADT do
+  it 'allows for a nullary constructor' do
+    expect(Shape::Void()).to be_kind_of(Shape::Void)
+  end
+
+  it 'typechecks the non-nullary constructors'do
+    expect { Shape::Square(23) }.to_not raise_exception
+    expect { Shape::Square("foo") }.to raise_exception(TypeError)
+  end
+
+  it 'implements equality by type and value' do
+    expect(Shape::Square(23)).to eq(Shape::Square(23))
+    expect(Shape::Circle(23)).to_not eq(Shape::Square(23))
+    expect(Shape::Square(23)).to_not eq(Shape::Square(55))
+  end
+
+  it 'exposes readers for the constructor parameters' do
+    expect(Shape::Square(23).width).to eq(23)
+  end
+
+  it 'allows for custom methods on type constructors' do
+    expect(Shape::Circle(1).area).to eq(Math::PI)
+  end
+
+  it 'uses subtyping' do
+    expect(Shape::Circle(1)).to be_kind_of(Shape)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: adts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josep M. Bach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Abstract Data Types for Ruby
+email:
+- josep.m.bach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- adts.gemspec
+- lib/adt.rb
+- lib/adt/constructor.rb
+- lib/adt/version.rb
+- spec/adt_spec.rb
+- spec/spec_helper.rb
+homepage: http://blog.txus.io/adts
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Abstract Data Types for Ruby
+test_files:
+- spec/adt_spec.rb
+- spec/spec_helper.rb