equipment 0.1.0

data/ProjectInfo

@@ -0,0 +1,55 @@
+--- %YAML:1.0
+
+title    : &title Equipment
+name     : &pkg equipment
+version  : '0.1.0'
+status   : alpha
+
+author   : Jonas Pfenniger
+email    : &email zimba.tm@gmail.com
+username : &username zimbatm
+homepage : "http://equipment.rubyforge.org"
+
+summary  : Camping equipments
+
+description: >
+  Equipment is a set of ready to use extensions for Camping.
+
+rubyforge:
+  project: *pkg
+  username: zimbatm
+
+dependencies:
+  - [ camping, '>= 1.4.2' ]
+
+executables: []
+
+#=================================================
+# Unremark and use as needed. Often defaults
+# are sufficiant and need not specify
+# extra parameters.
+#=================================================
+
+package: !!package
+  distribute : [ gem, zip, tgz ]  # tgz zip deb tar.bzip2 gem
+  exclude    : [ _darcs, doc, web ]
+
+rdoc: !!rdoc
+
+test: !!test
+
+release: !!release
+  host       : rubyforge.org
+  username   : *username
+  project    : *pkg
+  groupid    : 811
+  package    : *title
+  dir        : 'dist'
+
+publish: !!publish
+  target   : rubyforge
+  type     : web
+  host     : rubyforge.org
+  username : *username
+  dir      : web
+

data/README

@@ -0,0 +1,67 @@
+
+== Equipment
+
+Charge your Camping app with some equipments to survive the cyber wildness. I
+wanted to wait until I've completed the full set of tools but most of them are
+already quite usable.
+
+Before starting the adventure, choose your tools righly. Follows a list of free
+tools.
+
+Working equipment :
+
+* Ext::AppUtil : Access to your app from a controller extension.
+* Ext::ErubisView : Add Erubis template handling to your app.
+* Ext::Flash : Flash data (like in rails).
+* Ext::Forward : Forward a request (only for 1337 ppl).
+* Ext::Patches : A set of patches for Camping to change some things.
+* Ext::Sendfile : Provides `sendfile`. Uses sendfile with mongrel if available.
+* Ext::TemplateView : Extension that changes camping to allow easy adding of other templating languages.
+* Ext::UseHelper : Tell your template what scripts your view is using.
+* Ext::XmlView : Basic Xml builder. Ripped from some _why app. Ugly yet.
+
+
+Not working equipment (TODO) :
+
+* Ext::BasicAuth : Handles HttpBasic authentication.
+* Ext::Security : Generic handle for authentication and authorization.
+* Ext::JsHelpers : Adds javascript helpers.
+* Ext::Og : Og utilities to integrate in Camping better.
+* Ext::OgScaffold : Scaffolding.
+* Ext::OgSession : Session handling.
+* Ext::Ressource : Rest Controller like ActiveRessource.
+
+== Features
+
+* The above equipments.
+* Dependencies are automatically resolved.
+* Equipment itself provides a cool extension mechanism.
+
+== Usage
+
+Include an equipment in your app's module to instantly get the features that
+it describes. Modules and classes below are automatically included because of
+Equipment#included(app) which is defined in each equipment by extending the
+Equipment module.
+
+example :
+
+ Camping.goes :YourApp
+
+ Ext::Mount.equip(YourApp)
+
+ module YourApp::Controllers
+   # ::mount is now available here
+   mount '/somepath', :name=>:ControllerName, :url=>'/here'
+ end
+
+see in the examples for more details.
+
+== License
+
+GPL. not sure yet.
+
+== Author(s)
+
+* Jonas Pfenniger <zimba.tm@gmail.com>
+

data/examples/basicauthtest.rb

