terrimporter 0.7.3 → 0.7.4

data/lib/terrimporter/importer.rb

@@ -1,52 +1,54 @@
 module TerrImporter
-
-  class DefaultError < StandardError
-  end
-
-  class ConfigurationError < StandardError
-  end
-
-  class ConfigurationMissingError < StandardError
-  end
-
   class Application
+    #todo split importer into css_importer, image_importer, module_importer, js_importer
     class Importer
       include ImporterHelper
       attr_accessor :options, :config
 
       def initialize(options = {})
         self.options = options
-        self.config = Configuration.new options[:config_file]
-        self.config.load_configuration
-        @downloader = Downloader.new config['application_url']
+        loader = ConfigurationLoader.new(options[:config_file])
+        self.config = loader.load_configuration
+        initialize_downloader
+      end
+
+      def initialize_downloader
+        @downloader = Downloader.new(config.application_url)
       end
 
       def run
         if options[:all] != nil and options[:all] == true
-          LOG.info "Import everything"
-          import_js
-          import_css
-          import_images
-          import_modules
+          run_all_imports
         else
-          options.each do |option, value|
-            if option.to_s =~ /^import_/ and value == true
-              LOG.info "Import of #{option.to_s.split('_').last} started"
-              self.send option.to_s
-            end
+          run_specific_imports
+        end
+      end
+
+      def run_all_imports
+        LOG.info "Import everything"
+        import_js
+        import_css
+        import_images
+        import_modules
+      end
+
+      def run_specific_imports
+        options.each do |option, value|
+          if option.to_s =~ /^import_/ and value == true
+            LOG.info "Import of #{option.to_s.split('_').last} started"
+            self.send option.to_s
           end
         end
       end
 
       def import_css
         LOG.info("Importing stylesheets")
-        complete_config!
 
         unclean_suffix = "_unclean"
         stylesheets = config.stylesheets
 
         stylesheets.each do |css|
-          file_path = File.join(config['stylesheets']['destination_path'], css)
+          file_path = File.join(config.stylesheets_destination, css)
           options = {}
           options[:suffix] = $1 if css =~ /(ie.*).css$/ #add ie option if in array
           source_url = export_path(:css, options)
@@ -74,7 +76,7 @@ module TerrImporter
               FileUtils.remove unclean_file_path
             end
           else
-            File.remove(file_path)
+            FileUtils.remove(file_path)
             LOG.debug "Deleting empty"
           end
         end
@@ -82,32 +84,44 @@ module TerrImporter
 
       def import_js
         LOG.info("Importing javascripts")
-        complete_config!
-        file_path = File.join(config['javascripts']['destination_path'], "base.js")
+        file_path = File.join(config.javascripts_destination, "base.js")
         js_source_url = export_path(:js)
         LOG.debug "Import base.js from #{js_source_url} to #{file_path}"
         @downloader.download(js_source_url, file_path)
 
-        if config.additional_dynamic_javascripts?
-          if config['libraries_server_path'].nil?
+        if config.has_dynamic_javascripts?
+          if config.libraries_server_path.nil?
             LOG.info "Define 'libraries_server_path' in configuration file"
           else
             libraries_file_path = config.libraries_destination_path
-            LOG.info "Import libraries from #{config['libraries_server_path']} to #{libraries_file_path}"
+            LOG.info "Import libraries from #{config.libraries_server_path} to #{libraries_file_path}"
             js_libraries = config.dynamic_libraries
             js_libraries.each do |lib|
-              @downloader.download(File.join(config['libraries_server_path'], lib), File.join(libraries_file_path, lib))
+              @downloader.download(File.join(config.libraries_server_path, lib), File.join(libraries_file_path, lib))
             end
           end
         end
+
+        if config.has_dynamic_plugins?
+          if config.plugins_server_path.nil?
+            LOG.info "Define 'plugins_server_path' in configuration file"
+          else
+          plugins_file_path = config.plugins_destination_path
+          LOG.info "Import plugins from #{config.plugins_server_path} to #{plugins_file_path}"
+          js_plugins = config.dynamic_plugins
+          js_plugins.each do |lib|
+            @downloader.download(File.join(config.plugins_server_path, lib), File.join(plugins_file_path, lib))
+          end
+            end
+        end
       end
 
       def import_images
