jdt 0.0.2 → 0.0.3

data/lib/jdt/generator/generator.rb

@@ -1,261 +1,52 @@
 require 'thor'
+require 'thor/actions'
 require 'date'
 require 'nokogiri'
 
 module Jdt
 
-  class ExtensionTypeNotFoundError < RuntimeError;
-  end
-
   class Generator < Thor
     include Thor::Actions
 
-    # include templates directory
-    def self.source_root
-      File.dirname(__FILE__)
-    end
-
     attr_accessor :name, :author, :description, :creation_date, :location
 
-    def initialize(name)
+    desc "generate NAME", "generate using name"
+
+    def generate(name)
+
+      # set up variables with default values
       @name = name
       @version = "0.0.1"
       @author = "AUTHOR"
       @description = "DESCRIPTION"
       @creation_date = "#{Date::MONTHNAMES[Time.now.month]} #{Time.now.year}"
       @location = "."
-    end
 
-    no_tasks{
-    def generate
-      # create directory
+      # create directory and files which every extension needs
       empty_directory(prefixed_name)
-
-      # TODO create README, LICENSE, CHANGELOG
-    end
-
-    def type
-      throw NoMethodError
-    end
-
-    def type_short
-      throw NoMethodError
+      template("README.erb", "#{prefixed_name}/README")
+      #template("LICENSE.erb", "#{prefixed_name}/LICENSE")
+      template("CHANGELOG.erb", "#{prefixed_name}/CHANGELOG")
+      template("manifest.xml.erb", "#{prefixed_name}/manifest.xml")
     end
 
-    def self.find(type, name)
 
-      if (type == :component)
-        ComponentGenerator.new(name)
-      elsif(type == :module)
-        ModuleGenerator.new(name)
-      elsif(type == :plugin)
-        PluginGenerator.new(name)
-      elsif(type == :library)
-        LibraryGenerator.new(name)
-      elsif(type == :template)
-        TemplateGenerator.new(name)
-      elsif(type == :language)
-        LanguageGenerator.new(name)
-      else
-        raise ExtensionTypeNotFoundError
+    no_tasks {
+      def type
+        throw NoMethodError
       end
 
-    end
-
-    def prefixed_name
-      "#{type_short}_#{name}"
-    end
-
-    def folder
-      "#{location}/#{prefixed_name}"
-    end
-    }
-  end
-
-  class LanguageGenerator < Generator
-    no_tasks{
-    def generate
-      super
-
-    end
-
-    def type
-      "language"
-    end
-
-    def type_short
-      "lang"
-    end
-    }
-  end
-
-  class TemplateGenerator < Generator
-    no_tasks{
-    def generate
-      super
-
-      #create empty directory
-      empty_directory("#{folder}/css")
-      empty_directory("#{folder}/html")
-      empty_directory("#{folder}/images")
-    end
-
-    def type
-      "template"
-    end
-
-    def type_short
-      "tpl"
-    end
-    }
-  end
-
-  class LibraryGenerator < Generator
-    no_tasks{
-    def generate
-      super
-    end
-
-    def type
-      "library"
-    end
-
-    def type_short
-      "lib"
-    end
-    }
-  end
-
-  class PluginGenerator < Generator
-    no_tasks{
-    def generate
-      super
-
-      # create files
-      template("templates/plugin/manifest.xml.erb", "#{folder}/#{prefixed_name}.xml")
-      template("templates/plugin/main.php.erb", "#{folder}/#{prefixed_name}.php")
-    end
-
-    def type
-      "plugin"
-    end
-
-    def type_short
-      "plg"
-    end
-    }
-  end
-
-  class ModuleGenerator < Generator
-    no_tasks{
-    def generate
-      super
-
-      # create sub directories
-      empty_directory("#{folder}/tmpl")
-
-      # create files
-      template("templates/module/manifest.xml.erb", "#{folder}/#{prefixed_name}.xml")
-      template("templates/module/mod_name.php.erb", "#{folder}/#{prefixed_name}.php")
-      template("templates/module/helper.php.erb", "#{folder}/helper.php")
-      template("templates/module/tmpl/default.php.erb", "#{folder}/tmpl/default.php")
-    end
-
-    def type
-      "module"
-    end
-
-    def type_short
-      "mod"
-    end
-    }
-  end
-
-  class ComponentGenerator < Generator
-    no_tasks{
-    def generate
-      super
-
-      view_name = "#{name}"
-
-      empty_directory("#{folder}")
-      template('templates/component/manifest.xml.erb', "#{folder}/manifest.xml")
-      template('templates/component/script.php.erb', "#{folder}/script.php")
-
-      # site
-      site_dir = "#{folder}/site"
-      empty_directory("#{site_dir}")
-      template('templates/component/site/com_name.php.erb', "#{site_dir}/#{prefixed_name}.php")
-      template('templates/component/site/controller.php.erb', "#{site_dir}/controller.php")
-
-      #site view
-      empty_directory("#{site_dir}/views/")
-      empty_directory("#{site_dir}/views/#{view_name}")
-      template('templates/component/site/views/view_name/view.html.erb', "#{site_dir}/views/#{view_name}/view.html.php")
-      empty_directory("#{site_dir}/views/#{view_name}/tmpl")
-      template('templates/component/site/views/view_name/tmpl/default.php.erb', "#{site_dir}/views/#{view_name}/tmpl/default.php")
-      template('templates/component/site/views/view_name/tmpl/default.xml.erb', "#{site_dir}/views/#{view_name}/tmpl/default.xml")
-
-      #site models
-      empty_directory("#{site_dir}/models/")
-      template('templates/component/site/models/com_model_name.erb', "#{site_dir}/models/com_#{name}.php")
-
-      #site controllers
-      empty_directory("#{site_dir}/controllers/")
-
-      #site language
-      empty_directory("#{site_dir}/language/")
-      empty_directory("#{site_dir}/language/en-GB/")
-      empty_directory("#{site_dir}/language/de-DE/")
-
-      # admin
-      admin_dir = "#{folder}/admin"
-      empty_directory("#{admin_dir}")
-      template('templates/component/admin/access.xml.erb', "#{admin_dir}/access.xml")
-      template('templates/component/admin/config.xml.erb', "#{admin_dir}/config.xml")
-      template('templates/component/admin/com_name.php.erb', "#{admin_dir}/com_#{name}.php")
-      template('templates/component/admin/controller.php.erb', "#{admin_dir}/controller.php")
-
-      #admin views
-      empty_directory("#{admin_dir}/views/")
-      empty_directory("#{admin_dir}/views/#{view_name}")
-      template('templates/component/admin/views/view_name/view.html.erb', "#{admin_dir}/views/#{view_name}/view.html.php")
-      empty_directory("#{admin_dir}/views/#{view_name}/tmpl")
-      template('templates/component/admin/views/view_name/tmpl/default.php.erb', "#{admin_dir}/views/#{view_name}/tmpl/default.php")
-
-      #admin models
-      empty_directory("#{admin_dir}/models/")
-      empty_directory("#{admin_dir}/models/forms/")
-      empty_directory("#{admin_dir}/models/rules/")
-      empty_directory("#{admin_dir}/models/fields/")
-
-      #admin controllers
-      empty_directory("#{admin_dir}/controllers/")
-
-      #admin helpers
-      empty_directory("#{admin_dir}/helpers/")
-
-      #admin tables
-      empty_directory("#{admin_dir}/tables/")
-
-      #admin language
-      empty_directory("#{admin_dir}/language/")
-      empty_directory("#{admin_dir}/language/en-GB/")
-      empty_directory("#{admin_dir}/language/de-DE/")
-
-      #admin sql
-      empty_directory("#{admin_dir}/sql/")
-      empty_directory("#{admin_dir}/sql/updates/")
-
-    end
+      def type_short
+        throw NoMethodError
+      end
 
-    def type
-      "component"
-    end
+      def prefixed_name
+        "#{type_short}_#{name}"
+      end
 
-    def type_short
-      "com"
-    end
+      def folder
+        "#{location}/#{prefixed_name}"
+      end
     }
   end
 

data/lib/jdt/generator/language_generator.rb

@@ -0,0 +1,21 @@
+module Jdt
+
+  class LanguageGenerator < Generator
+
+    def generate(name)
+      super
+
+    end
+
+    no_tasks {
+      def type
+        "language"
+      end
+
+      def type_short
+        "lang"
+      end
+    }
+  end
+
+end

data/lib/jdt/generator/library_generator.rb

@@ -0,0 +1,29 @@
+module Jdt
+
+
+  class LibraryGenerator < Generator
+
+    # include templates directory
+    def self.source_root
+      "#{File.dirname(__FILE__)}/templates/library"
+    end
+
+    def generate(name)
+      super
+
+      empty_directory("#{prefixed_name}/lib")
+      template("entry.php","#{prefixed_name}/#{prefixed_name}.php")
+    end
+
+    no_tasks {
+      def type
+        "library"
+      end
+
+      def type_short
+        "lib"
+      end
+    }
+  end
+
+end

data/lib/jdt/generator/module_generator.rb

@@ -0,0 +1,29 @@
+module Jdt
+
+  class ModuleGenerator < Generator
+
+    def generate(name)
+      super
+
+      # create sub directories
+      empty_directory("#{folder}/tmpl")
+
+      # create files
+      template("templates/module/manifest.xml.erb", "#{folder}/#{prefixed_name}.xml")
+      template("templates/module/mod_name.php.erb", "#{folder}/#{prefixed_name}.php")
+      template("templates/module/helper.php.erb", "#{folder}/helper.php")
+      template("templates/module/tmpl/default.php.erb", "#{folder}/tmpl/default.php")
+    end
+
+    no_tasks {
+      def type
+        "module"
+      end
+
+      def type_short
+        "mod"
+      end
+    }
+  end
+
+end

data/lib/jdt/generator/plugin_generator.rb

@@ -0,0 +1,24 @@
+module Jdt
+
+  class PluginGenerator < Generator
+
+    def generate(name)
+      super
+
+      # create files
+      template("templates/plugin/manifest.xml.erb", "#{folder}/#{prefixed_name}.xml")
+      template("templates/plugin/main.php.erb", "#{folder}/#{prefixed_name}.php")
+    end
+
+    no_tasks {
+      def type
+        "plugin"
+      end
+
+      def type_short
+        "plg"
+      end
+    }
+  end
+
+end

data/lib/jdt/generator/template_generator.rb

@@ -0,0 +1,25 @@
+module Jdt
+
+  class TemplateGenerator < Generator
+
+    def generate(name)
+      super
+
+      #create empty directory
+      empty_directory("#{folder}/css")
+      empty_directory("#{folder}/html")
+      empty_directory("#{folder}/images")
+    end
+
+    no_tasks {
+      def type
+        "template"
+      end
+
+      def type_short
+        "tpl"
+      end
+    }
+  end
+
+end

data/lib/jdt/generator/templates/library/README.erb

@@ -0,0 +1,7 @@
+
+
+# Description
+
+# Installation
+
+# Frequently Asked Questions

data/lib/jdt/generator/templates/library/entry.php.erb

@@ -0,0 +1,4 @@
+<?PHP
+    /*
+     * This files is the entry file of the library <%= @name %>
+     */

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

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<extension type="library" version="1.7.0" method="upgrade">
+
+	<name><%= @name %></name>
+	<version><%= @version %></version>
+
+	<creationDate><%= @creation_date %></creationDate>
+	<homepage>https://www.github.com/simonharrer/activerecord</homepage>
+	<description><%= @description %></description>
+	
+	<!-- optional attributes
+	<author><%= @author %></author>
+	<authorEmail>email.to@author.com</authorEmail>
+    <authorUrl>http://www.url.to/author</authorUrl>
+
+    <license>LICENSE</license>
+    <copyright>COPYRIGHT</copyright>
+    -->
+
+    <!-- Library specific attributes -->
+	<libraryname><%= @libraryname %></libraryname>
+
+    <!-- Copy Section -->
+    <files>
+        <filename><%= @name %>.php</filename>
+        <filename>README</filename>
+        <filename>CHANGELOG</filename>
+        <folder>lib</folder>
+    </files>
+
+
+</extension>

data/lib/jdt/generator.rb

@@ -1 +1,7 @@
-require "jdt/generator/generator"
+require "jdt/generator/generator"
+require "jdt/generator/component_generator"
+require "jdt/generator/language_generator"
+require "jdt/generator/library_generator"
+require "jdt/generator/module_generator"
+require "jdt/generator/plugin_generator"
+require "jdt/generator/template_generator"

data/lib/jdt/manifest/build.rb

@@ -22,28 +22,18 @@ module Jdt
 
     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
+      zip_file_name = zip_file_name(type)
 
       # ensure that the file does not exist
-      if (File.exists?(zip_file_name))
-        File.delete(zip_file_name)
-      end
+      ensure_zip_file_does_not_exist(zip_file_name)
 
       # ensure that directory exists
-      dir = File.dirname(zip_file_name)
-      if(not File.directory?(dir))
-        Dir.mkdir(dir)
-      end
+      ensure_zip_dir_exists(zip_file_name)
 
       # create zip file
       Zip::ZipFile.open(zip_file_name, Zip::ZipFile::CREATE) do |zos|
         add_files_to_zip(zos)
+        add_index_html_to_every_dir(zos)
       end
 
       # return zip file
@@ -52,6 +42,30 @@ module Jdt
 
     private
 
+    def ensure_zip_dir_exists(zip_file_name)
+      dir = File.dirname(zip_file_name)
+      if (not File.directory?(dir))
+        Dir.mkdir(dir)
+      end
+    end
+
+    def ensure_zip_file_does_not_exist(zip_file_name)
+      if (File.exists?(zip_file_name))
+        File.delete(zip_file_name)
+      end
+    end
+
+    def zip_file_name(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
+      zip_file_name
+    end
+
     def zip_folder
       "#{@manifest.folder}/zip"
     end
@@ -68,7 +82,7 @@ module Jdt
       Time.now.strftime("%Y%m%d%H%M%S%L")
     end
 
-     def add_files_to_zip(zip)
+    def add_files_to_zip(zip)
 
       # add manifest
       add_manifest(zip)
@@ -99,7 +113,35 @@ module Jdt
       end
     end
 
+    def add_index_html_to_every_dir(zos)
+      # TODO add a index.html file containing only the line <html><body bgcolor="#FFFFFF"></body></html> at every directory within the zip file
+    end
+
+  end
 
+  class IndexCreater
+    include Thor::Actions
+
+    def initialize (path)
+      @path = path
+    end
+
+    def create_index
+      create_index_recursive(@path)
+    end
+
+    private
+
+    def create_index_recursive (path)
+      template('/templates/component/index.html.erb', "#{path}/index.html")
+      Dir.chdir("#{path}") do
+        Dir.glob("*").each do |dir|
+          if File.directory?(dir)
+            create_index_recursive("#{path}/#{dir}")
+          end
+        end
+      end
+    end
 
   end
 

data/lib/jdt/manifest/find.rb

@@ -1,3 +1,5 @@
+require "pathname"
+
 module Jdt
 
   class Manifest
@@ -7,7 +9,7 @@ module Jdt
     end
 
     def to_specific
-      if(ext_type == "library")
+      if (ext_type == "library")
         LibraryManifest.new(file)
       else
         raise RuntimeError("the current type #{ext_type} is not supported")
@@ -36,9 +38,26 @@ module Jdt
 
     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]
+      manifest_files = []
+
+      Pathname.new(File.expand_path(path)).ascend do |current_path|
+
+        # create list of possible files for the manifest
+        current_folder = current_path
+        current_folder_name = File.basename(current_folder)
+
+        manifest_named_after_directory = "#{current_folder}/#{current_folder_name}.xml"
+        manifest_with_fixed_name = "#{current_folder}/manifest.xml"
+        manifest_files << manifest_with_fixed_name
+        manifest_files << manifest_named_after_directory
+
+        if (current_folder_name.include? "_")
+          folder_name_without_prefix = current_folder_name.split("_")[1..-1].join("_")
+
+          manifest_files << "#{current_folder}/#{folder_name_without_prefix}.xml"
+        end
+
+      end
 
       # evaluate each possible manifest file
       manifest_files.each do |file|

data/lib/jdt/manifest/secure.rb

@@ -5,33 +5,9 @@ module Jdt
   class Manifest
 
     def secure
-      
-    end
-
-  end
-
-  class IndexCreater
-    include Thor::Actions
-
-    def initialize (path)
-      @path = path
-    end
-
-    def create_index
-      create_index_recursive(@path)
-    end
-
-    private
-
-    def create_index_recursive (path)
-      template('/templates/component/index.html.erb', "#{path}/index.html")
-      Dir.chdir("#{path}") do
-        Dir.glob("*").each do |dir|
-          if File.directory?(dir)
-            create_index_recursive("#{path}/#{dir}")
-          end
-        end
-      end
+      "do nothing"
+      # TODO check if every file with the ending .php contains the line::::: defined('_JEXEC') or die('Restricted access');
+      # TODO if not, insert this directly after the line containing <?php within the file, including the comment: //No direct access to this file and print which files have been changed.   
     end
 
   end