@@ -0,0 +1,59 @@
+require 'camping'
+require 'ext/basic_auth'
+
+$DBG = true
+
+Camping.goes :BasicAuthTest
+
+module BasicAuthTest
+  Ext::BasicAuth.equip(self)
+
+  module Base
+    def authenticate
+      @user, @pass = super
+    end
+  end
+
+  module Controllers
+    # Allow not authenticated users
+    class Index < R '/'
+      def get; render :index ; end
+    end
+
+    class AskAuth < R '/ask_auth'
+
+      def authorize(user, pass, force=true)
+        puts "Authorize called"
+        return false
+        (user == pass and not user.empty?) || super
+      end
+
+      def get; render :ask_auth ; end
+    end
+  end
+
+  module Views
+    def layout
+      html do
+        head { title "BasicAuth test" }
+        body do
+          pre 'user : ' + @user.inspect
+          pre 'pass : ' + @pass.inspect
+          div { yield }
+        end
+      end
+    end
+
+    def index
+      h1 "Index"
+      p 'User must be equal to the password.'
+      a "AskAuth", :href=>R(AskAuth)
+    end
+
+    def ask_auth
+      h2 "You're authenticated now."
+      a "Index", :href=>R(Index)
+    end
+
+  end
+end

data/examples/erubytest.rb

@@ -0,0 +1,36 @@
+require 'camping'
+require 'ext/eruby_view'
+
+$DBG = true
+
+Camping.goes :ErubyTest
+
+
+module ErubyTest
+  Ext::ErubyView.equip(self)
+
+  Views.template_root = File.dirname(__FILE__)
+
+  module Controllers
+    class Index < R '/'
+      def get
+        @somevar = 'var var'
+        render :index
+      end
+    end
+  end
+
+  module Views
+    def layout
+      html do
+        head { title "Erubis test" }
+        body { yield }
+      end
+    end
+
+    def index
+      h1 "No template"
+    end
+  end
+end
+

data/examples/flashtest.rb

@@ -0,0 +1,46 @@
+require 'camping'
+require 'ext/flash'
+
+$DBG = true
+
+Camping.goes :FlashTest
+
+
+module FlashTest
+  Ext::Flash.equip(self)
+
+  module Controllers
+    class Index < R '/'
+      def get; render :index ; end
+    end
+
+    class SomeError
+      def get;
+        1 / 0
+      rescue => ex
+        flash.error = ex.message
+        redirect R(Index)
+      end
+    end
+  end
+
+  module Views
+    def layout
+      html do
+        head do
+          title "Flash test"
+        end
+        body do
+          pre 'Cookies: ' + @cookies.inspect
+          p "Error : #{flash.error}" if flash.error
+          self << yield
+        end
+      end
+    end
+
+    def index
+      h1 "Index"
+      a "SomeError", :href=>R(SomeError)
+    end
+  end
+end

data/examples/index.erb

@@ -0,0 +1,9 @@
+<h1>Erubis view</h1>
+
+<p>Somevar : <%= @somevar.inspect %></p>
+
+<p>Some link : <%= R(Index) %></p>
+
+<p>template class : <%= self.class %></p>
+
+

data/examples/mounttest.rb

@@ -0,0 +1,34 @@
+require 'camping'
+require 'ext/mount'
+
+$DBG = true
+
+Camping.goes :MountTest
+
+
+module MountTest
+  Ext::Mount.equip(self)
+
+  module Controllers
+    mount File.dirname(File.expand_path(__FILE__)), :name=>:Dir, :url=>'/dir'
+
+    class Index < R '/'
+      def get; render :index ; end
+    end
+  end
+
+  module Views
+    def layout
+      html do
+        head { title "Mount test" }
+        body { yield }
+      end
+    end
+
+    def index
+      h1 "Index"
+      a "DirListing", :href=>"/dir" #,:href=>R(Example)
+    end
+  end
+end
+

data/examples/ogtest.rb

