no_backsies 0.3.1 → 0.3.2

data/.ruby

@@ -0,0 +1,47 @@
+---
+source:
+- meta
+authors:
+- name: 7rans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2009'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: qed
+  groups:
+  - test
+  development: true
+- name: detroit
+  groups:
+  - build
+  development: true
+dependencies: []
+conflicts: []
+repositories: []
+resources:
+  home: http://rubyworks.github.com/no_backsies
+  code: http://github.com/rubyworks/no_backsies
+  mail: http://googlegroups/group/rubyworks-mailinglist
+  docs: http://rubydoc.info/gems/no_backsies/frames
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2011-04-29'
+summary: Better handling of Ruby callbacks
+title: NoBacksies
+version: 0.3.2
+name: no_backsies
+description: ! 'NoBacksies is a callback layer built on top of Ruby''s built-in callback
+
+  methods. It makes it possible to add new callbacks very easily, without
+
+  having to fuss with more nuanced issues of defining and redefining callback
+
+  methods.'
+organization: Rubyworks
+date: '2011-10-27'

data/.yardopts

@@ -0,0 +1,7 @@
+--output-dir doc
+--title NoBacksies
+--protected
+--private
+lib/
+-
+[A-Z]*.*

data/HISTORY.rdoc

@@ -1,5 +1,25 @@
 = RELEASE HISTORY
 
+== 0.3.2 | 2011-10-27
+
+This release adds support for calling super from within callback procedures.
+
+Changes:
+
+* Add support for calling super.
+
+
+== 0.3.1 | 2011-07-06
+
+Fix method argumements on const_missing, included, extended
+and inherited callbacks.
+
+Changes:
+
+* Fixed callback arguments that have been copy/pasted. (blambeau)
+* Add individual tests for each callback.
+
+
 == 0.3.0 | 2011-07-06
 
 This release is made primarily because the program is now

data/QED.rdoc

@@ -286,7 +286,7 @@ Given a class that defines a no-backsies +const_missing+ callback.
       @list ||= []
     end
 
-    callback :const_missing do |const|
+    callback :const_missing, :superless=>true do |const|
       list << const
     end
 
@@ -299,6 +299,8 @@ Then the results are as follows.
 
   Y.list #=> [:FOO, :BAR]
 
+Notice we used `:superless` to prevent super from being called, which would
+have raised an NameError.
 
 = Included
 

data/README.rdoc

@@ -1,5 +1,12 @@
 = No Backsies
 
