picombo 0.3.1 → 0.3.2

data/lib/classes/cache/file.rb

@@ -10,17 +10,17 @@ module Picombo
 		# Constructor.
 		def initialize(config)
 			@@config = config
-			raise "Cache directory does not exist: "+APPPATH+'cache' unless File.directory?(APPPATH+'cache/')
-			raise "Cache directory not writable: "+APPPATH+'cache' unless File.writable?(APPPATH+'cache/')
+			raise "Cache directory does not exist: "+::APPPATH+'cache' unless File.directory?(::APPPATH+'cache/')
+			raise "Cache directory not writable: "+::APPPATH+'cache' unless File.writable?(::APPPATH+'cache/')
 		end
 
 		# Finds an array of files that exist for a specified key
 		def exists(keys)
-			return Dir.glob(APPPATH+'cache/*~*') if keys == true
+			return Dir.glob(::APPPATH+'cache/*~*') if keys == true
 
 			paths = []
 			[*keys].each do |key|
-				Dir.glob(APPPATH+'cache/'+key.to_s+'~*').each do |path|
+				Dir.glob(::APPPATH+'cache/'+key.to_s+'~*').each do |path|
 					paths.push(path)
 				end
 			end
@@ -37,7 +37,7 @@ module Picombo
 			items.each do |key, value|
 				delete(key)
 
-				File.open(APPPATH+'cache/'+key.to_s+'~'+lifetime.to_s, 'w') {|f| f.write(Marshal.dump(value)) }
+				File.open(::APPPATH+'cache/'+key.to_s+'~'+lifetime.to_s, 'w') {|f| f.write(Marshal.dump(value)) }
 			end
 
 			return true

data/lib/classes/config.rb

@@ -10,7 +10,6 @@ module Picombo
 	# === Overview
 	# There are several built in config file types:
 	#  * config.yaml
-	#  * datamapper.yaml
 	#  * cache.yaml
 	#  * log.yaml
 	#  * mimes.yaml
@@ -23,18 +22,18 @@ module Picombo
 	# To call config values, use the Picombo::Config.get method. The first parameter is the path of your config value, using dot notation. With dot notation, the first part is the filename, and everything after that is the path inside the file.
 	#
 	# ==== Example
-	# For the following file (datamapper.yaml):
+	# For the following file (config.yaml):
 	#
-	# 	default:
-	# 	 driver: mysql
-	# 	 host: localhost
-	# 	 database: picom_db
-	# 	 username: picom_u
-	# 	 password: picom_p
+	# 	site_domain: localhost:3000
+	# 	protocol: http
+	# 	extensions:
+	# 	  []
+	# 	hooks:
+	# 	  [profiler]
 	#
-	# You can get the database config value like:
+	# You can get the core config values like:
 	#
-	# Picombo::Config.get('datamapper.default.database')
+	# Picombo::Config.get('core.protocol')
 	class Config
 		include Enumerable
 

data/lib/classes/e404.rb

@@ -1,5 +1,9 @@
 module Picombo
-	# == Main 404 exception class. Used to detect 404 errors in the app
+	# == 404 Exception
+	# 
+	# Main 404 exception class. Used to detect 404 errors in the app.
+	# 
+	# When you raise a E404 exception, Picombo will instantiate the Picombo::Controllers::Error_404 controller and execute it's run_error() method with the uri passed in. You can override how your 404 pages look by overloading this class.
 	class E404 < Exception
 		
 	end

data/lib/classes/log.rb

@@ -22,7 +22,7 @@ module Picombo
 
 			if types[type] <= Picombo::Config.get('log.log_threshold')
 				t = Time.now
-				f = File.new(APPPATH+Picombo::Config.get('log.directory')+t.year.to_s+'-'+t.month.to_s+'-'+t.day.to_s+'.log', 'a')
+				f = File.new(::APPPATH+Picombo::Config.get('log.directory')+t.year.to_s+'-'+t.month.to_s+'-'+t.day.to_s+'.log', 'a')
 				f.write(t.to_s+' --- '+type.to_s+': '+message.to_s+"\n");
 				f.close
 			end

data/lib/classes/router.rb

@@ -22,6 +22,14 @@ module Picombo
 	# 				{:controller => 'city', :method => 'index', :params => Regexp.last_match[2,3]}
 	# 		end
 	#  })
+	# 
+	# === Route Hashes
+	# The router uses route hashes as shown above to determine which controller/method should be run. It has the following properties:
+	#  :controller - The controller name to execute
+	#  :method     - The method of the controller to run
+	#  :param      - The parameters to pass to the controller method
+	# 
+	# If you use lambda routes, you *must* return a properly formatted routing hash.
 
 	class Router
 		@@req = nil

data/lib/classes/stache.rb

@@ -0,0 +1,44 @@
+require 'mustache'
+
+module Picombo
+	# == Mustache Module
+	# 
+	# Picombo comes with builtin support for Mustache view templates
+	# 
+	# === How to use
+	# 
+	# All view files go into the views folder. You need a .rb class along with a .mustache template file. Your view class files should extend the Mustache class:
+	# 
+	# 	module Picombo
+	# 		module Stache
+	# 			class Home_Index < Mustache
+	# 				self.template = File.open(Picombo::Core.find_file('views', 'home/index', true, 'mustache').shift).read
+	# 			end
+	# 		end
+	# 	end
+	# 
+	# You should always set the template in your class. In most scenarios, it's easiest to read it in from a file as displayed above. You can also specify a raw string template there and not do the file read.
+	# 
+	# To render the template to your browser, use the output method:
+	# 	Picombo::Stache::Home_Index.new.output
+	module Stache
+		# Autoloader for missing mustache classes.
+		def Stache.const_missing(name)
+			filename = name.to_s
+
+			require 'views/'+filename.downcase.gsub(/_/, '/')
+
+			raise name.to_s+' not found!' if ! const_defined?(name)
+
+			klass = const_get(name)
+			return klass if klass
+			raise klass+" not found!"
+		end
+	end
+end
+
+class Mustache
+	def output
+		Picombo::Core.response(render)
+	end
+end