-        complete_config!
-        if config.images?
+
+        if config.has_images?
           LOG.info "Import images"
-          config['images'].each do |image|
-            image_source_path = File.join(config['image_server_path'], image['server_path'])
+          config.images.each do |image|
+            image_source_path = File.join(config.images_server_path, image['server_path'])
             @downloader.batch_download(image_source_path, image['destination_path'], image['file_types'])
           end
         else
@@ -115,17 +129,11 @@ module TerrImporter
         end
       end
 
-      def complete_config!
-        unless config.mandatory_present?
-          config.determine_configuration_values_from_html @downloader.download('')
-        end
-      end
-
       def import_modules
-        complete_config!
-        if config.modules?
+
+        if config.has_modules?
           LOG.info "Module import"
-          config['modules'].each do |mod|
+          config.modules.each do |mod|
             name = mod['name']
             skin = mod['skin']
             module_source_url = module_path(name, mod['module_template'], skin, mod['template_only'])
@@ -142,7 +150,7 @@ module TerrImporter
         skin = '' if skin.nil?
         raise ConfigurationError, "Name cannot be empty for template" if name.nil?
         raise ConfigurationError, "Module template missing in configuration for template #{name}" if module_template.nil?
-        export_path = config['application_url'].clone
+        export_path = config.application_url.clone
         export_path << "/terrific/module/details/#{name}/#{module_template}/#{skin}/format/module#{"content" if template}"
         export_path
       end
@@ -151,17 +159,17 @@ module TerrImporter
 
       def export_path(for_what = :js, options={})
         raise DefaultError, "Specify js or css url" unless for_what == :js or for_what == :css
-        export_settings = config['export_settings'].clone
+        export_settings = config.export_settings.clone
         export_settings.merge!(options)
         export_settings['appbaseurl'] = "" if for_what == :css
 
-        export_path = config['export_path'][for_what.to_s].clone
+        export_path = for_what == :js ? config.js_export_path.clone : config.css_export_path.clone
         export_path << '?' << export_settings.map { |k, v| "#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}" }.join("&")
         export_path
       end
 
       def replace_stylesheet_lines!(line)
-        config['stylesheets']['replace_strings'].each do |replace|
+        config.stylesheet_replace_strings.each do |replace|
           replace_line!(line, replace['what'], replace['with'])
         end
         line

data/lib/terrimporter/statistic.rb

@@ -0,0 +1,37 @@
+class Statistic
+  attr_accessor :statistics, :times
+
+  def initialize
+    @header = ["-------------------------------",
+               " SUMMARY ",
+               "-------------------------------"]
+
+    self.statistics = {
+        :download => {:count => 0, :message => ""},
+        :js => {:count => 0, :message => ""},
+        :css => {:count => 0, :message => ""},
+        :image => {:count => 0, :message => ""},
+        :error => {:count => 0, :message => ""}
+    }
+  end
+
+  def add_message(type, message)
+    self.statistics[type][:message] = message
+  end
+
+  def add(type, count)
+    self.statistics[type][:count] += count
+  end
+
+  def print_summary
+    @header.each do |h|
+      puts h
+    end
+    self.statistics.each do |key, value|
+      puts "#{key.to_s.upcase}: [#{value[:count]}] #{value[:message]}" unless value[:count] == 0
+    end
+  end
+
+end
+
+STAT = Statistic.new

data/lib/terrimporter/stylesheet_importer.rb

