drep 0.3.3

data/lib/drep/alterers/drep_extenders.rb

@@ -0,0 +1,29 @@
+#    DRep - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of DRep.
+#
+#    DRep is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    DRep is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with DRep. If not, see <http://www.gnu.org/licenses/>.
+
+def extend_load_paths(src_file_name)
+  unless src_file_name.nil?
+    req_dir_name     = File.dirname(src_file_name)
+    req_abs_dir_name = File.expand_path(req_dir_name)
+
+    unless $LOAD_PATH.include?(req_dir_name) or
+             $LOAD_PATH.include?(req_abs_dir_name) then
+      $LOAD_PATH.unshift(req_dir_name)
+    end
+  end
+end

data/lib/drep/alterers/drep_helpers.rb

@@ -0,0 +1,221 @@
+#    DRep - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of DRep.
+#
+#    DRep is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    DRep is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with DRep. If not, see <http://www.gnu.org/licenses/>.
+
+class Object
+  def message(message)
+    if defined? @env.stdout
+      if not defined? @env.options.quiet or !@env.options.quiet
+        report(@env.stdout, message)
+      end
+    else
+      report(STDOUT, message)
+    end
+  end
+  alias msg message
+
+  def error(message)
+    if defined? @env.stderr
+      if not defined? @env.options.quiet or not @env.options.quiet
+        report(@env.stderr, message)
+      end
+    else
+      report(STDERR, message)
+    end
+  end
+  alias err error
+
+  def report(ios, message)
+    if ios.is_a?(IO) and
+         message.is_a?(String) then
+      ios.puts(message)
+    end
+  end
+
+  def form_str_from_list(list, separator = ', ')
+    result = ''
+
+    if list.is_a?(Array)
+      list.each_index do |i|
+        result += list[i].to_s()
+        result += (i != list.size - 1) ? separator.to_s() : ''
+      end
+    end
+
+    return result
+  end
+
+  def first_valid(item, *args)
+    result = item
+
+    if result.nil? and not args.nil?
+      args.each do |obj|
+        unless obj.nil?
+          result = obj; break
+        end
+      end
+    end
+
+    return result
+  end
+
+  def first_valid_text(strs, *patterns)
+    result = nil
+
+    if strs.is_a?(Array)
+      strs.each do |str|
+        if str.is_a?(String)
+          temp_str = str
+
+          if not temp_str.empty? and patterns.is_a?(Array)
+            temp_str.remove_nl!();  temp_str.br_to_nl!()
+            temp_str.strip_tags!(); temp_str.safe_strip!()
+
+            result = temp_str
+
+            patterns.each do |pattern|
+              if pattern.is_a?(Regexp) and
+                   not pattern.match(result).to_s().size == result.size
+                result = nil
+                break
+              end
+            end
+          end
+
+        end
+
+        break unless result.nil?
+      end
+    end
+
+    if result.nil?
+      result = ''
+    else
+      result.safe_strip!()
+    end
+
+    return result
+  end
+  alias first_text first_valid_text
+end
+
+class Array
+  def strip_tags()
+    result = []
+
+    self.each do |str|
+      if str.is_a?(String)
+        result << str.strip_tags()
+      end
+    end
+
+    return result
+  end
+end
+
+class Hash
+  def strip_tags()
+    result = {}
+
+    self.each do |key, str|
+      if str.is_a?(String)
+        result[key] = str.strip_tags()
+      end
+    end
+
+    return result
+  end
+end
+
+class String
+  def remove_nl!()
+    self.gsub!(/\n+/, '')
+    self.gsub!(/\r+/, '')
+    self.gsub!('\n', '')
+
+    return self
+  end
+
+  def remove_nl()
+    result = ''
+
+    result = self.gsub(/\n+/, '')
+
+    result.gsub!(/\r+/, '')
+    result.gsub!('\n', '')
+
+    return result
+  end
+
+  def safe_strip!()
+    self.gsub!(/\A[\s]+|[\s]+\z/m, '')
+
+    return self
+  end
+
+  def safe_strip()
+    return self.gsub(/\A[\s]+|[\s]+\z/m, '')
+  end
+
+  def strip_tags!()
+    self.gsub!(/<.*?>/, '')
+
+    return self
+  end
+
+  def strip_tags()
+    return self.gsub(/<.*?>/, '')
+  end
+
+  def br_to_nl!()
+    self.replace(self.split(/<br\s*[\/]?>/).join("\n"))
+
+    return self
+  end
+
+  def br_to_nl()
+    return self.split(/<br\s*[\/]?>/).join("\n")
+  end
+
+  def lspart(arg)
+    result = ''
+
+    pos = index(arg)
+    unless pos.nil?
+      result = self[(pos + 1)..-1]
+      unless result.nil?
+        result.safe_strip!()
+      end
+    end
+
+    return result
+  end
+
+  def rspart(arg)
+    result = ''
+
+    pos = index(arg)
+    unless pos.nil?
+      result = self[0..(pos - 1)]
+      unless result.nil?
+        result.safe_strip!()
+      end
+    end
+
+    return result
+  end
+end

