structured-acceptance-test 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b247928af0754f0da447bf44ad19fc76265c5c0
-  data.tar.gz: be9c9043e42ce03211f2792e96538da84d272e93
+  metadata.gz: 49cc33e85de90d729c0e7a88d5d9fdc198fd5249
+  data.tar.gz: 42509a0de215fd4956d1277b90265845cf0491b6
 SHA512:
-  metadata.gz: 027a533e426d3cd2363a478880ec516381e31a1d3a5eb3b4bea9aa2848d46823a291b6608d1fc75557a69a8b317f8ea727813e4e5e35995e566d22d7ba3f4025
-  data.tar.gz: 9f2b16309871ac643f2832e33fc0709d103197d2ae34e913b07d2ce133e9fe7389d450a77d64e93719a000d4d63661fc2c2d704c90dce7fb6942b8aa95bc7c9b
+  metadata.gz: 8dfdc18dc345aaac83b4f0386e68e1952143183576f1dcac592dfa14bbc8329e9416814c819ba8a11315ccde955852dddbb1fe24664ad36c165eb7e111d2b0ea
+  data.tar.gz: 334a82473516230ac3ce8831466f2dc7f9c628a4a4587bda0bcb55c613a24604be829192369e0365ca361393588e7a2a697455f781e760271239b4e7af1ace2f

data/lib/JSONable.rb

@@ -1,7 +1,51 @@
 module StatModule
   require 'json'
+  require 'colorize'
 
   class JSONable
+
+    FORMATTING_STAR = '⭐'
+    FORMATTING_CHECKMARK = '✅'
+    FORMATTING_BALL = '⚫'
+    FORMATTING_WARNING = '⚠'
+
+    def initialize(hash)
+      if hash.is_a? Hash
+        hash.each do |k, v|
+          if v.is_a? Array
+            items = []
+            v.each { |i|
+              case k
+                when 'findings'
+                  item = StatModule::Finding.new(nil, nil, nil, i)
+                when 'fixes'
+                  item = StatModule::Fix.new(nil, i)
+                when 'traces'
+                  item = StatModule::Location.new(nil, i)
+                else
+                  v = item
+              end
+              items.push(item)
+            }
+            v = items
+          end
+          if v.is_a? Hash
+            case k
+              when 'process'
+                v = StatModule::Process.new(nil, v)
+              when 'location'
+                v = StatModule::Location.new(nil, v)
+              when 'detail'
+                v = StatModule::Detail.new(nil, v)
+            end
+          end
+          self.instance_variable_set("@#{k}", v) ## create and initialize an instance variable for this key/value pair
+          self.class.send(:define_method, k, proc { self.instance_variable_get("@#{k}") }) ## create the getter that returns the instance variable
+          self.class.send(:define_method, "#{k}=", proc { |v| self.instance_variable_set("@#{k}", v) }) ## create the setter that sets the instance variable
+        end
+      end
+    end
+
     def to_json(excluded_fields = [])
       hash = {}
       self.instance_variables.each do |var|
@@ -9,5 +53,11 @@ module StatModule
       end
       hash.to_json
     end
+
+    def self.from_json! string
+      JSON.load(string).each do |var, val|
+        self.instance_variable_set '@' + var, val
+      end
+    end
   end
 end

data/lib/detail.rb

@@ -3,9 +3,15 @@ module StatModule
 
   class Detail < JSONable
 
-    def initialize(body)
-      @body = body
+    def initialize(body, hash = nil)
       @trace = []
+
+      if hash.is_a? Hash
+        super(hash)
+        return
+      end
+
+      @body = body
     end
 
     def body=(body)

data/lib/finding.rb

@@ -3,13 +3,19 @@ module StatModule
 
   class Finding < JSONable
 
-    def initialize(failure, rule, description)
+    def initialize(failure, rule, description, hash = nil)
+      @categories = []
+      @fixes = []
+
+      if hash.is_a? Hash
+        super(hash)
+        return
+      end
+
       raise TypeException unless rule.is_a?(String) && description.is_a?(String)
       @failure = failure
       @rule = rule
       @description = description
-      @categories = []
-      @fixes = []
     end
 
     def failure=(failure)
@@ -99,5 +105,19 @@ module StatModule
     def fixes
       @fixes
     end
+
+    def print(formatted = false)
+      result = "#{rule}, #{description}"
+      if formatted
+        if failure
+          result = "#{FORMATTING_BALL} #{result}".colorize(:red)
+        else
+          result = "#{FORMATTING_WARNING} #{result}".colorize(:yellow)
+        end
+      end
+      result += "\n#{location.print}" unless location.nil?
+      result += "\nRECOMMENDATION: #{recommendation}" unless recommendation.nil?
+      result
+    end
   end
 end

data/lib/fix.rb

@@ -3,7 +3,11 @@ module StatModule
 
   class Fix < JSONable
 
-    def initialize(location)
+    def initialize(location, hash = nil)
+      if hash.is_a? Hash
+        super(hash)
+        return
+      end
       @location = location
     end
 

data/lib/location.rb

@@ -3,7 +3,11 @@ module StatModule
 
   class Location < JSONable
 
-    def initialize(path)
+    def initialize(path, hash = nil)
+      if hash.is_a? Hash
+        super(hash)
+        return
+      end
       @path = path
     end
 
@@ -51,5 +55,30 @@ module StatModule
     def end_column
       @endColumn
     end
