mixers 1.1.0 → 1.2.0

data/HISTORY

@@ -0,0 +1,19 @@
+= RELEASE HISTORY
+
+== 1.2.0 / 2010-10-12
+
+This release deprecates the Advisable mixin, as it was not
+operating correctly, and I beleive requires a complete rewrite
+to do so --which I am not endeavoring into because it has become
+clear there are much better ways to appoach the needs it addressed.
+
+== 1.1.0 / 2010-05-07
+
+Thie release include a complete rewrite of the Advisable mixin
+and bug fixes to the Registerable mixin. Also QED doc/tests
+had been added for almost all mixins.
+
+== 1.0.0 / 2010-05-02
+
+Initial release of libraries as take directory from Ruby Facets.
+

data/LICENSE

@@ -1,22 +1,205 @@
-The MIT License
+.
 
-Copyright (c) 2010 Thomas Sawyer
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
 
-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:
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+   1. Definitions.
 
-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.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
 
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+.

data/PROFILE

@@ -0,0 +1,23 @@
+--- 
+title  : Mixers
+suite  : rubyworks
+summary: Collection of helpful mixin modules
+contact: Trans <transfire@gmail.com>
+license: Apache 2.0
+authors: Thomas Sawyer
+created: 2010-05-02
+
+description:
+  Ruby Mixers is collection mixin modules for the Ruby
+  programming language. Mixers is a spin-off of Ruby
+  Facets. When Ruby Facets scaled back to extensions
+  only project, it's mixin modules were gathered to
+  create this new project.
+
+resources:
+  home: http://rubyworks.github.com/mixers
+  code: http://github.com/rubyworks/mixers
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+
+copyright:
+  Copyright (c) 2010 Thomas Sawyer

data/README.rdoc

@@ -9,9 +9,11 @@ Mixers is a spin-off of Ruby Facets. When Ruby Facets
 scaled back to extensions only project, it's mixin 
 modules were gathered to create this new project.
 
-== COPYRIGHTS
+== COPYRIGHT
 
-Ruby Mixers Copyright (c) 2010 Thomas Sawyer
+(Apache 2.0 License)
 
-Ruby Mixers is distibuted under the terms of the MIT license.
+Ruby Mixers, Copyright (c) 2010 Thomas Sawyer
+
+Ruby Mixers is distibuted under the terms of the Apache 2.0 license.
 

data/VERSION

@@ -0,0 +1,8 @@
+name    : mixers
+date    : 2010-10-12
+version : 1.2.0
+
+requires:
+  - syckle (build)
+  - qed (test)
+

data/lib/mixers.rb

@@ -0,0 +1,11 @@
+module Mixers
+  DIRECTORY = File.dirname(__FILE__)
+
+  def self.version
+    @version ||= YAML.load(File.new(DIRECTORY + '/mixers/version.yml'))
+  end
+
+  def self.const_missing(name)
+    version[name.to_s.downcase] || super(name)
+  end
+end

data/lib/mixers/expirable.rb

@@ -4,10 +4,9 @@
 #
 module Expirable
 
-  attr_accessor :expiration
+  attr_reader :expiration
 
   # Set the expires timeout for this entry.
-
   def expiration=(time)
     case time
     when Time, Date, DateTime
@@ -17,29 +16,21 @@ module Expirable
     end
   end
 
-  #def expires_after(timeout = 86400)
-  #  @expires = Time.now + timeout
-  #end
-
   ## Set the expire timeout for this entry. The timeout happens
   ## after (base + rand(spread)) seconds.
-  #
-  #def expires_spread(base, spread)
-  #  @expires = Time.now + base + rand(spread)
-  #end
+  ##
+  ##def expires_spread(base, spread)
+  ##  @expires = Time.now + base + rand(spread)
+  ##end
 
   # Is this entry expired?
-
   def expired?
-    if @expiration.nil? or (Time.now > @expiration)
-      return true
-    else
-      return false
-    end
+    return true if expiration.nil?
+    return true if (Time.now > expiration)
+    return false
   end
 
   # Update the expiration period. Override in your application.
-
   def touch!
   end
 

data/lib/mixers/version.yml

