drupal.rb 0.0.12

data/lib/drupal/templates/5.x/comments/file

@@ -0,0 +1,9 @@
+// $Id$
+
+/**
+ * @file
+ * [module_description]
+ * @author [author] <[email]>
+ * @link [link]
+ * @package [module]
+ */

data/lib/drupal/templates/5.x/comments/large

@@ -0,0 +1,6 @@
+
+/* -----------------------------------------------------------------
+
+  [title]
+
+------------------------------------------------------------------ */

data/lib/drupal/templates/5.x/hooks/block

@@ -0,0 +1,44 @@
+
+/**
+ * Implementation of hook_block().
+ */
+function [module]_block($op = 'list', $delta = 0, $edit = array()) {
+  switch($op) {
+    case 'list':
+      $blocks = array();
+      $blocks[0] = array(
+        'info' => t('Block desc in listing'),
+      );
+      return $blocks;
+
+    case 'configure':
+      $form = array();
+      switch($delta){
+        default:
+          $form['item'] = array(
+            '#type' => 'textfield',
+            '#title' => t('Form Item'),
+            '#default_value' => variable_get('item_var', 0),
+          );
+      }
+      return $form;
+
+    case 'save':
+      switch($delta){
+        default:
+          variable_set('item_var', $edit['item_var']);
+      }
+      break;
+
+    case 'view':
+      $block = array();
+      switch($delta) {
+        case 0:
+          $block = array(
+            'subject' => t('Block title'),
+            'content' => 'content here',
+          );
+      }
+      return $block;
+  }
+}

data/lib/drupal/templates/5.x/hooks/cron

@@ -0,0 +1,7 @@
+
+/**
+ * Implementation of hook_cron().
+ */
+function [module]_cron() {
+
+}

data/lib/drupal/templates/5.x/hooks/form_alter

@@ -0,0 +1,14 @@
+
+/**
+ * Implementation of hook_form_alter().
+ */
+function [module]_form_alter($form_id, &$form) {
+  //Add a checkbox to the node-type-form.
+  if ($form_id == 'node_type_form' && isset($form['identity']['type'])) {
+    $form['workflow']['[module]'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Enable [module]'),
+      '#default_value' => variable_get('[module]_type_'. $form['#node_type']->type, 0),
+    );
+  }
+}

data/lib/drupal/templates/5.x/hooks/init

@@ -0,0 +1,7 @@
+
+/**
+ * Implementation of hook_init().
+ */
+function [module]_init() {
+
+}

data/lib/drupal/templates/5.x/hooks/install

@@ -0,0 +1,15 @@
+
+/**
+ * Implementation of hook_install().
+ */
+function [module]_install() {
+  switch ($GLOBALS['db_type']) {
+    case 'mysql':
+    case 'mysqli':
+      db_query();
+      break;
+    default:
+      drupal_set_message(t('Database type %dbtype is currently not supported. Please create database table manually.', array('%dbtype' => $GLOBALS['db_type'])), 'error');
+      break;
+  }
+}

data/lib/drupal/templates/5.x/hooks/menu

@@ -0,0 +1,24 @@
+
+/**
+ * Implementation of hook_menu().
+ */
+function [module]_menu($may_cache) {
+  $items = array();
+
+  if ($may_cache) {
+    $items[] = array(
+      'path' => 'admin/settings/[module]',
+      'title' => t('[module]'),
+      'callback' => '[module]_settings_page',
+      'access' => user_access('access administration pages'),
+    );
+    $items[] = array(
+      'path' => '',
+      'title' => t(''),
+      'callback' => '',
+      'access' => user_access(''),
+      'type' => MENU_SUGGESTED_ITEM,
+    );
+  }
+  return $items;
+}

data/lib/drupal/templates/5.x/hooks/perm

@@ -0,0 +1,7 @@
+
+/**
+ * Implementation of hook_perm().
+ */
+function [module]_perm() {
+  return array('');
+}

data/lib/drupal/templates/5.x/txt/changelog

@@ -0,0 +1,9 @@
+
+        $Id$
+
+
+        -------------------------------------------------------------------------------
+        [module] 6.4-1.0, YYYY-MM-DD
+        -------------------------------------------------------------------------------
+
+        - Initial release

data/lib/drupal/templates/5.x/txt/readme

