paramix 2.0.0 → 2.0.1

data/qed/02_general.rdoc

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

data/qed/03_battery.rdoc

@@ -0,0 +1,29 @@
+= 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/spec/nested_spec.rb

@@ -0,0 +1,229 @@
+require 'paramix'
+
+describe "nested modules where inner most module is parametric" do
+
+  m = Module.new do
+    include Paramix::Parametric
+
+    parameterized do |params|
+      public :f do
+        params[:p]
+      end
+    end
+  end
+
+  n = Module.new do
+    include m[:p=>"NMp"]
+  end
+
+  i = Class.new do
+    include n
+  end
+
+  e = Class.new do
+    extend  n
+  end
+
+
+  it "should" do
+    i.new.f.should == "NMp"
+  end
+
+  it "should" do
+    e.f.should == "NMp"
+  end
+
+end
+
+describe "nested parametric mixins with parameters" do
+
+  m = Module.new do
+    include Paramix::Parametric
+
+    parameterized do |params|
+      public :f do
+        params[:p]
+      end
+    end
+  end
+
+  n = Module.new do
+    include Paramix::Parametric
+    include m[:p=>"NMp"]
+
+    parameterized do |params|
+      public :g do
+        params[:p]
+      end
+    end
+  end
+
+  i = Class.new do
+    include n[:p => "INp"]
+  end
+
+  e = Class.new do
+    extend n[:p => "ENp"]
+  end
+
+
+  it "should" do
+    i.new.f.should == "NMp"
+  end
+
+  it "should" do
+    i.new.g.should == "INp"
+  end
+
+  it "should" do
+    e.f.should == "NMp"
+  end
+
+  it "should" do
+    e.g.should == "ENp"
+  end
+
+end
+
+describe "nested parametric mixins without parameters" do
+
+  m = Module.new do
+    include Paramix::Parametric
+
+    parameterized do |params|
+      public :f do
+        params[:p]
+      end
+    end
+  end
+
+  n = Module.new do
+    include m
+
+    parameterized do |params|
+      public :g do
+        params[:p]
+      end
+    end
+  end
+
+  i = Class.new do
+    include n[:p => "INp"]
+  end
+
+  e = Class.new do
+    extend n[:p => "ENp"]
+  end
+
+
+  it "should" do
+    i.new.f.should == "INp"
+  end
+
+  it "should" do
+    i.new.g.should == "INp"
+  end
+
+  it "should" do
+    e.f.should == "ENp"
+  end
+
+  it "should" do
+    e.g.should == "ENp"
+  end
+
+end
+
+describe "nested parametric mixins where the outer is not parameterized" do
+
+  m = Module.new do
+    include Paramix::Parametric
+
+    parameterized do |params|
+      public :f do
+        params[:p]
+      end
+    end
+  end
+
+  n = Module.new do
+    include Paramix::Parametric
+    include m[:p=>"NMp"]
+  end
+
+  i = Class.new do ; include n[] ; end
+  e = Class.new do ; extend  n[] ; end
+
+  ix = Class.new do ; include n[:p=>"IxNp"] ; end
+  ex = Class.new do ; extend  n[:p=>"ExNp"] ; end
+
+
+  it "should" do
+    i.new.f.should == "NMp"
+  end
+
+  it "should" do
+    e.f.should == "NMp"
+  end
+
+  it "should" do
+    i.new.f.should == "NMp"
+  end
+
+  it "should" do
+    e.f.should == "NMp"
+  end
+
+end
+
+
+describe "nested parametric mixins both parameterized" do
+
+  m = Module.new do
+    include Paramix::Parametric
+
+    parameterized do |params|
+      public :f do
+        params[:p]
+      end
+    end
+  end
+
+  n = Module.new do
+    include Paramix::Parametric
+    include m[:p=>"mood"]
+
+    parameterized do |params|
+      public :g do
+        params[:p]
+      end
+    end
+  end
+
+  i = Class.new do
+    include n[]
+  end
+
+  e = Class.new do
+    extend n[]
+  end
+
+
+  it "should" do
+    i.new.f.should == "mood"
+  end
+
+  it "should" do
+    i.new.g.should == nil  # TODO: or error ?
+  end
+
+  it "should" do
+    e.f.should == "mood"
+  end
+
+  it "should" do
+    e.g.should == nil
+  end
+
+end
+

data/spec/paramix_dynamic_spec.rb

@@ -0,0 +1,48 @@
+require 'paramix'
+
+describe "dynamic methods using paramtric mixins" do
+
+  module M
+    include Paramix::Parametric
+
+    parameterized do |params|
+
+      public :f do
+        params[:p]
+      end
+
+      attr_accessor params[:p]
+    end
+  end
+
+  class C1
+    include M[:p => "c1"]
+  end
+
+  class C2
+    include M[:p => "c2"]
+  end
+
+  it "should" do
+    c = C1.new
+    c.f.should == "c1"
+  end
+
+  it "should" do
+    c = C2.new
+    c.f.should == "c2"
+  end
+
+  it "should" do
+    c = C1.new
+    c.c1 = :yes1
+    c.c1.should == :yes1
+  end
+
+  it "should" do
+    c = C2.new
+    c.c2 = :yes2
+    c.c2.should == :yes2
+  end
+
+end

data/spec/paramix_extend_spec.rb

@@ -0,0 +1,21 @@
+require 'paramix'
+
+describe "extend with parametric mixins" do
+
+  # -- fixture ------------------------------
+
+  module M
+    include Paramix::Parametric
+
+    parameterized do |params|
+
+      public :f do
+        params[:p]
+      end
+
+    end
+  end
+
+
+end
+

data/spec/paramix_include_spec.rb

@@ -0,0 +1,44 @@
+require 'paramix'
+
+describe "include with parametric mixins" do
+
+  module M
+    include Paramix::Parametric
+
+    parameterized do |params|
+
+      public :f do
+        params[:p]
+      end
+
+    end
+  end
+
+  class I1
+    include M[:p => "mosh"]
+  end
+
+  class I2
+    include M[:p => "many"]
+  end
+
+  class E1
+    extend M[:p => "mosh"]
+  end
+
+  class E2
+    extend M[:p => "many"]
+  end
+
+  it "should vary the return value of the instance methods" do
+    I1.new.f.should == "mosh"
+    I2.new.f.should == "many"
+  end
+
+  it "should vary the return value of the class methods " do
+    E1.f.should == "mosh"
+    E2.f.should == "many"
+  end
+
+end
+