data/lib/drep/alterers/drep_validators.rb

@@ -0,0 +1,117 @@
+#    DRep - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of DRep.
+#
+#    DRep is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    DRep is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with DRep. If not, see <http://www.gnu.org/licenses/>.
+
+class Object
+  def valid(item, *args, &block)
+    if valid?(item, *args)
+      yield block if block_given?
+    end
+  end
+
+  def valid?(item, *args, &block)
+    result = item.nil? ? false : true
+
+    if result and args.is_a?(Enumerable)
+      args.each do |obj|
+        if obj.nil? or obj.is_a?(FalseClass)
+          result = false; break
+        end
+      end
+    end
+
+    if block_given?
+      yield block if result
+    end
+
+    return result
+  end
+
+  def valid_string(item, *args, &block)
+    if valid_string?(item, *args)
+      yield block if block_given?
+    end
+  end
+
+  def valid_string?(item, *args, &block)
+    if item.is_a?(String) and !item.strip().empty?
+      result = true
+    else
+      result = false
+    end
+
+    if result and args.is_a?(Enumerable)
+      args.each do |obj|
+        if obj.nil? or
+             !obj.is_a?(String) or
+              obj.strip().empty? then
+          result = false; break
+        end
+      end
+    end
+
+    if block_given?
+      yield block if result
+    end
+
+    return result
+  end 
+
+  def valid_hash_args(*args, &block)
+    if valid_hash_args?(args)
+      yield block if block_given?
+    end
+  end
+
+  def valid_hash_args?(*args, &block)
+    result = args.is_a?(Array) ? true : false
+
+    if result
+      args.each do |property|
+
+        if property.is_a?(Hash)
+          property.each do |name, value|
+            unless name.is_a?(Symbol) or
+                    name.is_a?(String) then
+              result = false
+            end
+          end
+        else
+          result = false
+        end
+
+        break unless result
+      end
+    end
+
+    yield block if result and block_given?
+
+    return result
+  end 
+
+  def matched?(str, pattern)
+    result = false
+
+    if str.is_a?(String) and pattern.is_a?(Regexp)
+      if pattern.match(str).to_s().size == str.size
+        result = true
+      end 
+    end
+
+    return result
+  end
+end

data/lib/drep/core/drep_binder.rb

@@ -0,0 +1,102 @@
+#    DRep - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of DRep.
+#
+#    DRep is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    DRep is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with DRep. If not, see <http://www.gnu.org/licenses/>.
+
+extend_load_paths __FILE__
+require 'alterers/drep_helpers'
+require 'alterers/drep_validators'
+
+module DRep
+
+  class DRepBinder
+    attr_reader :env
+
+    attr_reader :__vars_data__
+
+    def initialize(environment, vars_data)
+      unless environment.nil?
+        @env = environment
+      else
+        raise(ArgumentError, "Invalid environment", caller())
+      end
+
+      @__vars_data__ = vars_data
+      inject_vars()
+    end
+
+    def get_binding()
+      return binding()
+    end
+
+    private
+    def inject_vars()
+      if @__vars_data__.is_a?(Array)
+
+        @__vars_data__.each do |data_blob|
+          if data_blob.is_a?(Hash)
+
+            data_blob.each do |name, value|
+              var_str_name = "@#{name.to_s()}"
+              unless var_str_name.nil?
+                if instance_variable_defined?(var_str_name)
+                  err("Variables overlapping occurred in #{var_str_name}")
+                end
+                instance_variable_set(var_str_name.intern(), value)
+              else
+                err('Variable name is in incorrect format')
+              end
+            end
+
+          else
+            err('Invalid inner data blob format')
+          end
+        end
+
+      else
+        err('Invalid variables data format')
+      end
+    end
+
+    def method_missing(mid, *args)
+      result = ''
+
+      if args.size == 0
+        if @__vars_data__.is_a?(Array)
+          temp_data = nil
+          @__vars_data__.each do |data_blob|
+            if data_blob.is_a?(Hash)
+              var_value = data_blob[mid]
+              temp_data = var_value unless var_value.nil?
+            else
+              err('Invalid inner data blob format')
+            end
+          end
+          valid temp_data do
+            result = temp_data
+          end
+        else
+          err('Invalid variables data format')
+        end
+      else
+        err("Value binding failed. Invalid method call: #{mid}")
+      end
+
+      return result
+    end
+  end
+  
+end

data/lib/drep/core/drep_environment.rb

