jdt 0.0.2

data/lib/jdt/generator/templates/module/manifest.xml.erb

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<extension type="module" version="1.6.0" method="upgrade">
+  <name><%= @name %></name>
+  <author><%= @author %></author>
+  <version><%= @version %></version>
+  <description><%= @description %></description>
+  <creationDate><%= @creation_date %></creationDate>
+  <files>
+    <filename>mod_<%= @name %>.xml</filename>
+    <filename module="mod_<%= @name %>">mod_<%= @name %>.php</filename>
+    <filename>helper.php</filename>
+    <filename>tmpl/default.php</filename>
+  </files>
+  <params>
+  </params>
+</extension>

data/lib/jdt/generator/templates/module/mod_name.php.erb

@@ -0,0 +1,10 @@
+<?php
+
+// no direct access
+defined( '_JEXEC' ) or die( 'Restricted access' );
+
+// Include the syndicate functions only once
+require_once( dirname(__FILE__).DS.'helper.php' );
+
+$hello = mod<%= @name.capitalize %>Helper::getHello( $params );
+require( JModuleHelper::getLayoutPath( 'mod_<%= @name %>' ) );

data/lib/jdt/generator/templates/module/tmpl/default.php.erb

@@ -0,0 +1,3 @@
+<?php // no direct access
+defined( '_JEXEC' ) or die( 'Restricted access' ); ?>
+<?php echo $hello; ?>

data/lib/jdt/generator/templates/plugin/manifest.xml.erb

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<extension type="plugin" version="1.6.0" method="upgrade">
+  <name><%= @name %></name>
+  <author><%= @author %></author>
+  <version><%= @version %></version>
+  <description><%= @description %></description>
+  <creationDate><%= @creation_date %></creationDate>
+  <files>
+    <filename>mod_<%= @name %>.xml</filename>
+    <filename module="mod_<%= @name %>">mod_<%= @name %>.php</filename>
+    <filename>helper.php</filename>
+    <filename>tmpl/default.php</filename>
+  </files>
+  <params>
+  </params>
+</extension>

data/lib/jdt/generator/templates/script.php.erb

@@ -0,0 +1,66 @@
+<?php
+// No direct access to this file
+defined('_JEXEC') or die('Restricted access');
+
+/**
+ * Script file of HelloWorld component
+ */
+class com_helloWorldInstallerScript
+{
+	/**
+	 * method to install the component
+	 *
+	 * @return void
+	 */
+	function install($parent)
+	{
+		// $parent is the class calling this method
+		$parent->getParent()->setRedirectURL('index.php?option=com_helloworld');
+	}
+
+	/**
+	 * method to uninstall the component
+	 *
+	 * @return void
+	 */
+	function uninstall($parent)
+	{
+		// $parent is the class calling this method
+		echo '<p>' . JText::_('COM_HELLOWORLD_UNINSTALL_TEXT') . '</p>';
+	}
+
+	/**
+	 * method to update the component
+	 *
+	 * @return void
+	 */
+	function update($parent)
+	{
+		// $parent is the class calling this method
+		echo '<p>' . JText::_('COM_HELLOWORLD_UPDATE_TEXT') . '</p>';
+	}
+
+	/**
+	 * method to run before an install/update/uninstall method
+	 *
+	 * @return void
+	 */
+	function preflight($type, $parent)
+	{
+		// $parent is the class calling this method
+		// $type is the type of change (install, update or discover_install)
+		echo '<p>' . JText::_('COM_HELLOWORLD_PREFLIGHT_' . $type . '_TEXT') . '</p>';
+	}
+
+	/**
+	 * method to run after an install/update/uninstall method
+	 *
+	 * @return void
+	 */
+	function postflight($type, $parent)
+	{
+		// $parent is the class calling this method
+		// $type is the type of change (install, update or discover_install)
+		echo '<p>' . JText::_('COM_HELLOWORLD_POSTFLIGHT_' . $type . '_TEXT') . '</p>';
+	}
+}

data/lib/jdt/generator.rb

@@ -0,0 +1 @@
+require "jdt/generator/generator"

data/lib/jdt/manifest/attributes.rb

