myrrha 2.0.0 → 3.0.0.rc1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 3.0.0 / FIX ME
+
+* Implementation of domains has been moved to the domain gem. The syntax to create domains
+  has therefore changed. Myrrha::Domain does no longer exists.
+
 # 2.0.0 / 2012-09-26
 
 * Removed support for ruby 1.8.7
@@ -24,7 +29,7 @@
   a Coercions instance under `coercions`.
 
     class Point
-      include Domain::Impl.new(:x, :y)
+      include Domain::Impl.new([:x, :y])
 
       coercions do |c|
         c.coercion(String){|v,t| ...}

data/Gemfile

@@ -1,5 +1,9 @@
 source 'http://rubygems.org'
 
+group :runtime do
+  gem "domain", "= 1.0.0.rc1"
+end
+
 group :test do
   gem "rake", "~> 0.9.2"
   gem "rspec", "~> 2.8.0"

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     bluecloth (2.2.0)
     diff-lcs (1.1.3)
+    domain (1.0.0.rc1)
     rake (0.9.2.2)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
@@ -21,6 +22,7 @@ PLATFORMS
 
 DEPENDENCIES
   bluecloth (~> 2.2.0)
+  domain (= 1.0.0.rc1)
   rake (~> 0.9.2)
   rspec (~> 2.8.0)
   wlang (~> 0.10.2)

data/examples/sbyc_domain.rb

@@ -1,6 +1,6 @@
 require 'myrrha'
 
-PosInt = Myrrha::Domain.sbyc(Integer){|i| i>0}
+PosInt = Domain.sbyc(Integer){|i| i>0}
 
 ###
   

data/lib/myrrha/coerce.rb

@@ -1,9 +1,6 @@
 require 'myrrha'
 module Myrrha
-
-  class Boolean < Object
-    extend Myrrha::Domain::SByC.new(Object, [TrueClass, FalseClass], lambda{|x| (x==true) || (x==false)})
-  end
+  Boolean = Domain.union(TrueClass, FalseClass)
 
   #
   # Coerces _s_ to a Boolean

data/lib/myrrha/coercions.rb

@@ -225,8 +225,8 @@ module Myrrha
     def subdomain?(child, parent)
       if child == parent
         true
-      elsif parent.respond_to?(:superdomain_of?)
-        parent.superdomain_of?(child)
+      elsif parent.respond_to?(:super_domain_of?)
+        parent.super_domain_of?(child)
       elsif child.respond_to?(:superclass) && child.superclass
         subdomain?(child.superclass, parent)
       else

data/lib/myrrha/ext/domain.rb

@@ -0,0 +1,16 @@
+module Domain
+  module CoercionMethods
+
+    def coercions(&bl)
+      @coercions ||= ::Myrrha::Coercions.new{|c| c.main_target_domain = self}
+      @coercions.append(&bl) if bl
+      @coercions
+    end
+
+    def coerce(arg)
+      coercions.coerce(arg, self)
+    end
+
+  end # module CoercionMethods
+  include CoercionMethods
+end # module Domain

data/lib/myrrha/loader.rb

@@ -0,0 +1 @@
+require "domain"

data/lib/myrrha/version.rb

@@ -1,9 +1,9 @@
 module Myrrha
   module Version
 
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 0
-    TINY  = 0
+    TINY  = "0.rc1"
 
     def self.to_s
       [ MAJOR, MINOR, TINY ].join('.')

data/lib/myrrha.rb

@@ -1,12 +1,12 @@
 require_relative "myrrha/version"
 require_relative "myrrha/loader"
 require_relative 'myrrha/errors'
+require_relative 'myrrha/ext/domain'
 #
 # Myrrha -- the missing coercion framework for Ruby
 #
 module Myrrha
 
-  require_relative 'myrrha/domain'
   require_relative 'myrrha/coercions'
 
   # Builds a set of coercions rules.

data/myrrha.gemspec

@@ -128,7 +128,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("yard", "~> 0.7.4")
   s.add_development_dependency("bluecloth", "~> 2.2.0")
   s.add_development_dependency("wlang", "~> 0.10.2")
-  
+  s.add_dependency("domain", "= 1.0.0.rc1")
 
   # The version of ruby required by this gem
   #

data/myrrha.noespec

@@ -10,7 +10,7 @@ variables:
   upper:
     Myrrha
   version:
-    2.0.0
+    3.0.0.rc1
   summary: |-
     Myrrha provides the coercion framework which is missing to Ruby.
   description: |-
@@ -26,11 +26,12 @@ variables:
     - http://github.com/blambeau/myrrha
     - http://rubygems.org/gems/myrrha
   dependencies: 
