Sutto-perennial 0.1.0 → 0.2.0

data/bin/perennial

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "lib", "perennial")
+
+Perennial::Application.processing(ARGV) do |a|
+  
+  a.banner = "Perennial v#{Perennial::VERSION} CLI"
+  
+  a.generator!
+  
+  a.option(:force, "force the creation of the application")
+  a.add("create PATH [APP-NAME]", "Creates a Perennial-based library with a given PATH and, if provided, APP-NAME.") do |path, *args|
+    # Get the app name, path etc.
+    opts     = args.extract_options!
+    app_name = args.empty? ? File.basename(path) : args.shift
+    path     = File.expand_path(path)
+    # Check if the folder exists
+    if File.exist?(path) && !opts[:force]
+      puts "The path you tried to use, #{path}, already exists. Please try another or pass --force"
+      exit
+    end
+    # Convert the name and class name.
+    app_path   = app_name.underscore
+    app_module = app_name.camelize
+    # Actually do the generation.
+    env = {:application_module => app_module, :application_path => app_path}
+    setup_generator path
+    folders  'tmp', 'config', 'lib', 'handlers', 'test'
+    template 'application.erb', "lib/#{app_path}.rb",       env
+    template 'boot.erb',        'config/boot.rb',           env
+    template 'setup.erb',       'config/setup.rb',          env
+    template 'rakefile.erb',    'Rakefile',                 env
+    template 'test_helper.erb', 'test/test_helper.rb',      env
+    template 'test.erb',        "test/#{app_path}_test.rb", env
+  end
+  
+end

data/lib/perennial/application.rb

@@ -0,0 +1,149 @@
+module Perennial
+  class Application
+    
+    class CommandEnv
+      include Loggable
+      
+      # Executes a given block with given
+      # arguments in a specified environment.
+      # Used to provide the logger functionality
+      # as well as the ability to do things
+      # such as easily write generators.
+      def self.execute(blk, arguments)
+        klass = Class.new(self)
+        klass.class_eval { define_method(:apply, &blk) }
+        klass.new.apply(*arguments)
+      end
+      
+    end
+    
+    attr_accessor :options, :banner, :command_env
+    
+    def initialize(opts = {})
+      @options         = opts
+      @commands        = {}
+      @descriptions    = {}
+      @option_parsers  = {}
+      @option_parser   = nil
+      @command_options = {}
+      @command_env     = (opts[:command_env] || CommandEnv)
+      @banners         = {}
+    end
+    
+    def option(name, description = nil)
+      option_parser.add(name, description) { |v| @command_options[name] = v }
+    end
+    
+    def add_default_options!
+      option_parser.add_defaults!
+    end
+    
+    def generator!
+      self.command_env = Perennial::Generator::CommandEnv
+    end
+    
+    def add(raw_command, description = nil, &blk)
+      raise ArgumentError, "You must provide a block with an #{self.class.name}#add" if blk.nil?
+      raise ArgumentError, "Your block must accept atleast one argument (a hash of options)" if blk.arity == 0
+      command, _ = raw_command.split(" ", 2)
+      @banners[command] = raw_command
+      @commands[command]     = blk
+      @descriptions[command] = description if description.present?
+      # Add the default help message for a command
+      option_parser.add(:help, "Show this message") { help_for(command) }
+      @option_parsers[command] = option_parser
+      @option_parser = nil
+    end
+    
+    def execute(arguments)
+      return usage if arguments.empty?
+      arguments = arguments.dup
+      command = arguments.shift
+      if @commands.has_key?(command)
+        execute_command(command, arguments)
+      else
+        puts "Unknown command '#{command}', please try again."
+        return usage
+      end
+    end
+    
+    def usage
+      if banner.present?
+        puts banner
+        puts ""
+      end
+      puts "Usage:"
+      max_width = @banners.values.map { |b| b.length }.max
+      @commands.keys.sort.each do |command|
+        next unless @descriptions.has_key?(command)
+        formatted_command = "#{@banners[command]} [OPTIONS]".ljust(max_width + 10)
+        command = "%s - %s" % [formatted_command, @descriptions[command]]
+        puts command
+      end
+    end
+    
+    def help_for(command)
+     if banner.present?
+        puts banner
+        puts ""
+      end
+      puts @descriptions[command]
+      puts "Usage: #{$0} #{@banners[command]} [options]"
+      puts "Options:"
+      puts @option_parsers[command].summary
+      exit
+    end
+    
+    def self.processing(args, &blk)
+      application = self.new
+      if blk.arity == 1
+        blk.call(application)
+      else
+        application.instance_eval(&blk)
+      end
+      application.execute args
+    end
+    
+    protected
+    
+    def execute_command(command, arguments)
+      command_proc = @commands[command]
+      args, opts = extract_arguments(command, arguments)
+      if valid_arity?(command_proc, args)
+        args << opts
+        @command_env.execute(command_proc, args)
+      else
+        usage
+      end
+    end
+    
+    def extract_arguments(command, arguments)
+      option_parser = @option_parsers[command]
+      if option_parser.present?
+        option_parser.parse(arguments)
+        return option_parser.arguments, @command_options
+      else
+        return arguments, {}
+      end
+    end
+    
+    def option_parser(reset = false)
+      @option_parser = nil if reset
+      @option_parser ||= OptionParser.new
+    end
+    
+    def valid_arity?(blk, arguments)
+      needed_count   = blk.arity - 1
+      provided_count = arguments.size
+      if needed_count > 0 && needed_count != provided_count
+        puts "You didn't provide the correct number of arguments (needed #{needed_count}, provided #{provided_count})"
+      elsif needed_count < 0 && (-needed_count - 2) > provided_count
+        puts "You didn't provide enough arguments - a minimum of #{-needed_count} are needed."
+      else
+        return true
+      end
+      
+    end
+    
+  end
+end

