terrimporter 0.3.0 → 0.4.0

data/.gitignore

@@ -1,3 +1,7 @@
+coverage
+rdoc
+doc
+.yardoc
 *.gem
 .bundle
 Gemfile.lock

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    terrimporter (0.3.0)
+    terrimporter (0.4.0)
+      kwalify
 
 GEM
   remote: http://rubygems.org/
@@ -11,6 +12,7 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    kwalify (0.7.2)
     rake (0.9.2)
     rcov (0.9.9)
     shoulda (2.11.3)

data/Rakefile

@@ -1,2 +1,29 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "terrimporter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/config/schema.yml

@@ -0,0 +1,89 @@
+type: map
+mapping:
+  "version":
+    type: text
+    required: yes
+  "url":
+    type: str
+    required: yes
+    pattern: /^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/
+  "app_path":
+    type: str
+    required: yes
+    pattern:  /\/.*/
+  "export_path":
+    type: str
+    required: yes
+    pattern: /^\/terrific.*\%2\$s.*\%1\$s.*\%1\$s.*\.php$/
+  "libraries_source_path":
+    type: str
+    required: yes
+    pattern:  /\/.*/
+  "image_base_path":
+      type: str
+      required: yes
+      pattern:  /\/.*/
+  "downloader":
+       type: str
+       enum: [curl, wget]
+  "export_settings":
+    type: map
+    mapping:
+      "layout":
+        type: str
+        required: yes
+      "debug":
+        type: bool
+        default: false
+      "cache":
+        type: bool
+        default: false
+  "stylesheets":
+    type: map
+    mapping:
+      "dest":
+        type: str
+        required: yes
+      "styles":
+         type: str
+         name: css
+         required: no
+      "replace":
+        type: seq
+        required: no
+        sequence:
+          - type: map
+            mapping:
+              "what":
+                type: str
+                required: yes
+              "with":
+                type: str
+                required: yes
+  "javascripts":
+    type: map
+    mapping:
+      "dest":
+        type: str
+        required: yes
+      "dynamic_libraries":
+        type: str
+        name: js
+        required: no
+      "libraries_dest":
+        type: str
+        required: yes
+  "images":
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "src":
+            type: str
+            required: yes
+          "dest":
+            type: str
+            required: yes
+          "types":
+            type: str
+            required: no

data/config/terrimporter.config.yml

@@ -35,24 +35,24 @@
 #   dest:           The destination directory, relative from the current running directory
 #   types:          The image endings to be downloaded, specified as a space separated string
 ########################################################################################################################
-  terrific:
     version:      0.5
-    url:          http://terrific.abochecker
+    url:          http://terrific.url
     app_path:     /Users/danielkummer/_NAMICS/projekte/mobilezone/mobilezone-abo_optimizer/public/terrific
     export_path:  /terrific/base/%2$s/public/%1$s/base/base.%1$s.php
     libraries_source_path: /js/libraries/dynamic/
+    #todo remove backslash
     image_base_path: /img
     downloader: curl
     export_settings:
       layout: project
       debug: false
-      case: false
+      cache: false
     stylesheets:
       dest: public/stylesheets/
       styles: ie
       replace:
-      - what: /img/
-        with: /images/
+        - what: /img/
+          with: /images/
     javascripts:
       dest: public/javascripts/
       dynamic_libraries: warning pngfix

data/lib/config_validator.rb

@@ -0,0 +1,21 @@
+require 'kwalify'
+
+class ConfigValidator < Kwalify::Validator
+  ## hook method called by Validator#validate()
+  def validate_hook(value, rule, path, errors)
+    case rule.name
+      when 'css'
+        #todo split space separated values and check for .css
+        if value =~ /\.css/
+          msg = "no .css extension allowed, use filename only."
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+      when 'js'
+        if value =~ /\.js/
+          msg = "no .js extension allowed, use filename only."
+          errors << Kwalify::ValidationError.new(msg, path)
+        end
+    end
+  end
+
+end

data/lib/configuration.rb

