appkernel 0.1.1 → 0.1.2

data/History.txt

@@ -1,4 +1,20 @@
-== 0.1.0 2009-06-29
+== 0.1.3 YYY-MM-DD
+
+* x major enhancements
+  * functions defined in the same scope can call themselves
+  * validations can call function in the same module
+  * ability to provide defaults for function arguments.
+  * allow multiple classes in the :type option attribute
+
+== 0.1.2 2009-07-01
+
+* 1 major enhancment:
+  * can't remember for the life of me what it was. Are you really reading this?
+
+* 1 major enhancement:
+  * functioning prototype which allows you to create portable, self-validating functions
+
+== 0.1.1 2009-06-30
 
 * 1 major enhancement:
   * functioning prototype which allows you to create portable, self-validating functions

data/Manifest.txt

@@ -1,5 +1,6 @@
 History.txt
 Manifest.txt
+PostInstall.txt
 README.rdoc
 Rakefile
 lib/appkernel.rb
@@ -12,4 +13,3 @@ spec/appkernel/function_spec.rb
 spec/appkernel/validation_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+This gem brought to you by The Frontside Software, Inc.
+http://www.thefrontside.net
+
+
+

data/Rakefile

@@ -1,29 +1,28 @@
-require 'rubygems' unless ENV['NO_RUBYGEMS']
-%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
-$:.unshift(File.dirname(__FILE__) + '/lib') unless $:.member?(File.dirname(__FILE__) + '/lib')
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+
+$:.unshift File.dirname(__FILE__) + '/lib'
 require 'appkernel'
 
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumber_features
+
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('appkernel', AppKernel::VERSION) do |p|
-  p.developer('Charles Lowell', 'cowboyd@thefrontside.net')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.rubyforge_name       = p.name # TODO this is default value
-  # p.extra_deps         = [
-  #   ['activesupport','>= 2.0.2'],
-  # ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+$hoe = Hoe.spec 'appkernel' do
+  self.developer 'Charles Lowell', 'cowboyd@thefrontside.net'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
+require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
 
 # TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
 # task :default => [:spec, :features]

data/lib/appkernel.rb

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

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(symbol, definition)
+          fun = ::AppKernel::FunctionDefinition.new(symbol, self, definition)
           self.const_set(symbol, fun)
           self.send(:define_method, symbol) do |*args|
             FunctionApplication.apply_or_die(fun, *args)
@@ -39,7 +39,7 @@ class AppKernel
       @function = fun
       @errors = {}
       @args = Arguments.new(self, *args)
-      @return_value = self.class.do_apply(self, *args)
+      @return_value = self.class.do_apply(self)
     end
     
     def successful?
@@ -67,22 +67,36 @@ class AppKernel
               if opt = fun.options[k.to_sym]
                 set opt, v
               else
-                raise FunctionCallError, "unknown option :#{@name}"
+                raise FunctionCallError, "#{fun.name}: unknown option :#{k}"
               end 
             end
           elsif opt = @optorder.shift
             set opt, arg
           end
         end
+        for opt in fun.options.values
+          if @canonical[opt.name].nil? && !opt.default.nil?
+            @canonical[opt.name] = opt.default
+            @required.delete opt
+          end
+        end
         for opt in @required
-          app.errors[opt.name] = "missing required option '#{@name}'"
+          app.errors[opt.name] = "missing required option '#{opt.name}'"
         end
+        for name in fun.options.keys
+          @canonical[name] = nil if @canonical[name].nil?
+        end        
       end
       
-      def set(opt, value)      
-        if resolved = opt.resolve(@app, value)
+      def set(opt, value)
+        resolved = opt.resolve(@app, value)      
+        if !resolved.nil?
           @canonical[opt.name] = resolved
           @required.delete opt
+        elsif !value.nil? && opt.required? 
+          @required.delete opt
+          @required.delete opt
+          @app.errors[opt.name] = "no such value '#{value}' for required option '#{opt.name}'"          
         end
       end
     end
@@ -98,11 +112,12 @@ class AppKernel
         end
       end
       
-      def do_apply(app, *args)    
+      def do_apply(app)
         fun = app.function      
         app.errors.merge! fun.validation.validate(app.options) if app.successful?
         if app.successful?
           scope = Object.new