data/lib/perennial/generator.rb

@@ -0,0 +1,89 @@
+require 'open-uri'
+require 'fileutils'
+require 'erb'
+
+module Perennial
+  class Generator
+    
+    class CommandEnv < Perennial::Application::CommandEnv
+      
+      def initialize
+        @generator = nil
+      end
+      
+      protected
+      
+      def setup_generator(*args)
+        @generator = Generator.new(*args)
+      end
+      
+      def method_missing(name, *args, &blk)
+        if @generator && @generator.respond_to?(name)
+          @generator.send(name, *args, &blk)
+        else
+          super
+        end
+      end
+      
+    end
+    
+    attr_accessor :template_path, :destination_path
+    
+    def initialize(destination, opts = {})
+      @destination_path = destination
+      @template_path    = opts[:template_path] || File.join(Settings.library_root, "templates")
+      puts "Starting generator for #{destination}"
+    end
+    
+    def download(from, to)
+      describe "Downloading #{from}"
+      file to, open(from).read
+    end
+    
+    def folders(*args)
+      args.each do |f|
+        describe "Creating folder #{f}"
+        FileUtils.mkdir_p(expand_destination_path(f))
+      end
+    end
+    
+    def file(name, contents)
+      dest_folder = File.dirname(name)
+      folders(dest_folder) unless File.directory?(expand_destination_path(dest_folder))
+      describe "Creating file #{name}"
+      File.open(expand_destination_path(name), "w+") do |f|
+        f.write(contents)
+      end
+    end
+    
+    def template(source, destination, environment = {})
+      describe "Processing template #{source}"
+      raw_template = File.read(expand_template_path(source))
+      processed_template = ERB.new(raw_template).result(binding_for(environment))
+      file destination, processed_template
+    end
+    
+    protected
+    
+    def binding_for(hash = {})
+      object = Object.new
+      hash.each_pair do |k, v|
+        object.instance_variable_set("@#{k}", v)
+      end
+      return object.send(:binding)
+    end
+    
+    def expand_template_path(p)
+      File.expand_path(p, @template_path)
+    end
+    
+    def expand_destination_path(p)
+      File.expand_path(p, @destination_path)
+    end
+    
+    def describe(action)
+      puts "- #{action}"
+    end
+    
+  end
+end

