zen 0.2.8 → 0.3b

data/lib/zen/bin/create.rb

@@ -1,94 +1,305 @@
+require 'readline'
+require 'erb'
 require 'fileutils'
 
-#:nodoc:
 module Zen
   #:nodoc:
   module Bin
     ##
-    # Command that can be used to create a new application prototype.
+    # Command that can be used to create new Zen projects.
     #
-    # @author Yorick Peterse
-    # @since  0.2.8
+    # @since 0.3
     #
-    class Create
-      # The description of this command.
-      Description = 'Creates a new application prototype.'
+    class Create < Shebang::Command
+      command :create
+      banner  'Creates a new Zen project'
+      usage   'zen create [OPTIONS]'
 
-      # The banner of this application.
-      Banner = <<-TXT.strip
-Creates a new application prototype and saves it in the given path.
+      o :l, :lazy , 'Creates a new project with all default options'
+      o :f, :force, 'Overwrite existing directories when creating a project'
 
-Usage:
-  zen create [NAME] [OPTIONS]
+      # Path to the prototype application to use for new projects.
+      PROTOTYPE = __DIR__('../../../proto/app')
 
-Example:
-  zen create blog
-      TXT
+      # Hash containing various Rack servers and their default configuration
+      # files to use.
+      SERVER_CONFIGS = {
+        :unicorn => __DIR__('../../../proto/rack/unicorn.rb'),
+        :thin    => __DIR__('../../../proto/rack/thin.yml')
+      }
 