@@ -0,0 +1,41 @@
+require 'camping'
+require 'ext/og_scaffold'
+
+$DBG = true
+
+Camping.goes :OgTest
+
+module OgTest
+  Ext::OgScaffold.equip(self)
+
+  module Models
+    self.og = {:store => :mysql, :name=>'og_test', :user=>'root'}
+
+    class User
+      attr_accessor :login, String
+      attr_accessor :password, String
+      belongs_to Group
+    end
+
+    class Group
+      attr_accessor :name, String
+      has_many User
+    end
+  end
+
+  module Controllers
+    class Index < R '/'
+      def get
+        render :index
+      end
+    end
+  end
+
+  module Views
+    def index
+      h1 "Index"
+      p "Nothing special here"
+    end
+  end
+
+end

data/examples/patchestest.rb

@@ -0,0 +1,40 @@
+require 'camping'
+require 'ext/patches'
+
+$DBG = true
+
+Camping.goes :PatchesTest
+
+
+module PatchesTest
+  Ext::Patches.equip(self)
+
+  module Controllers
+    class Index < R '/'
+      def get
+        render :index
+      end
+    end
+
+    class ZeroDiv
+      def get
+        1 / 0
+      end
+    end
+  end
+
+  module Views
+    def layout
+      html do
+        head { title "Patches test" }
+        body { yield }
+      end
+    end
+
+    def index
+      h1 "Hello"
+      a "ZeroDiv", :href => R(ZeroDiv)
+    end
+  end
+end
+

data/examples/sendfiletest.rb

@@ -0,0 +1,29 @@
+require 'camping'
+require 'ext/sendfile'
+
+$DBG = true
+
+Camping.goes(:SendfileTest)
+
+Ext::Sendfile.equip(SendfileTest)
+
+module SendfileTest
+
+  module Controllers
+    class Index < R '/'
+      def get; render :index ; end
+    end
+
+    class GetSelf
+      def get; sendfile __FILE__ end
+    end
+  end
+
+  module Views
+    def index
+      h1 "Index"
+      a "Get self", :href=>R(GetSelf)
+    end
+  end
+end
+

data/lib/equipment.rb

