corrupt 0.3.6 → 0.3.7

data/Rakefile

@@ -3,10 +3,11 @@ task :default => 'spec'
 task :environment do
   ENV['CORRUPT_ENV'] ||= 'development'
   begin
-    require 'corrupt'
+    # Try to load from ./vendor first.
+    require File.dirname(__FILE__) + '/vendor/corrupt'
   rescue LoadError
-    # TODO: This might get moved to /vendor or some shit.
-    require File.dirname(__FILE__) + '/lib/corrupt'
+    # Now try the gem.
+    require 'corrupt'
   end
   Corrupt.boot!
 end

data/app/models/page.rb

@@ -1,4 +1,4 @@
-# This is an application model and will get loaded into the
+# This is an example application model and will get loaded into the
 # global namespace.  Corrupt uses DataMapper by default,
 # however, a model can be any Ruby class.
 class Page

data/config.ru

@@ -13,10 +13,16 @@ use Rack::Static, :urls => static_paths, :root => 'public'
 ENV['CORRUPT_ENV'] ||= 'production'
 
 begin
-  require 'corrupt'
+  # Try to load from ./vendor first.
+  require File.join(Dir.pwd, 'vendor', 'corrupt')
 rescue LoadError
-  # TODO: This might get moved to /vendor or some shit.
-  require File.join(File.dirname(__FILE__), 'lib', 'corrupt')
+  # Now try the gem.
+  begin
+    require 'corrupt'
+  rescue LoadError
+    require 'rubygems'
+    require 'corrupt'
+  end
 end
 
 Corrupt.boot!

data/lib/corrupt.rb

@@ -26,7 +26,7 @@ require 'corrupt/generators'
 require 'corrupt/framework/controller'
 
 module Corrupt
-  VERSION = '0.3.6'
+  VERSION = '0.3.7'
 
   # Setup the Corrupt environment.  This just calls Corrupt::System.boot!
   def self.boot!
@@ -40,28 +40,36 @@ module Corrupt
 
   private
 
+  # Points to the root of the current Corrupt application.
   def self.app_root
+    # FIXME: This is most certainly wrong.  Dir.pwd should probably not be used here.
     ENV['CORRUPT_APP'] || File.join(Dir.pwd, 'app')
   end
 
+  # Returns the Corrupt::Config instance.
   def self.config
     Corrupt::Config
   end
 
+  # Path to the application configuration file.
   def self.config_file
     ENV['CORRUPT_CONFIG'] || Corrupt.app_root + '/../config/app_config.yml'
   end
 
+  # The current Corrupt environment (development, production, etc.)
+  # Defaults to 'development'.
   def self.env
     ENV['CORRUPT_ENV'] || 'development'
   end
 
+  # Returns the logger instance.
   def self.log
     @log ||= Logger.new("#{Corrupt.app_root}/../log/#{Corrupt.env}.log")
     @log.level = (Corrupt.env == 'production' ? Logger::WARN : Logger::DEBUG)
     @log
   end
 
+  # Returns the root path of the Corrupt library.
   def self.root
     ENV['CORRUPT_ROOT'] || File.expand_path(File.dirname(__FILE__) + '/..')
   end

data/lib/corrupt/framework/controller.rb

@@ -16,6 +16,7 @@ module Corrupt
       end
 
       # Return the headers for the response.
+      # TODO: Save the header hash and allow setting of custom keys.
       def headers
         { 'Content-Length' => content.size.to_s,
           'Content-Type'   => 'text/html' }
@@ -32,7 +33,7 @@ module Corrupt
         [status, headers, content]
       end
 
-      # Set the template file to be rendered.
+      # Set the template file to be rendered or return the Corrupt::Template object.
       def template(file = nil)
         @template ||= Corrupt::Template.new(file)
       end

data/lib/corrupt/generators/app.rb

@@ -4,7 +4,6 @@ module Corrupt
     # Generator to create a new Corrupt application.
     class App
 