+          scope.extend fun.mod
           for k,v in app.options do
             scope.instance_variable_set("@#{k}", v)
           end
@@ -114,13 +129,14 @@ class AppKernel
   
   class FunctionDefinition
     
-    attr_reader :impl, :options, :validation
+    attr_reader :name, :mod, :impl, :options, :validation
     
-    def initialize(name, definition)
+    def initialize(name, mod, definition)
       @name = name
+      @mod = mod
       @options = {}
       @impl = lambda {}
-      @validation = ::AppKernel::Validation::Validator.new 
+      @validation = ::AppKernel::Validation::Validator.new(self)
       self.instance_eval &definition
     end
     
@@ -138,7 +154,7 @@ class AppKernel
     end
     
     def validate(&checks)
-      @validation = AppKernel::Validation::Validator.new(&checks)
+      @validation = AppKernel::Validation::Validator.new(self, &checks)
     end
 
     def to_s
@@ -147,13 +163,25 @@ class AppKernel
             
     class Option
       ID = lambda {|o| o}
-      attr_reader :name, :index
+      attr_reader :name, :index, :default
       def initialize(name, params)
         @name = name.to_sym
         @index = params[:index]
         @required = params[:required] == true
         @finder = params[:find]
-        @type = params[:type]
+        @types = params[:type] ? [params[:type]].flatten : nil
+        @default = params[:default]
+        validate!
+      end
+      
+      def validate!
+        if @default
+          if @types
+            raise OptionError, "#{@default} is not a kind of #{@types.join('|')}" unless @types.detect {|t| @default.kind_of?(t)}
+          elsif @required
+            Kernel.warn "option '#{@name}' unecessarily marked as required. It has a default value"
+          end
+        end
       end
                   
       def required?
@@ -167,13 +195,13 @@ class AppKernel
       def resolve(app, value)
         if value.nil?
           nil
-        elsif @type 
-          if value.is_a?(@type)
+        elsif @types 
+          if @types.detect {|t| value.is_a?(t)}
             value
           elsif @finder
             lookup(app, value)
           else
-            raise FunctionDefinitionError, "Don't know how to convert #{value.class}:#{value} -> #{@type}"
+            raise OptionError, "Don't know how to convert #{value.class}:#{value} -> #{@type}"
           end
         elsif @finder
           lookup(app, value)
@@ -186,8 +214,7 @@ class AppKernel
         result = @finder.call(value)
         app.errors[@name] = "couldn't find '#{@name}': #{value}" if result.nil? 
         result
-      end
-           
+      end                 
     end
     
     class Validator
@@ -195,6 +222,7 @@ class AppKernel
   end
   
   class FunctionCallError < StandardError; end
+  class OptionError < StandardError; end
   
   class ValidationError < StandardError
     def initialize(application)
@@ -202,7 +230,7 @@ class AppKernel
     end
     
     def message
-      @app.errors.values.first
+      "#{@app.function.name}: #{@app.errors.values.first}"
     end
   end
     

data/lib/appkernel/validation.rb

@@ -4,13 +4,15 @@ module AppKernel::Validation
     
     attr_reader :errors
     
-    def initialize(&block)
+    def initialize(fun, &block)
+      @fun = fun
       @body = block
     end
     
     def validate(vars = {})
       errors = {}
       scope = Object.new
+      scope.extend @fun.mod
       for k,v in vars do
         val = case v
         when nil
@@ -19,6 +21,10 @@ module AppKernel::Validation
           FixnumValue.new(v)
         when Symbol
           v
+        when FalseClass
+          FalseValue.new
+        when TrueClass
+          TrueValue.new
         else
           v.dup
         end
@@ -56,6 +62,18 @@ module AppKernel::Validation
     end
   end
   
+  class FalseValue < DelegateClass(FalseClass)
+    def initialize
+      super(false)
+    end
+  end
+  
+  class TrueValue < DelegateClass(TrueClass)
+    def initialize
+      super(true)      
+    end    
+  end
+  
   class FixnumValue < DelegateClass(Fixnum)
     def initialize(val)
       super(val)      

data/spec/appkernel/function_spec.rb

