drupal.rb 0.0.12

data/History.txt

@@ -0,0 +1,53 @@
+=== 0.0.11 / 2010-02-14 
+* Database scaffolding initial. Adds CRUD database includefile and schema in install.
+
+=== 0.0.8 / 2009-08-06
+
+* 1 Internal rewrite, 2 new features, 1 bugfix
+  * Added commandline option to allow selection of Drupal version for installation.
+
+  * Rewrote install system by parsing the drupal release XML rather then scraping HTML.
+  * Added defaults.yml config option. When this file is present, we parse the contents and 
+    present them as defaults in interactive mode. Quicker module-building!
+  * If hook "install" was chose, the .install file was not created. Fixed.
+
+=== 0.0.7 / 2009-05-02
+
+* Cleanup and rename to drupal.rb
+* Implemented ability to override global templates in a ~/.drupal.rb directory.
+
+=== 0.0.6 / 2008-10-16
+
+* 1 Minor Feature:
+
+  * Added hook_install() support
+
+=== 0.0.5 / 2008-10-06
+
+* 1 Minor Fix:
+
+  * Todo list was not parsing items starting with '@' in @todo
+
+=== 0.0.4 / 2008-10-03
+
+* 1 Major Feature:
+
+  * Installer allows lists of projects 'err,ac,devel'
+
+=== 0.0.3 / 2008-10-03
+
+* 1 Major Feature:
+
+  * Installer for Drupal projects
+
+=== 0.0.2 / 2008-10-02
+
+* 2 Bug Fixes:
+
+  * Executable
+  * Fixed template filepath errors
+
+=== 0.0.1 / 2008-09-27
+
+	* Initial release
+

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/drupal
+lib/drupal.rb
+lib/drupal/todo_list.rb
+lib/drupal/create_module.rb
+lib/drupal/install.rb
+lib/drupal/templates/comments/file
+lib/drupal/templates/comments/large
+lib/drupal/templates/hooks/block
+lib/drupal/templates/hooks/boot
+lib/drupal/templates/hooks/install
+lib/drupal/templates/hooks/cron
+lib/drupal/templates/hooks/form_alter
+lib/drupal/templates/hooks/init
+lib/drupal/templates/hooks/menu
+lib/drupal/templates/hooks/perm
+lib/drupal/templates/hooks/schema
+lib/drupal/templates/hooks/theme
+lib/drupal/templates/txt/changelog
+lib/drupal/templates/txt/readme

data/README.txt

@@ -0,0 +1,108 @@
+= drupal.rb
+
+http://berkes.github.com/drupal.rb/
+
+== DESCRIPTION:
+
+Drupal is an open source Ruby development tool allowing developers 
+to quickly generate and manage Drupal modules.
+
+== SYNOPSIS:
+
+	drupal [options] [arguments]
+
+== REQUIREMENTS:
+
+	none
+
+== ARGUMENTS:
+
+	create module <module_name>   		Generates a module skeleton from an interactive wizard.
+	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 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
+
+== LOCAL TEMPLATES
+
+  Create .drupal.rb/templates/ directories in your home-directory and put your
+  own templates there. Drupal.rb will pick these, instead of the global ones.
+
+  e.g. $ mkdir ~/.drupal.rb/
+       $ cp -r /path/to/gems/berkes-drupal.rb-0.0.7/var/lib/drupal/templates/ \
+         ~/.drupal.rb/templates/
+         
+== DEFAULTS
+  Create a file in ~/.drupal.rb/ named defaults.yml. The variables in there will
+  be used as defaults on the prompt when creating a module.
+  Alternatively you can copy the example from the doc dir in the package. 
+
+== AUTHOR:
+
+Original:
+  TJ Holowaychuk 
+  tj@vision-media.ca
+  http://vision-media.ca
+
+Current Maintainer:
+  Bèr Kessels
+  ber@webschuur.com 
+  http://webschuur.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require File.dirname(__FILE__) + '/lib/drupal'
+
+desc 'Build and install ruby gem.'
+task :build do
+  sh "sudo gem build ./drupal.gemspec"
+  sh "sudo gem install drupal-#{Drupal::VERSION}.gem"
+end
+
+desc 'Remove ruby gem build data.'
+task :remove do
+  sh "sudo gem uninstall drupal"
+  sh "sudo rm drupal-#{Drupal::VERSION}.gem"
+end
+
+desc 'Run tests.'
+task :test do
+  sh "ruby " + File.dirname(__FILE__) + '/test/test_drupal.rb' + ' -r tk'
+end

