appkernel 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2009-06-29
+
+* 1 major enhancement:
+  * functioning prototype which allows you to create portable, self-validating functions

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/appkernel.rb
+lib/appkernel/function.rb
+lib/appkernel/validation.rb
+script/console
+script/destroy
+script/generate
+spec/appkernel/function_spec.rb
+spec/appkernel/validation_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,73 @@
+= appkernel
+
+* http://github.com/cowboyd/appkernel
+
+== DESCRIPTION:
+
+AppKernel is a microframework for capturing your application in terms of minute, self-validating functions. 
+Once defined, these functions can be used in rails, cocoa, an sms gateway, or wherever you want to take them.
+
+== FEATURES:
+
+* 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)
+
+== SYNOPSIS:
+
+module Foo
+  include AppKernel::Function
+  
+  function :Hello do
+    option :to, :index => 1, :required => true
+
+    validate do
+     @to.check(@to != "spam", "I don't like spam!")
+    end
+
+    execute do
+      "Hello #{@to}!"
+    end
+  end
+
+  Hello("George") #=> "Hello, George!"
+  Hello(:to => "George") #=> "Hello, George!"
+  apply(Hello, "George").success? #=> true
+  apply(Hello, "George").return_value => "Hello, George!"
+
+  #Error Reporting
+
+  Hello("spam") #=> "Exception!! I don't like spam!"
+  apply(Hello, "spam").success? #=> false
+  apply(Hello, "spam").return_value #=> nil
+  apply(Hello, "spam").errors[:to] #=> "I don't like spam"
+end
+
+
+== INSTALL:
+
+	sudo gem install appkernel
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Charles Lowell <cowboyd@thefrontside.net>
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/Rakefile

@@ -0,0 +1,29 @@
+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 'appkernel'
+
+# 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'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/appkernel/function.rb

@@ -0,0 +1,153 @@
+require 'set'
+
+class AppKernel    
+  module Function
+    
+    def apply(fun, *args)
+      FunctionApplication.new(fun, *args)
+    end
+    
+    def self.included(mod)
+      class << mod
+        def function(symbol, &definition)
+          fun = ::AppKernel::FunctionDefinition.new(definition)
+          self.const_set(symbol, fun)
+          self.send(:define_method, symbol) do |*args|
+            FunctionApplication.apply_or_die(fun, *args)
+          end
+          if self.class == Module      
+            self.send(:module_function, symbol) 
+          else
+            class << self;self;end.send(:define_method, symbol) do |*args|
+              FunctionApplication.apply_or_die(fun, *args)
+            end
+          end
+        end
+        
+        def apply(fun, *args)
+          FunctionApplication.new(fun, *args)
+        end
+      end
+    end
+  end
+  
+  class FunctionApplication
+    
+    attr_reader :return_value, :errors, :function, :options
+    
+    def initialize(fun, *args)
+      @function = fun
+      @args = args
+      @options = {}
+      @errors = {}
+      @return_value = self.class.do_apply(self, *args)
+    end
+    
+    def successful?
+      @errors.empty?
+    end
+    
+    class << self
+      
+      def apply_or_die(fun, *args)
+        app = new(fun, *args)
+        if app.successful?
+          app.return_value
+        else
+          raise ValidationError, app
+        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
+          end
+        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
+  
+  class FunctionDefinition
+    
+    attr_reader :impl, :options, :validation
+    
+    def initialize(definition)
+      @options = {}
+      @impl = lambda {}
+      @validation = ::AppKernel::Validation::Validator.new 
+      self.instance_eval &definition
+    end
+    
+    def option(name, params = {})
+      name = name.to_sym
+      @options[name] = Option.new(name, params)
+    end
+    
+    def indexed_options
+      @options.values.select {|o| o.index}.sort_by {|a| a.index}
+    end
+    
+    def execute(&impl)
+      @impl = impl
+    end
+    
+    def validate(&checks)
+      @validation = AppKernel::Validation::Validator.new(&checks)
+    end
+            
+    class Option
+      attr_reader :name, :index
+      def initialize(name, params)
+        @name = name
+        @index = params[:index]
+        @required = params[:required] == true
+      end
+            
+      def set(o, value)
+        o.instance_variable_set("@#{@name}", value)
+      end
+      
+      def required?
+        @required
+      end
+      
+      def optional?
+        !@required
+      end
+    end
+    
+    class Validator
+    end
+  end
+  
+  class ValidationError < StandardError
+    def initialize(application)
+      @app = application
+    end
+    
+    def message
+      @app.errors.values.first
+    end
+  end
+    
+end

data/lib/appkernel/validation.rb