@@ -70,6 +70,22 @@ describe AppKernel::Function do
     end
   end
   
+  it "allows functions in the same module to be accessible without namespacing" do
+    function :First do
+      execute do
+        Second()
+      end
+    end
+    
+    function :Second do
+      execute do
+        "Hello"
+      end
+    end
+    
+    First().should == "Hello"
+  end
+  
   it "can be called by using the apply method instead of invoking it directly" do
     function :FiveAlive do
       option :desc, :index => 1
@@ -139,13 +155,62 @@ describe AppKernel::Function do
       TakesInt("5").should == 5
     end
     
+    describe "Default Values" do
+      it "allows for any option to have a default value" do
+        function :HasDefault do
+          option :value, :default => 5
+          
+          execute{@value}
+        end
+        
+        HasDefault().should == 5
+      end
+      
+      it "requires that the default value be the same as the option type if that is specified" do
+        lambda {
+          function :InvalidDefault do
+            option :value, :type => Integer, :default => "NOT_INT"
+          end
+        }.should raise_error
+      end
+      
+      it "warns if an option has a default and is also required" do
+        Kernel.should_receive(:warn)
+        function :QuestionableDefault do
+          option :value, :required => true, :default => 5
+        end
+      end
+      
+      it "sets a default option even if that option is explicitly passed in as nil" do
+        function :ExplicitNil do
+          option :value, :default => 'fun'
+          execute{@value}
+        end
+        
+        ExplicitNil(:value => nil).should == 'fun'
+      end
+    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
+      lambda {
+        TakesInt(5).should == 5
+      }.should_not raise_error
+    end
+    
+    it "an option can have multiple valid types" do
+      function :MultipleValidOptionTypes do
+        option :bool, :index => 1, :type => [TrueClass, FalseClass], :find => proc {|s| s == "true"}
+        execute {@bool}
+      end
+      
+      MultipleValidOptionTypes("true").should be(true)
+      MultipleValidOptionTypes("false").should be(false)
+      MultipleValidOptionTypes(true).should be(true)
+      MultipleValidOptionTypes(false).should be(false)
     end
     
     it "raises an exception if it can't tell how to find a complex type" do
@@ -185,6 +250,16 @@ describe AppKernel::Function do
         Noop(:foo => 'bar')
       }.should raise_error(AppKernel::FunctionCallError)
     end
+    
+    it "allows false as a default value" do
+      function :FalseDefault do
+        option :bool, :default => false
+        execute {@bool}
+      end
+      
+      FalseDefault().should be(false)
+    end
+    
   end
   
   def function(sym, &body)

data/spec/appkernel/validation_spec.rb

@@ -25,7 +25,7 @@ describe AppKernel::Validation do
   end
   
   def validate(vars = {}, &block)
-    v = AppKernel::Validation::Validator.new(&block)
+    v = AppKernel::Validation::Validator.new(stub(:Fun, :mod => Module.new),&block)
     v.validate vars
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: appkernel
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Charles Lowell
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-29 00:00:00 -05:00
+date: 2009-11-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.1
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -30,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.3
     version: 
 description: |-
   AppKernel is a microframework for capturing your application in terms of minute, self-validating functions. 
@@ -44,10 +34,11 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
+- PostInstall.txt
 files: 
 - History.txt
 - Manifest.txt
+- PostInstall.txt
 - README.rdoc
 - Rakefile
 - lib/appkernel.rb
@@ -60,12 +51,11 @@ files:
 - spec/appkernel/validation_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tasks/rspec.rake
 has_rdoc: true
 homepage: http://github.com/cowboyd/appkernel
 licenses: []
 
-post_install_message: 
+post_install_message: PostInstall.txt
 rdoc_options: 
 - --main
 - README.rdoc
@@ -86,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: appkernel
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: AppKernel is a microframework for capturing your application in terms of minute, self-validating functions

data/tasks/rspec.rake

@@ -1,21 +0,0 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems' unless ENV['NO_RUBYGEMS']
-  require 'spec'
-end
-begin
-  require 'spec/rake/spectask'
-rescue LoadError
-  puts <<-EOS
-To use rspec for testing you must install rspec gem:
-    gem install rspec
-EOS
-  exit(0)
-end
-
-desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end