@@ -0,0 +1,77 @@
+require "nokogiri"
+
+module Jdt
+
+  class ElementNotFoundError < RuntimeError
+
+  end
+
+  class Manifest
+
+    def required_joomla_version
+      @doc.xpath("//extension").first['version']
+    end
+
+    def ext_method
+      @doc.xpath("//extension").first['method']
+    end
+
+    def author
+      @doc.xpath("//extension/author").text
+    end
+
+    def author_email
+      @doc.xpath("//extension/authorEmail").text
+    end
+
+    def author_url
+      @doc.xpath("//extension/authorUrl").text
+    end
+
+    def creation_date
+      @doc.xpath("//extension/creationDate").text
+    end
+
+    def name
+      @doc.xpath("//extension/name").text
+    end
+
+    def prefixed_name
+      "#{ext_type_short}_#{name}"
+    end
+
+    def prefixed_name_with_version
+      "#{prefixed_name}-v#{version}"
+    end
+
+    def description
+      @doc.xpath("//extension/description").text
+    end
+
+    def version
+      @doc.xpath("//extension/version").text
+    end
+
+    def homepage
+      @doc.xpath("//extension/homepage").text
+    end
+
+    def copyright
+      @doc.xpath("//extension/copyright").text
+    end
+
+    def license
+      @doc.xpath("//extension/license").text
+    end
+
+    def ext_type_short
+      raise NoMethodError
+    end
+
+    def ext_type
+      @doc.xpath("//extension").first['type']
+    end
+
+  end
+
+end

data/lib/jdt/manifest/build.rb

@@ -0,0 +1,106 @@
+require 'zip/zip'
+
+module Jdt
+
+  class Manifest
+
+    def build
+      ExtensionZipper.new(self).zip(:build)
+    end
+
+    def release
+      ExtensionZipper.new(self).zip(:release)
+    end
+
+  end
+
+  class ExtensionZipper
+
+    def initialize(manifest)
+      @manifest = manifest
+    end
+
+    def zip(type)
+
+      if (type == :release)
+        zip_file_name = zip_file
+      elsif (type == :build)
+        zip_file_name = zip_file_with_timestamp
+      else
+        raise ArgumentError("Type is not either :release or :build, but #{type}")
+      end
+
+      # ensure that the file does not exist
+      if (File.exists?(zip_file_name))
+        File.delete(zip_file_name)
+      end
+
+      # ensure that directory exists
+      dir = File.dirname(zip_file_name)
+      if(not File.directory?(dir))
+        Dir.mkdir(dir)
+      end
+
+      # create zip file
+      Zip::ZipFile.open(zip_file_name, Zip::ZipFile::CREATE) do |zos|
+        add_files_to_zip(zos)
+      end
+
+      # return zip file
+      zip_file_name
+    end
+
+    private
+
+    def zip_folder
+      "#{@manifest.folder}/zip"
+    end
+
+    def zip_file
+      "#{zip_folder}/#{@manifest.prefixed_name_with_version}.zip"
+    end
+
+    def zip_file_with_timestamp
+      "#{zip_folder}/#{@manifest.prefixed_name_with_version}_#{timestamp}.zip"
+    end
+
+    def timestamp
+      Time.now.strftime("%Y%m%d%H%M%S%L")
+    end
+
+     def add_files_to_zip(zip)
+
+      # add manifest
+      add_manifest(zip)
+
+      # add all referenced files and folders from manifest
+      add_referenced(zip)
+
+    end
+
+    def add_manifest(zip)
+      zip.add(File.basename(@manifest.file), @manifest.file)
+    end
+
+    def add_referenced(zip)
+      @manifest.referenced.each do |ref|
+
+        if (ref.file?)
+          zip.add(ref.path_in_extension, ref.path_in_filesystem)
+        elsif (ref.folder?)
+          Dir["#{ref.path_in_filesystem}/**/*"].each do |f|
+            if (File.file?(f))
+              absolute_file = File.expand_path(f)
+              relative_file = absolute_file[(@manifest.folder.length + 1) .. -1]
+              zip.add(relative_file, absolute_file)
+            end
+          end
+        end
+      end
+    end
+
+
+
+  end
+
+end

data/lib/jdt/manifest/bump.rb

@@ -0,0 +1,40 @@
+require "nokogiri"
+
+module Jdt
+
+  class Manifest
+
+    def bump!(type)
+      new_version = bump_version(type, version)
+      @doc.at_css("extension > version").content = new_version
+      update_file_with_doc
+    end
+
+    private
+
+    def update_file_with_doc
+      File.open(file,"w") do |f|
+        f.write(@doc.to_xml)
+      end
+    end
+
+    def bump_version(type, version)
+      new_version = version.split(".").map { |item| item.to_i }
+      if (type == :patch)
+        new_version[2] = new_version[2] + 1
+      elsif (type == :minor)
+        new_version[1] = new_version[1] + 1
+        new_version[2] = 0
+      elsif (type == :major)
+        new_version[0] = new_version[0] + 1
+        new_version[1] = 0
+        new_version[2] = 0
+      else
+        raise RuntimeError("given type (#{type})not found")
+      end
+      new_version.join(".")
+    end
+
+  end
+
+end

