jdt 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+.idea
+# ignore this
+/pkg/
+*.gem
+/tmp/
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Here come the changes that were made by specific versions

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in jdt.gemspec
+gemspec
+
+gem "thor"
+gem "rspec"
+gem "nokogiri"
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    jdt (0.0.2)
+      nokogiri
+      rubyzip
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.4.6)
+      bcat (>= 0.6.1)
+      childprocess (>= 0.2.0)
+      cucumber (>= 1.0.2)
+      rspec (>= 2.6.0)
+    bcat (0.6.1)
+      rack (~> 1.0)
+    builder (3.0.0)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    cucumber (1.0.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.4.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.3)
+    ffi (1.0.9-java)
+    ffi (1.0.9-x86-mingw32)
+    gherkin (2.4.18-java)
+      json (>= 1.4.6)
+    gherkin (2.4.18-x86-mingw32)
+      json (>= 1.4.6)
+    json (1.5.4)
+    json (1.5.4-java)
+    nokogiri (1.5.0-java)
+    nokogiri (1.5.0-x86-mingw32)
+    rack (1.3.2)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rubyzip (0.9.4)
+    term-ansicolor (1.0.6)
+    thor (0.14.6)
+
+PLATFORMS
+  java
+  x86-mingw32
+
+DEPENDENCIES
+  aruba
+  cucumber
+  jdt!
+  nokogiri
+  rake
+  rspec
+  thor

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Feki.de e.V.
+
+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/README.md

