appkernel 0.1.0 → 0.1.1

data/History.txt

@@ -2,3 +2,7 @@
 
 * 1 major enhancement:
   * functioning prototype which allows you to create portable, self-validating functions
+
+== 0.1.0 2009-06-29
+* 1 major enhancement:
+  * support for object resolution and required arguments

data/README.rdoc

@@ -11,6 +11,7 @@ Once defined, these functions can be used in rails, cocoa, an sms gateway, or wh
 
 * Package the bits of your application in terms of what it *does*, not the entities it contains.
 * Get a command line interface for free (that's better than vanilla script/console)
+* Transparent conversion between options and the strings that represent them.
 
 == SYNOPSIS:
 

data/lib/appkernel/function.rb

@@ -10,7 +10,7 @@ class AppKernel
     def self.included(mod)
       class << mod
         def function(symbol, &definition)
-          fun = ::AppKernel::FunctionDefinition.new(definition)
+          fun = ::AppKernel::FunctionDefinition.new(symbol, definition)
           self.const_set(symbol, fun)
           self.send(:define_method, symbol) do |*args|
             FunctionApplication.apply_or_die(fun, *args)
@@ -33,13 +33,12 @@ class AppKernel
   
   class FunctionApplication
     
-    attr_reader :return_value, :errors, :function, :options
+    attr_reader :return_value, :errors, :function, :args
     
     def initialize(fun, *args)
       @function = fun
-      @args = args
-      @options = {}
       @errors = {}
+      @args = Arguments.new(self, *args)
       @return_value = self.class.do_apply(self, *args)
     end
     
@@ -47,6 +46,47 @@ class AppKernel
       @errors.empty?
     end
     
+    def options
+      @args.canonical
+    end
+    
+    class Arguments   
+      
+      attr_reader :canonical
+               
+      def initialize(app, *args)
+        fun = app.function
+        @app = app
+        @canonical = {}
+        @required = Set.new(fun.options.values.select {|o| o.required?})      
+        @optorder = fun.indexed_options  
+
+        for arg in args
+          if (arg.is_a?(Hash))
+            arg.each do |k,v|
+              if opt = fun.options[k.to_sym]
+                set opt, v
+              else
+                raise FunctionCallError, "unknown option :#{@name}"
+              end 
+            end
+          elsif opt = @optorder.shift
+            set opt, arg
+          end
+        end
+        for opt in @required
+          app.errors[opt.name] = "missing required option '#{@name}'"
+        end
+      end
+      
+      def set(opt, value)      
+        if resolved = opt.resolve(@app, value)
+          @canonical[opt.name] = resolved
+          @required.delete opt
+        end
+      end
+    end
+    
     class << self
       
       def apply_or_die(fun, *args)
@@ -58,31 +98,16 @@ class AppKernel
         end
       end
       
-      def do_apply(app, *args)
-        fun = app.function
-        instance = Object.new
-        indexed_options = fun.indexed_options
-        required_options = Set.new(fun.options.values.select {|o| o.required?})
-        for arg in args do
-          if arg.kind_of?(Hash)
-            arg.each do |k,v| 
-              if opt = fun.options[k.to_sym]
-                opt.set instance, v
-                required_options.delete opt
-                app.options[opt.name] = v
-              end
-            end
-          elsif opt = indexed_options.shift
-            opt.set instance, arg
-            required_options.delete opt
-            app.options[opt.name] = arg
+      def do_apply(app, *args)    
+        fun = app.function      
+        app.errors.merge! fun.validation.validate(app.options) if app.successful?
+        if app.successful?
+          scope = Object.new
+          for k,v in app.options do
+            scope.instance_variable_set("@#{k}", v)
           end
+          scope.instance_eval &fun.impl
         end
-        for opt in required_options do
-          app.errors[opt.name] = "Missing required option '#{opt.name}'"
-        end
-        app.errors.merge! fun.validation.validate(app.options)
-        instance.instance_eval &fun.impl if app.successful?
       end
     end    
   end
@@ -91,7 +116,8 @@ class AppKernel
     
     attr_reader :impl, :options, :validation
     
-    def initialize(definition)
+    def initialize(name, definition)
+      @name = name
       @options = {}
       @impl = lambda {}
       @validation = ::AppKernel::Validation::Validator.new 
@@ -114,19 +140,22 @@ class AppKernel
     def validate(&checks)
       @validation = AppKernel::Validation::Validator.new(&checks)
     end
+
+    def to_s
+      "#{@name}()"
+    end
             
     class Option
+      ID = lambda {|o| o}
       attr_reader :name, :index
       def initialize(name, params)
-        @name = name
+        @name = name.to_sym
         @index = params[:index]
         @required = params[:required] == true
+        @finder = params[:find]
+        @type = params[:type]
       end
-            
-      def set(o, value)
-        o.instance_variable_set("@#{@name}", value)
-      end
-      
+                  
       def required?
         @required
       end
@@ -134,12 +163,39 @@ class AppKernel
       def optional?
         !@required
       end
+      
+      def resolve(app, value)
+        if value.nil?
+          nil
+        elsif @type 
+          if value.is_a?(@type)
+            value
+          elsif @finder
+            lookup(app, value)
+          else
+            raise FunctionDefinitionError, "Don't know how to convert #{value.class}:#{value} -> #{@type}"
+          end
+        elsif @finder
+          lookup(app, value)
+        else
+          value
+        end
+      end
+      
+      def lookup(app, value)
+        result = @finder.call(value)
+        app.errors[@name] = "couldn't find '#{@name}': #{value}" if result.nil? 
+        result
+      end
+           
     end
     
     class Validator
     end
   end
   
+  class FunctionCallError < StandardError; end
+  
   class ValidationError < StandardError
     def initialize(application)
       @app = application

data/lib/appkernel/validation.rb

@@ -17,14 +17,18 @@ module AppKernel::Validation
           NilValue.new
         when Fixnum
           FixnumValue.new(v)
+        when Symbol
+          v
         else
           v.dup
         end
-        val.extend Check
-        val.instance_eval do
-          @_add_validation_error = lambda {|message|
-            errors[k] = message
-          }
+        unless Symbol === val
+          val.extend Check
+          val.instance_eval do
+            @_add_validation_error = lambda {|message|
+              errors[k] = message
+            }
+          end
         end
         scope.instance_variable_set("@#{k}", val)
       end      

data/lib/appkernel.rb

@@ -1,6 +1,6 @@
 
 class AppKernel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
   require 'appkernel/function'
   require 'appkernel/validation'
 end

data/spec/appkernel/function_spec.rb

@@ -28,22 +28,18 @@ describe AppKernel::Function do
   end
   
   it "allows certain options to be the default option" do
-    @mod.module_eval do
-      function :Say do
-        option :greeting, :index => 0
-        option :to, :index => 1
-        option :extra
-        
-        execute do
-          "#{@greeting} #{@to}#{(', ' + @extra) if @extra}" 
-        end
-      end
-      
+    function :Say do
+      option :greeting, :index => 0
+      option :to, :index => 1
+      option :extra
       
-      Say("Hello", "Charles", :extra => "How are you?").should == "Hello Charles, How are you?"
-      Say("Hello", "Charles").should == "Hello Charles"
-      Say(:greeting => "Hello", :to => "Charles").should == "Hello Charles"
+      execute do
+        "#{@greeting} #{@to}#{(', ' + @extra) if @extra}" 
+      end            
     end
+    Say("Hello", "Charles", :extra => "How are you?").should == "Hello Charles, How are you?"
+    Say("Hello", "Charles").should == "Hello Charles"
+    Say(:greeting => "Hello", :to => "Charles").should == "Hello Charles"    
   end
   
   it "allows classes that include the module to also use the commands from that module" do
@@ -75,27 +71,23 @@ describe AppKernel::Function do
   end
   
   it "can be called by using the apply method instead of invoking it directly" do
-    @mod.module_eval do
-      function :FiveAlive do
-        option :desc, :index => 1
-        execute do
-          "FiveAlive is a #{@desc}"
-        end
-      end  
-    end
+    function :FiveAlive do
+      option :desc, :index => 1
+      execute do
+        "FiveAlive is a #{@desc}"
+      end
+    end  
     result = apply(@mod::FiveAlive, "candy bar")
     result.return_value.should == "FiveAlive is a candy bar"
     result.successful?.should be(true)
   end
   
   it "can have required options, but they are never required by default" do
-    @mod.module_eval do
-      function :Say do
-        option :greeting, :index => 1, :required => true
-        option :to, :index => 2, :required => true
-        option :extra, :index => 3
-      end      
-    end
+    function :Say do
+      option :greeting, :index => 1, :required => true
+      option :to, :index => 2, :required => true
+      option :extra, :index => 3
+    end      
     result = apply(@mod::Say, "Hello", "World", "I'm doing fine.")
     result.successful?.should be(true)
     result = apply(@mod::Say)
@@ -107,10 +99,8 @@ describe AppKernel::Function do
   end
   
   it "raises an error immediately if you try to call a function that has invalid arguments" do
-    @mod.module_eval do
-      function :Harpo do
-        option :mandatory, :required => true
-      end
+    function :Harpo do
+      option :mandatory, :required => true
     end
 
     lambda {
@@ -119,14 +109,12 @@ describe AppKernel::Function do
   end
   
   it "allows validation of its arguments" do
-    @mod.module_eval do
-      function :Picky do
-        option :arg, :index => 1                
-        validate do
-          @arg.check @arg == 5 && @arg != 6, "must be 5 and not be 6"
-        end      
-      end  
-    end
+    function :Picky do
+      option :arg, :index => 1                
+      validate do
+        @arg.check @arg == 5 && @arg != 6, "must be 5 and not be 6"
+      end      
+    end  
 
     apply(@mod::Picky, 5).successful?.should be(true)
     result = apply(@mod::Picky, 6)
@@ -137,75 +125,72 @@ describe AppKernel::Function do
     result.successful?.should be(false)
     result.errors[:arg].should == "must be 5 and not be 6"
   end
+  
+  describe "Option Resolution" do
+    it "can take a find parameter in the function definition which tells it how to lookup arguments" do
+      function :TakesInt do
+        option :num, :index => 1, :find => proc {|s| s.to_i}
+        
+        execute do
+          @num
+        end
+      end
+      
+      TakesInt("5").should == 5
+    end
+    
+    it "doesn't do an argument conversion if the argument is already of the correct type" do
+      function :TakesInt do
+        option :num, :index => 1, :type => Integer, :find => proc {|s| raise StandardError, "Hey, don't call me!"}
+        execute {@num}
+      end
+            
+      TakesInt(5).should == 5
+    end
+    
+    it "raises an exception if it can't tell how to find a complex type" do
+      weird = Class.new
+      function :TakesWeirdObject do
+        option :weird, :type => weird
+        execute {@weird}
+      end
+      
+      lambda {
+        TakesWeirdObject(:weird => "weird")
+      }.should raise_error
+      
+      werd = weird.new
+      TakesWeirdObject(:weird => werd).should == werd
+    end
+    
+    it "triggers an error if an option is required and after trying to find it, it is still nil." do
+      objects = {:foo => 'bar', :baz => "bang", }
+      
+      function :Lookup do
+        option :obj, :index => 1, :required => true, :find => proc {|key| objects[key]}
+        execute {@obj}
+      end
+      
+      Lookup(:foo).should == 'bar'
+      Lookup(:baz).should == 'bang'
+      lambda { 
+        Lookup(:bif)        
+      }.should raise_error
+    end
+    
+    it "triggers an error if an option is unknown" do
+      function(:Noop) {}
+      Noop()
+      lambda {
+        Noop(:foo => 'bar')
+      }.should raise_error(AppKernel::FunctionCallError)
+    end
+  end
+  
+  def function(sym, &body)
+    @mod.module_eval do
+      function sym, &body
+    end
+  end
+  
 end
-
-
-# module Awacs::Ssid
-#   include AppKernel::Function
-#   
-#   function :GetErrorCountBySource do
-#     option :solr, :nil => false
-#     option :source, :nil => false, :empty => false
-#         
-#     item = Struct.new(:source, :error_count)          
-#     execute do
-#       @solr.query("sys_error_marker:(\"SSID-AUGMENTATION-ERROR\")", 
-#         :filter_queries => ["PublicationTitle_t:[* TO *]"],
-#         :rows => 0,
-#         :facets => {:fields => "sys_source_id", :mincount => 1, :limit => 1000, :sort => "count"}
-#       ).data['facet_counts']['facet_fields']['sys_source_id'].enum_for(:each_slice, 2).map do |slice|
-#         item.new(*slice)
-#       end          
-#     end                
-#   end
-#   
-#   function :GetErrorCountByPublicationTitle do
-#     option :solr, :nil => false
-#     option :source, :nil => false, :empty => false
-#     option :title, :nil => false, :empty => false
-#     
-#     item = Struct.new(:title, :error_count)
-#     
-#     execute do
-#       @solr.query(%Q{sys_error_marker:("SSID-AUGMENT-FAILED")}, 
-#       :filter_queries => %Q{sys_source_id:("#{@source}")}, 
-#       :facets => {:fields => ['PublicationTitle_sfacet'], :mincount => 1, :limit => 1000, :sort => :count}
-#       ).data['facet_counts']['facet_fields']['PublicationTitle_sfacet'].enum_for(:each_slice, 2).map do |slice|
-#         item.new(*slice)
-#       end
-#     end
-#   end
-#   
-#   
-    # executeable :AddMapping do
-    #   option :type, :nil => false, :type => SsidMatchType, :lookup => proc {|s| SsidMatchType.find_by_name s}
-    #   option :value, :nil => false
-    #   option :ssid, :nil => false
-    #   
-    #   execute do
-    #     SsidMapping.create :match_rule => FindOrCreateRule(:type => @type, :value => @value), :ssid => @ssid
-    #   end
-    # end
-    # 
-    # function :DeleteMapping do
-    #   option :mapping, :index => 1, :type => SsidMapping, :lookup => proc {|s| SsidMapping.find(s)}
-    #   
-    #   execute do
-    #     @mapping.delete!
-    #   end
-    # end
-
-#   function :SaveMappings do
-#     option :adds, :default => [], :massage => proc {|o| [o].flatten}
-#     option :deletes, :default => [], :massage => proc {|o| [o].flatten}
-#   end
-#   
-# end
-# 
-# #later on....
-# include Awacs::Ssid
-# GetErrorCountBySource :source => "proquest"
-# GetErrorCountByPublicationTitle, :source => "proquest", :title => "Journal of Water Law"
-# AddMapping :rule => {:match_type => 'ISSN', :match_value => '001287'}, :ssid => '123459'
-# AddMapping :rule => 89, :ssid => 1234569
-# 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: appkernel
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Charles Lowell