speck_gem 1.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem "rack"
+gem "tilt"
+gem "mocha_standalone"

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    metaclass (0.0.1)
+    mocha (0.12.3)
+      metaclass (~> 0.0.1)
+    rack (1.5.2)
+    tilt (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rack
+  tilt

data/README.md

@@ -0,0 +1,99 @@
+Speck
+=====
+
+Ruby Microframework.
+
+Getting Started
+===============
+1. make filesystem seen in app directory
+2. require gem
+
+
+Routing
+=======
+
+```ruby
+# routes.rb
+
+match '/','Home' do
+	get '' => 'index'
+	post 'login' => 'authenticate'
+end
+
+match '/vacations','Vacation' do
+	get '' => 'index', '/:id'=>'show'
+	put '/:id' => 'update'
+	post '/:id' => 'edit'
+
+	match '/:id1/photos','Photo' do
+	 	get '' => 'index', '/:id2' => 'show'
+	 	put '/:id2' => 'update'
+	 	post '/:id2' => 'edit'
+	 end
+end
+```
+
+Controllers
+===========
+```ruby
+class Photo < Speck::Controller
+	def index
+		session[:user] = params[:user]
+		render('home.html.erb')
+	end
+
+	def show
+		@user = session[:user]
+		@photo = fetch_photo(params[:id])
+		render('photo.html.erb')
+	end
+end
+
+```
+
+Templates
+=========
+Speck uses the tilt gem for template rendering. Many templating languages are supported. Below is an example using erb.
+```html
+<h1><%= @user %></h1>
+
+<% @photos.each do |photo| %>
+	<% @id = photo.id %>
+	<% @location = photo.location %>
+	<% @file = photo.file_path %>
+	<%= render('photo_partial.html.erb') %>
+<% end %>
+
+```
+and photo_partial.html.erb
+```html
+<h3><%= @id %></h3>
+<p><%= @location %></p>
+<img src='<%= @file %>' />
+```
+There are helper functions for paths, javascrpit, and css. 
+
+App Structure
+=============
+```
+/app
+	/assets
+	/controllers
+	/views
+	config.rb
+	exception.html.erb
+	Gemfile
+	routes.rb
+	server.log
+```
+
+Rake Commands
+=============
+* rake test: runs the gem's test suite
+
+TODO
+====
+* test config
+* test session persistence
+* app structure
+* rake task for building app structure

data/Rakefile

@@ -0,0 +1,11 @@
+task :test do
+  require "cutest"
+  require "speck"
+  require "mocha_standalone"
+  Cutest.run(Dir["test/*.rb"]-Dir["test/*_example.rb"])
+end
+
+task :default => :test
+
+require 'bundler'  
+Bundler::GemHelper.install_tasks

data/app/Gemfile

@@ -0,0 +1,2 @@
+gem "speck"
+gem "tilt"

data/app/config.rb

@@ -0,0 +1,3 @@
+require 'speck'
+
+Speck::Config.run()

data/app/exception.html.erb

@@ -0,0 +1,2 @@
+<h1><%= @status %></h1>
+<p><%= @message %></p>

data/app/server.log

@@ -0,0 +1,5 @@
+# Logfile created on 2013-05-12 23:40:45 -0400 by logger.rb/31641
+E, [2013-05-12T23:40:45.944095 #43403] ERROR -- : [2013-05-12 23:40:45 -0400] 500: Missing rack.input
+
+E, [2013-05-12T23:42:06.077617 #43650] ERROR -- : [2013-05-12 23:42:06 -0400] 500: Missing rack.input
+

data/lib/speck/config.rb

@@ -0,0 +1,67 @@
+require 'rack'
+
+
+module Speck
+	class Config
+		private_class_method :new
+
+		def self.app_root
+			if Dir.pwd[-3,3] == 'app'
+				dir = Dir.pwd 
+			else
+				dir = Dir.pwd+'/app'
+			end
+			@@app_root ||= dir
+		end
+
+		def self.set_app_root(root)
+			@@app_root = root
+		end
+
+		def set_app_server(type)
+			@@server = type
+		end
+
+		def self.app_server
+			@@server ||= Rack::Handler::WEBrick
+		end
+
+		def self.app_port
+			@@port ||= 5000
+		end
+
+		def self.set_app_port(port)
+			@@port = port 
+		end
+
+		def self.app_middleware
+			@@middleware ||= [[Rack::Static,{:urls => ["/assets"]}],
+			[Rack::Session::Cookie, {:key => 'rack.session',
+                               :path => '/',
+                               :expire_after => 2592000,
+                               :secret => 'SECRETKEY1111'}]]
+		end
+
+		def self.add_app_middleware(middleware, options)
+			nxt = [middleware, options]
+			if app_middleware.nil?
+				@@middleware = [nxt] 
+			else
+				@@middleware << nxt
+			end
+		end
+
+		def self.launch
+			app = Rack::Builder.app do
+				Speck::Config.app_middleware.each do |middleware|
+					use middleware[0], middleware[1]
+				end
+				Signal.trap('INT') {
+  				Speck::Config.app_server.shutdown
+				}
+				run Speck::Router.new
+			end
+			app_server.run(app, :Port => app_port)
+		end
+	end
+end

data/lib/speck/controller.rb

@@ -0,0 +1,76 @@
+require 'tilt'
+
+module Speck
+	
+	class Controller
+
+		def initialize(session, params)
+			@__session = session
+			@__params = params
+		end
+
+		def link(path,text)
+			"<a href='#{path}'>#{text}</a>"
+		end
+
+		def asset(filename)
+			path('asset',filename)
+		end
+
+		def controller(filename)
+			path('controller',filename)
+		end
+
+		def view(filename)
+			path('view',filename)
+		end
+
+		def path(type,filename)
+			case type
+			when /app/
+				Config.app_root+'/'+filename
+			when /asset/
+				'/assets/'+filename
+			when /controller/
+				Config.app_root+'/controllers/'+filename
+			when /view/
+				Config.app_root+'/views/'+filename
+			else
+				message = "#{type} is not a valid type! Valid types are 'app','asset','controller','view'!"
+				raise Speck_Exception.new(message)
+			end
+		end
+
+		def js(filename)
+			if filename =~ /\.js/
+				js = path('assets',filename)
+			else
+				js = path('assets',filename+'.js')
+			end
+			"<script src='#{js}' type='text/javascript' charset='utf-8'></script>"
+		end
+
+		def css(filename)
+			if filename =~ /\.css/
+				style = path('assets',filename)
+			else
+				style = path('assets',filename+'.css')
+			end
+			"<link rel='STYLESHEET' href='#{style}' type='text/css'>"
+		end
+
+		def render(template_path)
+			Log.render(template_path)
+			Tilt.new(template_path).render(self)
+		end
+
+		def session
+			@__session
+		end
+
+		def params
+			@__params
+		end
+	end
+
+end

data/lib/speck/exception.rb

@@ -0,0 +1,17 @@
+module Speck
+	class Speck_Exception < RuntimeError
+	end
+
+	class Routing_Exception < Speck_Exception
+		attr_reader :status, :message
+
+		def initialize(status, message)
+			@status = status
+			@message = message
+		end
+
+		def render()
+			Tilt.new(Config.app_root+'/exception.html.erb').render(self)
+		end
+	end
+end

data/lib/speck/log.rb

@@ -0,0 +1,37 @@
+require 'logger'
+
+module Speck
+	class Log
+
+		def self.log
+			@log ||= Logger.new(Config.app_root+'/server.log', shift_age = 'weekly')
+		end
+
+		def self.render(path)
+			write(Logger::INFO, "Renderig: #{path}")
+		end
+
+		def self.request(request)
+			write(Logger::INFO,"Starting: #{request.request_method} #{request.fullpath}")
+		end 
+
+		def self.dispatch(controller,action,params)
+			write(Logger::INFO,"Dispatching: #{controller}.#{action} with #{params}")
+		end
+
+		def self.exception(status,message)
+			write(Logger::WARN,"#{status}: #{message}")
+		end
+
+		def self.error(error)
+			puts error.backtrace
+			write(Logger::ERROR,"500: #{error.message}")
+		end
+
+		def self.write(severity,msg)
+			out = "[#{Time.now}] #{msg}\n"
+			puts out
+			log.add(severity,message=out)
+		end
+	end
+end

data/lib/speck/router.rb

@@ -0,0 +1,115 @@
+require 'rack'
+require 'speck/controller'
+require 'speck/log'
+require 'speck/exception'
+require 'speck/config'
+
+Dir[Speck::Config.app_root+"/controllers/*.rb"].each {|file| require file }
+
+
+module Speck
+	class Router
+	
+		attr_reader :routes
+		
+		@@HTTP_REQUESTS = [:GET, :PUT, :POST, :DELETE]
+		
+		def initialize(path=nil)
+			@routes = {}
+			@controller = []
+			@base = ''
+			@@HTTP_REQUESTS.each{ |req| @routes[req] = {}}
+			build_routes(path)
+		end
+		
+		def build_routes(path=nil)
+			path ||= Config.app_root+'/routes.rb'
+			instance_eval(File.read(path))
+		end
+		
+		def match(base,controller, &block)
+			@base << base
+			@controller << controller
+			instance_eval(&block)
+			@controller.pop()
+			@base.chomp!(base)
+		end
+		
+		def call(env)
+		  @request = Rack::Request.new(env)
+		  @response = process
+		  @response.finish
+		end
+
+		def symbolize_keys(hash)
+			hash.keys.each do |key|
+				hash[(key.to_sym rescue key) || key] = hash.delete(key)
+			end
+			hash
+		end
+
+		def controller_action_params
+			routes = @routes[@request.request_method.to_sym]
+			valid_routes = routes.keys.select{ |route| matching? route}
+			raise Routing_Exception.new(404,'Page not found!') if valid_routes.empty?
+			controller, action = routes[valid_routes.first]
+			params = extract_params(valid_routes.first)
+			params.merge!(symbolize_keys(@request.params)) if @request.form_data?
+			[controller, action, params]
+		end
+
+		def matching?(route)
+			route_list = route.split('/')
+			path_list = @request.path.split('/')
+			return false unless path_list.length == route_list.length
+			path_list.length.times { |i| return false unless route_list[i][0] == ":" or route_list[i] == path_list[i]}
+			true
+		end
+
+		def extract_params(route)
+			route_list = route.split('/')
+			path_list = @request.path.split('/')
+
+			params = {}
+			path_list.length.times do |i|
+				params[route_list[i].sub(":","").to_sym] = path_list[i] if route_list[i][0] == ":"
+			end
+			params
+		end
+		
+		def process
+			Log.request(@request)
+			begin
+				controller, action, params = controller_action_params
+				Log.dispatch(controller,action,params)
+				session = @request.env['rack.session']
+				session[:init] = true #forces session loading
+				body = Kernel.const_get(controller).new(session|| {}, params).send(action)
+				status = 200
+			rescue Routing_Exception => ex
+				Log.exception(ex.status, ex.message)
+				body = ex.render
+				status = ex.status
+			rescue RuntimeError => e
+				Log.error(e)
+				ex = Routing_Exception.new(500,'Server Error!')
+				body = ex.render
+				status = 500
+			end
+			resp = Rack::Response.new(body=body, status=status)
+		end
+
+		def add_route(request_type, bindings)
+				bindings.each { |route, action| @routes[request_type][@base+route] = [@controller.last,action] }
+		end
+
+		def method_missing(name, *args, &block)
+			if @@HTTP_REQUESTS.include?(name.upcase)
+				add_route(name.upcase,args[0])
+			else
+				super(name, *args, &block)
+			end
+		end
+	
+	end
+end

data/lib/speck.rb

@@ -0,0 +1,4 @@
+require 'speck/log'
+require 'speck/router'
+require 'speck/controller'
+require 'speck/config'

data/server.log

@@ -0,0 +1 @@
+# Logfile created on 2013-05-12 22:35:54 -0400 by logger.rb/31641

data/speck.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name        = 'speck_gem'
+  s.version     = '1.0.0'
+  s.date        = '2013-04-06'
+  s.summary     = "See documentation"
+  s.description = "A simple ruby web framework"
+  s.authors     = ["David Thomas"]
+  s.email       = 'davidthomas5412@gmail.com'
+  s.files       = `git ls-files`.split("\n") - %w[.gitignore]
+end

data/test/controller_example.rb

@@ -0,0 +1,51 @@
+require 'speck'
+
+class Location < Speck::Controller
+	def index
+		"index called"
+	end
+
+	def show
+		"id: #{params[:id]}"
+	end
+
+	def template
+		@msg = 'template message'
+		render('test/template_example.html.erb')
+	end
+
+	def template_with_partial
+		@title = "template title"
+		@body = "partial body"
+		render('test/template2_example.html.erb')
+	end
+end
+
+class Book < Speck::Controller
+	def show
+		"id: #{params[:id]}"
+	end
+end
+
+
+class Home < Speck::Controller
+	def index
+		"index body"
+	end
+
+	def authenticate
+		raise RuntimeError
+	end
+end
+
+class Vacation < Speck::Controller
+	def show
+		"id: #{params[:id]}"
+	end
+end
+
+class Photo < Speck::Controller
+	def show
+		"id1: #{params[:id1]} id2: #{params[:id2]}"
+	end
+end

data/test/controllers.rb

@@ -0,0 +1,60 @@
+require File.dirname(File.expand_path(__FILE__))+'/controller_example.rb'
+
+def assert_contain(actual, expected)
+	actual =~ expected
+end
+
+setup do
+	Speck::Log.stubs(:render)
+end
+
+test "controller dispatching actions" do
+	assert_equal Location.new({},{}).send('index'), "index called"
+	assert_equal Location.new({},{:id => 99}).send('show'), "id: 99"
+end
+
+test "controller rendering with instance variables" do
+	assert_contain Location.new({},{}).send('template'), /template message/
+end
+
+test "controller classes don't share param state" do
+	assert_equal Location.new({},{:id => 0}).send('show'), "id: 0"
+	assert_equal Book.new({},{:id => 1}).send('show'), "id: 1"
+end
+
+test "recursive rendering of partials" do
+	assert_contain Location.new({},{}).send('template_with_partial'), /template title/
+	assert_contain Location.new({},{}).send('template_with_partial'), /partial body/
+end
+
+test "session persists accross requests" do
+end
+
+test "path" do
+	loc = Location.new({},{})
+	root = Speck::Config.app_root
+	assert_equal loc.path('app','config.rb'), root+'/config.rb'
+	assert_equal loc.path('views','photo.html.erb'), root+'/views/photo.html.erb'
+	assert_equal loc.path('asset','jquery.js'), '/assets/jquery.js'
+end
+
+test "invalid path raises speck exception" do
+	loc = Location.new({},{})
+	assert_raise Speck::Speck_Exception do
+		loc.path('veew','')
+	end
+end
+
+test "javascript helper" do
+	loc = Location.new({},{})
+	root = Speck::Config.app_root
+	expected = "<script src='/assets/jquery.js' type='text/javascript' charset='utf-8'></script>"
+	assert_equal loc.js('jquery'), expected
+end
+
+test "css helper" do
+	loc = Location.new({},{})
+	root = Speck::Config.app_root
+	expected = "<link rel='STYLESHEET' href='/assets/style.css' type='text/css'>"
+	assert_equal loc.css('style'), expected
+end

data/test/exception.rb

@@ -0,0 +1,11 @@
+setup do
+	Speck::Config.set_app_root('app')
+end
+
+test "404 routing exception" do
+	ex = Speck::Routing_Exception.new(404,'Page not found!')
+	assert_equal ex.status, 404
+	assert_equal ex.message, 'Page not found!'
+	assert_equal ex.render, "<h1>404</h1>
+<p>Page not found!</p>"
+end

data/test/logger.rb

@@ -0,0 +1,7 @@
+test "logger is singleton" do 
+	initial_log = Speck::Log.log
+	initial_log.expects(:add)
+	Speck::Log.expects(:write)
+	Speck::Log.dispatch("controller","acton","params")
+	assert_equal Speck::Log.log, initial_log
+end

data/test/partial_example.html.erb

@@ -0,0 +1 @@
+<%= @body %>

data/test/router.rb

@@ -0,0 +1,66 @@
+test = File.dirname(File.expand_path(__FILE__))
+require test+'/controller_example.rb'
+
+### To test response
+module Rack
+	class Response
+		attr_reader :body
+	end
+end
+
+def expect_request
+	Speck::Log.expects(:request)
+	Speck::Log.expects(:dispatch)
+end
+
+def test_response(r,env,status,body)
+	expect_request
+	env['rack.session'] ={}
+	resp = r.call(env)
+	assert_equal resp[2].body(), [body]
+	assert_equal resp[0], status
+end
+
+setup do
+	Speck::Router.new(test+'/routes_example.rb')
+end
+
+test 'routes controller action' do |r|
+	assert_equal r.routes[:GET]['/'], ['Home','index']
+	assert_equal r.routes[:POST]['/login'], ['Home','authenticate']
+end
+
+test 'nested routes' do |r|
+	assert_equal r.routes[:GET]['/vacations/:id1/photos'], ['Photo','index']
+end
+
+test 'route with param' do |r|
+	assert_equal r.routes[:PUT]['/vacations/:id'], ['Vacation','update']
+end
+
+test 'handle example request' do |r|
+	env = {"PATH_INFO"=>"/", "REQUEST_METHOD"=>"GET"}
+	test_response(r,env,200,"index body")
+end
+
+test 'handle exmple request with parameters' do |r|
+	env = {"PATH_INFO"=>"/vacations/99", "REQUEST_METHOD"=>"GET"}
+	test_response(r,env,200,"id: 99")
+end
+
+test 'handle nested route request with multiple parameters' do |r|
+	env = {"PATH_INFO"=>"/vacations/1/photos/2", "REQUEST_METHOD"=>"GET"}
+	test_response(r,env,200,"id1: 1 id2: 2")
+end
+
+test 'handle 404' do |r|
+	env = {"PATH_INFO"=>"facebook", "REQUEST_METHOD"=>"GET"}
+	Speck::Log.expects(:exception)
+	test_response(r,env,404,"<h1>404</h1>\n<p>Page not found!</p>")
+end
+
+test 'handle 500' do |r|
+	env = {"PATH_INFO"=>"/login", "REQUEST_METHOD"=>"POST"}
+	Speck::Log.expects(:error)
+	test_response(r,env,500,"<h1>500</h1>\n<p>Server Error!</p>")
+end

data/test/routes_example.rb

@@ -0,0 +1,16 @@
+match '/','Home' do
+	get '' => 'index'
+	post 'login' => 'authenticate'
+end
+
+match '/vacations','Vacation' do
+	get '' => 'index', '/:id'=>'show'
+	put '/:id' => 'update'
+	post '/:id' => 'edit'
+
+	match '/:id1/photos','Photo' do
+	 	get '' => 'index', '/:id2' => 'show'
+	 	put '/:id2' => 'update'
+	 	post '/:id2' => 'edit'
+	 end
+end

data/test/template2_example.html.erb

@@ -0,0 +1,2 @@
+<h1><%= @title %></h1>
+<p><%= render('test/partial_example.html.erb') %></p>

data/test/template_example.html.erb

@@ -0,0 +1 @@
+<p><%= @message %></p>

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: speck_gem
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies: []
+description: A simple ruby web framework
+email: davidthomas5412@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/Gemfile
+- app/config.rb
+- app/exception.html.erb
+- app/routes.rb
+- app/server.log
+- app/server.log.20130511
+- lib/speck.rb
+- lib/speck/config.rb
+- lib/speck/controller.rb
+- lib/speck/exception.rb
+- lib/speck/log.rb
+- lib/speck/router.rb
+- server.log
+- speck.gemspec
+- test/config.rb
+- test/controller_example.rb
+- test/controllers.rb
+- test/exception.rb
+- test/logger.rb
+- test/partial_example.html.erb
+- test/router.rb
+- test/routes_example.rb
+- test/template2_example.html.erb
+- test/template_example.html.erb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: See documentation
+test_files: []