forwarder19 0.2.0rc4 → 0.2.0rc5

data/README.md

@@ -20,9 +20,7 @@ http://www.opensource.org/licenses/mit-license.html
 
 ## Performance
 
-Performance is _normal_, as it is for 'Forwardable' however the goal is to have delegated methods
-to run about as twice as fast as methods created by 'Forwardable.def_delegator'. This seems to be
-a realistic goal as can be seen here: https://github.com/RobertDober/Forwarder19/blob/dev/bm/study.rb
+Execution time is that of 85~95% of Forwardable by evalling strings whenever possible.
 
 
 ## Simple Delegation As In Forwardable
@@ -95,6 +93,53 @@ one parameter. This becomes clearer with an example.
            with: [ /[,.]\b/, '\& ' ]
 ```
 
+### A Useful Shorthand
+
+As I found myself using the following idioms all the time
+
+```ruby
+
+  forward :some_method, to: :@some_hash, as: :[], with: :some_method
+  forward :other_method, to: :hash, as: :[], with: :other_key
+
+```
+
+I conceived the `to_hash` shortcut for these. Strictly spoken (and not striktly spoken
+too) this is a gross generalisation of the usecase as if they target had to be a `Hash`
+all the time. This is not the case of course, we are just forwarding a message with a
+parameter...
+
+Here is how the above idioms can be expressed by means of the `to_hash` target:
+
+```ruby
+
+   forward :some_method, to_hash: :@some_hash
+   forward :other_method, to_hash: :hash, as: :other_key
+
+```
+
+Concerning jargon we are doing something a little bit confusing here. In all cases we have
+an implicit translation (which is `:[]` of course). In the second case we have an explicit
+translation (being `:other_key`) too. The explicit translation is transformed into the first,
+and only argument, as we do not allow explicit arguments for `to_hash:` targets.
+
+However you still can use the `forward_all` version and a `to_hash:` chain target, here is
+an example:
+
+```ruby
+
+   class Params
+     extend Forwarder
+     forward_all :count, :limit, to_hash: [:@params, :mandatory]
+     forward :pretend?, to_hash: [:@params, :optional], as: :dry_run
+   end
+
+```
+
+AOP is not supported for `to_hash:` targets in this version, this might change in the future
+as use cases are imaginable (e.g. an after filter for the `:pretend?` method, applying !! to
+the result).
+
 ### Partial Application
 
 This example gives us the oppurtunity to look at a use case for partial applications. Let us assume that

data/lib/forwarder/arguments.rb

@@ -44,9 +44,9 @@ module Forwarder
       @params[:to_object]
     end
 
-    def delegatable?
-      !aop? && !custom_target? && !all? && !chain? && !args && !lambda?
-    end
+#     def delegatable?
+#       !aop? && !custom_target? && !all? && !chain? && !args && !lambda?
+#     end
 
     def evaluable?
       !lambda? &&
@@ -78,6 +78,10 @@ module Forwarder
       Evaller.serialize args
     end
       
+    def to_hash?
+      @__to_hash__ ||= @params[ :to_hash ]
+    end
+
     def translation alternative=nil, &blk
       @params[ :as ].tap do | tltion |
         break alternative unless tltion
@@ -94,7 +98,6 @@ module Forwarder
     def check_for_incompatibilities!
       raise ArgumentError, "cannot provide translations for forward_all" if @__all__ && translation
       raise ArgumentError, "cannot provide arguments for forward_all" if @__all__ && args?
-
     end
 
     def initialize *args, &blk
@@ -105,6 +108,7 @@ module Forwarder
       set_target
       set_args blk
       check_for_incompatibilities!
+      translate_to_hash
     end
 
     def set_args blk
@@ -112,8 +116,10 @@ module Forwarder
       hw = @params.has_key? :with
       ha = @params.has_key? :with_ary
       raise ArgumentError, "cannot use :with and :with_ary parameter" if hw && ha
-      set_args_normal if hw
-      set_args_ary if ha
+      unless to_hash?
+        set_args_normal if hw
+        set_args_ary if ha
+      end
     end
 
     def set_args_ary
@@ -124,9 +130,9 @@ module Forwarder
     def set_args_normal
       case arg = @params[:with]
       when Array
-        @args = arg.dup
+        @args = arg.dup rescue arg
       else
-        @args = [ arg ]
+        @args = [ (arg.dup rescue arg) ]
       end
     end
 
@@ -152,7 +158,7 @@ module Forwarder
     end
 
     def set_target
-      [:to, :to_chain, :to_object].each do | tgt_kwd |
+      [:to, :to_chain, :to_object, :to_hash].each do | tgt_kwd |
         tgt = @params[ tgt_kwd ]
         next unless tgt
 
@@ -162,6 +168,10 @@ module Forwarder
       raise ArgumentError, "no target specified." unless @target
     end
 
+    def translate_to_hash
+      return unless @params[:to_hash]
+      raise ArgumentError, "cannot provide arguments for to_hash:" if @params.has_key?( :with ) || @params.has_key?( :with_ary )
+    end
     def use_block?
       aop_values.include?( :use_block )
     end

data/lib/forwarder/compiler.rb

@@ -8,6 +8,9 @@ module Forwarder
       # Cannot compile because of intrinsic uncompilable traits of arguments
       return if arguments.must_not_compile?
 
+      # To Hash can always compile
+      return compile_to_hash if arguments.to_hash?
+
       # Cannot compile because arguments cannot be compiled
       @compiled_args = Evaller.serialize arguments.args
 
@@ -21,12 +24,6 @@ module Forwarder
 
     private
 
-    def compile_to_all
-      arguments.message.map{ |msg|
-        "def #{msg} *args, &blk; #{arguments.target}.#{msg}( *args, &blk ) end"
-      }.join("\n")
-    end
-
     def compile_one
       tltion = arguments.translation arguments.message
       "def #{arguments.message} *args, &blk; " +
@@ -35,6 +32,23 @@ module Forwarder
         "*args, &blk ) end"
     end
 
+    def compile_to_all
+      arguments.message.map{ |msg|
+        "def #{msg} *args, &blk; #{arguments.target}.#{msg}( *args, &blk ) end"
+      }.join("\n")
+    end
+
+    def compile_to_hash
+      target = arguments.to_hash?
+      target = target.join(".") if Array === target
+      [arguments.message]
+        .flatten
+        .map do | msg |
+          # N.B. that the expression between [] is always a Symbol
+          "def #{msg}; #{target}[ #{(arguments.translation||msg).to_sym.inspect} ] end"
+        end.join("\n")#.tap do |x| debugger end
+    end
+
     def initialize args
       @arguments = args 
     end

data/lib/forwarder/meta.rb

@@ -4,7 +4,6 @@ module Forwarder
 
     attr_reader :arguments, :forwardee
 
-
     # TODO: Break AOP out of this so that we do not check @ runtime
     def forward
       if arguments.aop?

data/lib/forwarder/version.rb

@@ -1,3 +1,3 @@
 module Forwarder
-  VERSION = '0.2.0rc4'
+  VERSION = '0.2.0rc5'
 end # module Forwarder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forwarder19
 version: !ruby/object:Gem::Version
-  version: 0.2.0rc4
+  version: 0.2.0rc5
   prerelease: 5
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000Z
+date: 2012-04-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lab419_core
-  requirement: &19218520 !ruby/object:Gem::Requirement
+  requirement: &13783720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *19218520
+  version_requirements: *13783720
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &19214860 !ruby/object:Gem::Requirement
+  requirement: &13782800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.11'
   type: :development
   prerelease: false
-  version_requirements: *19214860
+  version_requirements: *13782800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19066140 !ruby/object:Gem::Requirement
+  requirement: &13781560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *19066140
+  version_requirements: *13781560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18401500 !ruby/object:Gem::Requirement
+  requirement: &13780620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *18401500
+  version_requirements: *13780620
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &18397100 !ruby/object:Gem::Requirement
+  requirement: &13779720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *18397100
+  version_requirements: *13779720
 - !ruby/object:Gem::Dependency
   name: wirble
-  requirement: &18395760 !ruby/object:Gem::Requirement
+  requirement: &13778460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,26 +76,12 @@ dependencies:
         version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *18395760
-description: ! 'Ruby''s core Forwardable gets the job done(barely) and produces most
-  unreadable code. Furthermore it is about twice as slow (1.9.2-p290) or thrice as
-  slow (1.9.3-p0) as it needs to be.
-
-
-  This is a nonintrusive (as is Forwardable) module that allows to delegate methods
-  to instance variables,
-
-  objects returned by instance_methods, other methods of the same receiver, the receiver
-  itself, a chain of messages or
-
-  an arbitrary object. Paramters can be provided in the forwarding definition (parially
-  or totally=.
-
-  It also defines some AOP support as after and before filters.
-
-
-  Performance will be pushed to 2~3 times of Fowardable with the 0.2 branch of this
-  gem'
+  version_requirements: *13778460
+description: ! "Ruby's core Forwardable gets the job done(barely) and produces most
+  unreadable code. \n\n  Forwarder19 not only is more readable, much more feature
+  rich, but also slightly faster, meaning you can use it without performance penalty.\n\n
+  \ Additional features include: providing arguments, (partially if needed), AOP and
+  custom forwarding to hashes\n  "
 email: robert.dober@gmail.com
 executables: []
 extensions: []