@@ -0,0 +1,8 @@
+name    : mixers
+date    : 2010-10-12
+version : 1.2.0
+
+requires:
+  - syckle (build)
+  - qed (test)
+

data/qed/06_expirable.rdoc

@@ -12,7 +12,7 @@ Example class.
 
 Now the experation can be set to a Time object, or a number of seconds
 from +Time.now+. For instance, to set the expiration for one second
-from now:
+from now.
 
   X.expiration = 1
 
@@ -20,7 +20,7 @@ We can see the the object has not yet expired.
 
   X.refute.expired?
 
-But if we wait one second.
+But if we wait one seconds.
 
   sleep 1
 

data/qed/08_ostructable.rdoc

@@ -4,7 +4,7 @@ Require the library.
 
   require 'mixers/ostructable'
 
-We will use the simpliest example class:
+We will use the simpliest example class.
 
   class X
     include OpenStructable

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixers
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -14,25 +15,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 -04:00
+date: 2010-10-12 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
-description: |-
-  Ruby Mixers is collection mixin modules for the Ruby
-  programming language. Mixers is a spin-off of Ruby
-  Facets. When Ruby Facets scaled back to extensions
-  only project, it's mixin modules were gathered to
-  create this new project.
-email: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: syckle
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: qed
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Ruby Mixers is collection mixin modules for the Ruby programming language. Mixers is a spin-off of Ruby Facets. When Ruby Facets scaled back to extensions only project, it's mixin modules were gathered to create this new project.
+email: transfire@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
 files: 
-- lib/mixers/advisable.rb
 - lib/mixers/cloneable.rb
 - lib/mixers/enumargs.rb
 - lib/mixers/equitable.rb
@@ -42,23 +64,8 @@ files:
 - lib/mixers/ostructable.rb
 - lib/mixers/preinitialize.rb
 - lib/mixers/registerable.rb
-- meta/authors
-- meta/contact
-- meta/description
-- meta/name
-- meta/repository
-- meta/sites/api
-- meta/sites/blog
-- meta/sites/development
-- meta/sites/documentation
-- meta/sites/homepage
-- meta/sites/mail
-- meta/sites/source
-- meta/sites/wiki
-- meta/suite
-- meta/summary
-- meta/version
-- qed/01_advisable.rdoc
+- lib/mixers/version.yml
+- lib/mixers.rb
 - qed/02_cloneable.rdoc
 - qed/03_enumargs.rdoc
 - qed/04_equitable.rdoc
@@ -73,37 +80,45 @@ files:
 - test/test_equitable.rb
 - test/test_instantiable.rb
 - test/test_preinitilizable.rb
+- PROFILE
 - LICENSE
 - README.rdoc
 - HISTORY
+- VERSION
 has_rdoc: true
 homepage: http://rubyworks.github.com/mixers
-licenses: []
-
+licenses: 
+- Apache 2.0
 post_install_message: 
 rdoc_options: 
 - --title
 - Mixers API
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: mixers
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Collection of helpful mixin modules

data/lib/mixers/advisable.rb

@@ -1,80 +0,0 @@
-# = Advisable
-#
-# Advisable provides a means of using before, after and
-# around adivce in dynamic fashion.
-#
-module Advisable
-
-  require 'facets/proc/bind'
-
-  def self.append_features(base)
-    base.extend(self)
-  end
-
-  def before(meth, &block)
-    advice_before[meth.to_sym] << block
-    method_added(meth) if method_defined?(meth)
-  end
-
-  def after(meth, &block)
-    advice_after[meth.to_sym] << block
-    method_added(meth) if method_defined?(meth)
-  end
-
-  def around(meth, &block)
-    advice_around[meth.to_sym] << block
-    method_added(meth) if method_defined?(meth)
-  end
-
-  def advice_before
-    @@advice_before ||= Hash.new{|h,k| h[k] = []}
-  end
-
-  def advice_after
-    @@advice_after ||= Hash.new{|h,k| h[k] = []}
-  end
-
-  def advice_around
-    @@advice_around ||= Hash.new{|h,k| h[k] = []}
-  end
-
-  # TODO: Should around advice be fed the result of the last around advice?
-  def method_added(meth)
-    @method_added_stack ||= []
-    return if @method_added_stack.last == meth
-    @method_added_stack << meth
-
-    if advice_before.key?(meth) or advice_after.key?(meth)
-
-      before = advice_before[meth]  || []
-      around = advice_around[meth]  || []
-      after  = advice_after[meth]   || []
-
-      alias_method "#{meth}:advised", meth
-      target = instance_method("#{meth}:advised")
-
-      define_method meth do |*a, &b|
-        before.reverse_each do |block|
-          block.bind(self).call(*a,&b)
-        end
-        if around.empty?
-          result = target.bind(self).call(*a,&b)
-        else
-          around.each do |block|
-            result = block.call(target.bind(self),*a,&b)
-          end
-        end
-        after.each do |block|
-          block.bind(self).call(*a,&b)
-        end
-        result
-      end
-    end
-
-    super(meth)
-
-    @method_added_stack.pop
-  end
-
-end
-