@@ -0,0 +1,93 @@
+require 'etc'
+require 'kwalify'
+require 'config_validator'
+
+module TerrImporter
+  class Application
+    class Configuration < Hash
+
+      CONFIG_DEFAULT_NAME = 'terrimporter.config.yml'
+      SCHEMA_DEFAULT_NAME = 'schema.yml'
+
+      attr_accessor :validations, :config_file
+
+      def initialize(config_file = nil)
+        self.config_file = config_file unless config_file.nil?
+
+      end
+
+      def load_configuration
+        config_file_path = determine_config_file_path
+        validate_and_load_config(config_file_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)
+        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}
+      end
+
+      def valid_config_paths
+        [
+            Dir.pwd,
+            File.join(Dir.pwd, 'config'),
+            File.join(Dir.pwd, '.config'),
+            Etc.getpwuid.dir
+        ]
+      end
+
+      #todo split!
+      def validate_and_load_config(file)
+        puts "Load configuration "
+
+        schema = Kwalify::Yaml.load_file(schema_file_path)
+        #validator = Kwalify::Validator.new(schema)
+        validator = ConfigValidator.new(schema)
+
+        parser = Kwalify::Yaml::Parser.new(validator)
+        document = parser.parse_file(file)
+        ## show errors if exist
+        errors = parser.errors()
+        ##todo convert to single statement, map for example
+        if errors && !errors.empty?
+          error_message = ""
+          for e in errors
+            error_message << "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}\n"
+          end
+          raise ConfigurationError, error_message
+        end
+
+        self.merge! document
+
+      end
+
+      def schema_file_path
+        File.join(File.dirname(__FILE__), '..', 'config', SCHEMA_DEFAULT_NAME)
+      end
+
+      #todo
+      def validate_schema
+        meta_validator = Kwalify::MetaValidator.instance
+
+        ## validate schema definition
+        parser = Kwalify::Yaml::Parser.new(meta_validator)
+        errors = parser.parse_file(schema_file_path)
+        for e in errors
+          puts "#{e.linenum}:#{e.column} [#{e.path}] #{e.message}"
+        end if errors && !errors.empty?
+      end
+
+      def create_config
+        FileUtils.cp(File.join(File.dirname(__FILE__), "..", "config", CONFIG_DEFAULT_NAME), File.join(Dir.pwd, CONFIG_DEFAULT_NAME))
+      end
+    end
+  end
+end

data/lib/importer.rb

@@ -4,9 +4,8 @@ require 'yaml'
 require 'uri'
 
 
-module TerrImporter
 
-  CONFIG_DEFAULT_NAME = 'terrimporter.config.yml'
+module TerrImporter
 
   class DefaultError < StandardError
   end
@@ -16,16 +15,20 @@ module TerrImporter
 
   class Importer
     require 'options'
+    require 'configuration'
     include Logging
 
+    #todo remove
     attr_accessor :options, :config
 
     def initialize(options = {})
       self.options = options
+      self.config = TerrImporter::Application::Configuration.new options[:config_file]
+
     end
 
     def run
-      init_config(config_file_path)
+      self.config.load_configuration
 
       if options[:all] != nil and options[:all] == true
         import_js
@@ -106,39 +109,6 @@ module TerrImporter
     end
 
     private
-    def init_config (config_file)
-      raise ConfigurationError, "config file #{config_file} doesn't exist, if this is a new project, run with the option -i'" unless File.exists?(config_file)
-      load_config(config_file)
-      validate_config(self.config)
-    end
-
-    def config_file_path(config_directory = nil)
-      config_directory = Dir.pwd if config_directory.nil?
-      File.join(config_directory, CONFIG_DEFAULT_NAME)
-    end
-
-
-    def validate_config(config)
-      raise ConfigurationError, "specify downloader (curl or wget)" unless config['downloader'] =~ /curl|wget/
-      raise ConfigurationError, "url format invalid" unless config['url'] =~ URI::regexp
-      raise ConfigurationError, "version invalid" if config['version'].to_s.empty?
-      raise ConfigurationError, "app path invalid" if config['app_path'].to_s.empty?
-      raise ConfigurationError, "export path invalid" if config['export_path'].to_s.empty?
-      raise ConfigurationError, "image base path invalid" if config['image_base_path'].to_s.empty?
-      config['stylesheets']['styles'].each do |css|
-        raise ConfigurationError, ".css extension not allowed on style definition: #{css}" if css =~ /\.css$/
-      end
-      config['javascripts']['dynamic_libraries'].each do |js|
-        raise ConfigurationError, ".js extension not allowed on javascript dynamic library definition: #{js}" if js =~ /\.js$/
-      end
-      raise ConfigurationError, "dynamic javascript libraries path invalid" if config['javascripts']['libraries_dest'].to_s.empty?
-    end
-
-    def load_config(file)
-      puts "Load configuration "
-      self.config = YAML.load_file(file)['terrific']
-    end
-
 
     def batch_download_files(relative_source_path, relative_dest_path, type_filter = "")
       source_path = relative_source_path