data/lib/core/core.rb

@@ -7,6 +7,65 @@
 # 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.
+# 
+# == Filesystem Structure
+# 
+# Picombo supports automatic class autoloading. This depends on the directory structure of Picombo. It has a few standard structures:
+# 
+# 	classes/
+# 	config/
+# 	controllers/
+# 	hooks/
+# 	models/
+# 	views/
+# 
+# === Classes
+# This is the location that general classes go in the filesystem.
+# 
+# These class names must be in the Picombo module to be properly autoloaded.
+# 
+# === Config
+# This is where config items go. All config files except the Route file should be YAML to be read properly.
+# 
+# === Controllers
+# This is where controllers go (See the controllers doc for more information).
+# 
+# These class names should be in the Picombo::Controllers module to be properly autoloaded.
+# 
+# === Hooks
+# Hooks go here. You can use hooks to extend/replace/expand system functionality. Hooks run before anything else in the system setup process.
+# 
+# === Models
+# This is where your models go (See the models doc for more information).
+# 
+# These class names should be in the Picombo::Models module to be properly autoloaded.
+# 
+# === Views
+# This is where views go (See the Stache docs for specific usage).
+# 
+# If you write a Picombo extension, it's important to know that all extensions should follow this same directory layout. In Picombo, all standard filesystem locations are searched from application first, through the extension list, and finally down to the core system folder. This lets you easily extend and replace functionality with extensions.
+# 
+# == Autoloading
+# As long as your files/classes are setup as above, autoloading will "just work". There's one special case, however: underscores in class names. When you have an underscore in your class name, it will be translated to a directory seperator.
+# 
+# 	class Picombo::Controllers::Foo_Bar
+# 
+# lives in:
+# 	controllers/foo/bar.rb
+# 
+# and
+# 	class Picombo::Cache_Memcache
+# 
+# lives in:
+# 	classes/cache/memcache.rb
+# 
+# == Typical Request Flow
+# In a typical Picombo request here's how a request get's processed:
+# 
+# 1. URI comes in from the browser to the server, and is passes to the Router
+# 2. The router processes the URI using the routes.rb config file to do any special routing
+# 3. The routed URI is the then processed by the appropriate controller
+# 4. The controller processes any input, works with Views and Models to generate the request output
 
 module Picombo
 	# == Core
@@ -40,8 +99,8 @@ module Picombo
 			Picombo::Config.get('config.extensions').each do |extension|
 				require extension
 			end
-			$LOAD_PATH.delete(APPPATH)
-			$LOAD_PATH.unshift(APPPATH)
+			$LOAD_PATH.delete(::APPPATH)
+			$LOAD_PATH.unshift(::APPPATH)
 
 			# Load hooks
 			Picombo::Config.get('config.hooks').each do |hook|

data/lib/core/core_cli.rb

@@ -1,9 +1,6 @@
 require 'core/core'
 
 module Picombo
-	# == Core
-	#
-	# The core class for Picombo. Handles system initialization and other core functionality.
 	class Core
 
 		# Standard call function that gets invoked by Rack
@@ -23,8 +20,8 @@ module Picombo
 			Picombo::Config.get('config.extensions').each do |extension|
 				require extension
 			end
-			$LOAD_PATH.delete(APPPATH)
-			$LOAD_PATH.unshift(APPPATH)
+			$LOAD_PATH.delete(::APPPATH)
+			$LOAD_PATH.unshift(::APPPATH)
 
 			# Load hooks
 			Picombo::Config.get('config.hooks').each do |hook|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Jeremy Bush
@@ -66,6 +66,7 @@ files:
 - ./lib/classes/log.rb
 - ./lib/classes/router.rb
 - ./lib/classes/session.rb
+- ./lib/classes/stache.rb
 - ./lib/classes/url.rb
 - ./lib/config/cache.yaml
 - ./lib/config/log.yaml
@@ -75,7 +76,6 @@ files:
 - ./lib/controllers/template.rb
 - ./lib/core/core.rb
 - ./lib/core/core_cli.rb
-- ./lib/hooks/mustache.rb
 - ./lib/hooks/profiler.rb
 - ./lib/picombo.rb
 - ./lib/views/error/404.mustache

data/lib/hooks/mustache.rb

@@ -1,24 +0,0 @@
-require 'mustache'
-
-module Picombo
-	module Stache
-		# Autoloader for missing mustache classes.
-		def Stache.const_missing(name)
-			filename = name.to_s
-
-			require 'views/'+filename.downcase.gsub(/_/, '/')
-
-			raise name.to_s+' not found!' if ! const_defined?(name)
-
-			klass = const_get(name)
-			return klass if klass
-			raise klass+" not found!"
-		end
-	end
-end
-
-class Mustache
-	def output
-		Picombo::Core.response(render)
-	end
-end