platypus 1.0.0 → 1.0.1

data/.ruby

@@ -0,0 +1,44 @@
+---
+authors:
+- name: Thomas Sawyer
+- name: Jonas Pfenniger
+copyrights:
+- holder: Thomas Sawyer
+  year: '2004'
+  license: BSD-2-Clause
+replacements: []
+conflicts: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
+repositories:
+- uri: http://rubyworks.github.com/platypus.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/platypus
+  code: http://github.com/rubyworks/platypus
+  mail: http://googlegroups/group/rubyworks-mailinglist
+load_path:
+- lib
+extra: {}
+source:
+- Profile
+alternatives: []
+revision: 0
+version: 1.0.1
+name: platypus
+title: Platypus
+summary: Riding on Types with Ruby
+created: '2004-01-01'
+description: Provides a complete double-dispatch type conversion system, method overloadability
+  and psuedo-classes.
+organization: RubyWorks
+date: '2011-10-20'

data/HISTORY.rdoc

@@ -0,0 +1,20 @@
+= Release History
+
+
+== 1.0.1 / 2011-10-19
+
+This release simply refreshes the project build script.
+Functionality hasn't changed at all.
+
+Changes:
+
+* Administrative details only.
+
+
+== 1.0.0 / 2009-07-07
+
+This is the initial stand-alone release of Platypus.
+
+Changes:
+
+* Happy Birthday!

data/NOTES.rdoc

@@ -1,5 +1,13 @@
 = Developer's Notes
 
+
+== 2011-10-19 | Name of Project
+
+This project used to be call Typecast. Maybe that was better than the "silly" 
+Platypus name? But, then again, "typecast" doesn't quite cover everything this
+library does.
+
+
 == 2010-05-27 | Alias for +Overloadable#overload+
 
 I am not sure if I like +con+, +sig+ or +over+ better as a short alias for +overload+. I thought of +con+ becuase of it's double meaning as Latin for 'with' and as an abbreviation for 'conditional'. But it seems esoteric in practice, perhaps b/c it would be too general a term if we were programming in Spanish. While +over+ probably makes the most sense in terms of being an abbreviated form of +overload+, +sig+ is the same number of characters as +def+ and conveys some additional semantics which applies to method overloading --the *signature*.

data/{README → README.rdoc}

@@ -17,46 +17,52 @@
 Platypus provides a generalized type conversion system,
 method overloading and psuedo-classes.
 
-
-== RELEASE NOTES
-
-Please see HISTORY file.
-
-
 == SYNOPSIS
 
-=== Type Conversion
+Type conversion work like a rational duck might expect.
 
    "1234".to(Float)    => 1234.0  (Float)
 
    Time.from("6:30")   => 1234.0  (Time)
 
-=== Method Overloading
+You can of course define your own.
+
+  class X
+    typecast String do |x|
+      "#{x}"
+    end
+  end
 
-To overload a method use the #overload method to define
-new functionality based on a specified type interface.
+To overload a method, mixin the Overloadable module and use the #overload (or #sig)
+method to define new functionality based on a specified type interface.
 
    class X
      include Overloadable
 
-     def x
-       "hello"
+     def f
+       "f"
      end
 
      sig Integer
 
-     def x(i)
-       i
+     def f(i)
+       "f#{i}"
      end
 
      sig String, String
 
-     def x(s1, s2)
-       [s1, s2]
+     def f(s1, s2)
+       [s1, s2].join('+')
      end
    end
 
-=== Psuedo-Classes
+   x = X.new
+
+   x.f          #=> "f"
+   x.f(1)       #=> "f1"
+   x.f("A","B") #=> "A+B"
+
+Finally, the Platypus gives you the Type superclass (aka pseudo-classes).
 
   class KiloType < Type
     x % 1000 == 0
@@ -65,19 +71,26 @@ new functionality based on a specified type interface.
   KiloType === 1000
   KiloType === 2000
 
