autumn 3.1.8

data/lib/autumn/tool/create.rb

@@ -0,0 +1,48 @@
+#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+
+require 'autumn/tool/project_creator'
+
+module Autumn
+  module Tool
+
+    # Create is a simple class used to create new projects based on the proto
+    # directory.
+    #
+    # It is primarly used for this command:
+    #
+    #   ramaze --create project
+    #
+    # where project is the directory you want the content put into.
+
+    class Create
+
+      # Default options passed to Create::create
+      #   :proto  is the directory to duplicate
+      #   :amend  no files may be overwritten but missing files will be added
+      #   :force  will overwrite existing files
+      #   :layout copy one subdirectory in +proto+
+
+      DEFAULT = {
+        :proto => File.join(ROOT, 'skel'),
+        :amend => false,
+        :force => false,
+        :layout => '/',
+      }
+
+      # Using ProjectCreator to copy all files and directories from lib/proto
+      # to another location.
+      # +options+ are described in the DEFAULT constant and should be:
+      #   :force  => (true|false|nil)
+      #   :amend  => (true|false|nil)
+      #   :layout => (String|nil)
+      #   :proto  => String
+
+      def self.create(project, options = {})
+        options = DEFAULT.merge(options)
+        creator = ProjectCreator.new(project, options)
+        creator.create
+      end
+    end
+  end
+end

data/lib/autumn/tool/project_creator.rb

@@ -0,0 +1,110 @@
+#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
+# All files in this distribution are subject to the terms of the Ruby license.
+
+require 'fileutils'
+require 'find'
+
+class ProjectCreator
+  PROTO = []
+  PROTO << '~/.autumn_skel/' if ENV["HOME"] # Guard against Windows
+  attr_accessor :name, :options
+
+  def initialize(name, options = {})
+    @name, @options = name, options
+  end
+
+  def target
+    File.expand_path(name)
+  end
+
+  def proto
+    PROTO.map!{|pr| File.expand_path(pr) }
+    proto = options[:proto] ||= PROTO.find{|f| File.directory?(f) }
+    layout = options[:layout] ||= '/'
+    File.expand_path(File.join(proto, layout))
+  end
+
+  def create_root?
+    return true unless File.directory?(target)
+    return true if amend? or force?
+    fatal "%p is a directory, choose different project name or use --amend/--force" % target
+  end
+
+  def got_proto?
+    return true if File.directory?(proto)
+    fatal "Cannot create, %p doesn't exist, use --proto or create the proto directory" % proto
+  end
+
+  def create
+    got_proto?
+
+    puts "Found proto at: %p, proceeding...\n\n" % proto
+    mkdir(relate('/')) if create_root?
+    proceed
+  end
+
+  def proceed
+    files, directories = partition{|path| File.file?(path) }
+    proceed_directories(directories)
+    proceed_files(files)
+  end
+
+  def proceed_files(files)
+    files.each{|file| copy(file, relate(file)) }
+  end
+
+  def proceed_directories(dirs)
+    dirs.each{|dir| mkdir(relate(dir)) }
+  end
+
+  def mkdir(dir)
+    exists = File.directory?(dir)
+    return if exists and amend?
+    return if exists and not force?
+    puts "mkdir(%p)" % dir
+    FileUtils.mkdir_p(dir)
+  end
+
+  def copy(from, to)
+    return unless copy_check(to)
+    puts "copy(%p, %p)" % [from, to]
+    FileUtils.cp(from, to)
+    post_process(to)
+  end
+
+  def copy_check(to)
+    exists = File.file?(to)
+    return if exists and amend?
+    return if exists and not force?
+    return true
+  end
+
+  # Think about a useful way to process the generated files it should be
+  # possible to substitute some things like the project name in the
+  # configuration
+
+  def post_process(file)
+    source = File.read(file)
+    File.open(file, 'w+') do |io|
+      io.puts source.gsub('$${project}', @name)
+    end
+  end
+
+  def relate(path)
+    File.join(target, path.to_s.sub(proto, ''))
+  end
+
+  def amend?; options[:amend] end
+  def force?; options[:force] end
+
+  def fatal(message)
+    warn message
+    exit 1
+  end
+
+  def each
+    Dir["#{proto}/**/*"].each{|path| yield(path) }
+  end
+
+  include Enumerable
+end

data/lib/autumn/version.rb

@@ -0,0 +1,3 @@
+module Autumn
+  VERSION = "3.1.8"
+end

data/lib/skel/Rakefile