data/bin/drupal

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'drupal'
+Drupal.new.run(ARGV)

data/drupal.rb.gemspec

@@ -0,0 +1,59 @@
+Gem::Specification.new do |s|
+  s.name     = "drupal.rb"
+  s.version  = "0.0.12"
+  s.date     = "2010-02-14"
+  s.summary  = "Drupal development kit"
+  s.email    = "ber@webschuur.com"
+  s.homepage = "http://berkes.github.com/drupal.rb/"
+  s.description = "Drupal is an open source Ruby development tool allowing developers to quickly generate and manage Drupal modules."
+  s.has_rdoc = true
+  s.require_path = "lib"
+  s.authors  = ["tj@vision-media.ca", "ber@webschuur.com"]
+  s.add_dependency("archive-tar-minitar", ">0.5.0")
+  s.add_dependency("active_support", ">0.0.0")
+  s.requirements = [
+    "A POSIX compliant environment (Mac, Unix, Linux, and for Windows Cygwin)",
+    "Minitar Gem version 0.5.0 or greater. http://raa.ruby-lang.org/project/minitar",
+    "Pluralize, as found in active_support, for database scaffolding."  ]
+  s.files    = ["History.txt", 
+		"Manifest.txt", 
+		"README.txt", 
+		"Rakefile", 
+		"drupal.rb.gemspec", 
+		"lib/drupal.rb", 
+		"lib/drupal/create_module.rb", 
+		"lib/drupal/todo_list.rb", 
+		"lib/drupal/install.rb", 
+		"lib/drupal/templates/6.x/comments/file", 
+		"lib/drupal/templates/6.x/comments/large", 
+		"lib/drupal/templates/6.x/hooks/block", 
+		"lib/drupal/templates/6.x/hooks/boot", 
+		"lib/drupal/templates/6.x/hooks/cron", 
+		"lib/drupal/templates/6.x/hooks/form_alter", 
+		"lib/drupal/templates/6.x/hooks/init", 
+		"lib/drupal/templates/6.x/hooks/menu", 
+		"lib/drupal/templates/6.x/hooks/perm", 
+		"lib/drupal/templates/6.x/hooks/theme", 
+		"lib/drupal/templates/6.x/txt/changelog", 
+		"lib/drupal/templates/6.x/txt/readme",
+		"lib/drupal/templates/6.x/base/info",
+		
+		"lib/drupal/templates/5.x/comments/file", 
+		"lib/drupal/templates/5.x/comments/large", 
+		"lib/drupal/templates/5.x/hooks/block", 
+		"lib/drupal/templates/5.x/hooks/install", 
+		"lib/drupal/templates/5.x/hooks/cron", 
+		"lib/drupal/templates/5.x/hooks/form_alter", 
+		"lib/drupal/templates/5.x/hooks/init", 
+		"lib/drupal/templates/5.x/hooks/menu", 
+		"lib/drupal/templates/5.x/hooks/perm",
+		"lib/drupal/templates/5.x/txt/changelog", 
+		"lib/drupal/templates/5.x/txt/readme",
+		"lib/drupal/templates/5.x/base/info",
+		
+		"bin/drupal"]
+	s.executables = ["drupal"]
+  s.test_files = ["test/test_drupal.rb", "test/test_install.rb", "test/test_create_module.rb", "test/test_todo_list.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+end

data/lib/drupal/create_module.rb

@@ -0,0 +1,276 @@
+require 'yaml'
+require 'active_support'
+
+class Drupal
+  class Create_Module
+
+    # Create a module using the module builing wizard.
+    def run(arguments)
+      @arguments = arguments
+      @dir = @arguments[1] || '.' # TODO remove trailing slash, check validity, and existance
+      self.check_module_name
+      self.run_wizard
+    end
+
+    # Ensure module name is supplied and that it is
+    # formatted correctly as module names must be alphanumeric
+    # and must begin with a letter.
+    def check_module_name
+      case
+        when @arguments.empty?; puts 'Module name required.'; exit 3
+        when !@arguments[0].match(/^[a-z][\w]+/); puts 'Invalid module name.'; exit 4
+        else @module = @arguments[0]
+      end
+    end
+
+    # Run module generation wizard.
+    def run_wizard
+      # TODO create self.log() with padding to even output
+      defaults = get_defaults
+
+      # TODO make each ask have a commandline-option equivalent.
+      @version = self.ask('What drupal version to scaffold for?:', defaults[:version])
+      @author = self.ask('What is your name?:', defaults[:author])
+      @link = self.ask('What is the URI to your companies website?:', defaults[:link])
+      @email = self.ask('What is your email?:', defaults[:email])
+      @module_name = self.ask('Enter a human readable name for your module:', defaults[:module_name])
+      @table = self.ask('Database table name for your module. Without the modulename. A table name "pirates" on the module "cool_people" we would give us a table "cool_people_pirates" Leave empty for no database-scaffolding.')
+      @module_description = self.ask('Enter a short description of your module:', defaults[:module_description])
+      @module_dependencies = self.ask('Enter a list of dependencies for your module:', defaults[:module_dependencies], true)
+      # Hooks
+      puts self.list_templates('Hooks:', 'hooks')
+      @hooks = self.ask('Which hooks would you like to implement?:', '', true)
+      # Files
+      puts self.list_templates('Files:', 'txt')
+      @files = self.ask('Which additional files would you like to include?:', '', true)
+      # Dirs
+      puts "\nCommon directories:"
+      puts ['js', 'images', 'css'].collect{ |d| " - " << d }
+      @dirs = self.ask('Which directories would you like to create?:', '', true)
+      # Finish
+      self.create_tokens
+      self.create_hook_weights
+      self.create_module
+    end
+
+    # Create global tokens.
+    def create_tokens
+      if not @table.nil?
+        @record = @table.singularize
+      else
+        @record = ''
+      end
+      
+      @tokens = {
+          :module => @module,
+          :link => @link,
+          :email => @email,
+          :author => @author,
+          :module_name => @module_name,
+          :module_description => @module_description,
+          :module_dependencies => @module_dependencies,
+          :table => @table,
+          :record => @record,
+        }
+    end
+
+    # Register hook weights
+    def create_hook_weights
+      @hook_weights = [
+          'perm',
+          'cron',
+          'boot',
+          'init',
+          'menu',
+          'theme',
+          'form_alter',
+          'block',
+        ]
+    end
+
+    # Create module from wizard results.
+    def create_module
+      puts "\n... Creating module '#{@module}' in '#{@dir}'"
+      # Base directory
+      create_dir("#{@module}")
+      self.create_module_dirs
+      self.create_module_files
+      self.create_module_file
+      self.create_module_database_files
+      self.create_module_info_file
+      puts 'Module created :)'
+    end
+
+    # Create directories.
+    def create_module_dirs
+      @dirs.each{ |dir| create_dir("#{@module}/#{dir}") }
+    end
+
+    # Create file templates.
+    def create_module_files
+      @files.each do |file|
+        filepath = "#{file.upcase}.txt"
+        create_file(filepath)
+        append_template(filepath, "txt/#{file}", @tokens)
+      end
+    end
+
+    # Create .module file.
+    def create_module_file
+      create_file("#{@module}.module", "<?php\n")
+      append_template("#{@module}.module", 'comments/file', @tokens)
+      append_template("#{@module}.module", 'comments/large', {'title' => 'Hook Implementations'})
+      for hook in @hook_weights
+        if @hooks.include?(hook)
+          append_template("#{@module}.module", "hooks/#{hook}", @tokens)
+        end
+      end
+    end
+
+    # Create .install file, database includes and schema..
+    def create_module_database_files
+      if not @table.empty?
+        create_file("#{@module}.install", "<?php\n")
+        append_template("#{@module}.install", 'comments/file', @tokens)
+        ['install', 'schema'].each do |hook|
+          append_template("#{@module}.install", "incs/#{hook}", @tokens)
+        end
+        
+        create_file("#{@module}_db.inc", "<?php\n")
+        append_template("#{@module}_db.inc", 'comments/file_db', @tokens)
+        append_template("#{@module}_db.inc", "incs/module_db", @tokens)
+        
+        append_template("#{@module}.module", "hooks/init", @tokens) unless @hooks.include('init')
+      end
+    end
+
+    # Create info file.
+    def create_module_info_file
+      tokens = {
+        'module_name' => @module_name,
+        'module_description' => @module_description,
+        'version' => @version,
+      }
+
+      if !@module_dependencies.nil?
+        #In 6.x each dep has a new line. In 5.x they are on a single line.
+        if (@version == '6.x')
+          @module_dependencies.each do |dependency|
+           tokens['dependencies_chunk'] = "\ndependencies[] = #{dependency}"
+          end       
+        elsif (@version == '5.x')
+          tokens['dependencies_chunk'] = "dependencies = " + @module_dependencies.join(',')
+        end
+      end
+      
+      filepath = "#{@module}.info"
+      create_file(filepath)
+      append_template(filepath, "base/info", tokens)
+    end
+
+    # Create a new directory.
+    def create_dir(dir)
+      dir = "#{@dir}/#{dir}"
+      puts "... Creating directory '#{dir}'"
+      Dir.mkdir(dir)
+    end
+
+    # Create a new file.
+    def create_file(filepath, contents = '')
+      filepath = "#{@dir}/#{@module}/#{filepath}"
+      puts "... Creating file '#{filepath}'"
+      File.open(filepath, 'w') do |f|
+        f.write contents
+      end
+    end
+
+    # Append a tokenized template template to a file.
+    def append_template(filepath, template, tokens = {})
+      # TODO: ensure template exists
+      # TODO: is \n included with STDIN?
+      _template = template
+      filepath = "#{@dir}/#{@module}/#{filepath}"
+      template = get_template_location << template
+      puts "... Adding template '#{_template}' to '#{filepath}'"
+      contents = File.read(template)
+      tokens.each_pair do |token, value|
+        if value.class == String && contents.include?("[#{token}]")
+          contents.gsub!(/\[#{token}\]/, value)
+        end
+      end
+      File.open(filepath, 'a') do |f|
+        f.write contents
+      end
+    end
+
+    # Prompt user for input
+    def ask(question, default = '', list = false)
+      if not default.to_s.empty? then question = question << " (#{default})" end
+      puts "\n" << question
+
+      # TODO: support 'all'
+      # TODO: why is gets not working?
+      # TODO: not catching exception when CTRL+C ?
+      begin
+        case list
+          when true; input = STDIN.gets.split
+          when false; input = STDIN.gets.gsub!(/\n/, '')
+        end
+      rescue => e
+        puts ':)'
+      end
+
+      if input.empty?
+        return default
+      else
+        return input
+      end
+    end
+
+    # List templates available of a certain type.
+    def list_templates(title, type)
+      "\n" << title << self.get_templates(type).collect{ |t| "\n - " << File.basename(t) }.join
+    end
+
+    # Get array of templates of a certain type.
+    def get_templates(type)
+      Dir[get_template_location << type << '/*']
+    end
+
+
+    private
+    def get_template_location
+      location = File.expand_path "~/.drupal.rb/templates/#{@version}"
+
+      unless File.directory? location
+        location = File.dirname(__FILE__) + "/templates/#{@version}"
+      end
+
+      return location + '/'
+    end
+
+    # @TODO: implement defaults that can be altered for list of hooks and files
+    def get_defaults
+      defaults = {}
+      location = File.expand_path '~/.drupal.rb/defaults.yml'
+      if File.readable? location
+        defaults_yml = File.open( location ) { |yf| YAML::load( yf ) }
+
+        # @TODO: There is most probably a much nicer Rubyism for this nested looping.
+        # If you know Ruby better then I do, please chime in and change this.
+        create_tokens().each do |token|
+          defaults_yml.each do |d|
+            if (d.has_key? token.first.to_s)
+              defaults[token.first] = d[token.first.to_s]
+            end
+          end
+        end
+      else
+        defaults = create_tokens
+      end
+
+      return defaults
+    end
+  end
+end
+

data/lib/drupal/install.rb

@@ -0,0 +1,143 @@
+require 'rubygems'
+require 'net/http'
+require 'rexml/document'
+require 'zlib'
+require 'archive/tar/minitar'
+
+class Drupal
+  class Install
+    include REXML
+    # Attempt to download core installation or module.
+    def run(arguments)
+      @project = arguments[0]
+      @dest = arguments[1] || '.'
+      @version = arguments[2] || '6.x'
+      abort "Destination #{@dest} is not a directory." unless File.directory?(@dest)
+      abort 'Project name required (core | <project>).' if arguments.empty?
+      install_projects
+    end
+
+    def debug(message)
+      puts '... ' + message
+    end
+
+    # Install single project or iterate lists.
+    def install_projects
+      if @project.include? ','
+        projects = @project.split ','
+        projects.each do |p|
+          @project = p
+          check_core
+          install_project
+          puts
+        end
+      else
+        check_core
+        install_project
+      end
+    end
+
+    # Check if the destination is empty.
+    def destination_empty?
+      Dir['*'].length == 0
+    end
+
+    # Allow users to type 'core' instead of 'drupal install drupal'
+    def check_core
+      @project = 'drupal' if @project =~ /^core|drupal$/
+    end
+
+    # Check if a uri is available.
+    def uri_available?(uri)
+      open(uri) rescue false
+    end
+
+    # Install project.
+    # @TODO move all the updates.drupal.org xml parsing into a separate Class
+    def install_project
+      xmldoc = get_xml(@project, @version)
+      release = get_release(xmldoc, 'latest')
+      @tarpath = get_tarball(release)
+
+      # Extract tarball
+      tgz = Zlib::GzipReader.new(File.open(@tarpath, 'rb'))
+      Archive::Tar::Minitar.unpack(tgz, @dest) rescue abort "Failed to extract #{@tarpath} to #{@dest}"
+      
+      # Remove tarball
+      File.delete(@tarpath) rescue abort "Failed to remove #{@tarpath}"
+
+      # Installation complete
+      debug "Project #{@project} installed to #{File.dirname(@tarpath)}" unless @dest == '.'
+      debug 'Installation complete'
+    end
+
+    def get_xml project, version='6.x'
+      debug "Locating #{project} page for version #{version}"
+      # Locate tarball from project page
+      begin
+        response = Net::HTTP.get_response(URI.parse("http://updates.drupal.org/release-history/#{project}/#{version}"))
+        # TODO: unhardcode the dependency on Drupal 6, make this an environment or static var.
+        # TODO: check 404, 403 etc.
+        xmldoc = Document.new response.body
+        if xmldoc.root.name == 'error' #TODO: better error handling here.
+          message = xmldoc.root.text
+          raise message
+        end
+      rescue
+        abort "Could not fetch #{project}. Error: #{message}"
+      end
+
+      return xmldoc
+    end
+
+    def get_releases(xmldoc)
+      releases = Hash.new
+
+      xmldoc.root.each_element('//release') do |release|
+        releases[release.text('version')] = release
+      end
+
+      return releases
+    end
+
+    # returns the release with releasenumber 'which' from xmldoc.
+    # use 'latest' for which, if you want the latest stable release
+    def get_release(xmldoc, which)
+      releases = get_releases(xmldoc)
+
+      ordered = releases.keys.sort_by {|k| k.to_s.split(/\.|-/).map {|v| v.to_i} }
+
+      if ( which == 'latest' )
+        release = releases[ordered.last]
+      elsif ordered.include? which
+        release = releases[which]
+      else
+        raise "Failed to find requested release #{which}"
+      end
+
+      return release
+    end
+
+    def get_tarball(release)
+      tarball = release.elements['//download_link'].text
+      tarpath = File.basename(tarball)
+
+      abort "Failed to find Drupal 6 tar of #{@project}" if tarball.nil?
+      debug "Found tarball #{tarball}"
+
+      # Fetch tarball
+      begin
+        response = Net::HTTP.get_response(URI.parse(tarball))
+        puts tarpath
+        File.open(tarpath, 'w') do |f|
+          f.write response.body
+        end
+        debug "Copied tarball to #{tarpath}"
+      rescue
+        abort "Failed to copy remote tarball #{tarball} to #{tarpath}"
+      end
+
+      return tarpath
+    end
+  end
+end

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

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