@@ -0,0 +1,36 @@
+
+        $Id$
+
+
+        [module]
+        Provided by [link]
+        Developed by [author]
+
+        -------------------------------------------------------------------------------
+        INSTALLATION
+        -------------------------------------------------------------------------------
+
+        todo
+
+        -------------------------------------------------------------------------------
+        PERMISSIONS
+        -------------------------------------------------------------------------------
+
+        permission
+          - description
+
+
+        -------------------------------------------------------------------------------
+        PUBLIC API
+        -------------------------------------------------------------------------------
+
+        todo
+
+        -------------------------------------------------------------------------------
+        CONVENTIONS
+        -------------------------------------------------------------------------------
+
+        todo
+
+
+

data/lib/drupal/templates/6.x/base/info

@@ -0,0 +1,6 @@
+; $Id$'
+
+name = [module_name]
+description = [module_description]
+core = [version]
+[dependencies_chunk]

data/lib/drupal/templates/6.x/comments/file

@@ -0,0 +1,9 @@
+// $Id$
+
+/**
+ * @file
+ * [module_description]
+ * @author [author] <[email]>
+ * @link [link]
+ * @package [module]
+ */

data/lib/drupal/templates/6.x/comments/large

@@ -0,0 +1,6 @@
+
+/* -----------------------------------------------------------------
+
+  [title]
+
+------------------------------------------------------------------ */

data/lib/drupal/templates/6.x/hooks/block

@@ -0,0 +1,45 @@
+
+/**
+ * Implementation of hook_block().
+ */
+function [module]_block($op = 'list', $delta = 0, $edit = array()) {
+  switch($op) {
+    case 'list':
+      $blocks = array();
+      $blocks[0] = array(
+        'info' => t('Block desc in listing'),
+        'cache' => BLOCK_CACHE_PER_ROLE | BLOCK_CACHE_PER_PAGE,
+      );
+      return $blocks;
+
+    case 'configure':
+      $form = array();
+      switch($delta){
+        default:
+          $form['item'] = array(
+            '#type' => 'textfield',
+            '#title' => t('Form Item'),
+            '#default_value' => variable_get('item_var', 0),
+          );
+      }
+      return $form;
+
+    case 'save':
+      switch($delta){
+        default:
+          variable_set('item_var', $edit['item_var']);
+      }
+      break;
+
+    case 'view':
+      $block = array();
+      switch($delta) {
+        case 0:
+          $block = array(
+            'subject' => t('Block title'),
+            'content' => 'content here',
+          );
+      }
+      return $block;
+  }
+}

data/lib/drupal/templates/6.x/hooks/boot

@@ -0,0 +1,7 @@
+
+/**
+ * Implementation of hook_boot().
+ */
+function [module]_boot() {
+
+}

data/lib/drupal/templates/6.x/hooks/cron

@@ -0,0 +1,7 @@
+
+/**
+ * Implementation of hook_cron().
+ */
+function [module]_cron() {
+
+}

data/lib/drupal/templates/6.x/hooks/form_alter

@@ -0,0 +1,11 @@
+
+/**
+ * Implementation of hook_form_alter().
+ */
+function [module]_form_alter(&$form, $form_state, $form_id) {
+  switch($form_id) {
+    case '':
+      // @todo: do something
+      break;
+  }
+}

data/lib/drupal/templates/6.x/hooks/init

@@ -0,0 +1,8 @@
+
+/**
+ * Implementation of hook_init().
+ */
+function [module]_init() {
+  $base = drupal_get_path('module', '[module]');
+  require_once($base .'/[module]_db.inc'); //@TODO: remove if you have no database-handling.
+}

data/lib/drupal/templates/6.x/hooks/menu

@@ -0,0 +1,17 @@
+
+/**
+ * Implementation of hook_menu().
+ */
+function [module]_menu() {
+  $items = array();
+
+  $items['admin/settings/[module]'] = array(
+    'title' => '[module]',
+    'page callback' => 'drupal_get_form',
+    'page arguments' => array('[module]_settings'),
+    'access arguments' => array('administer [module]'),
+    'file' => '[module].admin.inc',
+  );
+
+  return $items;
+}

data/lib/drupal/templates/6.x/hooks/perm

@@ -0,0 +1,7 @@
+
+/**
+ * Implementation of hook_perm().
+ */
+function [module]_perm() {
+  return array('administer [module]');
+}

data/lib/drupal/templates/6.x/hooks/theme

@@ -0,0 +1,11 @@
+
+/**
+ * Implementation of hook_theme().
+ */
+function [module]_theme($existing, $type, $theme, $path) {
+  return array(
+    'forum_topic_navigation' => array(
+      'arguments' => array('node' => NULL),
+    ),
+  );
+}

data/lib/drupal/templates/6.x/txt/changelog

