terrimporter 0.4.0 → 0.5.4

data/lib/terrimporter.rb

@@ -1,51 +1,55 @@
 require 'shellwords'
-require 'options'
-require 'importer'
+require 'terrimporter/version'
+require 'terrimporter/app_logger'
+require 'terrimporter/options'
+require 'terrimporter/importer'
+require 'terrimporter/config_helper'
+require 'terrimporter/config_validator'
+require 'terrimporter/configuration'
+require 'terrimporter/downloader'
 
 module TerrImporter
   class Application
     class << self
       include Shellwords
+      include ConfigHelper
 
       def run!(*arguments)
         options = build_options(arguments)
 
-        if options[:init]
-          #todo the config path can be differen in importer, extract to special class for loading and managing
-          #todo raise error instead of puts and exit
-          if File.exists?(File.join(Dir.pwd, CONFIG_DEFAULT_NAME))
-          puts "Configuration already existing, use the force option to override"
-            return 1
+        begin
+          unless options[:init].nil?
+            if config_working_directory_exists? and options[:init] != :backup and options[:init] != :replace
+              raise TerrImporter::ConfigurationError, "Configuration already exists, use the override or backup option"
+            end
+            create_config_file
+            return 0
           end
-          create_config
-          return 0
-        end
 
-        if options[:invalid_argument]
-          $stderr.puts options[:invalid_argument]
-          options[:show_help] = true
-        end
+          if options[:invalid_argument]
+            $stderr.puts options[:invalid_argument]
+            options[:show_help] = true
+          end
 
-        if options[:show_help]
-          $stderr.puts options.opts
-          return 1
-        end
+          if options[:show_help]
+            $stderr.puts options.opts
+            return 1
+          end
 
-        #if options[:input_file].nil?
-        #  $stderr.puts options.opts
-        #  return 1
-        #end
+          if options[:show_version]
+            puts TerrImporter::VERSION
+            return 0
+          end
 
