paramix 2.0.0 → 2.0.1

data/.ruby

@@ -0,0 +1,42 @@
+---
+source:
+- PROFILE
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2006'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/paramix.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/paramix
+  code: http://github.com/rubyworks/paramix
+extra: {}
+load_path:
+- lib
+revision: 0
+title: Paramix
+summary: Parametric Mixins
+description: Parametric Mixins provides parameters for mixin modules.
+organization: RubyWorks
+created: '2006-01-01'
+name: paramix
+version: 2.0.1
+date: '2011-10-22'

data/.yardopts

@@ -0,0 +1,6 @@
+--protected
+--private
+lib
+-
+[A-Z]*.*
+

data/COPYING.rdoc

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+
+== Paramix
+
+Copyright:: (c) 2006 Thomas Sawyer, Rubyworks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/paramix
+
+    Copyright 2006 Thomas Sawyer. All rights reserved.
+
+    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/HISTORY.rdoc

@@ -1,13 +1,24 @@
 = RELEASE HISTORY
 
+== 2.0.1 // 2011-10-22
+
+This release simply brings the project uptodate with the latest
+build tools, and switches the license to BSD-2-Clause.
+
+Changes:
+
+* Modernize build configuration.
+* Switch to FreeBSD license.
+
+
 == 2.0.0 // 2010-04-06
 
-Thanks to a conversation with Jonathan ... Paramix has been
-completely rewritten.  Whereas anonymous modules were avoided
-in prior versions, it has become clear that the worries of
-memory consumption that would accompany them were largely 
+Thanks to a conversation with Jonathan Rochkind, Paramix has
+been completely rewritten.  Whereas anonymous modules were
+avoided in prior versions, it has become clear that the worries
+of memory consumption that would accompany them were largely 
 unfounded. This new version therefore makes use of them.
-The new code is refreshing concise, and the design fully
+The new code is refreshingly concise, and the design fully
 comforming to POLS.
 
 Changes:

data/QED.rdoc

@@ -0,0 +1,206 @@
+= Basic Example
+
+Require the library.
+
+  require 'paramix'
+
+Create a parametric mixin.
+
+    module MyMixin
+      include Paramix::Parametric
+
+      parameterized do |params|
+
+        public params[:name] do
+          params[:value]
+        end
+
+      end
+    end
+
+Create a class that uses the mixin and set the parameter.
+
+    class X
+      include MyMixin[:name => 'f', :value=>1]
+    end
+
+Then the parameter is accessible.
+
+    X.new.f.assert == 1
+
+
+= Nested Parematric Mixins
+
+If we create another parametric mixin which depends on the first.
+
+    module AnotherMixin
+      include Paramix::Parametric
+      include MyMixin[:name => 'f', :value=>1]
+
+      parameterized do |params|
+
+        public params[:name] do
+          params[:value]
+        end
+
+      end
+    end
+
+And a class for it.
+
+    class Y
+      include AnotherMixin[:name => 'g', :value=>2]
+    end
+
+We can see that the parameters stay with their respective mixins.
+
+    Y.new.f.assert == 1
+    Y.new.g.assert == 2
+
+However if we do the same, but do not paramterize the first module then
+the including module also become parametric.
+
+    module ThirdMixin
+      #include Paramix::Parametric
+      include MyMixin
+
+      parameterized do |params|
+
+        public params[:name].succ do
+          params[:value]
+        end
+
+      end
+    end
+
+And a class for it.
+
+    class Z
+      include ThirdMixin[:name => 'q', :value=>3]
+    end
+
+We can see that the value of the parameter has propogated up to its
+ancestor parametric module.
+
+    Z.new.q.assert == 3
+    Z.new.r.assert == 3
+
+
+= Parametric Include
+
+Load the library.
+
+  require 'paramix'
+
+Given a parametric mixin.
+
+  module M
+    include Paramix::Parametric
+
+    parameterized do |params|
+
+      public :f do
+        params[:p]
+      end
+
+    end
+  end
+
+We can inlcude the parameteric module in a some classes.
+
+  class I1
+    include M[:p => "mosh"]
+  end
+
+  class I2
+    include M[:p => "many"]
+  end
+
+And the result will vary according to the parameter set.
+
+  I1.new.f  #=> "mosh"
+  I2.new.f  #=> "many"
+
+
+= Parametric Extension
+
+We can also extend classes witht the mixin.
+
+  class E1
+    extend M[:p => "mosh2"]
+  end
+
+  class E2
+    extend M[:p => "many2"]
+  end
+
+And the results will likewise work as expected.
+
+   E1.f  #=> "mosh2"
+   E2.f  #=> "many2"
+
+
+= Dynamically Defined Methods
+
+Parametric mixins can be used to define dynamic code.
+
+  module N
+    include Paramix::Parametric
+
+    parameterized do |params|
+      attr_accessor params[:a]
+    end
+  end
+
+Now if we include this module we will have new attributes based on
+the parameter assigned.
+
+  class D1
+    include N[:a => "m1"]
+  end
+
+  class D2
+    include N[:a => "m2"]
+  end
+
+  d1 = D1.new
+  d1.m1 = :yes1
+
+  d1.m1  #=> :yes1
+
+  d2 = D2.new
+  d2.m2 = :yes2
+
+  d2.m2  #=> :yes2
+
+
+= Works with Namespaces
+
+Parametric mixins work regardless of the namespace depth.
+
+  module R
+    module M
+      include Paramix::Parametric
+
+      parameterized do |params|
+        public :f do
+          params[:p]
+        end
+      end
+    end
+  end
+
+  module Q
+    class I
+      include R::M[:p => "mosh"]
+    end
+    class E
+      extend R::M[:p => "many"]
+    end
+  end
+
+  Q::I.new.f  #=> "mosh"
+
+  Q::E.f #=> "many"
+
+

