picombo 0.1.0

data/lib/core/core.rb

@@ -0,0 +1,234 @@
+# Picombo MVC Web Framework
+#
+# Author:: Jeremy Bush
+# Copyright:: Copyright (c) 2010 Jeremy Bush
+# License:: See LICENSE
+
+# Picombo is a Rack-based Ruby MVC web framework with design principles taken from the Kohana PHP Framework.
+#
+# It's designed to be fast, lightweight and easy to use.
+
+module Picombo
+	class Core
+		@@extension = 'html'
+
+		def self.extension()
+			@@extension
+		end
+		def self.extension=(extension)
+			@@extension = extension
+		end
+
+		# Standard call function that gets invoked by Rack
+		def call(env)
+			# start system benchmark
+			Picombo::Bench.instance.start('application')
+			Picombo::Bench.instance.start('loading')
+
+			@@env = env
+			@@req = Rack::Request.new(env)
+
+			@@extension = File.extname(@@req.path)[1..-1]
+			@@extension = 'html' if @@extension.nil?
+
+			@@response = Rack::Response.new
+			#@@response['Content-Type'] = Picombo::Config.load('mimes.'+@@extension)[0]
+			@@response['Content-Type'] = 'text/html'
+			@@response.status = 200
+			@@redirect = []
+
+			# Add directory extensions to the filesystem
+			Picombo::Config.get('config.extensions').each do |extension|
+				require extension
+			end
+			$LOAD_PATH.delete(APPPATH)
+			$LOAD_PATH.unshift(APPPATH)
+
+			# Load hooks
+			Picombo::Config.get('config.hooks').each do |hook|
+				Picombo::Core.find_file('hooks', hook).each do |file|
+					require file
+				end
+			end
+
+			## intialize the input library
+			Picombo::Input.instance.set_request(@@req)
+			Picombo::Session.instance.init(@@req)
+			Picombo::Cookie.instance.init(@@req)
+			Picombo::Bench.instance.stop('loading')
+
+			Picombo::Log.write(:debug, 'Picombo Setup Complete')
+			output = Picombo::Router.new(@@req).process()
+
+			Picombo::Event.run('system.shutdown')
+
+			output
+		end
+
+		# Sets a system redirect
+		def self.redirect(location, status = 302)
+			# Add the base url if a relative path was requested
+			location = Picombo::Url.base+location unless location[0..3] == 'http'
+
+			@@redirect = [location, status]
+			render
+		end
+
+		# Adds content to the output buffer
+		def self.response(str, status = 200)
+			@@response.status = status
+			@@response.write(str)
+		end
+
+		# Allows access to raw response object
+		def self.raw_response
+			@@response
+		end
+
+		# Renders the output buffer. Called by Picombo::Router only.
+		def self.render
+			if ! @@redirect.empty?
+				@@response.redirect(*@@redirect)
+				return @@response.finish
+			end
+
+			Picombo::Event.run('system.display')
+
+			response = @@response.finish
+			@@response = Rack::Response.new
+			response
+		end
+
+		# Finds a file recursively in the CFS.
+		#
+		# Searches application, then extension locations in order, then system.
+		#
+		# Returns an array of files that are found
+		def self.find_file(directory, file, required = false, ext = 'rb')
+			ext = "."+ext
+
+			files = []
+			$LOAD_PATH.each do |path|
+				if File.exist?(path+'/'+directory+'/'+file+ext)
+					files.unshift(path+'/'+directory+'/'+file+ext)
+				end
+			end
+
+			raise LoadError if required and files.empty?
+
+			# reverse the array, to put application files first
+			return directory == 'config' ? files : files.reverse!
+		end
+
+		# Lists all files and directories in a resource path.
+		def self.list_files(directory)
+			files = []
+
+			$LOAD_PATH.each do |path|
+				if File.directory?(path+'/'+directory)
+					files.concat(Dir.new(path+'/'+directory).entries.collect! {|file|
+						unless (file == '.' or file == '..')
+							path+directory+'/'+file
+						end
+					})
+				end
+			end
+			files.delete('.')
+			files.delete('..')
+			files.compact
+		end
+	end
+
+	# Autoloader for missing Picombo classes
+	def Picombo.const_missing(name)
+		filename = name.to_s
+
+		require 'classes/'+filename
+
+		raise filename+' not found!' if ! const_defined?(name)
+
+		klass = const_get(name)
+		return klass if klass
+		raise klass+" not found!"
+	end
+
+	# == Model Module
+	#
+	# Models are the back end classes that handle business logic and data access. They accept input from controllers,
+	# and can manipulate data sources such as databases and other kinds of data.
+	#
+	# === Creating Model Files
+	#
+	# You can use any kind of modeling library to represent your models, such as DataMapper or ActiveRecord.
+	# You can also create "raw" models that don't use a library, and directly access a database. You will need
+	# to include your own database access methods in this case
+	#
+	# === Model Naming Conventions
+	# * Models live in the Picombo::Models namespace. They must be prefaced with these modules in the file
+	# * Models are placed in the /models directory
+	# * Model filenames must be named the same as the class name: class Foobar would live in /models/foobar.rb
+	# * Model filenames must be lowercase
+	module Models
+		# Autoloader for missing models
+		def Models.const_missing(name)
+			filename = name.to_s
+
+			require 'models/'+filename.downcase
+
+			raise filename+' not found!' if ! const_defined?(name)
+
+			klass = const_get(name)
+			return klass if klass
+			raise klass+" not found!"
+		end
+	end
+
+	# == Controller Module
+	#
+	# Controllers are the front level classes that expose your app to the web. They pass information to the model,
+	# retrieve information from the model, and pass data to views, which contain the final output for users.
+	#
+	# === Calling Controllers
+	# Controllers are called via URIs, i.e. http://example.com/foobar/baz
+	# * Segment #1 is the controller name
+	# * Segment #2 is the controller method to call
+	#
+	# Controller Naming Conventions
+	# * Controllers live in the Picombo::Controllers namespace. They must be prefaced with these modules in the file
+	# * Controllers are placed in the /controllers directory
+	# * Controller filenames must be named the same as the class name: class Foobar would live in /controllers/foobar.rb
+	# * Controller filenames must be lowercase
+	#
+	# === Controller Arguments
+	# Controller arguments are passed via URI segments after the second, i.e. http://example.com/foobar/baz/foo/bar
+	# * This would match the baz method of the foobar controller, and match the arg1 and arg2 method arguments
+	# * def baz(arg1, arg2)
+	# The arguments must match the method exactly or a 404 exception will occur
+	#
+	# === Example Controller
+	#
+	# 	module Picombo
+	# 		module Controllers
+	# 			class Foobar
+	# 				def index
+	# 					Picombo::Core.response('Hello World!')
+	# 				end
+	# 			end
+	# 		end
+	# 	end
+	# This controller and method could be called via http://example.com/foobar/index
+	module Controllers
+		# Autoloader for missing controller names
+		def Controllers.const_missing(name)
+			filename = name.to_s
+
+			require 'controllers/'+filename
+
+			raise LoadError if ! const_defined?(name)
+
+			klass = const_get(name)
+			return klass if klass
+			raise LoadError
+		end
+	end
+end