+{Homepage}[http://rubyworks.github.com/no_backsies] |
+{Development}[http://github.com/rubyworks/no_backsies] |
+{Mailing List}[http://groups.google.com/group/rubyworks-mailinglist] |
+{API Reference}[http://rubydoc.info/gems/no_backsies/frames] |
+{Demonstrandum}[http://rubyworks.github.com/no_backsies/qed.html]
+
+
 == DESCRIPTION
 
 NoBacksies is a callback layer built on top of Ruby's built-in callback
@@ -8,13 +15,9 @@ having to fuss with more nuanced issues of defining and redefining callback
 methods.
 
 
-== RESOURCES
+== Compatability
 
-* {Homepage}[http://rubyworks.github.com/no_backsies]
-* {Development}[http://github.com/rubyworks/no_backsies]
-* {Mailing List}[http://groups.google.com/group/rubyworks-mailinglist]
-* {API Reference}[http://rubydoc.info/gems/no_backsies/frames]
-* {Demonstrandum}[http://rubyworks.github.com/no_backsies/QED.html]
+NoBacksies does not currently work with *Rubinius*. Anyone know why?
 
 
 == EXAMPLES
@@ -69,6 +72,37 @@ Install the RubyGems package in the usual fashion.
   $ gem install no_backsies
 
 
+== CONTRIBUTE
+
+=== Development
+
+Source code is hosted on GitHub[http://github.com/rubyworks/qed].
+If you'd like to submit a patch please fork the repository and
+submit a pull request (ideally in a topic branch).
+
+=== Testing
+
+QED[http://rubyworks.github.com/qed] is used to testing.
+
+  $ gem install qed
+
+To run the tests:
+
+  $ qed [path/to/test]
+
+=== Donations
+
+Software development is very time consuming. Rubyworks does a lot of FOSS 
+development for el <i>$0</i>. We do it for the love of programming and
+for Ruby. Any dollars that do come our way help us continue
+the effort. So anything you may offer will help these projects such as this
+continue to flourish. 
+
+See the {Rubyworks Homepage}[http://rubyworks.github.com]. 
+
+Thanks.
+
+
 == LEGAL
 
 (BSD 2 License)

data/lib/no_backsies.rb

@@ -1,6 +1,6 @@
 # NoBacksies module ecapsulates all supported callback mixins.
 #
-# NoBackseis::Callbacks can be mixed-in and all supported callbacks will
+# NoBacksies::Callbacks can be mixed-in and all supported callbacks will
 # be applied to the class or module. 
 # 
 #   class Y
@@ -46,14 +46,50 @@
 #   y = Y.new
 #   y.foo! #=> "foo!"
 #
-# NOTE: Currently the NoBackies module only supports class level callbacks.
-# We will look into adding instance level callbacks in a future version.
+# == Calling Super
 #
-#--
-# TODO: What about adding `super if defined?(super)` to callback methods?
-# Should this be standard? Should it occur before or after? Or should
-# in be controlled via a special callback, e.g. `callback method_added, :super`?
-#++
+# Each callback invocation passes along a superblock procedure, which can be
+# used to invoke `super` for the underlying callback method. For example,
+# it is common to call `super` in a `const_missing` callback if the dynamic
+# constant lookup fails.
+#
+#     callback :const_missing do |const, &superblock|
+#       psuedo_constants[const] || superblock.call
+#     end
+#
+# By default, super is called after call callback procedures are called becuase
+# that is by far the most commonly desired behavior. To suppress this behavior
+# pass the `:superless=>true` flag to the `callback` method.
+#
+#   callback :included, :superless=>true do |mod|
+#     ...
+#   end
+#
+# == Customizing the Underlying Callback Procedure
+#
+# Every callback follows the same simply pattern, e.g. for `method_added`:
+#
+#    def self.method_added(method)
+#      if defined?(super)
+#        callback_invoke(:method_added, method){ super(method) }
+#      else
+#        callback_invoke(:method_added, method)
+#      end
+#    end
+#
+# So it is easy enough to customize if you have some special requirements.
+# Say you want to call super before all callback procedures, and never allow
+# any callback procedure to do so themselves, then you could simply redefine
+# the underlying callback method as:
+#
+#    def self.method_added(method)
+#      super(method) if defined?(super)
+#      callback_invoke(:method_added, method)
+#    end
+#
+# NOTE: Currently the NoBacksies module only supports class level callbacks.
+# We will look into adding instance level callbacks, such as `method_missing`
+# in a future version.
 
 module NoBacksies
 
@@ -115,23 +151,27 @@ module NoBacksies
     end
 
     # Invoke a callback.
-    def callback_invoke(name, *args)
+    #
+    def callback_invoke(name, *args, &superblock)
       name = name.to_sym
       return unless callback_express[name]
       callbacks[name].each do |block, options|
         if options[:safe]
           callback_express(name=>false) do
-            block.call(*args)            
+            block.call(*args, &superblock)            
           end
         else
-          block.call(*args)
+          block.call(*args, &superblock)
         end
         if options[:once]
           callbacks[name].delete([block, options])
         end
+        if !options[:superless]
+          superblock.call if superblock
+        end
       end
     end
-  end
+  end #module
 
   # Callback system for #method_added.
   module MethodAdded
@@ -143,7 +183,11 @@ module NoBacksies
 
     #
     def method_added(method)
-      callback_invoke(:method_added, method)
+      if defined?(super)
+        callback_invoke(:method_added, method){ super(method) }
+      else
+        callback_invoke(:method_added, method)
+      end
     end
   end
 
@@ -157,7 +201,11 @@ module NoBacksies
 
     #
     def method_removed(method)
-      callback_invoke(:method_removed, method)
+      if defined?(super)
+        callback_invoke(:method_removed, method){ super(method) }
+      else
+        callback_invoke(:method_removed, method)
+      end
     end
   end
 
@@ -171,7 +219,11 @@ module NoBacksies
 
     #
     def method_undefined(method)
-      callback_invoke(:method_undefined, method)
+      if defined?(super)
+        callback_invoke(:method_undefined, method){ super(method) }
+      else
+        callback_invoke(:method_undefined, method)
+      end
     end
   end
 
@@ -185,11 +237,15 @@ module NoBacksies
 
     #
     def singleton_method_added(method)
-      callback_invoke(:singleton_method_added, method)
+      if defined?(super)
+        callback_invoke(:singleton_method_added, method){ super(method) }
+      else
+        callback_invoke(:singleton_method_added, method)
+      end
     end
   end
 
-  # Callback system for #method_removed.
+  # Callback system for #singleton_method_removed.
   module SingletonMethodRemoved
     #
     def self.append_features(base)
@@ -199,11 +255,15 @@ module NoBacksies
 
     #
     def singleton_method_removed(method)
-      callback_invoke(:singleton_method_removed, method)
+      if defined?(super)
+        callback_invoke(:singleton_method_removed, method){ super(method) }
+      else
+        callback_invoke(:singleton_method_removed, method)
+      end
     end
   end
 
-  # Callback system for #method_removed.
+  # Callback system for #singleton_method_undefined.
   module SingletonMethodUndefined
     #
     def self.append_features(base)
@@ -213,12 +273,16 @@ module NoBacksies
 
     #
     def singleton_method_undefined(method)
-      callback_invoke(:singleton_method_undefined, method)
+      if defined?(super)
+        callback_invoke(:singleton_method_undefined, method){ super(method) }
+      else
+        callback_invoke(:singleton_method_undefined, method)
+      end
     end
   end
 
-  # Callback system for #const_missing.
-  module ConstMissing
+  # Callback system for #included.
+  module Included
     #
     def self.append_features(base)
       base.extend CallbackMethods
@@ -226,13 +290,17 @@ module NoBacksies
     end
 
     #
-    def const_missing(const)
-      callback_invoke(:const_missing, const)
+    def included(mod)
+      if defined?(super)
+        callback_invoke(:included, mod){ super(mod) }
+      else
+        callback_invoke(:included, mod)
+      end
     end
   end
 
-  # Callback system for #included.
-  module Included
+  # Callback system for #extended.
+  module Extended
     #
     def self.append_features(base)
       base.extend CallbackMethods
@@ -240,13 +308,17 @@ module NoBacksies
     end
 
     #
-    def included(mod)
-      callback_invoke(:included, mod)
+    def extended(mod)
+      if defined?(super)
+        callback_invoke(:extended, mod){ super(mod) }
+      else
+        callback_invoke(:extended, mod)
+      end
     end
   end
 
-  # Callback system for #extended.
-  module Extended
+  # Callback system for #inherited.
+  module Inherited
     #
     def self.append_features(base)
       base.extend CallbackMethods
@@ -254,13 +326,19 @@ module NoBacksies
     end
 
     #
-    def extended(mod)
-      callback_invoke(:extended, mod)
+    def inherited(base)
+      if defined?(super)
+        callback_invoke(:inherited, base){ super(base) }
+      else
+        callback_invoke(:inherited, base)
+      end
     end
   end
 
-  # Callback system for #inherited.
-  module Inherited
+  # Callback system for #const_missing.
+  #
+  # Unlike other callback mixins, this does NOT invoke super (for obvious reasons).
+  module ConstMissing
     #
     def self.append_features(base)
       base.extend CallbackMethods
@@ -268,10 +346,13 @@ module NoBacksies
     end
 
     #
-    def inherited(base)
-      callback_invoke(:inherited, base)
+    def const_missing(const)
+      if defined?(super)
+        callback_invoke(:const_missing, const){ super(const) }
+      else
+        callback_invoke(:const_missing, const)
+      end
     end
   end
 
 end
-

data/qed/callbacks/07_const_missing.rdoc

@@ -9,7 +9,7 @@ Given a class that defines a no-backsies +const_missing+ callback.
       @list ||= []
     end
 
-    callback :const_missing do |const|
+    callback :const_missing, :superless=>true do |const|
       list << const
     end
 
@@ -22,3 +22,5 @@ Then the results are as follows.
 
   Y.list #=> [:FOO, :BAR]
 
+Notice we used `:superless` to prevent super from being called, which would
+have raised an NameError.

metadata

@@ -1,52 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: no_backsies
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.2
   prerelease: 
-  version: 0.3.1
 platform: ruby
-authors: 
-- Thomas Sawyer
+authors:
+- 7rans
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: qed
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &18797320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: detroit
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *18797320
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &18712220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: |-
-  NoBacksies is a callback layer built on top of Ruby's built-in callback
+  prerelease: false
+  version_requirements: *18712220
+description: ! 'NoBacksies is a callback layer built on top of Ruby''s built-in callback
+
   methods. It makes it possible to add new callbacks very easily, without
+
   having to fuss with more nuanced issues of defining and redefining callback
-  methods.
-email: transfire@gmail.com
-executables: []
 
+  methods.'
+email:
+- transfire@gmail.com
+executables: []
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- HISTORY.rdoc
 - README.rdoc
-files: 
+- QED.rdoc
+- COPYING.rdoc
+- NOTICE.rdoc
+files:
+- .ruby
+- .yardopts
 - lib/no_backsies.rb
 - qed/01_example.rdoc
 - qed/02_express.rdoc
@@ -68,34 +74,28 @@ files:
 - COPYING.rdoc
 - NOTICE.rdoc
 homepage: http://rubyworks.github.com/no_backsies
-licenses: []
-
+licenses:
+- BSD-2-Clause
 post_install_message: 
-rdoc_options: 
-- --title
-- NoBacksies API
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: no_backsies
-rubygems_version: 1.8.2
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Better handling of Ruby callbacks
 test_files: []
-