@@ -0,0 +1,195 @@
+# Equipment is a set of tools for Camping.
+# 
+# See the README for more informations.
+
+require 'camping'
+
+=begin # doesn't work
+class << Camping
+  def goes(m)
+    p super(m)
+#    app = const_get(m)
+#    app.extend CampingExt
+#    app
+  end
+end
+=end
+
+# This module extends every app that uses equipments. It provides some
+# useful methods.
+module CampingExt
+  # List of extensions already in the application
+  def exts; @exts ||= [] end
+
+  # Shortcut method to add an equipment to the app.
+  #
+  # You can use YourApp.equip(Extension) instead of
+  # Extension.equip(YourApp) once this extension is
+  # installed.
+  #
+  def equip(*exts)
+    exts.each do |ext|
+      ext.equip(self)
+    end
+    self
+  end
+
+  # This will allow you to chain create methods.
+  #
+  # == Examplanation
+  #
+  # When calling YourApp.create, the call order is :
+  #  * YourApp.create
+  #  * Last extended module.create
+  #  * Second last extended module.create
+  #  * ...
+  #  * First extended module.create
+  #
+  # By extending this app first, it will set a blank create method that
+  # will ensure that you don't get a NoMethodError when calling `super`
+  # 
+  def create; end
+
+  # Same as for #create.
+  #
+  # This method is intended to be used by launchers that support dynamically
+  # installing and removing applications.
+  # 
+  def install; end
+
+  # See #install.
+  def uninstall; end
+end
+
+module Equipment
+
+  # Utility for equipments. Automatically sets a set of rule for importing
+  # methods, classes, class methods in your application for your extension.
+  #
+  # == Example
+  #
+  #  module MyUtil
+  #    extend Equipment
+  #    module ViewsClassMethod; end #=> YourApp::Views's class methods
+  #    module Controllers; class X; end; end #=> New X controller
+  #    module Helpers; def somemethod; end; end #=> New somemethoer
+  #  end
+  # 
+  #  Camping.goes :YourApp
+  #
+  #
+  #  module YourApp
+  #    MyUtil.equip(self)
+  #  end
+  #  
+  #  # or
+  #  
+  #  YourApp.extend CampingExt
+  #  YourApp.equip(MyUtil)
+  #
+  def equip(app)
+    raise "Only for Camping apps" unless app.respond_to? :goes
+    app.extend CampingExt
+
+    # Only equip once
+    return false if app.exts.include?(self)
+    app.exts << self
+
+    # dependencies
+    deps.each { |ext| ext.equip(app) }
+
+    puts "** equipped #{self} in #{app}" if $DBG
+
+    app_mods = app.constants.sort.select do |name|
+      app.const_get(name).kind_of?(Module)
+    end
+
+    puts "App Mods  : #{app_mods.inspect}" if $DBG
+    puts "Ext Mods  : #{constants.inspect}" if $DBG
+
+    app_mods.each do |name|
+      app_mod = app.const_get(name)
+      if const_defined?(name) and mod = const_get(name) and 
+         not mod.kind_of?(Class) and mod != app_mod
+        if mod.public_instance_methods.size > 0 or
+           mod.protected_instance_methods.size > 0 or
+           mod.private_instance_methods.size > 0
+          app_mod.send :include, mod
+          puts "Included  : #{mod} -> #{app_mod}" if $DBG
+          # Exceptions until include_deep is working
+          case name
+          when "Helpers"
+            app::Base.send :include, mod
+            puts "Included  : #{mod} -> #{app::Base}" if $DBG
+            app::Mab.send  :include, mod
+            puts "Included  : #{mod} -> #{app::Mab}"  if $DBG
+            if app.const_defined? :V
+              app::V.send  :include, mod
+              puts "Included  : #{mod} -> #{app::V}"  if $DBG
+            end
+          when "Views"
+            app::Mab.send  :include, mod
+            puts "Included  : #{mod} -> #{app::Mab}"  if $DBG
+          end
+        end
+        if mod.constants.size > 0
+          mod.transfer_classes_to(app_mod, :force)
+          puts "Cls trans : #{mod} -> #{app_mod}" if $DBG
+        end
+      end
+      if const_defined?("#{name}ClassMethods")
+        mod_ext = const_get("#{name}ClassMethods")
+        app_mod.extend(mod_ext)
+        puts "Extended  : #{mod_ext} -> #{app_mod}" if $DBG
+      end
+    end
+  end
+
+  # An array of equipment modules on which that equipment depends on for
+  # working. Works with #included.
+  def deps
+    @__deps ||= []
+  end
+
+  # Asynchronous dependencies for later inclusion in a camping app. Fills
+  # #dependencies for #included.
+  def depends_on(mod); deps << mod; end
+
+end
+
+class Module
+
+  # Utility method to transfer all classes of a module into another. It is
+  # useful when you write Camping extensions. cf. other equipments.
+  #
+  # I'm using this to override ServerError and NotFound controllers.
+  def transfer_classes_to(dest, force=false)
+    constants.each do |str|
+      k = const_get(str)
+      if k.kind_of? Class
+        dest.send :remove_const, str if force and dest.const_defined? str
+        dest.const_set str, k.dup unless dest.const_defined? str
+      end
+    end
+  end
+
+end
+
+=begin
+class Object
+
+  # Sets all instance variables of an object to another
+  #
+  # if force is set to true, existing instance variables will be overwritten
+  def instance_variables_send(obj, force=false)
+    instance_variables.each do |v|
+      if force or not obj.instance_variables.include? v
+        obj.instance_variable_set(v, instance_variable_get(v))
+      end
+    end
+    obj
+  end
+  alias :ivs_send :instance_variables_send
+end
+=end
+