spire 0.3.3 → 0.4.0

data/README.rdoc

@@ -12,6 +12,12 @@ This will install spire, create a project called 'project_name' in the same dire
 
 = Usage 
 
+== Creating a project
+
+To create a new project you simply use the spire executable like so:
+    spire -c my_project
+and it will make a template app in ./my_project in the folder it was executed.
+
 == Routes
 
 Routes are used in the config.ru, they work like the old-style Rails routes:
@@ -49,6 +55,12 @@ This would display a html page with that text. The Response.new initiator could
     end
 Where the first instance variable @status is the HTTP status to show, the second being the content type, and the last being the returned value as a string.
 
+=== Controller generator
+ 
+You can generate controllers using the spire executable. To do this you can simply run:
+    spire -g foo
+Which will generate the FooController in the app/controllers directory with all the necessary code for you.
+
 == Views
 
 === RHTML
@@ -58,18 +70,30 @@ With the naming scheme of:
     template.rhtml
 The .rhtml is important so Spire knows what file it is. To pass data to a view, you simply define an instance variable before you render the template and it will automatically be accessible in your view template.
 To render a template, you simply use:
-    render("index.rhtml")
+    render :view => "index.rhtml"
 
 === HAML
 HAML templates can be rendered like so:
-    render("index.haml")
+    render :view => "index.haml"
 This would load the index.haml view in:
     /app/views/index.haml
 To pass data to the view, define and fill an instance variable with content or an object, and you can use it inside your HAML view.
 
 === HTML
 HTML are static templates to be used in your project/app, they can't use variables, nor can they execute ruby code. They can be rendered using:
-    render("index.html")
+    render :view => "index.html"
 Which would load the 'index.html' file from:
     project_name/app/views/index.html
-The first argument is the file name, the second being the extension.
+The first argument is the file name, the second being the extension.
+You could also use:
+		render :file => "index.html" 
+if the html file is in:
+    /public/index.html
+
+== Files
+To return a file from a method, you can use the render method for this task:
+    render :file => "test.pdf"
+This will give the browser the file 'test.pdf' from the /public directory. This method will also match the content-type of this automatically using magic and will give the browser the correct content type and response automatically. This will also give a HTML 404 error page if the file does not exist. 
+
+== Dependencies 
+You will need 'git', 'wget' and 'ruby' and 'rubygems' to get started.

data/Rakefile

@@ -18,8 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/snicol/spire"
   gem.license = "MIT"
   gem.summary = %Q{A light controller-only rack framework with a dash of views}