-    - {name: rake,         version: "~> 0.9.2",  groups: [test, release]}
-    - {name: rspec,        version: "~> 2.8.0",  groups: [test, release]}
-    - {name: yard,         version: "~> 0.7.4",  groups: [doc          ]}
-    - {name: bluecloth,    version: "~> 2.2.0",  groups: [doc          ]}
-    - {name: wlang,        version: "~> 0.10.2", groups: [release      ]}
+    - {name: domain,       version: "= 1.0.0.rc1", groups: [runtime]      }
+    - {name: rake,         version: "~> 0.9.2",    groups: [test, release]}
+    - {name: rspec,        version: "~> 2.8.0",    groups: [test, release]}
+    - {name: yard,         version: "~> 0.7.4",    groups: [doc          ]}
+    - {name: bluecloth,    version: "~> 2.2.0",    groups: [doc          ]}
+    - {name: wlang,        version: "~> 0.10.2",   groups: [release      ]}
   rake_tasks:
     debug_mail:
       rx_changelog_sections: /^# /

data/spec/ext/domain/test_coerce.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+describe Domain, "coerce" do
+
+  let(:domain){ Domain.scalar(:x, :y) }
+
+  before do
+    domain.coercions do |c|
+      c.coercion(String){|v,_| domain.new(1,2) }
+    end
+  end
+
+  it 'should delegate to coercions' do
+    domain.coerce("blah").should eq(domain.new(1,2))
+  end
+
+end

data/spec/ext/domain/test_coercions.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+describe Domain, "coercions" do
+
+  let(:domain){ Domain.scalar(:x, :y) }
+
+  context 'without a block' do
+    subject{ domain.coercions }
+
+    it{ should be_a(Myrrha::Coercions) }
+
+    it 'should have the main target domain defined' do
+      subject.main_target_domain.should eq(domain)
+    end
+  end
+
+  context 'with a block' do
+    subject{ domain.coercions{|c| @seen=c} }
+
+    it 'should yield the coercions' do
+      subject
+      @seen.should eq(subject)
+    end
+  end
+
+end

data/spec/myrrha/test_coercions.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 describe "Myrrha.coercions" do
   
   it "should support using user-defined domains" do
-    name = Myrrha::Domain.sbyc{|s| s.is_a?(Symbol)}
+    name = Domain.sbyc{|s| s.is_a?(Symbol)}
     rules = Myrrha.coercions do |r|
       r.coercion String, name, lambda{|s,t| s.to_sym}
       r.coercion name, String, lambda{|s,t| s.to_s}

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: myrrha
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 3.0.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: domain
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
 description: ! "Myrrha provides the coercion framework which is missing to Ruby. Coercions\nare
   simply defined as a set of rules for converting values from source to target\ndomains
   (in an abstract sense). As a typical and useful example, it comes with \na coerce()
@@ -122,12 +138,8 @@ files:
 - examples/to_ruby_literal_noext.rb
 - lib/myrrha/coerce.rb
 - lib/myrrha/coercions.rb
-- lib/myrrha/domain/coercion_methods.rb
-- lib/myrrha/domain/impl.rb
-- lib/myrrha/domain/sbyc.rb
-- lib/myrrha/domain/value_methods.rb
-- lib/myrrha/domain.rb
 - lib/myrrha/errors.rb
+- lib/myrrha/ext/domain.rb
 - lib/myrrha/loader.rb
 - lib/myrrha/to_ruby_literal.rb
 - lib/myrrha/version.rb
@@ -139,10 +151,8 @@ files:
 - spec/coercions/test_delegate.rb
 - spec/coercions/test_dup.rb
 - spec/coercions/test_subdomain.rb
-- spec/domain/impl/test_behavior.rb
-- spec/domain/impl/test_value_methods.rb
-- spec/domain/sbyc/test_behavior.rb
-- spec/domain/test_sbyc.rb
+- spec/ext/domain/test_coerce.rb
+- spec/ext/domain/test_coercions.rb
 - spec/myrrha/test_coercions.rb
 - spec/shared/a_value.rb
 - spec/spec_helper.rb
@@ -179,15 +189,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1652815196407861424
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -201,10 +208,8 @@ test_files:
 - spec/coercions/test_delegate.rb
 - spec/coercions/test_dup.rb
 - spec/coercions/test_subdomain.rb
-- spec/domain/impl/test_behavior.rb
-- spec/domain/impl/test_value_methods.rb
-- spec/domain/sbyc/test_behavior.rb
-- spec/domain/test_sbyc.rb
+- spec/ext/domain/test_coerce.rb
+- spec/ext/domain/test_coercions.rb
 - spec/myrrha/test_coercions.rb
 - spec/shared/a_value.rb
 - spec/spec_helper.rb