@@ -0,0 +1,163 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+
+def include_autumn
+  begin
+    require "autumn"
+    require "autumn/genesis"
+  rescue LoadError
+    require "rubygems"
+    require "autumn"
+    require "autumn/genesis"
+  end
+end
+
+task :default do
+  puts 'Type "rake --tasks" to see a list of tasks you can perform.'
+end
+
+# Load the Autumn environment.
+task :environment do
+  include_autumn
+  AL_ROOT = File.dirname(__FILE__)
+  @genesis = Autumn::Genesis.new
+  @genesis.load_global_settings
+  @genesis.load_season_settings
+end
+
+task :boot do
+  include_autumn
+  AL_ROOT = File.dirname(__FILE__)
+  @genesis = Autumn::Genesis.new
+  @genesis.boot! false
+end
+
+namespace :app do
+  desc "Launch the Autumn daemon"
+  task :start do
+    system 'autumn start -D'
+  end
+  
+  desc "Stop the Autumn daemon"
+  task :stop do
+    system 'autumn stop'
+  end
+  
+  desc "Restart the Autumn daemon"
+  task :restart do
+    system 'autumn restart -D'
+  end
+  
+  desc "Start Autumn but not as a daemon (stay on top)"
+  task :run do
+    system 'autumn start'
+  end
+  
+  desc "Force the daemon to a stopped state (clears PID files)"
+  task :zap do
+    system 'autumn stop'
+  end
+end
+
+namespace :log do
+  desc "Remove all log files"
+  task :clear do
+    system 'rm -vf tmp/*.log tmp/*.output log/*.log*'
+  end
+  
+  desc "Print all error messages in the log files"
+  task :errors => :environment do
+    season_log = "log/#{@genesis.config.global :season}.log"
+    system_log = 'tmp/autumn.log'
+    if File.exists? season_log then
+      puts "==== ERROR-LEVEL LOG MESSAGES ===="
+      File.open(season_log, 'r') do |log|
+        puts log.grep(/^[EF],/)
+      end
+    end
+    if File.exists? system_log then
+      puts "====   UNCAUGHT EXCEPTIONS    ===="
+      File.open(system_log, 'r') do |log|
+        puts log.grep(/^[EF],/)
+      end
+    end
+  end
+end
+
+def local_db?(db)
+  db.host.nil? or db.host == 'localhost'
+end
+
+namespace :db do
+  desc "Recreate database tables according to the model objects"
+  task :migrate => :boot do
+    dname = ENV['DB']
+    raise "Usage: DB=[Database config name] rake db:migrate" unless dname
+    raise "Unknown database config #{dname}" unless database = repository(dname.to_sym)
+    puts "Migrating the #{dname} database..."
+    # Find models that have definitions for the selected database and migrate them
+    repository(dname.to_sym) do
+      repository(dname.to_sym).models.each { |mod| mod.auto_migrate! dname.to_sym }
+    end
+  end
+  desc "Nondestructively update database tables according to the model objects"
+  task :upgrade => :boot do
+    dname = ENV['DB']
+    raise "Usage: DB=[Database config name] rake db:upgrade" unless dname
+    raise "Unknown database config #{dname}" unless database = repository(dname.to_sym)
+    puts "Upgrading the #{dname} database..."
+    # Find models that have definitions for the selected database and upgrade them
+    repository(dname.to_sym) do
+      repository(dname.to_sym).models.each { |mod| mod.auto_upgrade! dname.to_sym }
+    end
+  end
+end
+
+namespace :doc do
+  desc "Generate documentation for all leaves"
+  task :leaves => :environment do
+    FileUtils.remove_dir 'doc/leaves' if File.directory? 'doc/leaves'
+    Dir.glob("leaves/*").each do |leaf_dir|
+      Dir.chdir leaf_dir do
+        system "rdoc --main README --title '#{File.basename(leaf_dir).camelcase} Documentation' -o ../../doc/leaves/#{File.basename leaf_dir} --line-numbers --inline-source controller.rb helpers models README"
+      end
+    end
+  end
+  
+  desc "Remove all documentation"
+  task :clear => :environment do
+    FileUtils.remove_dir 'doc/api' if File.directory? 'doc/api'
+    FileUtils.remove_dir 'doc/leaves' if File.directory? 'doc/leaves'
+  end
+end
+
+desc "Verify leaf and API specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*.rb', 'leaves/*/spec/**/*.rb']
+  t.spec_opts = [ '-cfs' ]
+end
+
+namespace :spec do
+  desc "Verify API specs"
+  Spec::Rake::SpecTask.new('autumn') do |t|
+    t.spec_files = FileList['spec/**/*.rb']
+    t.spec_opts = [ '-cfs' ]
+  end
+  
+  desc "Verify leaf specs"
+  Spec::Rake::SpecTask.new('leaves') do |t|
+    t.spec_files = FileList['leaves/*/spec/**/*.rb']
+    t.spec_opts = [ '-cfs' ]
+  end
+end
+
+# Load any custom Rake tasks in the bot's tasks directory.
+Dir["leaves/*"].each do |leaf|
+  leaf_name = File.basename(leaf, ".rb").downcase
+  namespace leaf_name.to_sym do # Tasks are placed in a namespace named after the leaf
+    FileList["leaves/#{leaf_name}/tasks/**/*.rake"].sort.each do |task|
+      load task
+    end
+  end
+end