data/lib/jdt/manifest/find.rb

@@ -0,0 +1,58 @@
+module Jdt
+
+  class Manifest
+
+    def self.find(path = ".")
+      Manifest.new(ManifestFinder.new(path).find).to_specific
+    end
+
+    def to_specific
+      if(ext_type == "library")
+        LibraryManifest.new(file)
+      else
+        raise RuntimeError("the current type #{ext_type} is not supported")
+      end
+    end
+
+  end
+
+  class NoManifestException < RuntimeError
+
+  end
+
+  class ManifestFinder
+
+    attr_accessor :path
+
+    def initialize(search_path = ".")
+      @path = search_path
+    end
+
+    def find
+      retrieve_manifest_path
+    end
+
+    private
+
+    def retrieve_manifest_path
+
+      # create list of possible files for the manifest
+      manifest_named_after_directory = File.basename(File.expand_path(path))
+      manifest_files = ["#{File.expand_path(path)}/manifest.xml", manifest_named_after_directory]
+
+      # evaluate each possible manifest file
+      manifest_files.each do |file|
+
+        if (File.exists?(file))
+          return file
+        end
+
+      end
+
+      # if no manifest is found, raise error
+      raise NoManifestException, "Manifest not found in current directory"
+    end
+
+  end
+
+end

data/lib/jdt/manifest/library_manifest.rb

@@ -0,0 +1,19 @@
+require "nokogiri"
+
+module Jdt
+  class LibraryManifest < Manifest
+
+    def type
+      "library"
+    end
+
+    def ext_type_short
+      "lib"
+    end
+
+    def library_name
+      @doc.xpath("//extension/libraryname").text
+    end
+
+  end
+end

data/lib/jdt/manifest/manifest.rb

@@ -0,0 +1,29 @@
+require "nokogiri"
+
+module Jdt
+
+  class Manifest
+
+    attr_accessor :file, :doc
+
+    def initialize(path)
+      @file = path
+      @doc = Nokogiri::XML(File.read(file))
+    end
+
+    def to_xml
+      xsl = Nokogiri::XSLT(File.read("#{File.dirname(File.expand_path(__FILE__))}/xslts/pretty_print.xsl"))
+      xsl.transform(@doc).to_s
+    end
+
+    def folder
+      File.dirname(file)
+    end
+
+    def exists?
+      File.exists?(file)
+    end
+
+  end
+
+end

data/lib/jdt/manifest/referenced.rb

@@ -0,0 +1,96 @@
+module Jdt
+
+  class Manifest
+
+    def referenced
+
+      list = []
+
+      # add files and media
+      @doc.css("files","media").each do |files|
+
+        parent_folder = files['folder']
+
+        files.css("filename").each do |file|
+          list << create_file_ref(file.text,parent_folder)
+        end
+
+        files.css("folder").each do |file|
+          list << create_folder_ref(file.text,parent_folder)
+        end
+
+      end
+
+      # scriptfile
+      @doc.css("scriptfile").each do |file|
+        list << create_file_ref(file.text)
+      end
+
+      return list
+    end
+
+    private
+
+    def create_file_ref(path, parent_folder = nil)
+      ref = Referenced.new
+      ref.path = path
+      ref.parent_folder = parent_folder
+      ref.type = :file
+      ref.extension_path = folder
+
+      return ref
+    end
+
+    def create_folder_ref(path, parent_folder = nil)
+      ref = Referenced.new
+      ref.path = path
+      ref.parent_folder = parent_folder
+      ref.type = :folder
+      ref.extension_path = folder
+
+      return ref
+    end
+
+  end
+
+  class Referenced
+    
+    attr_accessor :parent_folder, :path, :type, :extension_path
+
+    def path_in_filesystem
+      "#{extension_path}/#{path_in_extension}"
+    end
+
+    def path_in_extension
+      if (parent_folder and parent_folder != "")
+        "#{parent_folder}/#{path}"
+      else
+        "#{path}"
+      end
+    end
+
+    def file?
+      type == :file
+    end
+
+    def folder?
+      type == :folder
+    end
+
+    def exists?
+      if (file?)
+        File.exists?(path_in_filesystem)
+      elsif (folder?)
+        Dir.exists?(path_in_filesystem)
+      else
+        raise RuntimeError("Neither file nor folder.")
+      end
+    end
+
+    def to_s
+      "Reference to #{type} #{path_in_extension}"
+    end
+
+  end
+
+end