data/README.md

@@ -0,0 +1,53 @@
+# Paramix
+
+| Project    | Paramix                             |
+|:-----------|:------------------------------------|
+| Copyright  | (c) 2006 Rubyworks                  |
+| License    | BSD-2-Clause                        |
+| Website    | http://rubyworks.github.com/paramix |
+| GitHub     | http://github.com/rubyworks/paramix |
+| Status     | [![Build Status](https://secure.travis-ci.org/rubyworks/paramix.png)](http://travis-ci.org/rubyworks/paramix) |
+
+## Description
+
+Parametric Mixins provides an easy means to "functionalize" modules.
+The module can then be differentiated upon usage according to the
+parameters provided.
+
+
+## Release Notes
+
+Please see the HISTORY.rdoc file.
+
+
+## Example
+
+Here is a simple example that uses a a parameter 
+to define a method and another parameter to define
+it's return value.
+
+    module M
+      include Paramix::Parametric
+
+      paramaterized do |params|
+        define_method params[:name] do
+          params[:value]
+        end
+      end
+    end
+
+    class X
+      include M[:name=>'foo', :value='bar']
+    end
+
+    X.new.foo  #=> 'bar'
+
+
+## Copyrights
+
+Copyright (c) 2006 Thomas Sawyer
+
+This program is ditributed unser the terms of the BSD-2-Clause license.
+
+See COPYING.rdoc file for details.
+

data/lib/paramix.rb

@@ -1,6 +1,10 @@
-# paramix.rb, Copyright (c)2010 Thomas Sawyer [MIT License]
+# Paramix
+# Copyright 2010 Thomas Sawyer
+# Apache 2.0 License
 
-# Paramix project namespace.
+require 'paramix/version'
+
+# Paramix namespace.
 #
 module Paramix
 
@@ -27,7 +31,6 @@ module Paramix
   #
   #   MyClass.new.hello   #=> 'Hello from Ruby!'
   #
-  #
   module Parametric
 
     #

data/lib/paramix/version.rb

@@ -0,0 +1,3 @@
+module Paramix
+  VERSION = "2.0.0"  #:erb: VERSION = "<%= version %>"
+end

data/qed/01_basic.rdoc

@@ -0,0 +1,87 @@
+= Basic Example
+
+Require the library.
+
+  require 'paramix'
+
+Create a parametric mixin.
+
+    module MyMixin
+      include Paramix::Parametric
+
+      parameterized do |params|
+
+        public params[:name] do
+          params[:value]
+        end
+
+      end
+    end
+
+Create a class that uses the mixin and set the parameter.
+
+    class X
+      include MyMixin[:name => 'f', :value=>1]
+    end
+
+Then the parameter is accessible.
+
+    X.new.f.assert == 1
+
+
+= Nested Parematric Mixins
+
+If we create another parametric mixin which depends on the first.
+
+    module AnotherMixin
+      include Paramix::Parametric
+      include MyMixin[:name => 'f', :value=>1]
+
+      parameterized do |params|
+
+        public params[:name] do
+          params[:value]
+        end
+
+      end
+    end
+
+And a class for it.
+
+    class Y
+      include AnotherMixin[:name => 'g', :value=>2]
+    end
+
+We can see that the parameters stay with their respective mixins.
+
+    Y.new.f.assert == 1
+    Y.new.g.assert == 2
+
+However if we do the same, but do not paramterize the first module then
+the including module also become parametric.
+
+    module ThirdMixin
+      #include Paramix::Parametric
+      include MyMixin
+
+      parameterized do |params|
+
+        public params[:name].succ do
+          params[:value]
+        end
+
+      end
+    end
+
+And a class for it.
+
+    class Z
+      include ThirdMixin[:name => 'q', :value=>3]
+    end
+
+We can see that the value of the parameter has propogated up to its
+ancestor parametric module.
+
+    Z.new.q.assert == 3
+    Z.new.r.assert == 3
+