@@ -0,0 +1,101 @@
+# Abstract
+The **Joomla Development Tool** (short: **jdt**) is a command line tool to easen the development of extensions for [Joomla! CMS](http://www.joomla.org/). It tries to bring the command line facilities of other famous web frameworks like [Rails](http://rubyonrails.org/) to [Joomla!](http://www.joomla.org/).
+
+# Features
+
+- `status` (shows the current extension type, name, version, author, etc.)
+- `new TYPE NAME` (bootstraps a Joomla! extension, e.g. a component)
+- `version`  (version of the JDT)
+- `build` (creates zip file for deployment, with timestamp)
+- `release` (creates zip file for deployment)
+- `bump` (increments either --patch, --minor or --major version, --patch is default)
+
+(NOT YET IMPLEMENTED)
+
+- `clean` (removes the `/zip` and the `/.jdt` directories)
+- `install` (installs the extension at a Joomla! instance)
+- `uninstall` (uninstalls the extension from a Joomla! instance)
+- `install-jdump` (installs JDump at a Joomla! instance)
+- `uninstall-jdump` (uninstall JDump from a Joomla! instance)
+- `sync` (copy the files to a local Joomla! installation, once or continously)
+- `scaffold` (create models, controllers, views with default data)
+- `test` (executes unit and integration tests)
+- `xampp` (starts and stops xampp, open Joomla in browser)
+- `open` (open the Extension in Browser)
+
+# Are additional files being created within my extension?
+
+Yes.
+
+* `/zip` stores your deployable zip files of your extension
+* `/.jdt` caches deployment information (NOT YET IMPLEMENTED)
+
+However, these can be deleted by issuing the `jdt clean` command. (NOT YET IMPLEMENTED)
+
+# Can I use it for Joomla 1.5 development?
+No, only Joomla 1.6 development is supported. This is due to the change of the manifest structure.   
+
+# Installation Instructions
+
+(NOT YET IMPLEMENTED)
+
+The installation is pretty simple. You need either [JRuby](http://www.jruby.org) oder [Ruby](http://www.ruby-lang.org). After that, you can easily install the JDT using the following command:
+
+1. `gem install jdt`
+
+The tool is then useable in the command line using `$> jdt`
+
+# Development Instructions
+
+Make sure that you have [RubyGems](https://rubygems.org/) 1.8.9 installed (gem update --system 1.8.9).
+
+1. clone the repository
+
+    `git clone https://www.github.com/simonharrer/joomlatools.git`
+
+2. install the following gems: [ZenTest](https://github.com/seattlerb/zentest), [gem-release](https://github.com/svenfuchs/gem-release), [bundler](http://gembundler.com/)
+
+    * `gem install ZenTest`
+    * `gem install gem-release`
+    * `gem install bundle`
+
+3. `bundle` (installs all required gems defined by the gem specification)
+4. `autotest` (to execute the tests, continously)
+
+## Testing
+Testing is done using cucumber with aruba for testing the command line interface.
+
+### Acceptance and Integration Tests
+The acceptance and integration tests are specified using the [`gherkin`](https://github.com/cucumber/cucumber/wiki/Gherkin) language and executed using [`cucumber`](https://github.com/cucumber/cucumber).
+They are located within the `features` folder and can be executed using `cucumber features` from within the root directory of the JDT.
+
+The tests are written to only work in specific cases:
+
+* the gem has to be installed locally using `rake install` from within the JDT directory
+* the tests only work using Windows. If you have a posix system, it would work if you simply replace all jdt.bat with jdt. TODO implement logic in cucumber using before and after to ensure that the command is correct
+
+### Unit Tests
+The unit tests are implemented using [`rspec`](https://github.com/rspec/rspec).
+They are located within the `spec` folder and can be executed using `rspec spec` from within the root directory of the JDT.
+
+
+## Technical Runtime Details
+
+It is written with Ruby 1.8.7 ontop of several libraries:
+
+* [`thor`](https://github.com/wycats/thor) to provide the command line commands
+* [`nokogiri`](http://nokogiri.org/) to read the manifest xml file per Joomla! extension
+* [`rubyzip`](http://rubyzip.sourceforge.net/) to create zip files as deployable artifacts
+
+## Releasing
+
+* make sure that everything is commited
+* `gem bump` this increases the version number
+* `gem release` this creates the gem and pushes it to [RubyGems](https://rubygems.org/)
+
+## Installing locally
+
+Make sure you have the gem `rake` and `gem-release` installed. Then execute `rake install` to install it locally. This automatically builds the gem and installs it over the current local installation of the gem.
+
+# Joomla Versions
+This tool solely supports **Joomla! 1.7**, as older versions do have much more ambiquity within their manifest.xml files.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/jdt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'jdt' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('jdt', 'jdt')

data/features/manifest.feature

@@ -0,0 +1,25 @@
+Feature: Manifest
+
+  Scenario: Not within an extension
+    Given the current directory is no extension directory
+    When I run `jdt.bat manifest`
+    Then the output should contain exactly "No manifest found\n"
+
+  Scenario: Success
+    Given a file named "manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension type="library" version="1.7.0" method="upgrade">
+  <name>activerecord</name>
+  <version>1.0.0</version>
+</extension>
+    """
+    When I run `jdt.bat manifest`
+    Then the output should contain exactly:
+"""
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="library" version="1.7.0">
+  <name>activerecord</name>
+  <version>1.0.0</version>
+</extension>
+"""

data/features/new.feature

@@ -0,0 +1,97 @@
+Feature: new
+
+  Scenario: Create library
+    When I run `jdt new library test`
+    Then a directory named "lib_test" should exist
+    And a file named "test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="library" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+  <libraryname>test</libraryname>
+  
+</extension>
+    """
+    And a file named "test/test.php" with:
+    """
+
+    """
+
+  Scenario: Create plugin
+    When I run `jdt new plugin test`
+    Then a directory named "plg_test" should exist
+    And a file named "test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="library" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+  <libraryname>test</libraryname>
+
+</extension>
+    """
+    And a file named "test/test.php" with:
+    """
+
+    """
+
+  Scenario: Create template
+    When I run `jdt new template test`
+    Then a directory named "tpl_test" should exist
+    And a file named "tpl_test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="template" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+</extension>
+    """
+
+  Scenario: Create language
+    When I run `jdt new language test`
+    Then a directory named "lang_test" should exist
+    And a file named "lang_test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="language" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+</extension>
+    """
+
+  Scenario: Create module
+    When I run `jdt new module test`
+    Then a directory named "mod_test" should exist
+    And a file named "mod_test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="module" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+</extension>
+    """
+
+  Scenario: Create component
+    When I run `jdt new component test`
+    Then a directory named "com_test" should exist
+    And a file named "com_test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="module" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+</extension>
+    """
+
+  Scenario: Create package
+     When I run `jdt new package test`
+    Then a directory named "pkg_test" should exist
+    And a file named "pkg_test/manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension method="upgrade" type="package" version="1.7.0">
+  <name>test</name>
+  <version>0.0.1</version>
+</extension>
+    """

data/features/release.feature

@@ -0,0 +1,47 @@
+Feature: release
+
+  In order to obtain a deployable zip file of the extension
+  I as a CLI
+
+
+  Scenario: Not within an extension
+    Given the current directory is no extension directory
+    When I run `jdt.bat release`
+    Then the output should contain exactly "No manifest found\n"
+
+    
+  Scenario: Success
+    Given a file named "manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension type="library" version="1.7.0" method="upgrade">
+
+  <name>activerecord</name>
+  <version>0.0.1</version>
+
+  <files>
+    <filename>README</filename>
+    <folder>lib</folder>
+  </files>
+
+</extension>
+    """
+    And a file named "README" with:
+    """
+    test
+    """
+    And an empty file named "CHANGELOG"
+    And a directory named "lib"
+    And an empty file named "lib/test.php"
+    And a directory named "zip" should not exist
+
+    When I run `jdt.bat release`
+
+    Then a directory named "zip" should exist
+    And a file named "zip/lib_activerecord-v0.0.1.zip" should exist
+    And a file named "README" should exist within a zip file "zip/lib_activerecord-v0.0.1.zip" with:
+    """
+    test
+    """
+    And a file named "CHANGELOG" should not exist within a zip file "zip/lib_activerecord-v0.0.1.zip"
+    And a file named "lib/test.php" should exist within a zip file "zip/lib_activerecord-v0.0.1.zip"

data/features/status.feature

@@ -0,0 +1,22 @@
+Feature: Status
+
+  In order to know which extension with what version is currently edited
+  As a CLI
+  I want to obtain the name, type and version of the extension
+
+  Scenario: Not within an extension
+    Given the current directory is no extension directory
+    When I run `jdt.bat status`
+    Then the output should contain exactly "No manifest found\n"
+
+  Scenario: Status success
+    Given a file named "manifest.xml" with:
+    """
+<?xml version="1.0" encoding="UTF-8"?>
+<extension type="library" version="1.7.0" method="upgrade">
+  <name>activerecord</name>
+  <version>1.0.0</version>
+</extension>
+      """
+    When I run `jdt.bat status`
+    Then the output should contain exactly "Extension lib_activerecord-v1.0.0\n"

data/features/step_definitions/my_steps.rb

@@ -0,0 +1,37 @@
+require "aruba/api"
+require "zip/zipfilesystem"
+
+
+Given /^the current directory is no extension directory$/ do
+  # do nothing, just use default directory
+end
+
+When /^a file named "([^"]*)" should exist within a zip file "([^"]*)"$/ do |file, zip|
+
+  Zip::ZipFile.open(File.join(current_dir,zip)) do |zip_file|
+    expect {
+      zip_file.get_entry(file)
+    }.to_not raise_error(Errno::ENOENT)
+  end
+
+end
+
+When /^a file named "([^"]*)" should not exist within a zip file "([^"]*)"$/ do |file, zip|
+
+  Zip::ZipFile.open(File.join(current_dir,zip)) do |zip_file|
+    expect {
+      zip_file.get_entry(file)
+    }.to raise_error(Errno::ENOENT)
+  end
+
+end
+
+When /^a file named "([^"]*)" should exist within a zip file "([^"]*)" with:$/ do |file, zip, file_content|
+
+  Zip::ZipFile.open(File.join(current_dir,zip)) do |zip_file|
+    expect {
+      zip_file.read(file).should eq(file_content)
+    }.to_not raise_error(Errno::ENOENT)
+  end
+
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require "aruba"
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+Before do
+  @aruba_timeout_seconds = 20
+end

data/features/support/setup.rb

@@ -0,0 +1,2 @@
+require "aruba/cucumber"
+

data/features/version.feature

@@ -0,0 +1,9 @@
+Feature: Version
+
+  In order to detect, which version is installed
+  As a CLI
+  I want to obtain the current version
+
+  Scenario: Display current version
+    When I run `jdt.bat version`
+    Then the output should contain exactly "0.0.2\n"

data/jdt.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jdt/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jdt"
+  s.version = Jdt::VERSION
+  s.authors = ['Simon Harrer', 'Andreas Vorndran']
+  s.email = ['simon.harrer@feki.de','andreas.vorndran@feki.de']
+  s.homepage = 'http://github.com/simonharrer/joomlatools'
+  s.summary = %q{A command line tool for developing Joomla Extensions}
+  s.description = %q{A command line tool to help developing Joomla Extensions. }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "nokogiri"
+  s.add_dependency "thor"
+  s.add_dependency "rubyzip"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+end

data/lib/jdt/cli.rb

@@ -0,0 +1,34 @@
+require "thor"
+
+require "jdt/commands/build"
+require "jdt/commands/bump"
+require "jdt/commands/install"
+require "jdt/commands/new"
+require "jdt/commands/pretty_print"
+#require "jdt/commands/secure"
+require "jdt/commands/status"
+require "jdt/commands/validate"
+require "jdt/commands/version"
+
+require "jdt/manifest"
+require "jdt/generator"
+
+module Jdt
+
+  class CLI < Thor
+
+    no_tasks {
+      def handle_errors(&block)
+        begin
+          yield
+        rescue NoManifestException
+          say "No manifest found"
+        end
+      end
+    }
+
+  end
+
+
+
+end

data/lib/jdt/commands/build.rb

@@ -0,0 +1,28 @@
+require 'thor'
+
+module Jdt
+
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "build", "creates a zip stored under /zip with a timestamp"
+    method_options :location => "."
+
+    def build
+      handle_errors do
+        say "Build created at: #{Manifest.find(options[:location]).build}"
+      end
+    end
+
+    desc "release", "creates a zip stored under /zip"
+    method_options :location => "."
+
+    def release
+      handle_errors do
+        say "Release created at: #{Manifest.find(options[:location]).release}"
+      end
+    end
+
+  end
+
+end

data/lib/jdt/commands/bump.rb

@@ -0,0 +1,37 @@
+require "thor"
+
+module Jdt
+
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "bump", "bumps version incrementing the patch version counter (major.minor.patch)"
+    method_options :major => false
+    method_options :minor => false
+    method_options :location => "."
+
+    def bump
+      handle_errors do
+        # find manifest
+        manifest = Manifest.find(options[:location])
+
+        # determine what is to be bumped
+        if (options.major?)
+          bump_option = :major
+        elsif (options.minor?)
+          bump_option = :minor
+        else
+          bump_option = :patch
+        end
+
+        # bump
+        manifest.bump!(bump_option)
+
+        # inform user
+        say "Bumped version to #{manifest.version} (bumped #{bump_option.to_s})"
+      end
+    end
+
+  end
+
+end

data/lib/jdt/commands/install.rb

@@ -0,0 +1,20 @@
+require "thor"
+
+module Jdt
+
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "install", "installs the extension at an active Joomla! system"
+    method_options :location => "."
+
+    def install
+      handle_errors do
+        manifest = Manifest.find(options[:location])
+      end
+
+    end
+
+  end
+
+end

data/lib/jdt/commands/new.rb

@@ -0,0 +1,31 @@
+require 'thor'
+require 'nokogiri'
+
+module Jdt
+
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "new TYPE NAME", "creates a stub of TYPE with NAME"
+    method_options :location => "."
+
+    def new(type, name)
+
+      handle_errors do
+
+        begin
+          generator = Generator.find(type.to_sym, name)
+          generator.location = options[:location]
+          generator.generate
+        rescue Jdt::ExtensionTypeNotFoundError
+          say("Given type is no Joomla extension type. Chose one of the available Joomla extension types:")
+          say("Extension types: #{Generator::GENERATORS.join(" ")}")
+        end
+
+      end
+      
+    end
+
+  end
+
+end