-  gem.description = %Q{Light rack-based framework with controllers, static views and a router 
-    with templating engine support coming soon}
+  gem.description = %Q{Light rack-based framework with controllers, HAML/ERB views, router & error handler}
   gem.email = "scott@scottnicol.co.uk"
   gem.authors = ["Scott Nicol"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.0

data/lib/spire/class/MainController.rb

@@ -18,6 +18,7 @@ module Spire
         file = contents.extension_check
         return file
       end
+      
       if opts[:view].is_a? Array
         @storage = ""
         opts[:view].each do |file|          

data/lib/spire/error.rb

@@ -1,33 +1,27 @@
 module Spire
     class Error
-        def initialize(opts={})
-            status = opts[:status] or 200
-            message = opts[:message] or "Unknown Error"
-            
-            case status
+        def initialize(opts={:status => 200, :message=> "Unknown Error"})
+                        
+            case opts[:status]
             when 200
-                self.return_error(message, status)
+                self.return_error(opts[:message], opts[:status])
             when 404
+              if opts[:message]
+                self.return_error(opts[:message], opts[:status])
+              else
                 self.return_404
+              end
+            when 444
+                self.return_444
             when 401
                 self.return_401
             when 204
                 self.return_204
             when 301
                 self.return_301
-            when 444
-                self.return_444
             end
         end
 
-        def return_404
-            @return = Response.new("404 // Page not found", 'text/html;', 404)
-        end
-
-        def return_401
-            @return = Response.new("401 // Not authorized", 'text/html;', 401)
-        end
-
         def return_204
             @return = Response.new("204 // No content", 'text/html;', 204)
         end
@@ -35,15 +29,23 @@ module Spire
         def return_301
             @return = Response.new("301 // Moved permanently", 'text/html;', 301)
         end
-
-        def return_error(message, status)
-            @return = Response.new(message, 'text/html;', status)
+        
+        def return_401
+            @return = Response.new("401 // Not authorized", 'text/html;', 401)
+        end
+        
+        def return_404
+            @return = Response.new("404 // Page not found", 'text/html;', 404)
         end
-          
+        
         def return_444
             @return = Response.new("No response made by the server, check for a valid response", 'text/html;', 404)
         end
-        
+
+        def return_error(message, status)
+            @return = Response.new(message, 'text/html;', status)
+        end
+
         def to_rack
             @return.to_rack
         end

data/lib/spire/public.rb

@@ -3,21 +3,20 @@ require 'spire/resource/mime'
 module Spire
   class Public
     def initialize(opts={:render=>true})
-      @file = opts[:file]
-      @render = opts[:render]
+      @opts = opts
       mime = Mime.new
       @mime_types = mime.return_mimes
     end
     
     def extension_check
-      file_extension = File.extname(@file)
+      file_extension = File.extname(@opts[:file])
       @mime_types.each do |ext, type|
         if file_extension == ext
           @content_type = type
         end
       end
       
-      if @render
+      if @opts[:render]
         self.create_response
       else
         return [false, @content_type]
@@ -26,18 +25,14 @@ module Spire
     
     def create_response
       path = File.expand_path(__FILE__)
-      path["lib/spire/public.rb"] = "public/#{@file}"
-      return Error.new(:status => 404) unless File.exists?(path)
+      path["lib/spire/public.rb"] = "public/#{@opts[:file]}"
+      return Error.new(:status => 404, :message => "404 // File not found") unless File.exists?(path)
       file = IO.read(path)
       @return = {}
       @return[:file] = file
       @return[:content_type] = @content_type
       return @return
     end
-    
-    def to_rack
-      @return.to_rack
-    end
         
   end
 end

data/lib/spire/resource/mime.rb

@@ -8,12 +8,13 @@ module Spire
           ".css" => "text/css",
           ".ics" => "text/calendar",
           ".csv" => "text/csv",
-
+          
           ".png" => "image/png",
           ".jpeg" => "image/jpeg",
           ".gif" => "image/gif",
           ".bmp" => "image/bmp",
           ".tiff" => "image/tiff",
+          ".ico" => "image/image/x-icon",
 
           ".mpeg" => "video/mpeg",
 

data/lib/spire/router.rb

@@ -13,9 +13,8 @@ module Spire
 
     def route
       @app["controller"] = nil
-      
-      if @request["controller"] == "public"
-        self.return_file
+      if @request["controller"] == "favicon.ico"
+        return self.return_file("favicon.ico")
       end
       
       if @request["controller"] == nil
@@ -36,15 +35,15 @@ module Spire
         end
       end
       
-      unless @app["controller"] 
-        return Error.new :status => 404
+      unless @app["controller"]     
+        return Error.new :message => "404 // Route not found in system/routes.rb", :status => 404
       end
       
       return self.run
     end 
     
-    def return_file
-      result = Public.new :file => "test.html", :render => true
+    def return_file(file)
+      result = Public.new :file => file, :render => true
       file = result.extension_check
       return Response.new(file[:file], file[:content_type], 200)
     end
@@ -63,9 +62,9 @@ module Spire
       
       content_type = "text/html;"
       status = 200
-      
-      if result == 404
-        return Error.new :status => 404
+            
+      if result == 404 or result == nil
+        return Error.new :message => "404 // No method/Response from method. See #{@app["controller"]}##{@app["action"]} and check for a response", :status => 404
       end
       
       if @class.instance_variable_get(:@status)

data/spire.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "spire"
-  s.version = "0.3.3"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Nicol"]
-  s.date = "2011-10-20"
-  s.description = "Light rack-based framework with controllers, static views and a router \n    with templating engine support coming soon"
+  s.date = "2011-10-21"
+  s.description = "Light rack-based framework with controllers, HAML/ERB views, router & error handler"
   s.email = "scott@scottnicol.co.uk"
   s.executables = ["spire"]
   s.extra_rdoc_files = [
@@ -30,7 +30,6 @@ Gem::Specification.new do |s|
     "lib/spire/public.rb",
     "lib/spire/resource/mime.rb",
     "lib/spire/router.rb",
-    "routes.rb",
     "spire.gemspec"
   ]
   s.homepage = "http://github.com/snicol/spire"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spire
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-20 00:00:00.000000000Z
+date: 2011-10-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70258656997880 !ruby/object:Gem::Requirement
+  requirement: &70167713606260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258656997880
+  version_requirements: *70167713606260
 - !ruby/object:Gem::Dependency
   name: rack-rewrite
-  requirement: &70258656997400 !ruby/object:Gem::Requirement
+  requirement: &70167713605780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70258656997400
+  version_requirements: *70167713605780
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70258656996920 !ruby/object:Gem::Requirement
+  requirement: &70167713605300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258656996920
+  version_requirements: *70167713605300
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70258656996440 !ruby/object:Gem::Requirement
+  requirement: &70167713604820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70258656996440
+  version_requirements: *70167713604820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70258656995960 !ruby/object:Gem::Requirement
+  requirement: &70167713604340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70258656995960
+  version_requirements: *70167713604340
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70258656995480 !ruby/object:Gem::Requirement
+  requirement: &70167713603860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70258656995480
+  version_requirements: *70167713603860
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70258656995000 !ruby/object:Gem::Requirement
+  requirement: &70167713603380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,9 +87,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70258656995000
-description: ! "Light rack-based framework with controllers, static views and a router
-  \n    with templating engine support coming soon"
+  version_requirements: *70167713603380
+description: Light rack-based framework with controllers, HAML/ERB views, router &
+  error handler
 email: scott@scottnicol.co.uk
 executables:
 - spire
@@ -110,7 +110,6 @@ files:
 - lib/spire/public.rb
 - lib/spire/resource/mime.rb
 - lib/spire/router.rb
-- routes.rb
 - spire.gemspec
 homepage: http://github.com/snicol/spire
 licenses:
@@ -127,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1719392172410138947
+      hash: 2784368830073330069
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/routes.rb

@@ -1,4 +0,0 @@
-routes = {
-  "default" => "index#index", # the default route!
-  "/index" => "index#index",
-}