@@ -0,0 +1,60 @@
+require 'delegate'
+module AppKernel::Validation
+  class Validator
+    
+    attr_reader :errors
+    
+    def initialize(&block)
+      @body = block
+    end
+    
+    def validate(vars = {})
+      errors = {}
+      scope = Object.new
+      for k,v in vars do
+        val = case v
+        when nil
+          NilValue.new
+        when Fixnum
+          FixnumValue.new(v)
+        else
+          v.dup
+        end
+        val.extend Check
+        val.instance_eval do
+          @_add_validation_error = lambda {|message|
+            errors[k] = message
+          }
+        end
+        scope.instance_variable_set("@#{k}", val)
+      end      
+      scope.instance_eval &@body if @body
+      errors
+    end
+    
+  end
+  
+  module Check
+    def check(condition, message)
+      unless condition
+        @_add_validation_error.call(message)
+      end
+    end
+  end
+  
+  class NilValue < DelegateClass(NilClass)
+    def initialize
+      super(nil)
+    end
+    
+    def nil?
+      true
+    end
+  end
+  
+  class FixnumValue < DelegateClass(Fixnum)
+    def initialize(val)
+      super(val)      
+    end
+  end
+end

data/lib/appkernel.rb

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

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/appkernel.rb'}"
+puts "Loading appkernel gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/appkernel/function_spec.rb

@@ -0,0 +1,211 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+  
+describe AppKernel::Function do
+  
+  before(:each) do
+    @mod = Module.new do |mod|
+      mod.module_eval do
+        include AppKernel::Function
+      end
+    end
+    extend @mod
+    @klass = Class.new.class_eval do
+      include AppKernel::Function; self
+    end
+  end
+  
+  it "allows modules to define an function functions" do
+    @mod.module_eval do
+      function :Say do        
+        option :word
+        
+        execute do
+          @word
+        end
+      end
+      Say(:word => "hello").should == "hello"
+    end
+  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
+      
+      
+      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
+  end
+  
+  it "allows classes that include the module to also use the commands from that module" do
+    @mod.module_eval do
+      function :Included do
+        execute do
+          "It worked!"
+        end
+      end
+    end
+    mod = @mod
+    Class.new(Object).class_eval do
+      include mod
+      self
+    end.new.instance_eval do
+      Included().should == "It worked!"
+    end
+  end
+  
+  it "allows classes to define functions as well as modules" do
+    @klass.class_eval do
+      function :Say do
+        option :word, :index => 1
+        execute do
+          @word
+        end
+      end      
+    end
+  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
+    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
+    result = apply(@mod::Say, "Hello", "World", "I'm doing fine.")
+    result.successful?.should be(true)
+    result = apply(@mod::Say)
+    result.return_value.should be(nil)
+    result.successful?.should be(false)
+    result.errors[:greeting].should_not be(nil)
+    result.errors[:to].should_not be(nil)
+    result.errors[:extra].should be(nil)
+  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
+    end
+
+    lambda {
+      Harpo()
+    }.should raise_error(AppKernel::ValidationError)
+  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
+
+    apply(@mod::Picky, 5).successful?.should be(true)
+    result = apply(@mod::Picky, 6)
+    result.successful?.should be(false)
+    result.errors[:arg].should == "must be 5 and not be 6"
+    
+    result = apply(@mod::Picky, 7)
+    result.successful?.should be(false)
+    result.errors[:arg].should == "must be 5 and not be 6"
+  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
+# 

data/spec/appkernel/validation_spec.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe AppKernel::Validation do
+  
+  
+  it "can do assertions which are associated with a field" do
+    validate({:foo => 'bar'}) do
+      @foo.check(!@foo.nil?, "'foo' cannot be nil")
+    end.should be_empty
+    
+    validate({:foo => nil}) do
+      @foo.check(!@foo.nil?, "cannot be nil.")
+    end[:foo].should == "cannot be nil."
+  end
+
+  it "returns a positive result if there is no validation body passed" do
+    validate().should be_empty
+  end
+  
+  
+  it "can validate fixnum fields fixnums" do
+    validate({:num => 5}) do
+      @num.check(@num < 5, "too big number!")
+    end[:num].should == "too big number!"
+  end
+  
+  def validate(vars = {}, &block)
+    v = AppKernel::Validation::Validator.new(&block)
+    v.validate vars
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'appkernel'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: appkernel
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-29 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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: |-
+  AppKernel is a microframework for capturing your application in terms of minute, self-validating functions. 
+  Once defined, these functions can be used in rails, cocoa, an sms gateway, or wherever you want to take them.
+email: 
+- cowboyd@thefrontside.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/appkernel.rb
+- lib/appkernel/function.rb
+- lib/appkernel/validation.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/appkernel/function_spec.rb
+- 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: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: appkernel
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: AppKernel is a microframework for capturing your application in terms of minute, self-validating functions
+test_files: []
+