data/lib/myrrha/domain/coercion_methods.rb

@@ -1,17 +0,0 @@
-module Myrrha
-  module Domain
-    module CoercionMethods
-
-      def coercions(&bl)
-        @coercions ||= Coercions.new{|c| c.main_target_domain = self}
-        @coercions.append(&bl) if bl
-        @coercions
-      end
-
-      def coerce(arg)
-        coercions.coerce(arg, self)
-      end
-
-    end # module CoercionMethods
-  end # module Domain
-end # module Myrrha

data/lib/myrrha/domain/impl.rb

@@ -1,50 +0,0 @@
-module Myrrha
-  module Domain
-    class Impl < Module
-
-      def initialize(component_names)
-        @component_names = component_names.freeze
-        define_initialize
-        define_component_readers
-        include_value_methods
-      end
-
-      def included(clazz)
-        define_component_names_on(clazz)
-        define_coercion_methods_on(clazz)
-        super
-      end
-
-    private
-
-      def define_initialize
-        component_names = @component_names
-        define_method(:initialize){|*args|
-          component_names.zip(args).each do |n,arg|
-            instance_variable_set(:"@#{n}", arg)
-          end
-        }
-      end
-
-      def define_component_readers
-        @component_names.each do |n|
-          define_method(n){ instance_variable_get(:"@#{n}") }
-        end
-      end
-
-      def include_value_methods
-        module_eval{ include ValueMethods }
-      end
-
-      def define_component_names_on(clazz)
-        component_names = @component_names
-        clazz.define_singleton_method(:component_names){ component_names }
-      end
-
-      def define_coercion_methods_on(clazz)
-        clazz.extend(CoercionMethods)
-      end
-
-    end # class Impl
-  end # module Domain
-end # module Myrrha

data/lib/myrrha/domain/sbyc.rb

@@ -1,78 +0,0 @@
-module Myrrha
-  module Domain
-    class SByC < Module
-
-      def initialize(super_domain, sub_domains, predicate)
-        @super_domain = super_domain
-        @sub_domains = sub_domains
-        @predicate = predicate
-        define
-      end
-
-    private
-
-      def define
-        define_super_domain_method
-        define_sub_domains_method
-        define_predicate_method
-        include_type_methods
-        include_coercion_methods
-      end
-
-      def define_super_domain_method
-        super_domain = @super_domain
-        define_method(:super_domain){ super_domain }
-      end
-
-      def define_sub_domains_method
-        sub_domains = @sub_domains
-        define_method(:sub_domains){ sub_domains }
-      end
-
-      def define_predicate_method
-        predicate = @predicate
-        define_method(:predicate){ predicate }
-      end
-
-      def include_type_methods
-        module_eval{ include TypeMethods }
-      end
-
-      def include_coercion_methods
-        module_eval{ include CoercionMethods }
-      end
-
-      module TypeMethods
-
-        # Creates a new instance of this domain
-        def new(*args)
-          if (args.size == 1) && (superclass===args.first)
-            raise ArgumentError, "Invalid value #{args.join(' ')} for #{self}" unless self===args.first
-            args.first
-          elsif superclass.respond_to?(:new)
-            new(super(*args))
-          else
-            raise ArgumentError, "Invalid value #{args.join(' ')} for #{self}"
-          end
-        end
-
-        # (see Class.superclass)
-        def superclass
-          super_domain || super
-        end
-
-        # Returns true if clazz if an explicit sub domain of self or if it's the case in Ruby.
-        def superdomain_of?(child)
-          sub_domains.include?(child)
-        end
-
-        # Checks if `value` belongs to this domain
-        def ===(value)
-          (superclass === value) && predicate.call(value)
-        end
-
-      end # module TypeMethods
-
-    end # module SByC
-  end # module Domain
-end # module Myrrha

data/lib/myrrha/domain/value_methods.rb