@@ -0,0 +1,47 @@
+#    DRep - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of DRep.
+#
+#    DRep is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    DRep is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with DRep. If not, see <http://www.gnu.org/licenses/>.
+
+extend_load_paths __FILE__
+require 'alterers/drep_helpers'
+require 'alterers/drep_validators'
+
+module DRep
+  
+  class DRepEnvironment
+    attr_reader :stdin, :stdout, :stderr
+
+    attr_reader :options
+
+    def initialize(stdin, stdout, stderr, options)
+      if valid?(stdin, stdout, stderr)
+        @stdin  = stdin
+        @stdout = stdout
+        @stderr = stderr
+      else
+        raise('Not all standard streams are valid')
+      end
+
+      if valid?(options)
+        @options = options
+      else
+        raise('Options were not specified')
+      end
+    end
+  end
+
+end

data/lib/drep/core/drep_executer.rb

@@ -0,0 +1,199 @@
+#    DRep - Modular Open Software Tester.
+#    Copyright (C) 2009  Dmitrii Toksaitov
+#
+#    This file is part of DRep.
+#
+#    DRep is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    DRep is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with DRep. If not, see <http://www.gnu.org/licenses/>.
+
+require 'erb'
+
+require 'date'
+
+extend_load_paths __FILE__
+require 'alterers/drep_helpers'
+require 'alterers/drep_validators'
+
+require 'interfaces/drep_runnable'
+
+require 'drep_binder'
+
+module DRep
+
+  class DRepExecuter
+    include DRepRunnable
+
+    attr_reader :env
+
+    attr_reader :providers
+    attr_reader :templates
+
+    def initialize(environment, providers, templates)
+      unless environment.nil?
+        @env = environment
+      else
+        raise(ArgumentError, "Invalid environment", caller())
+      end
+
+      @providers = providers
+      @templates = templates
+    end
+
+    def run()
+      perform_tasks()
+    end
+
+    private
+    def perform_tasks()
+      vars = []
+
+      if valid?(@providers)
+        msg("Provider processing is about to start\n" +
+            "Number of providers to process: #{@providers.size}")
+
+        @providers.each do |provider|
+          extracted_vars = process_provider(provider)
+
+          unless extracted_vars.nil? or extracted_vars.empty?
+            vars << extracted_vars
+          end
+        end
+      else
+        err("Providers were not specified")
+      end
+
+      if valid?(@templates) and !vars.empty?
+        msg("Template processing is about to start\n" +
+            "Number of templates to process: #{@templates.size}")
+
+        @templates.each do |template|
+          process_template(template, vars)
+        end
+      else
+        err("Templates were not specified")
+      end
+    end
+
+    def process_provider(provider_def)
+      result = {}
+
+      extracted_vars = nil
+
+      provider = provider_def[:path]
+      if valid?(provider)
+        begin
+          msg("Processing provider: #{provider}")
+
+          require File.expand_path(provider)
+          if defined? Task.new()
+            extracted_vars = Task.new(@env).run(provider_def)
+          end
+        rescue Exception => e
+          err("Provider execution failed: #{e.message}")
+        end
+
+        if valid?(extracted_vars)
+          result = extracted_vars
+        else
+          err("Failed to get data from provider: #{provider}")
+        end
+      else
+        err("Invalid provider defenition")
+      end
+
+      return result
+    end
+
+    def process_template(template_def, vars)
+      if template_def.is_a?(Hash)
+        template_path = template_def[:path]
+        output        = template_def[:output]
+
+        if valid?(template_path)
+          begin
+            msg("Processing template: #{template_path}")
+            template_content = get_content(template_path)
+            valid template_content do
+              report = generate_report(template_content, vars)
+              output_ios = get_ios(output)
+
+              valid report, output_ios do
+                output_ios.write(report)
+              end
+            end
+          rescue Exception => e
+            err("Template population failed: #{e.message}")
+          end
+        else
+          err("Invalid template path")
+        end
+      else
+        err("Template defenition has invalid format")
+      end
+    end
+
+    def generate_report(template_content, vars)
+      result = nil
+
+      begin
+        msg("Forming variables binding")
+        data_binding = DRepBinder.new(@env, vars)
+
+        msg("Generating result")
+        erb_template = ERB.new(template_content, nil, '%<>')
+        result = erb_template.result(data_binding.get_binding())
+      rescue Exception => e
+        err("Report generation failed: #{e.message}")
+      end
+
+      return result
+    end
+
+    def get_content(path)
+      result = nil
+
+      begin
+        msg("Getting content: #{path}")
+        open(path) do |content|
+          result = content.read
+        end
+      rescue Exception => e
+        err("Failed to get content: #{e.message}")
+      end
+
+      return result
+    end
+    
+    def get_ios(output)
+      result = nil
+
+      begin
+        msg("Checking type of output")
+        if output.is_a?(String)
+          msg("Output destination: #{output}")
+          result = File.open(output, 'w+')
+        elsif output.is_a?(IO)
+          msg("Output provider: #{output.class}")
+          result = output
+        else
+          err("Result output object is invalid")
+        end
+      rescue Exception => e
+        err("Failed to check type of output: #{e.message}")
+      end
+
+      return result
+    end
+  end
+
+end