+
+    def print
+      result = "in #{path}"
+      if !begin_line.nil? && !end_line.nil?
+        if begin_line != end_line
+          if !begin_column.nil? && !end_column.nil?
+            result += ", line #{begin_line}:#{begin_column} to line #{end_line}:#{end_column}"
+          elsif !begin_column.nil? && end_column.nil?
+            result += ", line #{begin_line}:#{begin_column} to line #{end_line}"
+          elsif begin_column.nil? && !end_column.nil?
+            result += ", line #{begin_line} to line #{end_line}:#{end_column}"
+          else
+            result += ", lines #{begin_line}-#{end_line}"
+          end
+        else
+          if begin_column.nil?
+            result += ", line #{begin_line}"
+          else
+            result += ", line #{begin_line}:#{begin_column}"
+            result += "-#{end_column}" unless end_column.nil?
+          end
+        end
+      end
+      result
+    end
   end
 end

data/lib/process.rb

@@ -1,76 +1,91 @@
 module StatModule
 
-require_relative 'JSONable'
-
-class Process < JSONable
-
-  def initialize(name)
-    raise TypeException unless name.is_a?(String)
-    @name = name
-  end
-
-  def name=(name)
-    raise TypeException unless name.is_a?(String)
-    @name = name
-  end
-
-  def name
-    @name
-  end
-
-  def version=(version)
-    raise TypeException unless version.is_a?(String)
-    @version = version
-  end
-
-  def version
-    @version
-  end
-
-  def description=(description)
-    raise TypeException unless description.is_a?(String)
-    @description = description
-  end
-
-  def description
-    @description
-  end
-
-  def maintainer=(maintainer)
-    raise TypeException unless maintainer.is_a?(String)
-    @maintainer = maintainer
+  require_relative 'JSONable'
+
+  class Process < JSONable
+
+    def initialize(name, hash)
+      if hash.is_a? Hash
+        super(hash)
+        return
+      end
+
+      raise TypeException unless name.is_a?(String)
+      @name = name
+    end
+
+    def name=(name)
+      raise TypeException unless name.is_a?(String)
+      @name = name
+    end
+
+    def name
+      @name
+    end
+
+    def version=(version)
+      raise TypeException unless version.is_a?(String)
+      @version = version
+    end
+
+    def version
+      @version
+    end
+
+    def description=(description)
+      raise TypeException unless description.is_a?(String)
+      @description = description
+    end
+
+    def description
+      @description
+    end
+
+    def maintainer=(maintainer)
+      raise TypeException unless maintainer.is_a?(String)
+      @maintainer = maintainer
+    end
+
+    def maintainer
+      @maintainer
+    end
+
+    def email=(email)
+      raise TypeException unless email.is_a?(String)
+      @email = email
+    end
+
+    def email
+      @email
+    end
+
+    def website=(website)
+      raise TypeException unless website.is_a?(String)
+      @website = website
+    end
+
+    def website
+      @website
+    end
+
+    def repeatability=(repeatability)
+      raise TypeException unless Repeatability.all.include?(repeatability)
+      @repeatability = repeatability
+    end
+
+    def repeatability
+      @repeatability
+    end
+
+    def print(formatted = nil)
+      result = name
+      unless version.nil?
+        result += ", version #{version}"
+      end
+      if formatted
+        result = "#{FORMATTING_STAR.colorize(:yellow)} #{result}"
+      end
+      result
+    end
   end
-
-  def maintainer
-    @maintainer
-  end
-
-  def email=(email)
-    raise TypeException unless email.is_a?(String)
-    @email = email
-  end
-
-  def email
-    @email
-  end
-
-  def website=(website)
-    raise TypeException unless website.is_a?(String)
-    @website = website
-  end
-
-  def website
-    @website
-  end
-
-  def repeatability=(repeatability)
-    raise TypeException unless Repeatability.all.include?(repeatability)
-    @repeatability = repeatability
-  end
-
-  def repeatability
-    @repeatability
-  end
-end
-
 end

data/lib/stat.rb

@@ -15,12 +15,18 @@ module StatModule
   class Stat < JSONable
     attr_reader :statVersion
 
-    def initialize(process)
+    def initialize(process, hash = nil)
+      @finding_print_index = 0
+      @findings = []
+
+      if hash.is_a? Hash
+        super(hash)
+        return
+      end
+
       raise TypeException unless process.is_a?(StatModule::Process)
       @statVersion = '1.0.0'
       @process = process
-      @findings = []
-      @finding_print_index = 0
     end
 
     def findings=(findings)
@@ -55,6 +61,7 @@ module StatModule
       result = result[0..result.length - 3]
       puts(result)
       puts
+      $stdout.flush
     end
 
     def print_finding
@@ -63,6 +70,7 @@ module StatModule
         result += ',' unless @finding_print_index >= @findings.length - 1
         puts(result)
         puts
+        $stdout.flush
         @finding_print_index += 1
       else
         raise IndexOutOfBoundException
@@ -73,10 +81,37 @@ module StatModule
       @finding_print_index = 0
       puts ']}'
       puts
+      $stdout.flush
     end
 
     def to_json(options = {})
       super(['finding_print_index'])
     end
+
+    def summary_print(formatted = false)
+      errors = 0
+      warnings = 0
+      findings.each { |finding|
+        if finding.failure
+          errors += 1
+        else
+          warnings += 1
+        end
+      }
+      if errors == 0 && warnings == 0
+        result = "#{FORMATTING_CHECKMARK} PASSED with no warning".colorize(:green)
+      elsif errors == 0
+        result = "#{FORMATTING_WARNING} PASSED with #{warnings} warning".colorize(:yellow)
+      elsif warnings == 0
+        result = "#{FORMATTING_BALL} FAILED with #{errors} error".colorize(:red)
+      else
+        result = "#{FORMATTING_BALL} FAILED with #{errors} error and #{warnings} warning".colorize(:red)
+      end
+      if formatted
+        result
+      else
+        result[result.index(' ') + 1..result.length]
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: structured-acceptance-test
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - William Entriken
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies: []
 description: Structured acceptance test data structure gem
 email: github.com@phor.net