@@ -1,60 +0,0 @@
-module Myrrha
-  module Domain
-    module ValueMethods
-
-      # Parts of this module have been extracted from Virtus, MIT Copyright (c) 2011-2012
-      # Piotr Solnica.
-
-      # Returns a hash code for the value
-      #
-      # @return Integer
-      #
-      # @api public
-      def hash
-        component_names.map{|key| send(key).hash }.reduce(self.class.hash, :^)
-      end
-
-      # Compare the object with other object for equality
-      #
-      # @example
-      #   object.eql?(other)  # => true or false
-      #
-      # @param [Object] other
-      #   the other object to compare with
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def eql?(other)
-        instance_of?(other.class) and cmp?(__method__, other)
-      end
-
-      # Compare the object with other object for equivalency
-      #
-      # @example
-      #   object == other  # => true or false
-      #
-      # @param [Object] other
-      #   the other object to compare with
-      #
-      # @return [Boolean]
-      #
-      # @api public
-      def ==(other)
-        return false unless self.class <=> other.class
-        cmp?(__method__, other)
-      end
-
-    private
-
-      def cmp?(comparator, other)
-        component_names.all?{|key| send(key).send(comparator, other.send(key)) }
-      end
-
-      def component_names
-        self.class.component_names
-      end
-
-    end # module ValueMethods
-  end # module Domain
-end # module Myrrha

data/lib/myrrha/domain.rb

@@ -1,18 +0,0 @@
-module Myrrha
-  module Domain
-
-    # Creates a domain instance by specialization by constraint
-    #
-    # @param [Class] superdom the superdomain of the created domain
-    # @param [Proc] pred the domain predicate
-    # @return [Class] the created domain
-    def self.sbyc(superdom = Object, subdoms = [], &pred)
-      Class.new(superdom).extend SByC.new(superdom, subdoms, pred)
-    end
-
-  end # module Domain
-end # module Myrrha
-require_relative 'domain/value_methods'
-require_relative 'domain/coercion_methods'
-require_relative 'domain/impl'
-require_relative 'domain/sbyc'

data/spec/domain/impl/test_behavior.rb

@@ -1,41 +0,0 @@
-require 'spec_helper'
-module Myrrha
-  describe Domain, 'when included' do
-
-    let(:point){
-      Class.new{
-        include Myrrha::Domain::Impl.new([:r, :theta])
-
-        coercions do |c|
-          c.upon(NilClass)     {|v,t| new(0.0,0.0)                   }
-          c.coercion(String)   {|v,t| new(*v.split(',').map(&:to_f)) }
-          c.coercion(TrueClass){|v,t| throw :nextrule                }
-          c.fallback(TrueClass){|v,t| new(1.0, 1.0)                  }
-        end
-      }
-    }
-
-    let(:origin){ point.new(0.0, 0.0) }
-    let(:oneone){ point.new(1.0, 1.0) }
-
-    it 'installs the domain component names' do
-      point.component_names.should eq([:r, :theta])
-    end
-
-    it 'installs the component readers' do
-      origin.r.should eq(0.0)
-      origin.theta.should eq(0.0)
-    end
-
-    it 'has coercions properly installed' do
-      point.coercions.main_target_domain.should eq(point)
-    end
-
-    it 'supports expected coercions' do
-      point.coerce(nil).should eq(origin)
-      point.coerce(true).should eq(oneone)
-      point.coerce("2.0,3.0").should eq(point.new(2.0, 3.0))
-    end
-
-  end
-end

data/spec/domain/impl/test_value_methods.rb

@@ -1,101 +0,0 @@
-require 'spec_helper'
-module Myrrha
-  module Domain
-    class Impl
-      describe ValueMethods do
-
-        let(:domain){
-          Class.new{
-            def self.component_names
-              [:a, :b]
-            end
-            include ValueMethods
-            attr_reader :a, :b
-            def initialize(a, b)
-              @a, @b = a, b
-            end
-          }
-        }
-
-        let(:object){ domain.new(1, 2) }
-
-        describe "==" do
-          subject{ object == other }
-
-          context 'with itself' do
-            let(:other){ object }
-            it{ should be_true }
-          end
-
-          context 'with dupped' do
-            let(:other){ object.dup }
-            it{ should be_true }
-          end
-
-          context 'with equivalent' do
-            let(:other){ domain.new(1, 2) }
-            it{ should be_true }
-          end
-
-          context 'with equivalent of a subclass' do
-            let(:other){ Class.new(domain).new(1, 2) }
-            it{ should be_true }
-          end
-
-          context 'with non equivalent' do
-            let(:other){ domain.new(1, 3) }
-            it{ should be_false }
-          end
-
-          context 'with other class' do
-            let(:other){ self }
-            it{ should be_false }
-          end
-        end
-
-        describe "eql?" do
-          subject{ object.eql?(other) }
-
-          context 'with itself' do
-            let(:other){ object }
-            it{ should be_true }
-          end
-
-          context 'with dupped' do
-            let(:other){ object.dup }
-            it{ should be_true }
-          end
-
-          context 'with equivalent' do
-            let(:other){ domain.new(1, 2) }
-            it{ should be_true }
-          end
-
-          context 'with equivalent of a subclass' do
-            let(:other){ Class.new(domain).new(1, 2) }
-            it{ should be_false }
-          end
-
-          context 'with non equivalent' do
-            let(:other){ domain.new(1, 3) }
-            it{ should be_false }
-          end
-
-          context 'with other class' do
-            let(:other){ self }
-            it{ should be_false }
-          end
-        end
-
-        describe "hash" do
-          subject{ object.hash }
-
-          it 'should be consistent with equal' do
-            subject.should eq(domain.new(1,2).hash)
-          end
-        end
-
-      end
-    end
-  end
-end