@@ -0,0 +1,56 @@
+#major todo!!
+=begin
+module TerrImporter
+  class Application
+    class StylesheetImporter
+      include ImporterHelper
+      attr_accessor :config
+
+      def initialize(configuration)
+        self.config = configuration
+      end
+
+      def import!
+        LOG.info("Importing stylesheets")
+        unclean_suffix = "_unclean"
+        stylesheets = config.stylesheets
+
+        stylesheets.each do |css|
+          file_path = File.join(config.stylesheets_destination, css)
+          options = {}
+          options[:suffix] = $1 if css =~ /(ie.*).css$/ #add ie option if in array
+          source_url = export_path(:css, options)
+          unclean_file_path = file_path + unclean_suffix;
+          constructed_file_path = (config.replace_style_strings? ? unclean_file_path : file_path)
+          @downloader.download(source_url, constructed_file_path)
+
+          if file_contains_valid_css?(constructed_file_path)
+            if config.replace_style_strings?
+              LOG.info "CSS line replacements"
+              File.open(file_path, 'w') do |d|
+                File.open(constructed_file_path, 'r') do |s|
+                  lines = s.readlines
+                  lines.each do |line|
+                    d.print replace_stylesheet_lines!(line)
+                  end
+                end
+              end
+            else
+              LOG.debug "Skipping css line replacements"
+            end
+
+            if File.exists?(unclean_file_path)
+              LOG.debug "Deleting unclean css files"
+              FileUtils.remove unclean_file_path
+            end
+          else
+            File.remove(file_path)
+            LOG.debug "Deleting empty"
+          end
+        end
+      end
+
+    end
+  end
+end
+=end

data/lib/terrimporter/version.rb

@@ -1,4 +1,4 @@
-#Generated by rake task, last bump: minor7patch3major0
+#Generated by rake task, last bump: minor7patch4major0
 module TerrImporter
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

data/lib/terrimporter.rb

@@ -1,4 +1,6 @@
 require 'shellwords'
+require 'terrimporter/error'
+require 'terrimporter/statistic'
 require 'terrimporter/version'
 require 'terrimporter/download_helper'
 require 'terrimporter/app_logger'
@@ -6,6 +8,7 @@ require 'terrimporter/options'
 require 'terrimporter/importer_helper'
 require 'terrimporter/importer'
 require 'terrimporter/configuration_helper'
+require 'terrimporter/configuration_loader'
 require 'terrimporter/configuration'
 require 'terrimporter/downloader'
 require 'terrimporter/string_monkeypatch'
@@ -22,6 +25,7 @@ module TerrImporter
       include Shellwords
       include ConfigurationHelper
 
+      #todo refactor into smaller methods
       def run!(*arguments)
         options = build_options(arguments)
 
@@ -30,7 +34,13 @@ module TerrImporter
             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(options[:init], options[:application_url])
+            case options[:init]
+              when :backup
+                backup_config_file
+              when :replace
+                remove_config_file
+            end
+            create_config_file(options[:application_url])
             return 0
           end
 
@@ -41,7 +51,6 @@ module TerrImporter
               LOG.level = :info
           end
 
-
           if options[:invalid_argument]
             $stderr.puts options[:invalid_argument]
             options[:show_help] = true
@@ -64,6 +73,7 @@ module TerrImporter
 
           importer = TerrImporter::Application::Importer.new(options)
           importer.run
