berkes-drupal.rb 0.0.7 → 0.0.8

data/History.txt

@@ -1,3 +1,12 @@
+=== 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
 

data/README.txt

@@ -19,7 +19,8 @@ to quickly generate and manage Drupal modules.
 
 	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]  	Install a Drupal project or core itself to [dir]
+	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:
 
@@ -43,6 +44,18 @@ to quickly generate and manage Drupal modules.
   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
@@ -51,11 +64,15 @@ to quickly generate and manage Drupal modules.
   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. 
 	
 == TODO:
-
-  * Add defaults.yml-support. When .drupal.rb/defaults.yml exists, use these
-    instead of asking them everytime.
+  * Move helptext into one include instead of having it on 4 places (DRY!)
+  * Add Drupal version support to defaults.yml.
   * Remove ':' from todo list items
   * Add formatted help option
   * Support versions for installer

data/bin/drupal

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

data/drupal.rb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "drupal.rb"
-  s.version  = "0.0.7"
+  s.version  = "0.0.8"
   s.date     = "2008-10-16"
   s.summary  = "Drupal development kit"
   s.email    = "ber@webschuur.com"

data/lib/drupal.rb

@@ -8,7 +8,8 @@
 # 
 #   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]  	 Install Drupal project(s) to [dir] or the current directory.
+#   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:
 # 
@@ -38,6 +39,9 @@
 #   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
 #  
@@ -105,7 +109,8 @@ class Drupal
  
     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]  	 Install a Drupal project or core itself to [dir]    
+    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:
   
@@ -126,7 +131,10 @@ class Drupal
       
     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
       

data/lib/drupal/create_module.rb

@@ -1,7 +1,8 @@
+require 'yaml'
 
 class Drupal
   class Create_Module
-    
+
     # Create a module using the module builing wizard.
     def run(arguments)
       @arguments = arguments
@@ -9,44 +10,46 @@ class Drupal
       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 
+      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
+
       # Info
-      @author = self.ask('What is your name?:')
-      @link = self.ask('What is the URI to your companies website?:')
-      @email = self.ask('What is your email?:')
-      @module_name = self.ask('Enter a human readable name for your module:')
-      @module_description = self.ask('Enter a short description of your module:')
-      @module_dependencies = self.ask('Enter a list of dependencies for your module:', true)
+      @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])
+      @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)
+      @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)
+      @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)
+      @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
       @tokens = {
@@ -59,7 +62,7 @@ class Drupal
           :module_dependencies => @module_dependencies,
         }
     end
-    
+
     # Register hook weights
     def create_hook_weights
       @hook_weights = [
@@ -75,7 +78,7 @@ class Drupal
           'block',
         ]
     end
-    
+
     # Create module from wizard results.
     def create_module
       puts "\n... Creating module '#{@module}' in '#{@dir}'"
@@ -88,21 +91,21 @@ class Drupal
       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
     end
-    
+
     # Create .module file.
     def create_module_file
       create_file("#{@module}.module", "<?php\n")
@@ -112,20 +115,20 @@ class Drupal
         if @hooks.include?(hook)
           append_template("#{@module}.module", "hooks/#{hook}", @tokens) unless hook.match /^install|schema/
         end
-      end      
+      end
     end
-    
+
     # Create .install file.
     def create_module_install_file
-      if @hooks.include?('schema') || @hooks.include?('schema')
+      if @hooks.include?('schema') || @hooks.include?('install')
         create_file("#{@module}.install", "<?php\n")
         append_template("#{@module}.install", 'comments/file', @tokens)
         @hooks.each do |hook|
           append_template("#{@module}.install", "hooks/#{hook}", @tokens) if hook.match /^install|schema/
         end
-      end      
+      end
     end
-    
+
     # Create info file.
     def create_module_info_file
       contents = '; $Id$'
@@ -137,14 +140,14 @@ class Drupal
       end
       create_file("#{@module}.info", contents)
     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}"
@@ -153,7 +156,7 @@ class Drupal
         f.write contents
       end
     end
-    
+
     # Append a tokenized template template to a file.
     def append_template(filepath, template, tokens = {})
       # TODO: ensure template exists
@@ -172,28 +175,36 @@ class Drupal
         f.write contents
       end
     end
-    
+
     # Prompt user for input
-    def ask(question, list = false)
+    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; STDIN.gets.split
-          when false; STDIN.gets.gsub!(/\n/, '')
+          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 << '/*']
@@ -202,11 +213,36 @@ class Drupal
 
     private
     def get_template_location
-      location = File.expand_path '~/.drupal.rb/templates/'
+      location = File.expand_path '~/.drupal.rb/templates'
+
       unless File.directory? location
-        location = File.dirname(__FILE__) + '/templates/'
+        location = File.dirname(__FILE__) + '/templates'
+      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 location
+
+      return defaults
     end
   end
 end

data/lib/drupal/install.rb

@@ -1,23 +1,24 @@
-
 require 'zlib'
 require 'net/http'
+require 'rexml/document'
 
 class Drupal
   class Install
-    
+    include REXML
     # Attempt to download core installation or module.
     def run(arguments)
       @project = arguments[0]
-      @dest = arguments[1] || '.' 
+      @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? ','
@@ -25,71 +26,118 @@ class Drupal
         projects.each do |p|
           @project = p
           check_core
-          install_project 
+          install_project
           puts
-        end   
+        end
       else
         check_core
         install_project
       end
     end
-    
+
     # Check if the destination is empty.
     def destination_empty?
-      Dir['*'].length == 0 
+      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
-      debug "Locating #{@project} page"
-      # Locate tarball from project page
-      begin 
-        response = Net::HTTP.get_response(URI.parse("http://drupal.org/project/#{@project}"))
-        @markup = response.body
-        # TODO: check 404
-        debug 'Located the project page'
-      rescue
-        puts 'Failed to request page'
-      end
-      @markup.match /(#{@project}-6(?:.*?)\.gz)/
-      @tarball = $1
-      @tarpath = File.expand_path("#{@dest}/#{@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("http://ftp.drupal.org/files/projects/#{@tarball}"))
-        File.open(@tarpath, 'w') do |f|
-          f.write response.body
-        end
-        debug "Copied tarball to #{@tarpath}"
-      rescue
-        abort "Failed to copy remote tarball #{@tarball}"
-      end
-      
+      xmldoc = get_xml(@project, @version)
+      release = get_release(xmldoc, 'latest')
+      @tarpath = get_tarball(release)
+
       # Extract tarball
       @pwd = Dir.getwd
       Dir.chdir File.dirname(@tarpath) and debug "Changed cwd to #{File.dirname(@tarpath)}" unless @dest == '.'
       Kernel.system "tar -xf #{@tarpath}" rescue abort "Failed to extract #{@tarpath}"
       Dir.chdir @pwd and debug "Reverted cwd back to #{@pwd}" unless @dest == '.'
-      
+
       # Remove tarball
       Kernel.system "rm #{@tarpath}" rescue abort "Failed to remove #{@tarpath}"
-      
+
       # Installation complete
       debug "Project installed to #{File.dirname(@tarpath)}" unless @dest == '.'
       debug 'Installation complete'
     end
+
+    def get_xml project, version='6.x'
+      debug "Locating #{project} page"
+      # 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
+        debug "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
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: berkes-drupal.rb
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - tj@vision-media.ca
@@ -51,6 +51,7 @@ files:
 - bin/drupal
 has_rdoc: true
 homepage: http://berkes.github.com/drupal.rb/
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --main
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Drupal development kit