data/spec/domain/sbyc/test_behavior.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-module Myrrha
-  module Domain
-    describe SByC, 'when used by extension' do
-
-      class NegInt < Integer
-        extend Myrrha::Domain::SByC.new(Integer, [], lambda{|i| i<0})
-      end
-
-      specify("#name") {
-        NegInt.name.should eq("Myrrha::Domain::NegInt")
-      }
-
-      specify("#new") {
-        NegInt.new(-12).should eq(-12)
-        lambda {
-          NegInt.new(12)
-        }.should raise_error(ArgumentError)
-      }
-
-      specify("#superclass"){
-        NegInt.superclass.should eql(Integer)
-      }
-
-      specify("#superdomain_of?"){
-        NegInt.superdomain_of?(Object).should be_false
-        NegInt.superdomain_of?(Integer).should be_false
-      }
-
-      specify("#coercions"){
-        NegInt.coercions.should be_a(Myrrha::Coercions)
-        NegInt.coercions.main_target_domain.should eq(NegInt)
-      }
-
-      it "should be usable in a case" do
-        [-12, 12].map{|i|
-          case i
-          when NegInt  then :negint
-          when Integer then :integer
-          end
-        }.should eq([:negint, :integer])
-      end
-
-    end
-  end
-end

data/spec/domain/test_sbyc.rb

@@ -1,81 +0,0 @@
-require 'spec_helper'
-module Myrrha
-  module Domain
-    describe ".sbyc" do
-    
-      specify "the basic contract" do
-        subject = Myrrha::Domain.sbyc{|s| s == 12}
-        subject.should be_a(Class) 
-        subject.superclass.should eq(Object)
-        (subject === 12).should be_true
-        (subject === 13).should be_false
-      end
-    
-      specify "with a ruby superclass" do
-        subject = Myrrha::Domain.sbyc(Integer){|i| i > 0}
-        subject.should be_a(Class) 
-        subject.superclass.should eq(Integer)
-        (subject === 12).should be_true
-        (subject === 0).should be_false
-      end
-    
-      describe "A factored sub domain of Integer" do
-        PosInt = Myrrha::Domain.sbyc(Integer){|i| i > 0}
-        specify("#name") {
-          PosInt.name.should eq("Myrrha::Domain::PosInt")
-        }
-        specify("#new") {
-          PosInt.new(12).should eq(12)
-          lambda {
-            PosInt.new(0)
-          }.should raise_error(ArgumentError)
-        }
-        specify("#superclass"){
-          PosInt.superclass.should eql(Integer)
-        }
-        specify("#superdomain_of?"){
-          PosInt.superdomain_of?(Object).should be_false
-          PosInt.superdomain_of?(Integer).should be_false
-        }
-        it "should be usable in a case" do
-          [-12, 12].collect{|i|
-            case i
-            when PosInt
-              :posint
-            when Integer
-              :integer
-            end
-          }.should eq([:integer, :posint])
-        end
-      end
-      
-      describe "A factored sub domain of a user-defined Class" do
-        class Color
-          attr_reader :r
-          attr_reader :g
-          attr_reader :b
-          def initialize(r,g,b)
-            raise ArgumentError unless [r,g,b].all?{|i| i.is_a?(Integer)}
-            @r, @g, @b = r, g, b
-          end
-        end
-        RedToZero = Myrrha::Domain.sbyc(Color){|c| c.r == 0}
-        specify("#===") {
-          (RedToZero === Color.new(0,1,1)).should be_true
-          (RedToZero === Color.new(1,1,1)).should be_false
-        }
-        specify("#new") {
-          RedToZero.new(Color.new(0,1,1)).should be_a(Color)
-          RedToZero.new(0, 1, 1).should be_a(Color)
-          lambda{
-            RedToZero.new(Color.new(1,1,1))
-          }.should raise_error(ArgumentError)
-          lambda{
-            RedToZero.new(1, 1, 1)
-          }.should raise_error(ArgumentError)
-        }
-      end
-
-    end
-  end
-end