+          STAT.print_summary
           return 0
         rescue TerrImporter::ConfigurationError
           $stderr.puts %Q{Configuration Error #{ $!.message }}

data/test/fixtures/invalid.config.yml

@@ -1,5 +1,6 @@
     url:          http://terrific.url
     libraries_server_path: /js/libraries/dynamic
+    plugins_server_path: /js/plugins/dynamic
     image_server_path: /img
     export_settings:
       layout: project

data/test/fixtures/js/dynplugin.js

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

data/test/fixtures/minimal.test.config.yml

@@ -1,5 +1,6 @@
 application_url:          http://terrific.url
 libraries_server_path: /js/libraries/dynamic
+plugins_server_path: /js/plugins/dynamic
 image_server_path: /img
 export_settings:
   layout: project

data/test/fixtures/test.config.yml

@@ -1,5 +1,6 @@
     application_url:          http://terrific.url
     libraries_server_path: /js/libraries/dynamic
+    plugins_server_path: /js/plugins/dynamic
     image_server_path: /img
     export_settings:
       layout: project
@@ -15,6 +16,8 @@
       destination_path: test/tmp/public/javascripts/
       dynamic_libraries: dynlib
       libraries_destination_path: test/tmp/public/javascripts/lib
+      dynamic_plugins: dynplugin
+      plugins_destination_path: test/tmp/public/javascripts/plugins
     images:
       - server_path: /
         destination_path: test/tmp/public/images/

data/test/unit/test_arraymonkeypatch.rb

@@ -5,7 +5,7 @@ class TestArrayMonkeypatch < Test::Unit::TestCase
     testarray = ["file1.css", "file2", "file3", "file4.css"]
     expected = ["file1.css", "file2.css", "file3.css", "file4.css"]
 
-    assert_equal expected, testarray.add_if_missing!('.css')
+    assert_equal expected, testarray.add_missing_extension!('.css')
     assert_equal expected, expected.join(" ").robust_split
   end
 

data/test/unit/test_configuration.rb

@@ -5,31 +5,25 @@ class ConfigurationTest < Test::Unit::TestCase
   include ConfigurationHelper
 
   def setup
-    @configuration = TerrImporter::Application::Configuration.new test_config_file_path
-    @configuration.load_configuration
-  end
-
-  should 'find a configuration in the local path and not raise an error' do
-    assert_nothing_raised do
-      @configuration.determine_config_file_path
-    end
+    FakeWeb.register_uri(:get, "http://terrific.url", :body => File.expand_path('test/fixtures/html/application_root.html'), :content_type => 'text/plain')
+    @configuration = TerrImporter::Application::ConfigurationLoader.new(test_config_file_path).load_configuration
   end
 
   should 'have an image configuration' do
-    assert @configuration.images?
+    assert @configuration.has_images?
   end
 
   should 'have dynamic libraries' do
-    assert @configuration.additional_dynamic_javascripts?
+    assert @configuration.has_dynamic_javascripts?
   end
 
   should 'have modules' do
-    assert @configuration.modules?
+    assert @configuration.has_modules?
   end
 
   should 'use the normal libraries path if no dynamic libraries are specified' do
     @configuration['javascripts']['libraries_destination_path'] = nil
-    assert  @configuration['javascripts']['destination_path'], @configuration.libraries_destination_path
+    assert @configuration['javascripts']['destination_path'], @configuration.libraries_destination_path
   end
 
   should 'have style replacement strings' do
@@ -37,78 +31,27 @@ class ConfigurationTest < Test::Unit::TestCase
   end
 
   should 'have additional stylesheets configured' do
-    assert @configuration.additional_stylesheets?
-  end
-
-  context 'no configuration file around' do
-    setup { @invalid_configuration = TerrImporter::Application::Configuration.new }
-
-    should 'not find a configuration in the local path and raise an error' do
-      assert_raise TerrImporter::ConfigurationError do
-        @invalid_configuration.load_configuration
-        @invalid_configuration
-      end
-    end
-  end
-
-  context 'invalid config file' do
-    setup do
-      @configuration = TerrImporter::Application::Configuration.new invalid_test_config_file_path
-    end
-
-    should 'throw an error on an invalid config file' do
-      assert_raise TerrImporter::ConfigurationError do
-        @configuration.load_configuration
-      end
-    end
-  end
-
-  context 'test config file independent functions' do
-    setup {
-      @configuration = TerrImporter::Application::Configuration.new
-    }
-
-    should 'get the current working directory as config file path' do
-      config_in_cwd = File.join(Dir.pwd, config_default_name)
-      assert_equal config_in_cwd, @configuration.determine_config_file_path
-    end
-
-    should 'create a config file in the current directory' do
-      config_path = File.join(Dir.pwd, config_default_name)
-      FileUtils.rm_f config_path if File.exists? config_path
-      @configuration.create_config_file
-      assert File.exists?(config_path)
-    end
-  end
-
-  context 'required configurations' do
-    should 'test for all the required configurations needed to function properly' do
-      #these values are set by the downloader
-      @configuration['export_path'] = 'present'
-      @configuration['export_settings'] = {'application' => 'present'}
-      @configuration['application_url'] = 'present'
-
-      assert @configuration.mandatory_present?
-    end
+    assert @configuration.has_stylesheets?
   end
 
   context 'minimal working configuration' do
     setup do
-      @configuration = TerrImporter::Application::Configuration.new min_test_config_file_path
+      @loader = TerrImporter::Application::ConfigurationLoader.new min_test_config_file_path
+      @configuration = @loader.load_configuration
     end
 
     should 'not raise an error when loading the minimal configuration' do
       assert_nothing_raised do
-        @configuration.load_configuration
+        @loader.load_configuration
       end
     end
 
     should 'not have an image configuration' do
-      assert !@configuration.images?
+      assert !@configuration.has_images?
     end
 
     should 'not have dynamic libraries' do
-      assert !@configuration.additional_dynamic_javascripts?
+      assert !@configuration.has_dynamic_javascripts?
     end
 
     should 'not have style replacement strings' do
@@ -116,7 +59,7 @@ class ConfigurationTest < Test::Unit::TestCase
     end
 
     should 'not have additional stylesheets configured' do
-      assert !@configuration.additional_stylesheets?
+      assert !@configuration.has_stylesheets?
     end
 
     should 'only get the base.css file' do
@@ -124,43 +67,7 @@ class ConfigurationTest < Test::Unit::TestCase
     end
 
     should 'not have additional modules' do
-      assert !@configuration.modules?
-    end
-
-    context 'read additional configuration values from parent page' do
-
-    should 'extract version and app path from parent page' do
-      raw_html = File.open(File.expand_path('test/fixtures/html/application_root.html')).read
-      assert_nothing_raised do
-        @configuration.determine_configuration_values_from_html raw_html
-      end
-
-      assert !@configuration['version'].nil?
-      assert !@configuration['export_settings']['application'].nil?
-      assert !@configuration['export_path']['js'].nil?
-      assert !@configuration['export_path']['css'].nil?
-    end
-
-    should 'throw a configuration error if the parent pages js values can\'t be read correctly' do
-      raw_html = File.open(File.expand_path('test/fixtures/html/application_root_js_error.html')).read
-      assert_raises TerrImporter::ConfigurationError do
-        @configuration.determine_configuration_values_from_html raw_html
-      end
-    end
-
-    should 'throw a configuration error if the parent pages css values can\'t be read correctly' do
-      raw_html = File.open(File.expand_path('test/fixtures/html/application_root_css_error.html')).read
-      assert_raises TerrImporter::ConfigurationError do
-        @configuration.determine_configuration_values_from_html raw_html
-      end
-    end
-  end
-
-    #todo why is this failing?
-=begin
-    should 'return javascript destination path if libraries destination path is undefined' do
-      assert_equal @configuration['javascripts']['destination_path'], @configuration.libraries_destination_path
+      assert !@configuration.has_modules?
     end
-=end
   end
 end

data/test/unit/{test_config_helper.rb → test_configuration_helper.rb}

@@ -11,15 +11,16 @@ class ConfigValidatorTest < Test::Unit::TestCase
 
   should 'create a configuration file and backup the old one' do
     create_config_file
-    create_config_file(:backup)
+    backup_config_file
     assert File.exists?(config_working_directory_path + '.bak')
-    assert File.exists?(config_working_directory_path)
+    assert_same false, File.exists?(config_working_directory_path)
   end
 
   should 'create a configuration file and remove the old one' do
-    config_working_directory_path
-    create_config_file(:replace)
-    assert File.exists?(config_working_directory_path)
+    config_working_directory_path #todo whats this?
+    create_config_file
+    remove_config_file
+    assert_same false, File.exists?(config_working_directory_path)
   end
 
   should 'create a configuration file' do
@@ -29,7 +30,7 @@ class ConfigValidatorTest < Test::Unit::TestCase
 
   should 'create a configuration file and replace the application url' do
     application_url = "http://test.url"
-    create_config_file(nil, application_url)
+    create_config_file(application_url)
     configuration = File.read(config_working_directory_path)
     assert configuration.include?("application_url: #{application_url}")
   end