@@ -0,0 +1,9 @@
+
+        $Id$
+
+
+        -------------------------------------------------------------------------------
+        [module] 6.4-1.0, YYYY-MM-DD
+        -------------------------------------------------------------------------------
+
+        - Initial release

data/lib/drupal/templates/6.x/txt/readme

@@ -0,0 +1,36 @@
+
+        $Id$
+
+
+        [module]
+        Provided by [link]
+        Developed by [author]
+
+        -------------------------------------------------------------------------------
+        INSTALLATION
+        -------------------------------------------------------------------------------
+
+        todo
+
+        -------------------------------------------------------------------------------
+        PERMISSIONS
+        -------------------------------------------------------------------------------
+
+        permission
+          - description
+
+
+        -------------------------------------------------------------------------------
+        PUBLIC API
+        -------------------------------------------------------------------------------
+
+        todo
+
+        -------------------------------------------------------------------------------
+        CONVENTIONS
+        -------------------------------------------------------------------------------
+
+        todo
+
+
+

data/lib/drupal/todo_list.rb

@@ -0,0 +1,72 @@
+
+class Drupal
+  class Todo_List
+    
+    # Run todo list
+    def run(arguments)
+      @total = 0
+      @arguments = arguments
+      @total_only = true if @arguments[0] == 'total'
+      @arguments.shift if @total_only == true
+      parse_dir('.') if @arguments.empty?
+      for argument in @arguments
+        parse_file(argument) if File.file?(argument)
+        parse_dir(argument) if File.directory?(argument)
+      end
+      puts "Total todo items: #{@total}" if @total_only == true
+    end
+    
+    # Parse file for todo items.
+    def parse_file(filepath)
+      File.open(filepath) do |file|
+        items = []
+        linenumber = 0
+        file.each_line do |line|
+          linenumber += 1
+          if summary = ToDo.extract_summary(line)
+            context = ToDo.extract_context(linenumber, file)
+            item = ToDo.new(linenumber, summary, context)
+            @total += 1
+            items << item.to_s
+          end
+        end
+        puts "\n" + filepath unless items.empty? || @total_only == true
+        items.each{ |item| puts item } unless @total_only == true
+      end
+    end
+    
+    # Parse directory for todo items.
+    def parse_dir(dir)
+      Dir["#{dir == '.' ? '.' : dir}/**/*"].each do |file|
+        parse_file(file) if File.file?(file)
+      end
+    end
+  end
+end
+
+# TODO: example.
+class ToDo
+  attr_accessor :linenumber, :summary, :context
+  
+  def initialize (linenumber, summary, context)
+    @linenumber = linenumber
+    @summary = summary
+    @context = context
+  end
+  
+  def to_s
+    "#{@linenumber}: #{@summary}\n#{@context}\n"
+  end
+  
+  def ToDo.extract_summary(line)
+    matches = line.match /(?:#|\/\/|\/\*|@)[\s]*todo:?[\s]*(.+)$/i
+    matches[1] unless matches.nil? || matches.length <= 0
+  end
+  
+  def ToDo.extract_context(linenumber, file)
+    file.rewind
+    list = file.to_a
+    #rewind one line (one line above) then add the line itself and three lines below.
+    list.slice!(linenumber - 1, 5)
+  end
+end

data/lib/drupal.rb

@@ -0,0 +1,156 @@
+#!/usr/bin/env ruby
+
+# == SYNOPSIS:
+#
+#	  drupal [options] [arguments]
+#
+# == ARGUMENTS:
+# 
+#   create module <module_name> [dir]      Generates a module skeleton from an interactive wizard. Current directory unless [dir] is specified.
+#   todo list [total]                      Displays list of todo items or a total.   
+#   install <core | project> [dir] [5.x|6.x|7.x]  	 
+#                                          Install a Drupal project or core itself to [dir] (defaults to curent dir) for version (defaults to 6.x)
+#
+# == OPTIONS:
+# 
+#  	-h, --help       Display this help information.
+#	 	-V, --version    Display version of the Drupal development tool.
+#
+# == EXAMPLES:
+# 
+#   Create a new module in the current directory.
+#	    drupal create module my_module
+#
+#   Create a new module in a specific directory.
+#      drupal create module my_module ./sites/all/modules
+#
+#	  View todo list for current directory.
+#      drupal todo list
+#  
+#   View todo list for multiple files or directories.
+#	     drupal todo list ./sites/all/modules/mymodule 
+#
+#   View total todo items only.
+#     drupal todo list total ./sites/all/modules
+#    
+#   Install a module to the modules folder in my new installation (from drupal root)
+#     drupal install devel ./sites/all/modules
+#  
+#   Install a module when in the 'modules directory
+#     drupal install devel
+#
+#   Install a 5.x module when in the 'modules directory
+#     drupal install devel . 5.x
+#
+#   Install several modules to the modules folder
+#     drupal install devel,pathauto,err,ac ./sites/all/modules
+#  
+   
+require 'optparse'
+require 'ostruct'
+require File.dirname(__FILE__) + '/drupal/create_module'
+require File.dirname(__FILE__) + '/drupal/todo_list'
+require File.dirname(__FILE__) + '/drupal/install'
+
+class Drupal
+  
+  MAJOR = 0
+  MINOR = 0
+  TINY = 9
+  VERSION = [MAJOR, MINOR, TINY].join('.')
+  
+  # Run the drupal development tool.
+  def run(arguments) 
+    @arguments = arguments || [] 
+    @options = OpenStruct.new
+    abort 'Arguments required. Use --help for additional information.' if @arguments.empty?
+    parse_options
+    determine_handler
+    execute_handler
+  end
+  
+  # Parse stdin for options.
+  def parse_options
+    opts = OptionParser.new
+    opts.on('-h', '--help') { output_help }
+    opts.on('-V', '--version') { output_version }
+    opts.parse!(@arguments)
+  end
+  
+  # Determine handler based on the current arguments.
+  def determine_handler
+    @handler = @arguments.shift.capitalize
+    while !@arguments.empty? && !is_handler(@handler) do
+      @handler << '_' + @arguments.shift.capitalize
+    end
+  end
+  
+  # Execute the handler if it was found.
+  def execute_handler
+    abort 'Invalid command.' if !is_handler(@handler)
+    eval("Drupal::#{@handler}.new.run(@arguments)")
+  end
+  
+  # Check existance of a handler.
+  def is_handler(klass)
+    Drupal.const_defined?(klass) 
+  end
+  
+  # Output help information.
+  def output_help
+    # TODO: utilize RDoc
+    puts <<-USAGE
+    
+  SYNOPSIS:
+ 
+    drupal [options] [arguments]
+ 
+  ARGUMENTS:
+ 
+    create module <module_name> [dir]  Generates a module skeleton from an interactive wizard. Current directory unless [dir] is specified.
+    todo list [total]                  Displays list of todo items or a total.   
+    install <core | project> [dir] [5.x|6.x|7.x]
+                                       Install a Drupal project or core itself to [dir] (defaults to curent dir) for version (defaults to 6.x)
+    
+  EXAMPLES:
+  
+    Create a new module in the current directory.
+      drupal create module my_module
+
+    Create a new module in a specific directory.
+      drupal create module my_module ./sites/all/modules
+
+    View todo list for current directory.
+      drupal todo list
+  
+    View todo list for multiple files or directories.
+      drupal todo list ./sites/all/modules/mymodule 
+
+    View total todo items only.
+      drupal todo list total ./sites/all/modules   
+      
+    Install drupal core to the current directory.
+      drupal install core
+
+    Install a 5.x module when in the 'modules directory
+      drupal install devel . 5.x
+
+    Install a module to the modules folder in my new installation (from drupal root)
+      drupal install devel ./sites/all/modules
+      
+    Install a module when in the 'modules directory
+      drupal install devel
+       
+USAGE
+  exit
+  end
+  
+  # Output version information.
+  def output_version
+    puts "Version #{Drupal::VERSION}"
+    exit
+  end
+end
+
+
+

data/test/test_create_module.rb

@@ -0,0 +1 @@
+

data/test/test_drupal.rb

@@ -0,0 +1,6 @@
+
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/drupal.rb'
+require File.dirname(__FILE__) + '/test_install.rb'
+require File.dirname(__FILE__) + '/test_create_module.rb'
+require File.dirname(__FILE__) + '/test_todo_list.rb'

data/test/test_install.rb

@@ -0,0 +1,23 @@
+
+class DrupalInstall < Test::Unit::TestCase
+    def setup
+      Drupal.new.run('install ab'.split)
+      Kernel.system "mkdir _modules"
+      Drupal.new.run('install devel ./_modules'.split)
+    end
+
+    def teardown
+      Kernel.system "rm -fr ./ab/*"
+      Kernel.system "rmdir ./ab"
+      Kernel.system "rm -fr ./_modules/*"
+      Kernel.system "rmdir ./_modules"
+    end
+
+    def test_contrib_cwd
+      assert(File.directory?('./ab'), 'Failed to install ab module in cwd.')
+    end
+    
+    def test_contrib_dir
+      assert(File.directory?('./_modules/devel'), 'Failed to install devel to _modules directory.')
+    end
+end