-      # A list of directories to create when making a new application.
       DIRS = [
         'app',
         'app/controllers',
@@ -28,7 +27,6 @@ module Corrupt
         'tmp',
       ]
 
-      # A list of files to copy for a new application.
       FILES = [
         'config.ru',
         'Rakefile',
@@ -68,6 +66,8 @@ module Corrupt
 
       private
 
+      # This method is responsible for running the generator methods
+      # (creating directories, copying files, etc.).
       def setup_app!
         Dir.mkdir(@path) unless File.exists?(@path)
         create_directories
@@ -76,12 +76,14 @@ module Corrupt
         $stdout.puts "Application created in: #{@path}"
       end
 
+      # Create a directory for each entry in +DIRS+.
       def create_directories
         DIRS.each do |dir|
           Dir.mkdir(File.join(@path, dir))
         end
       end
 
+      # Copy each +FILES+ entry, preserving the path.
       def copy_files
         FILES.each do |file|
           base_file = File.expand_path(File.join(Corrupt.root, file))

data/lib/corrupt/router.rb

@@ -8,15 +8,15 @@ module Corrupt
     #     route.map '/path', :controller => 'Kickass', :action => 'take_names'
     #   end
     def initialize(&block)
-      @@routes = []
+      @@routes = {}
       yield self if block_given?
     end
 
     # Maps incoming URLs to a controller and action.
     # TODO: Maybe change the routes storage to a hash like:
     #   @@routes[path]  # => options
-    def map(path, options)
-      @@routes << [path, options]
+    def map(path, options = {})
+      @@routes[path] = options
     end
 
     # Return the configured routes.
@@ -24,17 +24,16 @@ module Corrupt
       @@routes
     end
 
-    # Dispatch a request to a controller and action.
+    # Dispatch an incoming request +path+ to a controller and action.
     def self.dispatch(path)
-      route = @@routes.select { |route| route[0] == path }.flatten
-      # FIXME: This could probably be handled a little better.
-      if route.empty?
-        Exceptions.new.four_oh_four
-      else
-        response = route[1]  # 2nd element is the controller/action hash.
+      response = routes[path]
+      if response
         Corrupt::Controller.const_get(response[:controller]).new.send(response[:action])
+      else
+        Exceptions.new.four_oh_four
       end
     end
-  end
+
+  end # Router
 
 end # Corrupt

data/lib/corrupt/system.rb

@@ -21,10 +21,12 @@ module Corrupt
 
     private
 
+    # Setup the Corrupt::Config instance.
     def load_app_config
       Corrupt::Config.setup(Corrupt.config_file)
     end
 
+    # Load any application controllers.
     def load_controllers
       app_controller = "#{Corrupt.app_root}/controllers/app_controller.rb"
       controllers = Dir["#{Corrupt.app_root}/controllers/*.rb"].sort
@@ -36,6 +38,7 @@ module Corrupt
       end
     end
 
+    # Load any application models.
     def load_models
       models = Dir["#{Corrupt.app_root}/models/*.rb"].sort
       models.each do |model|
@@ -43,10 +46,13 @@ module Corrupt
       end
     end
 
+    # Load the application <tt>/config/routes.rb</tt>.
     def prepare_router
-      load File.expand_path(File.dirname(Corrupt.app_root) + '/config/routes.rb')
+      load File.expand_path(Corrupt.app_root + '/../config/routes.rb')
     end
 
+    # Setup the database connection.
+    # TODO: This should only be ran if the application uses a database.
     def setup_database
       database = File.join(Corrupt.app_root, '..', Corrupt::Config['database'])
       DataMapper.setup(:default, "sqlite3:///#{database}")

data/spec/lib/corrupt/router_spec.rb

@@ -7,6 +7,13 @@ describe Router do
 
   it 'should store the configured routes' do
     @router.map '/', :controller => 'Main',  :action => 'index'
-    Router.routes.size.should == 1
+    @router.map '/kickass', :controller => 'Kickass',  :action => 'take_names'
+    Router.routes.size.should == 2
+  end
+
+  it 'should respond to either /main or /main/' do
+    @router.map '/main', :controller => 'Main', :action => 'index'
+    get('/main')[0].should == 200
+    get('/main/')[0].should == 200
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,15 @@
 require 'rubygems'
 require 'spec'
 
+# TODO: This is kinda convoluted and stupid.  Should just stick to one path for the specs.
 begin
-  require 'corrupt'
+  require File.dirname(__FILE__) + '/../lib/corrupt'
 rescue LoadError
-  # TODO: Might move this to /vendor or some shit.
-  require File.expand_path(File.dirname(__FILE__) + '/../lib/corrupt')
+  begin
+    require File.dirname(__FILE__) + '/../vendor/corrupt/corrupt'
+  rescue LoadError
+    require 'corrupt'
+  end
 end
 
 ENV['CORRUPT_ENV'] = 'test'

data/tasks/corrupt.rake

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+namespace :corrupt do
+  task :vendor_env do
+    @destination = 'vendor/corrupt'
+    @vendor_dir = File.dirname(__FILE__) + '/../vendor'
+  end
+
+  task :clean_vendor => [ :vendor_env ] do
+    FileUtils.rm_r(@destination) if File.exists?(@destination)
+  end
+
+  desc 'Freeze the Corrupt gem into ./vendor'
+  task :freeze => [ :clean_vendor ] do
+    `gem unpack corrupt --target #{@vendor_dir}`
+    FileUtils.mv(Dir['vendor/corrupt-*'].first, @destination)
+  end
+
+  desc 'Un-freeze the Corrupt gem (remove ./vendor/corrupt/)'
+  task :unfreeze => [ :clean_vendor ]
+end

data/tasks/doc.rake

@@ -0,0 +1,48 @@
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+desc 'Generate API documentation'
+task :doc do
+  Rake::Task['doc:api'].invoke
+end
+
+namespace :doc do
+  task :setup_rdoc do
+    @file_list = FileList[ "#{File.join(APP_ROOT, 'README')}",
+                           "#{APP_ROOT}/app/**/*.rb",
+                           "#{APP_ROOT}/lib/**/*.rb" ]
+    # Substitute APP_ROOT with a dot.  Makes for a better index in the generated docs.
+    @files = @file_list.collect  {|f| f.gsub(/#{APP_ROOT}/, '.')}
+    @options = %W[
+      --all
+      --inline-source
+      --line-numbers
+      --op #{File.join(APP_ROOT, 'doc', 'api')}
+      --title 'Corrupt API Documentation'
+    ]
+    # Generate a diagram, yes/no?
+    @options << '-d' if RUBY_PLATFORM !~ /win32/ && `which dot` =~ /\/dot/ && !ENV['NODOT']
+  end
+
+  task :api => [:setup_rdoc] do
+    run_rdoc(@options, @files)
+  end
+
+  desc 'Remove generated API documentation'
+  task :clear do
+    sh "rm -rf #{File.join(APP_ROOT, 'doc', 'api')}"
+  end
+
+  desc 'Rebuild API documentation'
+  task :rebuild do
+    Rake::Task['doc:clear'].invoke
+    Rake::Task['doc:api'].invoke
+  end
+end
+
+private
+
+def run_rdoc(options, files)
+  options = options.join(' ') if options.is_a? Array
+  files   = files.join(' ')   if files.is_a? Array
+  sh "rdoc #{options} #{files}"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: corrupt
 version: !ruby/object:Gem::Version 
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 -05:00
+date: 2009-04-19 00:00:00 -05:00
 default_executable: corrupt
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,6 +86,8 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/app.rake
+- tasks/corrupt.rake
+- tasks/doc.rake
 - tasks/gem.rake
 - tasks/notes.rake
 - tasks/spec.rake