platypus 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5a8cc9e4c9edf9bb0f2103eb75986e4db58a520ad16989883411fa55be0fde3
+  data.tar.gz: bd9f3a59f53981bd6434b17aad52750a3c52509bc1bd227fadd804e4f0d6117b
+SHA512:
+  metadata.gz: 2c2b06fb3ab9056d95638a03e86d1e208c58384958fd18385fa54248c2f25566d27b8dde8714c5fef8845078f95cc8e95a8c95be3c85e41bf50d84c559fe88c6
+  data.tar.gz: 833a810527e7421a3ec6536ab6ec2856169580048ed812d8ca32f58b268c19f0e1aeb84eefea4db491add05d6f1e31176d18efe1a2d5e59a9d7ab6641dca11ba

data/HISTORY.md

@@ -0,0 +1,41 @@
+# Release History
+
+## 1.1.0 / 2026-04-03
+
+Maintenance release. Modernized project tooling.
+
+Changes:
+
+* Replace custom Indexer system with standard gemspec.
+* Replace Travis CI with GitHub Actions.
+* Add Rakefile.
+* Update URLs to HTTPS.
+* Clean up obsolete files and .gitignore.
+
+
+## 1.0.2 / 2011-10-22
+
+This release fixes a bug that preventd Kernel#case? from being defined.
+
+Changes:
+
+* Remove Kernel#case? def condition [bug].
+
+
+## 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/LICENSE.txt