-      # Hash containing options that can be overwritten via the command line.
-      Options = {
-        :force => false
+      # Hash containing the options to use for creating a new project.
+      PROJECT_SETTINGS = {
+        :name      => 'zen_project',
+        :database  => {
+          :adapter  => 'sqlite',
+          :database => 'database.db',
+          :username => nil,
+          :password => nil
+        },
+        :server_config => nil
       }
 
       ##
-      # Creates a new instance of the class and specifies all the options.
+      # Method that is called when this command is invoked without any
+      # additional parameters.
       #
-      # @author Yorick Peterse
-      # @since  0.2.8
+      # @since 0.3
       #
-      def initialize
-        @stop    = false
-        @options = OptionParser.new do |opt|
-          opt.banner         = Banner
-          opt.summary_indent = '  '
+      def index
+        if option(:l)
+          create_project
+          return
+        end
 
-          opt.separator "\nOptions:\n"
+        intro
+        setup_name
+        database_settings
+        server_config
 
-          opt.on('-h', '--help', 'Shows this help message') do
-            puts @options
+        create_project
+      end
 
-            @stop = true
-          end
+      private
+
+      ##
+      # Displays a short introduction to the installer.
+      #
+      # @since 0.3
+      #
+      def intro
+        puts wrap_string(
+          'Welcome to the interactive project creator of Zen. ' \
+          'This installer will guide you through the process of creating ' \
+          'a new project using Zen.'
+        )
+
+        puts
+        puts wrap_string(
+          'Keep in mind that all settings specified for each project can be ' \
+            'changed to anything you like. Zen tries to make as little ' \
+            'assumptions as possible.'
+        )
+      end
+
+      ##
+      # Sets the name of the project.
+      #
+      # @since 0.3
+      #
+      def setup_name
+        heading('Project Name')
+
+        puts wrap_string(
+          'Each Zen project requires a name. This name is used for the ' \
+            'directory name as well as the session ID.'
+        )
+
+        name = readline('Name of your project', PROJECT_SETTINGS[:name])
+        name = name.downcase.gsub(/\s+/, '_')
+
+        PROJECT_SETTINGS[:name] = name unless name.empty?
+      end
+
+      ##
+      # Asks the user for various database settings.
+      #
+      # @since 0.3
+      #
+      def database_settings
+        heading('Database Settings')
+
+        puts wrap_string(
+          'Zen stores it\'s data in a SQL database such as PostgreSQL or ' \
+          'MySQL. In order to connect to such a database you must specify ' \
+          'the connection details such as the username and database name.'
+        )
+
+        PROJECT_SETTINGS[:database][:adapter] = readline(
+          'Adapter',
+          PROJECT_SETTINGS[:database][:adapter]
+        )
+
+        PROJECT_SETTINGS[:database][:database] = readline(
+          'Database',
+          PROJECT_SETTINGS[:database][:database],
+          false
+        )
+
+        PROJECT_SETTINGS[:database][:username] = readline('Username', nil, false)
+        PROJECT_SETTINGS[:database][:password] = readline('Password', nil, false)
+      end
+
+      ##
+      # Asks the user if he/she would like to use a default configuration file
+      # for Unicorn or Thin.
+      #
+      # @since 0.3
+      #
+      def server_config
+        heading('Server Configuration')
+
+        puts wrap_string(
+          'Zen comes with a few default configuration files that you can use ' \
+            'for your favorite Rack server. Zen comes with default ' \
+            'configuration files for the following Rack servers:'
+        )
+
+        puts
+
+        SERVER_CONFIGS.each do |name, path|
+          puts "* #{name}"
+        end
 
-          opt.on('-f', '--force', 'Overwrites existing directories') do
-            Options[:force] = true
+        puts
+        puts wrap_string(
+          'If you are using a different server or simply don\'t want a ' \
+            'default configuration file you can choose "none".'
+        )
+
+        server = readline('Default server configuration file', 'none').downcase
+
+        if !server.empty? and server != 'none' \
+        and !SERVER_CONFIGS.keys.include?(server.to_sym)
+          error('The specified configuration file is invalid')
+        end
+
+        PROJECT_SETTINGS[:server_config] = server.to_sym unless server == 'none'
+      end
+
+      ##
+      # Creates a new project based on the settings specified by the user.
+      #
+      # @since 0.3
+      #
+      def create_project
+        destination = File.join(Dir.pwd, PROJECT_SETTINGS[:name])
+
+        # Copy the application
+        if File.directory?(destination) and !option(:f)
+          error('There already is a directory using your project name')
+        else
+          puts 'Creating base files...'
+
+          FileUtils.rm_rf(destination)
+          FileUtils.cp_r(PROTOTYPE, destination)
+        end
+
+        # Copy the default Rack configuration file.
+        if !PROJECT_SETTINGS[:server_config].nil? \
+        and !PROJECT_SETTINGS[:server_config].empty?
+          puts 'Creating server configuration file...'
+
+          config = SERVER_CONFIGS[PROJECT_SETTINGS[:server_config]]
+
+          FileUtils.cp(
+            config,
+            File.join(destination, 'config', File.basename(config))
+          )
+        end
+
+        # Replace all the ERB tags
+        puts 'Setting variables...'
+
+        templates = Dir.glob(File.join(destination, '**', '*.erb'))
+
+        templates.each do |template|
+          processed = File.read(template, File.size(template))
+          processed = ERB.new(processed).result(binding)
+
+          File.open(template, 'w') do |handle|
+            handle.write(processed)
           end
+
+          # Remove the .erb extension
+          FileUtils.mv(
+            template,
+            File.join(File.dirname(template), File.basename(template, '.erb'))
+          )
         end
+
+        puts wrap_string(
+          "Your project has been created, you can find it in #{destination}"
+        )
       end
 
       ##
-      # Executes the command based on the specified command line arguments.
+      # Wraps a string at 80 characters and returns it.
       #
-      # @author Yorick Peterse
-      # @since  0.2.8
-      # @param  [Array] argv An array containing all the additional options that
-      # were specified in the command line.
+      # @since  0.3
+      # @param  [String] input The string to wrap.
+      # @return [String]
       #
-      def run(argv = [])
-        @options.parse!(argv)
+      def wrap_string(input)
+        input  = input.split(/\s+/)
+        output = ''
+        chars  = 0
 
-        app = argv.delete_at(0)
+        input.each do |chunk|
+          length = chunk.length
 
-        return if @stop === true
-        return puts @options if app.nil?
+          if ( chars + length ) <= ( 80 - length )
+            output += "#{chunk} "
+            chars  += length
+          else
+            output += "\n#{chunk} "
+            chars   = 0
+          end
+        end
 
-        proto = __DIR__('../../../proto/app')
+        return output.strip
+      end
 
-        if File.directory?(app) and Options[:force] === false
-          return $stderr.puts "The application #{app} already exists, use -f " \
-            + "to overwrite it."
-        else
-          FileUtils.rm_rf(app)
+      ##
+      # Displays a heading in yellow.
+      #
+      # @since 0.3
+      # @param [String] heading The heading to display.
+      #
+      def heading(heading)
+        puts "\n" + heading.yellow + "\n\n"
+      end
+
+      ##
+      # Shows a prompt using Readline.readline and returns the value entered by
+      # the user.
+      #
+      # @since  0.3
+      # @param  [String] message The message to display in the prompt.
+      # @param  [String] default The default value to use.
+      # @param  [TrueClass|FalseClass] newline When set to true an empty line
+      #  will be shown before the prompt.
+      # @return [String]
+      #
+      def readline(message, default = nil, newline = true)
+        puts if newline
+
+        prompt = "> #{message}"
+
+        if default
+          prompt += " (default: #{default})"
         end
 
-        # Copy the prototype
-        begin
-          FileUtils.cp_r(proto, app)
-          puts "The application has been generated and saved in #{app}"
-        rescue => e
-          return $stderr.puts "Failed to generate the application: #{e.message}"
+        prompt += ': '
+        value   = Readline.readline(prompt.blue).strip
+
+        if value.empty? and !default.nil?
+          value = default
         end
+
+        return value
+      end
+
+      ##
+      # Shows an error and exists the script.
+      #
+      # @since 0.3
+      # @param [String] message The error message to display.
+      #
+      def error(message)
+        puts message.red
+        exit(false)
       end
-    end # App
+    end # Create
   end # Bin
 end # Zen

data/lib/zen/bin/default.rb

@@ -0,0 +1,84 @@
+module Zen
+  #:nodoc:
+  module Bin
+    ##
+    # The default command that is executed.
+    #
+    # @since 0.3
+    #
+    class Default < Shebang::Command
+      command :default
+      banner  'Zen is a modular CMS written using Ramaze.'
+      usage   'zen [COMMAND] [OPTIONS]'
+
+      o :h, :help   , 'Shows this help message'  , :method => :help
+      o :v, :version, 'Shows the current version', :method => :version
+
+      ##
+      # Creates a new instance of the command and creates a list of all the
+      # installed commands.
+      #
+      # @since 0.3
+      #
+      def initialize
+        list_commands
+
+        super
+      end
+
+      ##
+      # Method that is invoked when this command is called.
+      #
+      # @since 0.3
+      #
+      def index
+        help
+      end
+
+      protected
+
+      ##
+      # Shows the current version of Zen.
+      #
+      # @since 0.3
+      #
+      def version
+        puts Zen::VERSION
+        exit
+      end
+
+      ##
+      # Generates an array of "rows" where each row contains the name and
+      # description of a command. The descriptions of all commands are aligned
+      # based on the length of the longest command name.
+      #
+      # This method has been ported from Ramaze.
+      #
+      # @since  0.3
+      # @return [Array]
+      #
+      def list_commands
+        cmds = Shebang::Commands.dup
+        cmds.delete(:default)
+
+        return if cmds.empty?
+
+        cmd_string = ''
+        longest    = cmds.map { |name, klass| name.to_s }.sort[0].size
+
+        cmds.each do |name, klass|
+          name = name.to_s
+          desc = klass.instance_variable_get(:@__banner).to_s
+
+          while name.length <= longest
+            name += ' '
+          end
+
+          cmd_string += "  #{name}    #{desc}\n"
+        end
+
+        self.class.help('Commands', cmd_string)
+      end
+    end # Default
+  end # Bin
+end # Zen

data/lib/zen/controller/admin_controller.rb

@@ -16,93 +16,12 @@ module Zen
     # method for the Users controller, mapped to /admin/users/login. If a user
     # isn't logged in he/she will be redirected to the login page.
     #
-    # @author Yorick Peterse
     # @since  0.1
     #
     class AdminController < Zen::Controller::BaseController
       layout :admin
       engine :etanni
-      helper :blue_form_vendor, :breadcrumb, :user, :acl, :message, :paginate
-
-      # Configure the pagination
-      trait :paginate => {
-        :limit => 20,
-        :var   => 'page'
-      }
-
-      ##
-      # The initialize method is called upon class initalization and is used to
-      # process several items before loading the controller(s) for the current
-      # extension.
-      #
-      # @author Yorick Peterse
-      # @since  1.0
-      #
-      def initialize
-        super
-
-        # Only allow users to access admin/users/login when they aren't logged
-        # in
-        if request.env['SCRIPT_NAME'] != 'admin/users/' \
-        and request.env['PATH_INFO']  != '/login' \
-        and !logged_in?
-          message(:error, lang('zen_general.errors.require_login'))
-          redirect('/admin/users/login')
-        end
-      end
-
-      ##
-      # Shortcut for Zen::Asset.stylesheet.
-      #
-      # @author Yorick Peterse
-      # @see    Zen::Asset.stylesheet
-      # @since  0.2.5
-      #
-      def self.stylesheet(files, options = {})
-        options = {:controller => self}.merge(options)
-
-        ::Zen::Asset.stylesheet(files, options)
-      end
-
-      ##
-      # Shortcut for Zen::Asset.javascript.
-      #
-      # @author Yorick Peterse
-      # @see    Zen::Asset.javascript
-      # @since  0.2.5
-      #
-      def self.javascript(files, options = {})
-        options = {:controller => self}.merge(options)
-
-        ::Zen::Asset.javascript(files, options)
-      end
-
-      # Load all default stylesheets
-      stylesheet(
-        [
-          'zen/reset',
-          'zen/grid',
-          'zen/layout',
-          'zen/general',
-          'zen/forms',
-          'zen/tables',
-          'zen/buttons',
-          'zen/messages'
-        ],
-        :global => true
-      )
-
-      # Load all default javascript files
-      javascript(
-        [
-          'vendor/mootools/core',
-          'vendor/mootools/more',
-          'zen/lib/asset',
-          'zen/lib/html_table',
-          'zen/index'
-        ],
-        :global => true
-      )
+      helper :breadcrumb, :asset, :search
     end # AdminController
   end # Controller
 end # Zen