data/lib/skel/config/global.yml

@@ -0,0 +1,2 @@
+---
+season: testing

data/lib/skel/config/seasons/testing/database.yml

@@ -0,0 +1,4 @@
+--- 
+Example: 
+  adapter: sqlite3
+  database: $project.db

data/lib/skel/config/seasons/testing/leaves.yml

@@ -0,0 +1,9 @@
+--- 
+Administrator: 
+  authentication: 
+    type: op
+  class: Administrator
+Scorekeeper: 
+  class: Scorekeeper
+Insulter: 
+  class: Insulter

data/lib/skel/config/seasons/testing/season.yml

@@ -0,0 +1,2 @@
+--- 
+logging: debug

data/lib/skel/config/seasons/testing/stems.yml

@@ -0,0 +1,10 @@
+--- 
+Example: 
+  nick: $${project}
+  leaves: 
+  - Administrator
+  - Scorekeeper
+  - Insulter
+  rejoin: true
+  channel: "#autumn"
+  server: irc.freenode.net

data/lib/skel/leaves/administrator/README

@@ -0,0 +1,20 @@
+= Administrator: An Autumn Leaf
+
+<b>Version 1.0 (Jul 8, 2008)</b>
+
+Author::    Tim Morgan (mailto:riscfuture@gmail.com)
+Copyright:: Copyright (c)2008 Tim Morgan
+License::   Distributed under the same terms as Ruby.
+
+This leaf allows the owner of the IRC bot to perform administrative commands on
+the bot, such as quitting or reloading it. In order to protect such commands
+from abuse, this bot uses the Authenticator module. The Authenticator method
+that is used is specified by the +authentication+ option. For more information,
+see the *Authentication* section of the README.
+
+== Usage
+
+!autumn:: Displays information about the version of Autumn that is running this
+          leaf (unprotected command).
+!quit:: Terminates the stem on which the message was received.
+!reload:: Reloads all source files of all leaves, and all their view files.

data/lib/skel/leaves/administrator/controller.rb

@@ -0,0 +1,67 @@
+# Controller for the Administrator leaf.
+
+class Controller < Autumn::Leaf
+  
+  # Typing this command reloads all source code for all leaves and support
+  # files, allowing you to make "on-the-fly" changes without restarting the
+  # process. It does this by reloading the source files defining the classes.
+  #
+  # If you supply the configuration name of a leaf, only that leaf is reloaded.
+  #
+  # This command does not reload the YAML configuration files, only the source
+  # code.
+  
+  def reload_command(stem, sender, reply_to, msg)
+    var :leaves => Hash.new
+    if msg then
+      if Foliater.instance.leaves.include?(msg) then
+        begin
+          Foliater.instance.hot_reload Foliater.instance.leaves[msg]
+        rescue
+          logger.error "Error when reloading #{msg}:"
+          logger.error $!
+          var(:leaves)[msg] = $!.to_s
+        else
+          var(:leaves)[msg] = false
+        end
+        logger.info "#{msg}: Reloaded"
+      else
+        var :not_found => msg
+      end
+    else
+      Foliater.instance.leaves.each do |name, leaf|
+        begin
+          Foliater.instance.hot_reload leaf
+        rescue
+          logger.error "Error when reloading #{name}:"
+          logger.error $!
+          var(:leaves)[name] = $!.to_s
+        else
+          var(:leaves)[name] = false
+        end
+        logger.info "#{name}: Reloaded"
+      end
+    end
+  end
+  ann :reload_command, :protected => true
+  
+  # Typing this command will cause the Stem to exit.
+  
+  def quit_command(stem, sender, reply_to, msg)
+    stem.quit
+  end
+  ann :quit_command, :protected => true
+  
+  # Typing this command will display information about the version of Autumn
+  # that is running this leaf.
+  
+  def autumn_command(stem, sender, reply_to, msg)
+    var :version => AUTUMN_VERSION
+  end
+  
+  # Suppress the !commands command; don't want to publicize the administrative
+  # features.
+  
+  def commands_command(stem, sender, reply_to, msg)
+  end
+end