data/lib/hooks/datamapper.rb

@@ -0,0 +1,13 @@
+# Set up database
+DataMapper.setup(:default,
+                 {:host => Picombo::Config.get('datamapper.default.host'),
+                  :adapter => Picombo::Config.get('datamapper.default.driver'),
+                  :database => Picombo::Config.get('datamapper.default.database'),
+                  :username => Picombo::Config.get('datamapper.default.username'),
+                  :password => Picombo::Config.get('datamapper.default.password')})
+
+module Picombo
+	class Model
+		include DataMapper::Resource
+	end
+end

data/lib/hooks/profiler.rb

@@ -0,0 +1,3 @@
+Picombo::Event.add('system.display') do
+	Picombo::View::Core.new('bench/footer').render()
+end

data/lib/views/404.rhtml

@@ -0,0 +1,2 @@
+<h1>Page Not Found</h1>
+<p>The page you requested, <%= @uri %>, was not found.</p>

data/lib/views/bench/footer.rhtml

@@ -0,0 +1,22 @@
+<table style="width: 100%">
+	<tr>
+		<th align="left">System Benchmarks</th>
+		<th align="right">Time</th>
+	</tr>
+	<tr>
+		<td>Picombo Setup</td>
+		<td align="right"><%= Picombo::Bench.instance.get('loading') %></td>
+	</tr>
+	<tr>
+		<td>Environment Setup</td>
+		<td align="right"><%= Picombo::Bench.instance.get('setup') %></td>
+	</tr>
+	<tr>
+		<td>Controller Execution</td>
+		<td align="right"><%= Picombo::Bench.instance.get('controller_execution') %></td>
+	</tr>
+	<tr>
+		<td>Total Execution</td>
+		<td align="right"><%= Picombo::Bench.instance.get('application') %></td>
+	</tr>
+</table>

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: picombo
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Bush
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-23 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Picombo is a lightweight MVC framework inspired by the Kohana PHP MVC framework.
+email: contractfrombelow@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bootstrap.rb
+- lib/classes/bench.rb
+- lib/classes/cache.rb
+- lib/classes/cache_file.rb
+- lib/classes/config.rb
+- lib/classes/cookie.rb
+- lib/classes/e404.rb
+- lib/classes/event.rb
+- lib/classes/html.rb
+- lib/classes/input.rb
+- lib/classes/log.rb
+- lib/classes/router.rb
+- lib/classes/security.rb
+- lib/classes/session.rb
+- lib/classes/url.rb
+- lib/classes/view
+- lib/classes/view/xml.rb
+- lib/classes/view.rb
+- lib/config/cache.yaml
+- lib/config/log.yaml
+- lib/config/mimes.yaml
+- lib/config/routes.yaml
+- lib/controllers
+- lib/controllers/error_404.rb
+- lib/controllers/template.rb
+- lib/core/core.rb
+- lib/hooks/datamapper.rb
+- lib/hooks/profiler.rb
+- lib/views/404.rhtml
+- lib/views/bench/footer.rhtml
+has_rdoc: false
+homepage: http://www.picombo.net/
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A lightweight MVC web framework
+test_files: []
+