terrimporter 0.7.3 → 0.7.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    terrimporter (0.7.2)
+    terrimporter (0.7.3)
       kwalify (>= 0.7.2)
 
 GEM

data/README.rdoc

@@ -3,6 +3,10 @@
 This package contains terrimporter, a simple command line utility to help import terrific (http://www.terrifically.org/)
 files such as javascripts, stylesheets, images and modules into your web project.
 
+terrimporter is compatible and has been tested against terrific 0.5.
+Backwards compatibility cannot be guaranteed!
+It will be updated to support newer terrific versions, especially the next 0.6 release with big api changes.
+
 terrimporter has the following features:
 
 * Import the generated base.js file

data/config/schema.yml

@@ -8,6 +8,10 @@ mapping:
     type: str
     required: yes
     pattern:  /\/.*/
+  "plugins_server_path":
+    type: str
+    required: yes
+    pattern:  /\/.*/
   "image_server_path":
       type: str
       required: yes
@@ -60,6 +64,12 @@ mapping:
       "libraries_destination_path":
         type: str
         required: no
+      "dynamic_plugins":
+        type: str
+        required: no
+      "plugins_destination_path":
+        type: str
+        required: no
   "images":
     type: seq
     required: no

data/config/terrimporter.yml

@@ -34,6 +34,9 @@ javascripts:
 #  dynamic_libraries: foo_lib.js bar_lib.js
 # Destination path of the dynamic libraries (relative)
 #  libraries_destination_path:  public/javascripts/libraries/
+# Destination path of the dynamic plugins
+#  dynamic_plugins: dynamic.js
+#  plugins_destination_path: public/javascript/plugins/
 
 # IMAGES - multiple entries allowed
 images:
@@ -58,8 +61,9 @@ export_settings:
   cache: false      # You most probably won't have to change this
   layout: project   # You most probably won't have to change this
 
-# The server side library source path for the dynamic libraries
+# The server side libraries and plugins source path for the dynamic libraries and dynamic plugins
 libraries_server_path: /js/libraries/dynamic
+plugins_server_path: /js/plugins/dynamic
 
 # The server side image base path
 image_server_path: /img

data/lib/terrimporter/app_logger.rb

@@ -1,5 +1,8 @@
+require 'rbconfig'
+
+
 class Logger
-  attr_accessor :level
+  attr_accessor :level, :log_format
 
   LOG_LEVELS = {:debug => 0, :info => 1, :warn => 2, :error=> 3, :fatal => 4}
   LOG_COLORS = {:debug =>'33', :info =>'32', :warn =>'33', :error=>'31', :fatal =>'31'}
@@ -11,13 +14,18 @@ class Logger
   #\033[033m    Yellow
   #\033[031m    Red
   #\033[037m    White
-
   # %s => [datetime], %s => color, %-5s => severity, %s => message
-  LOG_FORMAT = "\033[0;37m %s \033[0m[\033[%sm%-5s\033[0m]: %s \n"
+  LOG_FORMAT_UNIX = "\033[0;37m %s \033[0m[\033[%sm%-5s\033[0m]: %s \n"
+  LOG_FORMAT_WINDOWS = "%s %s[%-5s]: %s \n"
   TIME_FORMAT = "%H:%M:%S"
 
+  def is_windows
+     !((Config::CONFIG['host_os'] =~ /mswin|mingw/).nil?)
+  end
+
   def initialize
     self.level = :debug
+    self.log_format = is_windows ? LOG_FORMAT_WINDOWS : LOG_FORMAT_UNIX
   end
 
   def error(message)
@@ -34,19 +42,14 @@ class Logger
 
   def log(severity, message)
     return if LOG_LEVELS[severity] < LOG_LEVELS[self.level]
-
-    color = LOG_COLORS[severity]
-    if LOG_LEVELS[severity] >= LOG_LEVELS[:error]
-      $stderr.puts(LOG_FORMAT % [format_datetime(Time.now), color, severity.to_s.upcase, message])
-    else
-      $stdout.puts(LOG_FORMAT % [format_datetime(Time.now), color, severity.to_s.upcase, message])
-    end
+    color = is_windows ? '' : LOG_COLORS[severity]
+    out = LOG_LEVELS[severity] >= LOG_LEVELS[:error] ? $stderr : $stdout
+    out.puts(self.log_format % [format_datetime(Time.now), color, severity.to_s.upcase, message])
   end
 
   def format_datetime(time)
     time.strftime(TIME_FORMAT)
   end
-
 end
 
 LOG = Logger.new

data/lib/terrimporter/array_monkeypatch.rb

@@ -1,5 +1,5 @@
 class Array
-  def add_if_missing!(ending)
+  def add_missing_extension!(ending)
     self.collect! do |item|
       unless item =~ /#{ending}$/
         item + ending

data/lib/terrimporter/configuration.rb

@@ -1,120 +1,77 @@
-#require 'etc'
-#require 'kwalify'
-
 module TerrImporter
   class Application
     class Configuration < Hash
-      include ConfigurationHelper
-
-      attr_accessor :validations, :config_file
 
-      def initialize(config_file = nil)
-        self.config_file = config_file unless config_file.nil?
+      attr_accessor :validations
 
+      def application_url
+        self['application_url']
       end
 
-      def load_configuration
-        config_file_path = determine_config_file_path
-        LOG.debug "Configuration file located, load from #{config_file_path}"
-        validate_and_load_config(config_file_path)
+      def css_export_path
+        self['css_export_path']
       end
 
-      def determine_config_file_path
-        unless self.config_file.nil?
-          return self.config_file
-        end
-
-        valid_config_paths.each do |path|
-          file_path = File.join path, config_default_name
-          return file_path if File.exists?(file_path) and not file_path.include?(File.join('terrimporter', 'config')) #default config NOT valid
-        end
-
-        raise ConfigurationError, %Q{config file #{config_default_name} not found in search paths. Search paths are:
-        #{valid_config_paths.join "\n"} \n If this is a new project, run with the option --init}
+      def js_export_path
+        self['js_export_path']
       end
 
-      def valid_config_paths
-        [
-            Dir.pwd,
-            File.join(Dir.pwd, 'config'),
-            File.join(Dir.pwd, '.config'),
-        ]
+      def stylesheets_destination
+        self['stylesheets']['destination_path']
       end
 
-      def validate_and_load_config(file)
-        LOG.debug "Validating configuration..."
-
-        parser = Kwalify::Yaml::Parser.new(load_validator)
-        document = parser.parse_file(file)
-
-        errors = parser.errors()
-        if errors && !errors.empty?
-          error_message = errors.inject("") { |result, e| result << "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}\n" }
-          raise ConfigurationError, error_message
-        end
-        self.merge! document
-
+      def stylesheet_replace_strings
+        self['stylesheets']['replace_strings']
       end
 
-      def load_validator
-        LOG.debug "Loading validator from #{schema_file_path}"
-        schema = Kwalify::Yaml.load_file(schema_file_path)
-        Kwalify::Validator.new(schema)
+      def javascripts_destination
+        self['javascripts']['destination_path']
       end
 
-      def mandatory_present?
-        if self['export_path'].nil? or self['export_settings']['application'].nil? or self['application_url'].nil?
-          false
+      def stylesheets
+        stylesheet_list = ["base.css"]
+        if has_stylesheets?
+          stylesheet_list = stylesheet_list + self['stylesheets']['styles'].to_s.robust_split
         else
-          true
+          LOG.debug "No additional stylesheets defined in configuration file."
         end
+        stylesheet_list.add_missing_extension!('.css')
       end
 
-      def determine_configuration_values_from_html(raw_html)
-        css_result, js_result = raw_html.scan(/(\/terrific\/base\/(.*?)\/public\/.*base.(css|js).php)\?.*application=(.*?)(&amp;|&)/)
-
-        raise ConfigurationError, "Unable to extract css information from application url, content is: #{raw_html}" if css_result.nil? or css_result.size < 5
-        raise ConfigurationError, "Unable to extract javascript information from application url, content is: #{raw_html}" if js_result.nil? or js_result.size < 5
-
-        css_export_path = css_result[0]
-        js_export_path = js_result[0]
-        terrific_version = css_result[1]
-        application = css_result[3]
+      def images
+        self['images']
+      end
 
-        raise ConfigurationError, "Unable to determine css export path" if css_export_path.nil?
-        raise ConfigurationError, "Unable to determine js export path " if js_export_path.nil?
-        raise ConfigurationError, "Unable to determine terrific version" if terrific_version.nil?
-        raise ConfigurationError, "Unable to determine application path" if application.nil?
+      def modules
+        self['modules']
+      end
 
-        LOG.info "Determined the following configuration values from #{self['application_url']}:\n" +
-                     "terrific version: #{terrific_version} \n" +
-                     "application path: #{application}"
+      def images_server_path
+        self['image_server_path']
+      end
 
-        self['version'] = terrific_version
-        self['export_settings'] ||= {}
-        self['export_settings']['application'] = application
-        self['export_path'] = {'css' => css_export_path, 'js' => js_export_path}
+      def libraries_server_path
+        self['libraries_server_path']
       end
 
-      def stylesheets
-        stylesheets = ["base.css"]
-        if additional_stylesheets?
-          stylesheets = stylesheets + self['stylesheets']['styles'].to_s.robust_split
-        else
-          LOG.debug "No additional stylesheets defined."
-        end
-        stylesheets.add_if_missing!('.css')
+      def plugins_server_path
+        self['plugins_server_path']
       end
 
       def dynamic_libraries
         libraries = self['javascripts']['dynamic_libraries'].robust_split
-        libraries.add_if_missing!('.js')
+        libraries.add_missing_extension!('.js')
+      end
+
+      def dynamic_plugins
+        libraries = self['javascripts']['dynamic_plugins'].robust_split
+        libraries.add_missing_extension!('.js')
       end
 
       def replace_style_strings?
         !self['stylesheets'].nil? and
-        !self['stylesheets']['replace_strings'].nil? and
-        !self['stylesheets']['replace_strings'].first.nil?
+            !self['stylesheets']['replace_strings'].nil? and
+            !self['stylesheets']['replace_strings'].first.nil?
       end
 
       def libraries_destination_path
@@ -125,19 +82,35 @@ module TerrImporter
         end
       end
 
-      def additional_stylesheets?
+      def plugins_destination_path
+        if !self['javascripts']['plugins_destination_path'].nil?
+          File.join(self['javascripts']['plugins_destination_path'])
+        else
+          File.join(self['javascripts']['destination_path'])
+        end
+      end
+
+      def export_settings
+        self['export_settings']
+      end
+
+      def has_stylesheets?
         !self['stylesheets'].nil? and !self['stylesheets']['styles'].nil?
       end
 
-      def additional_dynamic_javascripts?
+      def has_dynamic_javascripts?
         !self['javascripts'].nil? and !self['javascripts']['dynamic_libraries'].nil?
       end
 
-      def images?
+      def has_dynamic_plugins?
+        !self['javascripts'].nil? and !self['javascripts']['dynamic_plugins'].nil?
+      end
+
+      def has_images?
         !self['images'].nil?
       end
 
-      def modules?
+      def has_modules?
         !self['modules'].nil?
       end
 

data/lib/terrimporter/configuration_helper.rb

@@ -1,5 +1,28 @@
 module ConfigurationHelper
 
+  def backup_config_file
+    LOG.debug "Backing up old configuration file to #{config_working_directory_path}.bak"
+    FileUtils.mv(config_working_directory_path, config_working_directory_path + '.bak')
+  end
+
+  def remove_config_file
+    LOG.debug "Removing old configuration file"
+    FileUtils.rm_f(config_working_directory_path) if File.exists? config_working_directory_path
+  end
+
+  def create_config_file(application_url = nil)
+    LOG.info "Creating configuration file..."
+    FileUtils.cp(config_example_path, config_working_directory_path)
+
+    unless application_url.nil?
+      configuration = File.read(config_working_directory_path)
+      configuration.gsub!(/application_url:.*$/, "application_url: #{application_url}")
+      File.open(config_working_directory_path, 'w') { |f| f.write(configuration) }
+    end
+
+    LOG.info "done! You should take a look an edit it to your needs..."
+  end
+
   def config_default_name
     'terrimporter.yml'
   end
@@ -8,6 +31,14 @@ module ConfigurationHelper
     'schema.yml'
   end
 
+  def config_search_paths
+    [
+        Dir.pwd,
+        File.join(Dir.pwd, 'config'),
+        File.join(Dir.pwd, '.config'),
+    ]
+  end
+
   def config_working_directory_path
     File.expand_path config_default_name
   end
@@ -24,28 +55,6 @@ module ConfigurationHelper
     File.join(base_config_path, schema_default_name)
   end
 
-  def create_config_file(backup_or_replace = nil, application_url = nil)
-    LOG.info "Creating configuration file..."
-    case backup_or_replace
-      when :backup
-        LOG.debug "Backing up old configuration file to #{config_working_directory_path}.bak"
-        FileUtils.mv(config_working_directory_path, config_working_directory_path + '.bak')
-      when :replace
-        LOG.debug "Replacing old configuration file"
-        FileUtils.rm_f(config_working_directory_path) if File.exists? config_working_directory_path
-    end
-    FileUtils.cp(config_example_path, config_working_directory_path)
-
-    unless application_url.nil?
-      configuration = File.read(config_working_directory_path)
-      configuration.gsub!(/application_url:.*$/, "application_url: #{application_url}")
-      File.open(config_working_directory_path, 'w') { |f| f.write(configuration) }
-    end
-
-    LOG.info "done! You should take a look an edit it to your needs..."
-  end
-
-  private
   def base_config_path
     File.join(File.dirname(__FILE__), '..', '..', 'config')
   end

data/lib/terrimporter/configuration_loader.rb

@@ -0,0 +1,85 @@
+module TerrImporter
+  class Application
+    class ConfigurationLoader
+      include ConfigurationHelper
+
+      attr_accessor :config_file
+
+      def initialize(config_file = nil)
+        self.config_file = config_file unless config_file.nil?
+      end
+
+      #todo also complete missing values here, after this step everything should work...
+      def load_configuration
+        config_file_path = determine_config_file_path
+        LOG.debug "Configuration file located, load from #{config_file_path}"
+        c = Configuration.new
+        c.merge!(validate_and_load_config(config_file_path))
+        c['version'], c['export_settings']['application'], c['css_export_path'], c['js_export_path'] = determine_configuration_values_from_html(Downloader.new(c['application_url']).download(''))
+        c
+      end
+
+      def determine_config_file_path
+        return self.config_file unless self.config_file.nil?
+
+        config_search_paths.each do |path|
+          file_path = File.join(path, config_default_name)
+          #default config supplied with terrimporter NOT valid
+          return file_path if File.exists?(file_path) and not file_path.include?(File.join('terrimporter', 'config'))
+        end
+
+        raise ConfigurationError, %Q{Configuration file #{config_default_name} not found in search paths. Search paths are:
+        #{config_search_paths.join "\n"} \n If this is a new project, run with the option --init}
+      end
+
+      def validate_and_load_config(file)
+        LOG.debug "Validate configuration file"
+        parser = Kwalify::Yaml::Parser.new(load_validator)
+        document = parser.parse_file(file)
+        errors = parser.errors()
+
+        if errors && !errors.empty?
+          error_message = errors.inject("") { |result, e| result << "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}\n" }
+          raise ConfigurationError, error_message
+        end
+        document
+      end
+
+      def load_validator
+        LOG.debug "Loading configuration file validator from #{schema_file_path}"
+        schema = Kwalify::Yaml.load_file(schema_file_path)
+        Kwalify::Validator.new(schema)
+      end
+
+      def determine_configuration_values_from_html(raw_html)
+        css_result, js_result = raw_html.scan(/(\/terrific\/base\/(.*?)\/public\/.*base.(css|js).php)\?.*application=(.*?)(&amp;|&)/)
+
+        raise ConfigurationError, "Unable to extract css information from application url, content is: #{raw_html}" if css_result.nil? or css_result.size < 5
+        raise ConfigurationError, "Unable to extract javascript information from application url, content is: #{raw_html}" if js_result.nil? or js_result.size < 5
+
+        css_export_path = css_result[0]
+        js_export_path = js_result[0]
+        terrific_version = css_result[1]
+        application = css_result[3]
+
+        raise ConfigurationError, "Unable to determine css export path" if css_export_path.nil?
+        raise ConfigurationError, "Unable to determine js export path " if js_export_path.nil?
+        raise ConfigurationError, "Unable to determine terrific version" if terrific_version.nil?
+        raise ConfigurationError, "Unable to determine application path" if application.nil?
+
+        LOG.info "Determined the following configuration values:\n" +
+                     "terrific version: #{terrific_version} \n" +
+                     "application path: #{application}"
+
+        #self['version'] = terrific_version
+        #self['export_settings'] ||= {}
+        #self['export_settings']['application'] = application
+        #self['css_export_path'] = css_export_path
+        #self['js_export_path'] = js_export_path
+        [terrific_version, application, css_export_path, js_export_path]
+      end
+
+
+    end
+  end
+end

data/lib/terrimporter/download_helper.rb

@@ -1,5 +1,5 @@
 module DownloadHelper
-  def create_dir_path(dir)
+  def create_directory(dir)
     unless File.directory?(dir) and File.file?(dir)
       LOG.debug "Creating directory: #{dir}"
       FileUtils.mkpath(dir)

data/lib/terrimporter/downloader.rb

@@ -15,23 +15,32 @@ module TerrImporter
         remote_url = url(remote_path)
         begin
           if local_path.nil? #download to buffer
-            LOG.debug "Download #{remote_url} to buffer"
-            data = StringIO.new
-            remote_url.open { |io| data = io.read }
-            data.to_s
+            download_to_buffer(remote_url)
           else
-            LOG.info "Download #{remote_url} to local path #{local_path}"
-            create_dir_path File.dirname(local_path)
-            open(local_path, "wb") { |file| file.write(remote_url.open.read) }
+            download_to_file(remote_url, local_path)
+            STAT.add(:download, 1)
           end
-        rescue SocketError => e
-          raise DefaultError, "Error opening url #{remote_url}: \n #{e.message}"
+        rescue Exception => e
+          raise DefaultError, "Error opening url: #{remote_url}"
         end
       end
 
+      def download_to_buffer(remote_url)
+        LOG.debug "Download #{remote_url} to buffer"
+        data = StringIO.new
+          remote_url.open { |io| data = io.read }
+          data.to_s
+      end
+
+      def download_to_file(remote_url, local_path)
+        LOG.info "Download #{remote_url} to local path #{local_path}"
+        create_directory File.dirname(local_path)
+        open(local_path, "wb") { |file| file.write(remote_url.open.read) }
+      end
+
       def batch_download(remote_path, local_path, type_filter = "")
         source_path = url(remote_path)
-        create_dir_path local_path
+        create_directory local_path
         LOG.debug "Download multiple files from #{source_path} to #{local_path} #{"allowed extensions: " + type_filter unless type_filter.empty?}"
 
         files = html_directory_list(source_path)

data/lib/terrimporter/error.rb

@@ -0,0 +1,10 @@
+module TerrImporter
+  class DefaultError < StandardError
+  end
+
+  class ConfigurationError < StandardError
+  end
+
+  class ConfigurationMissingError < StandardError
+  end
+end