@@ -0,0 +1,23 @@
+License:: BSD-2-Clause
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,122 @@
+# Platypus
+
+[Source Code](https://github.com/rubyworks/platypus) |
+[Report Issue](https://github.com/rubyworks/platypus/issues)
+
+[![Gem Version](https://img.shields.io/gem/v/platypus.svg?style=flat)](https://rubygems.org/gems/platypus)
+[![Build Status](https://github.com/rubyworks/platypus/actions/workflows/test.yml/badge.svg)](https://github.com/rubyworks/platypus/actions/workflows/test.yml)
+
+<b>Platypus provides a generalized type conversion system,
+method overloading and psuedo-classes for the Ruby programming
+language.</b>
+
+
+## Overview
+
+Type conversion work like a rational duck might expect.
+
+```ruby
+  "1234".to(Float)    => 1234.0  (Float)
+
+  Time.from("6:30")   => 1234.0  (Time)
+```
+
+You can of course define your own.
+
+```ruby
+  class X
+    typecast String do |x|
+      "#{x}"
+    end
+  end
+```
+
+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.
+
+```ruby
+  class X
+    include Overloadable
+
+    def f
+      "f"
+    end
+
+    sig Integer
+    def f(i)
+      "f#{i}"
+    end
+
+    sig String, String
+    def f(s1, s2)
+      [s1, s2].join('+')
+    end
+  end
+
+  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).
+
+```ruby
+  class KiloType < Type
+    x % 1000 == 0
+  end
+
+  KiloType === 1000
+  KiloType === 2000
+```
+
+To learn more about using Platypus see the [Demonstrundum](http://rubyworks.github.com/platypus/docs/demo).
+
+
+## Installation
+
+To install with RubyGems simply open a console and type:
+
+    $ gem install platypus
+
+Or add it as a dependency to your Gemfile.
+
+    gem "platypus"
+
+Old school site installation can be achieved with Setup.rb (gem install setup),
+then download the tarball package and type:
+
+    $ tar -xvzf platypus-1.0.0.tgz
+    $ cd platypus-1.0.0
+    $ setup.rb all
+
+Windows users use 'ruby setup.rb all'.
+
+
+## Authors
+
+* Thomas Sawyer (trans)
+* Jonas Pfenniger
+
+
+## Copying
+
+Copyright (c) 2010 Rubyworks
+
+This program is ditributed unser the terms of the *FreeBSD* license.
+
+See LICENSE.txt file for details.
+
+
+<br/><br/>
+
+     _   ___
+    / \ /   \
+    \. |: cc|     .---------.
+     (.|:,---,   <  Feel the \
+     (.|: \ c|    \ POWER!!! /
+     (.    y-'     '--------'
+      \ _ /
+       m m
+

data/demo/01_intro.md

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

data/demo/02_typecast.md

@@ -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/demo/03_type.md

@@ -0,0 +1,33 @@
+## 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.refute === 999999
+    MegaType.assert === 20000000
+
+

data/{qed/04_overload.rdoc → demo/04_overload.md}

@@ -1,57 +1,57 @@
-== Overloadable
+## 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'
+    require 'platypus/overload'
 
 Now we can define a class that utilizes it.
 
-  class X
-    include Overloadable
+    class X
+      include Overloadable
 
-    sig String, String
+      sig String, String
 
-    def x(str1, str2)
-      str1.assert.is_a?(String)
-      str2.assert.is_a?(String)
-    end
+      def x(str1, str2)
+        str1.assert.is_a?(String)
+        str2.assert.is_a?(String)
+      end
 
-    sig Integer, Integer
+      sig Integer, Integer
 
-    def x(int1, int2)
-      int1.assert.is_a?(Integer)
-      int2.assert.is_a?(Integer)
+      def x(int1, int2)
+        int1.assert.is_a?(Integer)
+        int2.assert.is_a?(Integer)
+      end
     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.new
 
-  x.x("Hello", "World")
+    x.x("Hello", "World")
 
-  x.x(100, 200)
+    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
+    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)
+    class X
+      def x(obj1, obj2)
+        obj1.refute.is_a?(Integer)
+        obj2.refute.is_a?(String)
+      end
     end
-  end
 
-  x.x("Hello", 200)
+    x.x("Hello", 200)
 

data/demo/applique/env.rb

@@ -0,0 +1 @@
+require 'ae'

data/lib/platypus/core_ext.rb

@@ -1,8 +1,9 @@
 module Kernel
 
+  # Dor all matchers === this object.
   def case?(*matchers)
     matchers.all?{ |m| m === self }
-  end unless method_defined?(:case?)
+  end
 
 end
 

data/lib/platypus/type.rb

@@ -24,7 +24,7 @@ require 'platypus/core_ext'
 #
 # While TypeCasts are not actual types in the sense they
 # are not actual classes. They can be used for conversion
-# by defining a "from_{class}" class method. In doing so
+# by defining a "from_<class>" class method. In doing so
 # you should make sure the result of the conversion conforms
 # to the typecast. You can use the TypeCast.validate method
 # to make that a bit easier. For instance:

data/lib/platypus/typecast.rb

@@ -49,7 +49,7 @@ end
 
 class Time #:nodoc:
   # This method will require the 'time.rb' Time extensions.
-  typecast String do
+  typecast String do |string|
     require 'time'
     parse(string)
   end

data/lib/platypus/version.rb

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

metadata

@@ -1,86 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: platypus
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Thomas Sawyer
 - Jonas Pfenniger
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: detroit
-  requirement: &14563700 !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
-  version_requirements: *14563700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: qed
-  requirement: &14562980 !ruby/object:Gem::Requirement
-    none: false
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
-  version_requirements: *14562980
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Provides a complete double-dispatch type conversion system, method overloadability
-  and psuedo-classes.
-email: 
+  and pseudo-classes.
+email:
+- transfire@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- HISTORY.rdoc
-- README.rdoc
-- NOTES.rdoc
+extra_rdoc_files: []
 files:
-- .ruby
+- HISTORY.md
+- LICENSE.txt
+- README.md
+- demo/01_intro.md
+- demo/02_typecast.md
+- demo/03_type.md
+- demo/04_overload.md
+- demo/applique/env.rb
+- lib/platypus.rb
 - 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
-- HISTORY.rdoc
-- README.rdoc
-- NOTES.rdoc
-homepage: http://rubyworks.github.com/platypus
-licenses: []
-post_install_message: 
+homepage: https://github.com/rubyworks/platypus
+licenses:
+- BSD-2-Clause
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.9
+specification_version: 4
 summary: Riding on Types with Ruby
 test_files: []

data/.ruby

@@ -1,44 +0,0 @@
----
-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

@@ -1,20 +0,0 @@
-= 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,14 +0,0 @@
-= 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.rdoc

@@ -1,108 +0,0 @@
-= Platypus
-     _   ___
-    / \ /   \
-    \. |: cc|
-     (.|:,---,
-     (.|: \ c|
-     (.    y-'
-      \ _ /
-       m m
-
-* home: http://rubyworks.github.com/platypus
-* work: http://github.com/rubyworks/platypus
-
-
-== DESCRIPTION
-
-Platypus provides a generalized type conversion system,
-method overloading and psuedo-classes.
-
-== SYNOPSIS
-
-Type conversion work like a rational duck might expect.
-
-   "1234".to(Float)    => 1234.0  (Float)
-
-   Time.from("6:30")   => 1234.0  (Time)
-
-You can of course define your own.
-
-  class X
-    typecast String do |x|
-      "#{x}"
-    end
-  end
-
-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 f
-       "f"
-     end
-
-     sig Integer
-
-     def f(i)
-       "f#{i}"
-     end
-
-     sig String, String
-
-     def f(s1, s2)
-       [s1, s2].join('+')
-     end
-   end
-
-   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
-  end
-
-  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 platypus
-
-Site installation can be achieved with Setup.rb (gem install setup),
-then download the tarball package and type:
-
-  $ tar -xvzf platypus-1.0.0.tgz
-  $ cd platypus-1.0.0
-  $ setup.rb all
-
-Windows users use 'ruby setup.rb all'.
-
-
-== COPYING
-
-Copyright (c) 2010 Thomas Sawyer
-
-This program is ditributed unser the terms of the *FreeBSD* license.
-
-See COPYING.rdoc file for details.
-
-
-*-* mode: rdoc *-*
-

data/qed/01_intro.rdoc

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

data/qed/02_typecast.rdoc

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

@@ -1,32 +0,0 @@
-== 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/test/test_overload.rb

@@ -1,173 +0,0 @@
-require 'platypus/overload'
-
-#
-class TC_Overload_01 < Test::Unit::TestCase
-
-  class X
-    include Overloadable
-
-    def x
-      "hello"
-    end
-
-    overload Array
-
-    def x(x)
-      [Array, x]
-    end
-
-    overload Symbol
-
-    def x(x)
-      [Symbol, x]
-    end
-  end
-
-  def setup
-    @x = X.new
-  end
-
-  def test_x
-    assert_equal( "hello", @x.x )
-  end
-
-  def test_a
-    assert_equal( [Array, [1]], @x.x([1]) )
-  end
-
-  def test_s
-    assert_equal( [Symbol, :a], @x.x(:a) )
-  end
-
-end
-
-#
-class TC_Overload_02 < Test::Unit::TestCase
-
-  class X
-    include Overloadable
-
-    def x
-      "hello"
-    end
-
-    overload Integer
-
-    def x(i)
-      i
-    end
-
-    overload String, String
-
-    def x(s1, s2)
-      [s1, s2]
-    end
-
-  end
-
-  def setup
-    @x = X.new
-  end
-
-  def test_x
-    assert_equal( "hello", @x.x )
-  end
-
-  def test_i
-    assert_equal( 1, @x.x(1) )
-  end
-
-  def test_s
-    assert_equal( ["a","b"], @x.x("a","b") )
-  end
-
-end
-
-#
-class TC_Overload_03 < Test::Unit::TestCase
-
-  class SubArray < Array
-  end
-
-  class SubSubArray < SubArray
-  end
-  
-  class X
-    include Overloadable
-
-    def x
-      "hello"
-    end
-
-    overload Integer
-
-    def x(i)
-      i
-    end
-    
-    overload Symbol
-
-    def x(s)
-      s
-    end
-    
-    overload String, String
-
-    def x(s1, s2)
-      [s1, s2]
-    end
-
-    overload Symbol, String
-
-    def x(s1, s2)
-      [s1, s2]
-    end
-    
-    overload Array
-
-    def x(a)
-      "array"
-    end
-
-  end
-
-  def setup
-    @x = X.new
-  end
-
-  def test_x
-    assert_equal( "hello", @x.x )
-  end
-
-  def test_i
-    assert_equal( 1, @x.x(1) )
-  end
-
-  def test_strings
-    assert_equal( ["a","b"], @x.x("a","b") )
-  end
-
-  def test_symbol_string
-    assert_equal( [:a,"b"], @x.x(:a,"b") )
-  end
-
-  def test_sym
-    assert_equal( :sym, @x.x(:sym) )
-  end
-  
-  def test_subarray
-    assert_equal("array", @x.x([]))
-    assert_equal("array", @x.x(SubArray.new))
-    assert_equal("array", @x.x(SubSubArray.new))
-  end
-  
-  #def test_raise
-  #  assert_raise ArgumentError do
-  #     X.module_eval do
-  #      overload 42
-  #    end
-  #  end
-  #end
-
-end
-