data/lib/perennial/loader.rb

@@ -32,7 +32,7 @@ module Perennial
     
     def run!
       self.register_signals
-      OptionParser.setup
+      OptionParser.parse_argv
       self.class.invoke_hooks! :before_setup
       Daemon.daemonize! if Settings.daemon?
       Logger.log_name = "#{@@current_type.to_s}.log"

data/lib/perennial/manifest.rb

@@ -18,6 +18,7 @@ module Perennial
         Manifest.namespace = self
         Manifest.app_name  = self.name.to_s.underscore
         parent_folder = __DIR__(1)
+        Settings.library_root = parent_folder
         attempt_require parent_folder / 'core_ext', parent_folder / 'exceptions'
         unless blk.nil?
           args = []

data/lib/perennial/option_parser.rb

@@ -1,7 +1,5 @@
-require 'singleton'
 module Perennial
   class OptionParser
-    include Singleton
     
     attr_reader :arguments
     
@@ -32,7 +30,7 @@ module Perennial
         max_length = [text.size, max_length].max
         output << [text, @descriptions[name]]
       end
-      output.map { |text, description| "#{text}: ".ljust(max_length + 2) + description }.join("\n")
+      output.map { |text, description| "#{text.ljust(max_length)} - #{description}" }.join("\n")
     end
     
     def parse(arguments = ARGV)
@@ -48,7 +46,7 @@ module Perennial
     end
     
     def self.method_missing(name, *args, &blk)
-      self.instance.send(name, *args, &blk)
+      self.default.send(name, *args, &blk)
     end
     
     # Over ride with your apps custom banner
@@ -78,17 +76,20 @@ module Perennial
       @defaults_added = true
     end
     
-    def setup
-      return if defined?(@setup) && @setup
-      setup!
-      @setup = true
+    def self.default
+      return @default if defined?(@default) && @default.present?
+      @default = setup_default!
     end
     
-    def self.setup!
-      opts = self.instance
+    def parse_argv(with = default)
+      with.parse
+      ARGV.replace with.arguments
+    end
+    
+    def self.setup_default!
+      opts = self.new
       opts.add_defaults!
-      opts.parse
-      ARGV.replace opts.arguments
+      return opts
     end
     
     protected

data/lib/perennial/settings.rb

@@ -27,6 +27,14 @@ module Perennial
         @@root ||= File.expand_path(File.dirname(__FILE__) / ".." / "..")
       end
       
+      def library_root=(path)
+        @@library_root = path.to_str
+      end
+      
+      def library_root
+        @@library_root ||= File.expand_path(File.dirname(__FILE__) / ".." / "..")
+      end
+      
       def setup?
         @@setup ||= false
       end

data/lib/perennial.rb

@@ -8,11 +8,11 @@ require 'perennial/exceptions'
 
 module Perennial
   
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
   
   has_libary :dispatchable, :hookable, :loader, :logger,
              :loggable, :manifest, :settings, :argument_parser,
-             :option_parser
+             :option_parser, :application, :generator
   
   def self.included(parent)
     parent.extend(Manifest::Mixin)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Sutto-perennial
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-01 00:00:00 -07:00
+date: 2009-08-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- bin/perennial
 - vendor/fakefs
 - vendor/fakefs/lib
 - vendor/fakefs/lib/fakefs.rb
@@ -32,6 +33,7 @@ files:
 - vendor/fakefs/test/fakefs_test.rb
 - vendor/fakefs/test/verify.rb
 - lib/perennial
+- lib/perennial/application.rb
 - lib/perennial/argument_parser.rb
 - lib/perennial/core_ext
 - lib/perennial/core_ext/attribute_accessors.rb
@@ -41,6 +43,7 @@ files:
 - lib/perennial/daemon.rb
 - lib/perennial/dispatchable.rb
 - lib/perennial/exceptions.rb
+- lib/perennial/generator.rb
 - lib/perennial/hookable.rb
 - lib/perennial/loader.rb
 - lib/perennial/loggable.rb