data/lib/options.rb

@@ -28,6 +28,9 @@ module TerrImporter
           o.on('-j', '--js', 'export configured javascript files') { self[:import_js] = true }
           o.on('--init', 'create configuration file in current working directory') { self[:init] = true }
           #todo add force option to init
+          o.on('-f', '--config CONFIG_FILE', 'use alternative configuration file') do |config_file|
+            self[:config_file] = config_file
+          end
 
           o.separator ''
           o.separator 'Additional configuration:'
@@ -59,7 +62,7 @@ module TerrImporter
       end
 
       def show_help_on_no_options
-        self[:show_help] = true unless self[:import_css] or self[:import_js] or self[:import_images] or self[:init]
+        self[:show_help] = true unless self[:import_css] or self[:import_js] or self[:import_images] or self[:init] or self[:version]
       end
 
     end

data/lib/terrimporter.rb

@@ -10,7 +10,6 @@ module TerrImporter
       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
@@ -50,12 +49,6 @@ module TerrImporter
         end
       end
 
-      #todo check force option, only override if not existing, else raise and exit
-      def create_config
-        FileUtils.cp(File.join(File.dirname(__FILE__), "..", "config", CONFIG_DEFAULT_NAME), File.join(Dir.pwd, CONFIG_DEFAULT_NAME))
-      end
-
-
       def build_options(arguments)
         env_opts_string = ENV['TERRIMPORTER_OPTS'] || ""
         env_opts = TerrImporter::Application::Options.new(shellwords(env_opts_string))

data/lib/terrimporter/version.rb

@@ -1,3 +1,3 @@
 module Terrimporter
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/terrimporter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["daniel.kummer@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{Import terrific javascripts, css files and images into a web project}
-  s.description = %q{This gem allows terrific(http://terrifically.org/) project import of css, javascript and image files based on a command line tool and a configuration file.}
+  s.description = %q{This gem allows terrific(http://terrifically.org/  ) project import of css, javascript and image files based on a command line tool and a configuration file.}
 
   s.rubyforge_project = "terrimporter"
 
@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "kwalify"
+
   s.add_development_dependency "shoulda", [">= 0"]
   s.add_development_dependency "bundler", ["~> 1.0.0"]
   s.add_development_dependency "jeweler", ["~> 1.6.4"]

data/test/unit/test_configuration.rb

@@ -0,0 +1,58 @@
+require "test/unit"
+require "kwalify"
+
+class ConfigurationTest < Test::Unit::TestCase
+
+  def setup
+    create_test_configuration_file
+    @configuration = TerrImporter::Application::Configuration.new @test_configuration_file
+    @configuration.load_configuration
+  end
+
+  def teardown
+    puts "Cleaning up configuration files"
+    delete_test_configuration_file
+  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
+  end
+
+  context 'test config file independed 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, TerrImporter::Application::Configuration::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, TerrImporter::Application::Configuration::CONFIG_DEFAULT_NAME)
+      FileUtils.rm_f config_path if File.exists? config_path
+      @configuration.create_config
+      assert File.exists?(config_path)
+    end
+  end
+
+  def schema_file_path
+    File.join(File.dirname(__FILE__), '..', '..', 'config', TerrImporter::Application::Configuration::SCHEMA_DEFAULT_NAME)
+  end
+
+  def create_test_configuration_file
+    example_configuration_path = File.join(File.dirname(__FILE__), '..', '..', 'config', TerrImporter::Application::Configuration::CONFIG_DEFAULT_NAME)
+    tmp_dir_path = File.join(File.dirname(__FILE__), '..', 'tmp')
+    test_configuration_path = File.join(tmp_dir_path, TerrImporter::Application::Configuration::CONFIG_DEFAULT_NAME)
+    FileUtils.mkdir(tmp_dir_path) unless File.exist? tmp_dir_path
+    FileUtils.cp example_configuration_path, test_configuration_path
+    @test_configuration_file = test_configuration_path
+  end
+
+  def delete_test_configuration_file
+    FileUtils.rm_rf @test_configuration_file if File.exists? @test_configuration_file
+  end
+
+end