-        begin
-          importer = TerrImporter::Importer.new(options)
+          importer = TerrImporter::Application::Importer.new(options)
           importer.run
           return 0
         rescue TerrImporter::ConfigurationError
           $stderr.puts %Q{Configuration Error #{ $!.message }}
+          return 1
         rescue TerrImporter::DefaultError
           $stderr.puts %Q{Unspecified Error #{ $!.message }}
           return 1
-
         end
       end
 

data/tasks/load_tasks.rb

@@ -0,0 +1,3 @@
+require 'rake'
+
+Dir["#{File.dirname(__FILE__)}/*.rake"].sort.each { |ext| load ext }

data/tasks/version.rake

@@ -0,0 +1,2 @@
+
+

data/terrimporter.gemspec

@@ -4,7 +4,7 @@ require "terrimporter/version"
 
 Gem::Specification.new do |s|
   s.name        = "terrimporter"
-  s.version     = Terrimporter::VERSION
+  s.version     = TerrImporter::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Kummer"]
   s.email       = ["daniel.kummer@gmail.com"]
@@ -17,13 +17,16 @@ Gem::Specification.new do |s|
   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.require_paths = ["lib", "tasks"]
 
-  s.add_dependency "kwalify"
+  s.default_executable = 'bin/terrimporter'
+
+  s.add_dependency "kwalify", [">= 0.7.2"]
 
   s.add_development_dependency "shoulda", [">= 0"]
   s.add_development_dependency "bundler", ["~> 1.0.0"]
-  s.add_development_dependency "jeweler", ["~> 1.6.4"]
+  s.add_development_dependency "rake", [">= 0"]
   s.add_development_dependency "rcov", [">= 0"]
+  s.add_development_dependency "fakeweb"
 
 end

data/test/fixtures/css/base.css

@@ -0,0 +1 @@
+This is the base.css file

data/test/fixtures/css/ie.css

@@ -0,0 +1 @@
+This is the ie.css file

data/test/fixtures/html/img_backgrounds_dir.html

@@ -0,0 +1,43 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+    <title>Index of /img/backgrounds</title>
+</head>
+<body>
+<h1>Index of /img/backgrounds</h1>
+<table>
+    <tr>
+        <th><img src="/icons/blank.gif" alt="[ICO]"></th>
+        <th><a href="?C=N;O=D">Name</a></th>
+        <th><a href="?C=M;O=A">Last modified</a></th>
+        <th><a href="?C=S;O=A">Size</a></th>
+        <th><a href="?C=D;O=A">Description</a></th>
+    </tr>
+    <tr>
+        <th colspan="5">
+            <hr>
+        </th>
+    </tr>
+
+    <tr>
+        <td valign="top"><img src="/icons/back.gif" alt="[DIR]"></td>
+        <td><a href="/img/">Parent Directory</a></td>
+        <td>&nbsp;</td>
+        <td align="right"> -</td>
+        <td>&nbsp;</td>
+    </tr>
+    <tr>
+        <td valign="top"><img src="/icons/image2.gif" alt="[IMG]"></td>
+        <td><a href="background.jpg">background.jpg</a></td>
+        <td align="right">16-Aug-2011 13:17</td>
+        <td align="right"> 71K</td>
+        <td>&nbsp;</td>
+    </tr>
+    <tr>
+        <th colspan="5">
+            <hr>
+        </th>
+    </tr>
+</table>
+</body>
+</html>

data/test/fixtures/html/img_dir.html

@@ -0,0 +1,67 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+    <title>Index of /img</title>
+</head>
+<body>
+<h1>Index of /img</h1>
+<table>
+    <tr>
+        <th><img src="/icons/blank.gif" alt="[ICO]"></th>
+        <th><a href="?C=N;O=D">Name</a></th>
+        <th><a href="?C=M;O=A">Last modified</a></th>
+        <th><a href="?C=S;O=A">Size</a></th>
+        <th><a href="?C=D;O=A">Description</a></th>
+    </tr>
+    <tr>
+        <th colspan="5">
+            <hr>
+        </th>
+    </tr>
+
+    <tr>
+        <td valign="top"><img src="/icons/back.gif" alt="[DIR]"></td>
+        <td><a href="/">Parent Directory</a></td>
+        <td>&nbsp;</td>
+        <td align="right"> -</td>
+        <td>&nbsp;</td>
+    </tr>
+
+    <tr>
+        <td valign="top"><img src="/icons/folder.gif" alt="[DIR]"></td>
+        <td><a href="backgrounds/">backgrounds/</a></td>
+        <td align="right">16-Aug-2011 13:17</td>
+        <td align="right"> -</td>
+        <td>&nbsp;</td>
+    </tr>
+
+    <tr>
+        <td valign="top"><img src="/icons/image2.gif" alt="[IMG]"></td>
+        <td><a href="testimage1.png">testimage1.png</a></td>
+        <td align="right">16-Aug-2011 13:17</td>
+        <td align="right">412</td>
+        <td>&nbsp;</td>
+    </tr>
+    <tr>
+        <td valign="top"><img src="/icons/image2.gif" alt="[IMG]"></td>
+        <td><a href="testimage2.png">testimage2.png</a></td>
+        <td align="right">16-Aug-2011 13:17</td>
+        <td align="right"> 22K</td>
+        <td>&nbsp;</td>
+    </tr>
+    <tr>
+        <td valign="top"><img src="/icons/image2.gif" alt="[IMG]"></td>
+        <td><a href="testimage3.png">testimage3.png</a></td>
+        <td align="right">16-Aug-2011 13:17</td>
+        <td align="right"> 18K</td>
+        <td>&nbsp;</td>
+    </tr>
+
+    <tr>
+        <th colspan="5">
+            <hr>
+        </th>
+    </tr>
+</table>
+</body>
+</html>

data/test/fixtures/html/js_dyn_dir.html

@@ -0,0 +1,44 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+    <title>Index of /js/libraries/dynamic</title>
+</head>
+<body>
+<h1>Index of /js/libraries/dynamic</h1>
+<table>
+    <tr>
+        <th><img src="/icons/blank.gif" alt="[ICO]"></th>
+        <th><a href="?C=N;O=D">Name</a></th>
+        <th><a href="?C=M;O=A">Last modified</a></th>
+        <th><a href="?C=S;O=A">Size</a></th>
+        <th><a href="?C=D;O=A">Description</a></th>
+    </tr>
+    <tr>
+        <th colspan="5">
+            <hr>
+        </th>
+    </tr>
+
+    <tr>
+        <td valign="top"><img src="/icons/back.gif" alt="[DIR]"></td>
+        <td><a href="/js/libraries/">Parent Directory</a></td>
+        <td>&nbsp;</td>
+        <td align="right"> -</td>
+        <td>&nbsp;</td>
+    </tr>
+    <tr>
+        <td valign="top"><img src="/icons/unknown.gif" alt="[   ]"></td>
+        <td><a href="dynlib.js">dynlib.js</a></td>
+        <td align="right">16-Aug-2011 13:17</td>
+        <td align="right">1.5K</td>
+        <td>&nbsp;</td>
+    </tr>
+    <tr>
+        <th colspan="5">
+            <hr>
+        </th>
+    </tr>
+</table>
+
+</body>
+</html>

data/test/fixtures/invalid.config.yml

@@ -0,0 +1,27 @@
+    version:
+    url:          http://terrific.url
+    app_path:     /terrific/webapp/path
+    export_path:  /terrific/base/%2$s/public/%1$s/base/base.%1$s.php
+    libraries_source_path: /js/libraries/dynamic
+    image_base_path: /img
+    export_settings:
+      layout: project
+      debug: false
+      cache: false
+    stylesheets:
+      dest: test/tmp/public/stylesheets/
+      styles: ie.css
+      replace:
+        - what: /img/
+          with: /images/
+    javascripts:
+      dest: test/tmp/public/javascripts/
+      dynamic_libraries: dynlib.js
+      libraries_dest: /lib
+    images:
+      - src: /
+        dest: test/tmp/public/images/
+        types: jpg png gif
+      - src: /backgrounds
+        dest: test/tmp/public/images/backgrounds/
+        types: jpg

data/test/fixtures/js/base.js

@@ -0,0 +1 @@
+This is the base.js file

data/test/fixtures/js/dynlib.js

@@ -0,0 +1 @@
+This file represents a dynamic js library.

data/test/fixtures/test.config.yml

@@ -0,0 +1,64 @@
+########################################################################################################################
+# Terrific import configuration file, adjust as needed.
+#
+# version:          Define the terrific version in use
+# url:              Terrific base url
+# app_path          Terrific application path (must start with '/')
+# export_path       You most probably won't have to change this
+# image_base_path:  The Terrific image base path. You most probably won't have to change this
+# libraries_source_path:  The library source path. You most probably won't have to change this
+# downloader:       The downloader to use, supported are 'curl' and 'wget'
+#
+# export_settings:  The settings below are added as query parameters for base.js and base.css
+#   layout:         You most probably won't have to change this
+#   debug:          False compacts the base.js and base.css files
+#   cache:          You most probably won't have to change this
+#
+# stylesheets:      Define the stylesheets in the following form:
+#   dest:           The destination directory, relative from the current running directory
+#   styles:         Name of the stylesheets, space separated without the .css extension. ex: ie ie6 ie7 ie8
+#                   the main style base.css is included by default and MUST NOT BE SPECIFIED
+#   replace:        Define path replacements after the stylesheets have been downloaded
+#                   you can define multiple replacements by repeating the '-what: with:' statements
+#     - what:       What to replace, default is string. if you want to use regex, use the format r/[regex]/
+#                   for help on regular expressions see http://www.rubular.com/ (an online editor/tester)
+#       with:       Replace with this (string)
+#
+# javascripts:      Define the javascript files in the following form
+#   dest:           Destination of the javascript base.js file
+#   dynamic_libraries: Dynamic libraries definition, space separated without the .js extension. ex: warning pngfix
+#   libraries_dest: Destination of the dynamic libraries relative to the 'dest' path. '/' means they're included in 'dest'
+#
+# images:           Define the images to be downloaded, the terrific base path is always "img", so the src root is "img/"
+#                   each of the entries describes one path for images to be downloaded
+#   -src:           The source path, "/" means "img/"
+#   dest:           The destination directory, relative from the current running directory
+#   types:          The image endings to be downloaded, specified as a space separated string
+########################################################################################################################
+    version:      0.5
+    url:          http://terrific.url
+    app_path:     /terrific/webapp/path
+    export_path:  /terrific/base/%2$s/public/%1$s/base/base.%1$s.php
+    libraries_source_path: /js/libraries/dynamic
+    image_base_path: /img
+    export_settings:
+      layout: project
+      debug: false
+      cache: false
+    stylesheets:
+      dest: test/tmp/public/stylesheets/
+      styles: ie
+      replace:
+        - what: /img/
+          with: /images/
+    javascripts:
+      dest: test/tmp/public/javascripts/
+      dynamic_libraries: dynlib
+      libraries_dest: /lib
+    images:
+      - src: /
+        dest: test/tmp/public/images/
+        types: jpg png gif
+      - src: /backgrounds
+        dest: test/tmp/public/images/backgrounds/
+        types: jpg

data/test/helper.rb

@@ -1,19 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'terrimporter'
-
-class Test::Unit::TestCase
-end

data/test/terrimporter.config.yml

@@ -0,0 +1,68 @@
+########################################################################################################################
+# Terrific import configuration file, adjust as needed.
+#
+# version:          Define the terrific version in use
+# url:              Terrific base url
+# app_path          Terrific application path (must start with '/')
+# export_path       You most probably won't have to change this
+# image_base_path:  The Terrific image base path. You most probably won't have to change this
+# libraries_source_path:  The library source path. You most probably won't have to change this
+# downloader:       The downloader to use, supported are 'curl' and 'wget'
+#
+# export_settings:  The settings below are added as query parameters for base.js and base.css
+#   layout:         You most probably won't have to change this
+#   debug:          False compacts the base.js and base.css files
+#   cache:          You most probably won't have to change this
+#
+# stylesheets:      Define the stylesheets in the following form:
+#   dest:           The destination directory, relative from the current running directory
+#   styles:         Name of the stylesheets, space separated without the .css extension. ex: ie ie6 ie7 ie8
+#                   the main style base.css is included by default and MUST NOT BE SPECIFIED
+#   replace:        Define path replacements after the stylesheets have been downloaded
+#                   you can define multiple replacements by repeating the '-what: with:' statements
+#     - what:       What to replace, default is string. if you want to use regex, use the format r/[regex]/
+#                   for help on regular expressions see http://www.rubular.com/ (an online editor/tester)
+#       with:       Replace with this (string)
+#
+# javascripts:      Define the javascript files in the following form
+#   dest:           Destination of the javascript base.js file
+#   dynamic_libraries: Dynamic libraries definition, space separated without the .js extension. ex: warning pngfix
+#   libraries_dest: Destination of the dynamic libraries relative to the 'dest' path. '/' means they're included in 'dest'
+#
+# images:           Define the images to be downloaded, the terrific base path is always "img", so the src root is "img/"
+#                   each of the entries describes one path for images to be downloaded
+#   -src:           The source path, "/" means "img/"
+#   dest:           The destination directory, relative from the current running directory
+#   types:          The image endings to be downloaded, specified as a space separated string
+########################################################################################################################
+    version:      0.5
+    url:          http://terrific.url
+    app_path:     /terrific/webapp/path
+    export_path:  /terrific/base/%2$s/public/%1$s/base/base.%1$s.php
+    libraries_source_path: /js/libraries/dynamic
+    image_base_path: /img
+    downloader: curl
+    export_settings:
+      layout: project
+      debug: false
+      cache: false
+    stylesheets:
+      dest: public/stylesheets/
+      styles: ie
+      replace:
+        - what: /img/
+          with: /images/
+    javascripts:
+      dest: public/javascripts/
+      dynamic_libraries: dynlib
+      libraries_dest: /
+    images:
+      - src: /
+        dest: public/images/
+        types: jpg png gif
+      - src: /
+        dest: public/
+        types: ico
+      - src: /backgrounds/
+        dest: public/images/backgrounds/
+        types: jpg

data/test/test/tmp/public/javascripts/base.js

@@ -0,0 +1 @@
+/Users/dkummer/_projects/terrimporter/test/test/fixtures/js/base.js

data/test/test/tmp/public/javascripts/lib/dynlib.js

@@ -0,0 +1 @@
+/Users/dkummer/_projects/terrimporter/test/test/fixtures/js/dynlib.js

data/test/test/tmp/public/stylesheets/base.css

@@ -0,0 +1 @@
+/Users/dkummer/_projects/terrimporter/test/test/fixtures/css/base.css

data/test/test/tmp/public/stylesheets/ie.css

@@ -0,0 +1 @@
+/Users/dkummer/_projects/terrimporter/test/test/fixtures/css/ie.css

data/test/test_helper.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'fake_web'
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib', 'terrimporter'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'terrimporter'
+
+class Test::Unit::TestCase
+  def schema_file_path
+    File.join(File.dirname(__FILE__), '..', 'config', schema_default_name)
+  end
+
+  def invalid_test_config_file_path
+    File.join(File.dirname(__FILE__), 'fixtures', 'invalid.config.yml')
+  end
+
+  def test_config_file_path
+    File.join(File.dirname(__FILE__), 'fixtures', 'test.config.yml')
+  end
+
+  def tmp_test_directory
+    File.join(File.dirname(__FILE__), 'tmp')
+  end
+
+  def create_tmp_test_directory
+    FileUtils.mkdir tmp_test_directory unless File.exists? tmp_test_directory
+  end
+
+  def delete_tmp_test_directory
+    FileUtils.rm_rf tmp_test_directory
+  end
+
+
+
+end

data/test/test_terrimporter.rb

@@ -1,8 +1,70 @@
-require 'helper'
+require 'test_helper'
 
 class TestTerrimporter < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    #flunk "hey buddy, you should probably rename this file and start testing for real"
-    assert true
+  include ConfigHelper
+
+  def setup
+    ENV['TERRIMPORTER_OPTS'] = nil
+  end
+
+  def teardown
+    File.delete config_file if File.exists? config_file
+  end
+
+  should 'build options as a combination form argument options and environment options' do
+    ENV['TERRIMPORTER_OPTS'] = "-j"
+    arguments = ["testfile", '-c']
+    merged_options = TerrImporter::Application.build_options(arguments)
+    assert merged_options.include?(:import_js)
+    assert merged_options.include?(:import_css)
+  end
+
+    should 'merge environment and argument options' do
+    ENV['TERRIMPORTER_OPTS'] = '-j -c'
+    merged_options = TerrImporter::Application.build_options([''] + ['-i', '--verbose'])
+    expected_options = {:import_css => true,
+                        :import_js => true,
+                        :import_images => true,
+                        :show_help => false,
+                        :verbose => true}
+
+    assert_contains merged_options, expected_options
+  end
+
+
+  should 'run the importer with the init command and a non existing configuration file' do
+    TerrImporter::Application.run!(["test"], '--init')
+    assert File.exists? config_file
+  end
+
+  should 'run the importer with the init command and a non existing configuration file' do
+    TerrImporter::Application.run!(["test"], '--init replace')
+    assert File.exists? config_file
+  end
+
+  should 'run the importer with the init command and a non existing configuration file' do
+    TerrImporter::Application.run!(["test"], '--init','backup')
+    assert File.exists? config_file
+  end
+
+  should 'run the importer with the init command and an existing configuration file, this leads to an error' do
+    TerrImporter::Application.run!(["test"], '--init')
+    return_code = TerrImporter::Application.run!(["test"], '--init')
+    assert return_code == 1
+  end
+
+  should 'run the importer with an invalid argument, display help and return error code' do
+    return_code = TerrImporter::Application.run!(["test"], '--invalid')
+    assert return_code == 1
+  end
+
+  should 'run the importer show help argument, display help and return error code' do
+    return_code = TerrImporter::Application.run!(["test"], '--help')
+    assert return_code == 1
   end
+
+  def config_file
+    File.join(File.dirname(__FILE__), '..', config_default_name)
+  end
+
 end

data/test/unit/test_app_logger.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+
+class LoggingTest < Test::Unit::TestCase
+  include Logging
+
+  def wrapped_log(message)
+    original_stdout = $stdout
+    original_stderr = $stderr
+
+    fake_stdout = StringIO.new
+    fake_stderr = StringIO.new
+
+    $stdout = fake_stdout
+    $stderr = fake_stderr
+
+    begin
+      log message
+    ensure
+      $stdout = original_stdout
+      $stderr = original_stderr
+    end
+
+    @stdout = fake_stdout.string
+    @stderr = fake_stderr.string
+
+  end
+
+  context "supported logging operations" do
+    should "log info to stdout" do
+      wrapped_log :info => "hello world"
+      assert @stdout.grep(/INFO.*hello world/)
+    end
+
+    should "log debug to stdout" do
+      wrapped_log :debug => "hello world"
+      assert @stdout.grep(/DEBUG.*hello world/)
+    end
+
+    should "log error to stdout" do
+      wrapped_log :error => "hello world"
+      assert @stdout.grep(/ERROR.*hello world/)
+    end
+  end
+
+  should "not log anything unsupported" do
+    wrapped_log :not_supported => "hello world"
+    assert @stdout.strip.empty?
+  end
+
+end