+To learn more about using Platypus see the Demonstrundum[http://rubyworks.github.com/platypus/docs/qed].
+
+
+== RELEASE NOTES
+
+Please see HISTORY file.
+
 
 == INSTALLATION
 
 To install with RubyGems simply open a console and type:
 
-  $ gem install typecast
+  $ gem install platypus
 
 Site installation can be achieved with Setup.rb (gem install setup),
 then download the tarball package and type:
 
-  $ tar -xvzf typecast-1.0.0.tgz
-  $ cd typecast-1.0.0
-  $ sudo setup.rb all
+  $ tar -xvzf platypus-1.0.0.tgz
+  $ cd platypus-1.0.0
+  $ setup.rb all
 
 Windows users use 'ruby setup.rb all'.
 
@@ -86,9 +99,10 @@ Windows users use 'ruby setup.rb all'.
 
 Copyright (c) 2010 Thomas Sawyer
 
-This program is ditributed unser the terms of the Ruby license.
+This program is ditributed unser the terms of the *FreeBSD* license.
+
+See COPYING.rdoc file for details.
 
-See LICENSE or COPYING file for details.
 
-#--
 *-* mode: rdoc *-*
+

data/lib/platypus.rb

@@ -1,3 +1,4 @@
+require 'platypus/version'
 require 'platypus/typecast'
 require 'platypus/overload'
 require 'platypus/type'

data/lib/platypus/version.rb

@@ -0,0 +1,3 @@
+module Platypus
+  VERSION = "1.0.0"
+end

data/qed/01_intro.rdoc

@@ -0,0 +1,2 @@
+= Platypus
+

data/qed/02_typecast.rdoc

@@ -0,0 +1,29 @@
+== Type Casting
+
+Require the casting library.
+
+  require 'platypus/typecast'
+
+Define a couple of typecasts.
+
+  class ::String
+    typecast ::Regexp do |string|
+      /#{string}/
+    end
+    typecast ::Regexp, :multiline do |string|
+      /#{string}/m
+    end
+  end
+
+  ::String.typecast ::Integer do |string|
+    Integer(string)
+  end
+
+See that they work.
+
+  ::Regexp.from("ABC").assert == /ABC/
+
+And again.
+
+  "123".to(::Integer).assert == 123
+

data/qed/03_type.rdoc

@@ -0,0 +1,32 @@
+== Pseudo-Types
+
+Require the library.
+
+  require 'platypus/type'
+
+Now we can create types which are psuedo-classes.
+
+  class KiloType < Type
+    condition do |x|
+      x.case? Integer
+      x.kind_of?(Integer)
+      x.respond_to?(:succ)
+      x > 1000
+    end
+  end
+
+  KiloType.assert === 2000
+  KiloType.refute === 999
+
+Using the convenience #x method.
+
+  class MegaType < Type
+    x.case? Integer
+    x.kind_of?(Integer)
+    x.respond_to?(:succ)
+    x > 1000000
+  end
+
+  MegaType.assert === 20000000
+  MegaType.refute === 999999
+

data/qed/04_overload.rdoc

@@ -0,0 +1,57 @@
+== Overloadable
+
+The Overloadable mixin provides a means for overloading
+methods based in method signature using an elegant syntax.
+To demonstrate, we first need to load the library.
+
+  require 'platypus/overload'
+
+Now we can define a class that utilizes it.
+
+  class X
+    include Overloadable
+
+    sig String, String
+
+    def x(str1, str2)
+      str1.assert.is_a?(String)
+      str2.assert.is_a?(String)
+    end
+
+    sig Integer, Integer
+
+    def x(int1, int2)
+      int1.assert.is_a?(Integer)
+      int2.assert.is_a?(Integer)
+    end
+  end
+
+As you can see will placed assertions directly into our methods 
+definitions. We simply need to run an exmaple of each definition to
+see that it worked.
+
+  x = X.new
+
+  x.x("Hello", "World")
+
+  x.x(100, 200)
+
+But what happens if the signiture is not matched? Either an ArgumentError will
+be raised.
+
+  expect ArgumentError do
+    x.x("Hello", 200)
+  end
+
+Or it will fallback to a non-signiature definition, if one is defined.
+
+
+  class X
+    def x(obj1, obj2)
+      obj1.refute.is_a?(Integer)
+      obj2.refute.is_a?(String)
+    end
+  end
+
+  x.x("Hello", 200)
+

metadata

@@ -1,78 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: platypus
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Thomas Sawyer
 - Jonas Pfenniger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-27 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Provides a complete double-dispatch type conversion system, method overloadability and psuedo-classes.
+date: 2011-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &14563700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14563700
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &14562980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14562980
+description: Provides a complete double-dispatch type conversion system, method overloadability
+  and psuedo-classes.
 email: 
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
+extra_rdoc_files:
+- HISTORY.rdoc
+- README.rdoc
+- NOTES.rdoc
+files:
+- .ruby
 - lib/platypus/core_ext.rb
 - lib/platypus/overload.rb
 - lib/platypus/type.rb
 - lib/platypus/typecast.rb
+- lib/platypus/version.rb
 - lib/platypus.rb
+- qed/01_intro.rdoc
+- qed/02_typecast.rdoc
+- qed/03_type.rdoc
+- qed/04_overload.rdoc
 - test/test_overload.rb
-- PROFILE
-- LICENSE
-- README
-- HISTORY
+- HISTORY.rdoc
+- README.rdoc
 - NOTES.rdoc
-- REQUIRE
-- VERSION
-has_rdoc: true
 homepage: http://rubyworks.github.com/platypus
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --title
-- Platypus API
-- --main
-- README
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: platypus
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Type Casting System
-test_files: 
-- test/test_overload.rb
+summary: Riding on Types with Ruby
+test_files: []

data/HISTORY

@@ -1,19 +0,0 @@
-= Change History
-
-# == History
-#
-# * 2006-06-06 3v1l_d4y:
-#   * Removed transformation options.
-#   * Removed StringIO typecast. It is not required by default.
-#   * Added TypeCastException for better error reporting while coding.
-#
-
-== 1.0.0 // 2009-07-07
-
-This is the initial stand-alone release of TypeCast,
-spun-off from Ruby Facets.
-
-* 1 Major Enhancement
-
-    * Happy Birthday!
-

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License
-
-Copyright (c) 2010 Thomas Sawyer
-
-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/PROFILE

@@ -1,24 +0,0 @@
---- 
-title  : Platypus
-suite  : rubyworks 
-summary: Type Casting System
-license: MIT
-created: 2004-01-01
-
-copyright:
-  Copyright (c) 2004 Thomas Sawyer
-
-authors:
-  - Thomas Sawyer
-  - Jonas Pfenniger
-
-description:
-  Provides a complete double-dispatch type conversion system,
-  method overloadability and psuedo-classes.
-
-resources:
-  homepage: http://rubyworks.github.com/platypus
-  development: http://github.com/rubyworks/platypus
-  repository: http://rubyworks.github.com/platypus.git
-  forum: http://googlegroups/group/rubyworks-mailinglist
-

data/REQUIRE

@@ -1,6 +0,0 @@
-development:
-- syckle
-
-development/test:
-- qed
-

data/VERSION

@@ -1,5 +0,0 @@
-name : platypus
-major: 1
-minor: 0
-patch: 0
-date : 2010-05-27