data/meta/authors

@@ -1 +0,0 @@
-Thomas Sawyer

data/meta/contact

@@ -1 +0,0 @@
-rubyworks-mailinglist@googlegroups.com

data/meta/description

@@ -1,6 +0,0 @@
-Ruby Mixers is collection mixin modules for the Ruby
-programming language. Mixers is a spin-off of Ruby
-Facets. When Ruby Facets scaled back to extensions
-only project, it's mixin modules were gathered to
-create this new project.
-

data/meta/name

@@ -1 +0,0 @@
-mixers

data/meta/repository

@@ -1 +0,0 @@
-git://github.com/rubyworks/mixers.git

data/meta/sites/api

@@ -1 +0,0 @@
-http://rubyworks.github.com/mixers/rdoc

data/meta/sites/blog

@@ -1 +0,0 @@
-http://rubyworks.github.com/

data/meta/sites/development

@@ -1 +0,0 @@
-http://github.com/rubyworks/mixers

data/meta/sites/documentation

@@ -1 +0,0 @@
-http://wiki.github.com/rubyworks/mixers

data/meta/sites/homepage

@@ -1 +0,0 @@
-http://rubyworks.github.com/mixers

data/meta/sites/mail

@@ -1 +0,0 @@
-http://groups.google.com/group/rubyworks-mailinglist

data/meta/sites/source

@@ -1 +0,0 @@
-http://github.com/rubyworks/mixers

data/meta/sites/wiki

@@ -1 +0,0 @@
-http://wiki.github.com/rubyworks/mixers

data/meta/suite

@@ -1 +0,0 @@
-rubyworks

data/meta/summary

@@ -1 +0,0 @@
-Collection of helpful mixin modules

data/meta/version

@@ -1 +0,0 @@
-1.1.0

data/qed/01_advisable.rdoc

@@ -1,71 +0,0 @@
-= Advisable
-
-Require the library.
-
-    require 'mixers/advisable'
-
-We will use this fixture.
-
-    class X
-      include Advisable
-
-      attr_reader :out
-
-      def initialize
-        @out = []
-      end
-
-      before :x do
-        @out << "BEFORE X#x"
-      end
-
-      after :x do
-        @out << "AFTER X#x"
-      end
-
-      def x
-        @out << "X#x"
-        "x"
-      end
-    end
-
-Our results:
-
-    x = X.new
-    r = x.x
-    o = x.out
-    r.assert == "x"
-    o.assert == ["BEFORE X#x", "X#x", "AFTER X#x"]
-
-And let's see what a subclass of the example does:
-
-    class Y < X
-      before :x do
-        @out << "BEFORE Y#x"
-      end
-
-      after :x do
-        @out << "AFTER Y#x"
-      end
-
-      around :x do |target|
-        "{" + target.call + "}"
-      end
-
-      def x
-        @out << "Y#x"
-        super
-      end
-    end
-
-    y = Y.new
-
-The result of #x should be a bracketed "x".
-
-    y.x.assert == "{x}"
-
-Then the out variable should indicate where the call has been.
-
-    y.out.assert == ["BEFORE Y#x", "BEFORE X#x", "Y#x", "X#x", "AFTER X#x", "AFTER Y#x"]
-
-