data/lib/jdt/manifest/schemas/library.xsd

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
+           xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="extension">
+    <xs:complexType>
+
+      <xs:choice maxOccurs="unbounded">
+        <xs:element type="xs:string" name="name"/>
+        <xs:element type="xs:string" name="libraryname"/>
+
+        <xs:element type="xs:string" name="version" minOccurs="0"/>
+
+        <xs:element type="xs:string" name="creationDate" minOccurs="0"/>
+        <xs:element type="xs:string" name="homepage" minOccurs="0"/>
+
+        <xs:element type="xs:string" name="author" minOccurs="0"/>
+        <xs:element type="xs:string" name="authorEmail" minOccurs="0"/>
+        <xs:element type="xs:string" name="authorUrl" minOccurs="0"/>
+
+        <xs:element type="xs:string" name="copyright" minOccurs="0"/>
+        <xs:element type="xs:string" name="license" minOccurs="0"/>
+        <xs:element type="xs:string" name="description" minOccurs="0"/>
+
+        <xs:element type="filesType" name="files"/>
+
+        <xs:element type="xs:string" name="scriptfile" minOccurs="0"/>
+
+        <xs:element name="updateservers">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="server" maxOccurs="unbounded" minOccurs="0">
+                <xs:complexType>
+                  <xs:simpleContent>
+                    <xs:extension base="xs:string">
+                      <xs:attribute type="xs:string" name="type" use="optional"/>
+                      <xs:attribute type="xs:string" name="priority" use="optional"/>
+                      <xs:attribute type="xs:string" name="name" use="optional"/>
+                    </xs:extension>
+                  </xs:simpleContent>
+                </xs:complexType>
+              </xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+
+      </xs:choice>
+
+      <xs:attribute name="type">
+        <xs:simpleType>
+          <xs:restriction base="xs:string">
+            <xs:enumeration value="library"/>
+          </xs:restriction>
+        </xs:simpleType>
+      </xs:attribute>
+
+      <xs:attribute type="xs:string" name="version"/>
+
+      <xs:attribute name="method">
+        <xs:simpleType>
+          <xs:restriction base="xs:string">
+            <xs:enumeration value="upgrade"/>
+            <xs:enumeration value="install"/>
+          </xs:restriction>
+        </xs:simpleType>
+      </xs:attribute>
+    </xs:complexType>
+  </xs:element>
+
+
+  <xs:complexType name="filesType">
+    <xs:choice maxOccurs="unbounded">
+      <xs:element type="xs:string" name="filename" minOccurs="0"/>
+      <xs:element type="xs:string" name="folder" minOccurs="0"/>
+    </xs:choice>
+
+    <xs:attribute type="xs:string" name="folder"/>
+  </xs:complexType>
+
+
+</xs:schema>

data/lib/jdt/manifest/schemas/manifest.xsd

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
+           xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="extension" type="extensionType"/>
+  <xs:complexType name="extensionType">
+    <xs:sequence maxOccurs="unbounded">
+      <xs:any processContents="lax"/>
+    </xs:sequence>
+    <xs:attribute name="type">
+      <xs:simpleType>
+        <xs:restriction base="xs:string">
+          <xs:enumeration value="component"/>
+          <xs:enumeration value="module"/>
+          <xs:enumeration value="plugin"/>
+          <xs:enumeration value="library"/>
+          <xs:enumeration value="template"/>
+          <xs:enumeration value="language"/>
+          <xs:enumeration value="package"/>
+        </xs:restriction>
+      </xs:simpleType>
+    </xs:attribute>
+    <xs:attribute type="xs:string" name="version"/>
+    <xs:attribute name="method">
+      <xs:simpleType>
+        <xs:restriction base="xs:string">
+          <xs:enumeration value="upgrade"/>
+          <xs:enumeration value="install"/>
+        </xs:restriction>
+      </xs:simpleType>
+    </xs:attribute>
+  </xs:complexType>
+</xs:schema>