corrupt 0.3.5 → 0.3.6

data/README

@@ -4,7 +4,12 @@ Bare-bones Rack based MVC framework.
 
 So many buzz-words, it could kill a baby seal.
 
-== Getting Started
+=== Code
+
+* Github: http://github.com/Oshuma/corrupt.rack
+* Rubyforge: http://rubyforge.org/projects/corrupt
+
+=== Getting Started
 
 If you haven't already:
 

data/lib/corrupt.rb

@@ -3,10 +3,8 @@ $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
 # Dependencies.
 begin
   require 'dm-core'
-  require 'dm-timestamps'
   require 'haml'
   require 'logger'
-  require 'maruku'  # TODO: Might get removed.
   require 'singleton'
   require 'sqlite3'
   require 'yaml'
@@ -28,14 +26,14 @@ require 'corrupt/generators'
 require 'corrupt/framework/controller'
 
 module Corrupt
-  VERSION = '0.3.5'
+  VERSION = '0.3.6'
 
-  # Setup the Corrupt environment.
+  # Setup the Corrupt environment.  This just calls Corrupt::System.boot!
   def self.boot!
     Corrupt::System.boot!
   end
 
-  # Output a version string.
+  # Output the Corrupt version string.
   def self.to_version
     "Corrupt v#{VERSION}"
   end

data/lib/corrupt/app.rb

@@ -3,6 +3,8 @@ module Corrupt
   # This is the main Rack app, which is ran through
   #   run Corrupt::App
   class App
+    # Returns a proper Rack response in the form of:
+    #   [status, headers, content]
     def self.call(env)
       Router.dispatch(env['PATH_INFO'])
     end

data/lib/corrupt/client.rb

@@ -1,6 +1,7 @@
 module Corrupt
   autoload :ClientHelpers, 'corrupt/client/helpers'
 
+  # The Corrupt command-line Client.
   class Client
     include ClientHelpers
 
@@ -9,10 +10,12 @@ module Corrupt
       @options = {}
     end
 
+    # Class wrapper to the instance method Corrupt::Client#run.
     def self.run
       new.run
     end
 
+    # Handles ARGV input from the client.
     def run
       input = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename($0)} [options]"

data/lib/corrupt/client/helpers.rb

@@ -1,4 +1,5 @@
 module Corrupt
+  # A few helpful methods, mainly used in the command-line Client.
   module ClientHelpers
 
     # Output an error message to +stream+ (defaults to $stderr).
@@ -13,6 +14,8 @@ module Corrupt
       opts[:stream].send(opts[:method], string)
     end
 
+    # After Corrupt::Client#run has setup <tt>@options</tt>, this method
+    # determines what action to take.
     def take_action!
       Corrupt::Generators::App.new(@options[:path]) if @options[:path]
     end

data/lib/corrupt/framework/controller.rb

@@ -24,13 +24,15 @@ module Corrupt
       # Return the full Rack response in this format:
       #   [status, headers, content]
       # An optional +status+ may be passed; defaults to 200.
+      #
+      # An optional block may be passed, which will yield a Corrupt::Template object.
       def return_response(status = 200)
         yield template if block_given?
         self.content = template.render
         [status, headers, content]
       end
 
-      # Set the template to be rendered.
+      # Set the template file to be rendered.
       def template(file = nil)
         @template ||= Corrupt::Template.new(file)
       end

data/lib/corrupt/generators/app.rb

@@ -1,7 +1,7 @@
 module Corrupt
   module Generators
-    # autoload :Fileutils, 'fileutils'
 
+    # Generator to create a new Corrupt application.
     class App
 
       # A list of directories to create when making a new application.

data/lib/corrupt/router.rb

@@ -3,6 +3,10 @@ module Corrupt
   # Handles URL dispatching for the application.
   # Routes are stored in a class variable, accessible by Router.routes.
   class Router
+    # The Router is normally used like this:
+    #   Corrupt::Router.new do |route|
+    #     route.map '/path', :controller => 'Kickass', :action => 'take_names'
+    #   end
     def initialize(&block)
       @@routes = []
       yield self if block_given?

data/lib/corrupt/template.rb

@@ -1,7 +1,8 @@
 module Corrupt
 
+  # This class is responsible for setting view variables and rendering a template file.
   class Template
-    # TODO: Maybe parameterize the layout option?
+    # TODO: Maybe add a layout option?
     def initialize(file)
       # FIXME: This is rather ugly; maybe raise a 'view not found' exception?
       if file
@@ -14,6 +15,8 @@ module Corrupt
       @variables = {}
     end
 
+    # This captures any key/value pair called on the Template object
+    # and saves them for later use in the rendered template file.
     def method_missing(name, *args)
       # Trip the trailing '='
       name = name.to_s.gsub!(/[=]$/, '')
@@ -22,6 +25,8 @@ module Corrupt
 
     # Renders the file with any variables and returns an HTML string.
     # Wraps the file inside of the layout.
+    #
+    # Currently only supports Haml templates.
     def render
       wrap = Haml::Engine.new(File.read(@layout))
       wrap.render do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: corrupt
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,10 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
+date: 2009-04-18 00:00:00 -05:00
+default_executable: corrupt
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.9
+    version: 
 description: No nonsense Rack-based framework.
 email: 
 - dale@save-state.net
@@ -20,8 +39,8 @@ executables:
 - corrupt
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - Rakefile
 - README
@@ -71,13 +90,18 @@ files:
 - tasks/notes.rake
 - tasks/spec.rake
 - tasks/util.rake
-has_rdoc: false
-homepage: http://corrupt.save-state.net/
+has_rdoc: true
+homepage: http://github.com/Oshuma/corrupt.rack/
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- Corrupt API
+- --main
+- README
+- --inline-source
+- --line-numbers
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -97,7 +121,7 @@ requirements: []
 rubyforge_project: corrupt
 rubygems_version: 1.3.2
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Rack-based MVC framework.
 test_files: []