structured-acceptance-test 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f581dbe460ec7e6c654bc3181df2fd8711a1b1a
-  data.tar.gz: 9bc1dc9372d8b0752531469be9ac83150d778750
+SHA256:
+  metadata.gz: 7eb89a8fd641e832bc16239d0d22c2e95e0614f04eafb5052ebf75ab73838eee
+  data.tar.gz: c75f33f0763a6be1bfa4c81d62e97438dcc94702fe1d745b619b4c6de9ebd9bd
 SHA512:
-  metadata.gz: 4b7826e641a54264490b0d6e985992cbb50b1d5c599c4b13835ae4e6ca42b48af15d26733fe8a5867ce2ef740b87212eb110f409a85159c20545bbdcda5c8ab0
-  data.tar.gz: 441400ecf15de90f27f44cf85512b47386bb65790e0f412f24990a2eec548954a737e6e86ac307327181962ced129e75148830b1b45ff033e648dcf94834a4d5
+  metadata.gz: cefb90c13ab6e0e616df7e5b520032798cd98b3833b2f61901044a47da7b5517155cf067d6019775bfbccbb6b26ebf24c4a9d776ddd13f43d8f4f231060781e5
+  data.tar.gz: 4040066d402612c070542ee6e3ccfd79f5db6810ce9984c7e4c58d719fe95dd0eff445cb4ad290c6e4788ca9f39704aa9a94b1ae82054cd1926b00897489eb7f

data/lib/JSONable.rb

@@ -9,6 +9,11 @@ module StatModule
     FORMATTING_BALL = '⚫'
     FORMATTING_WARNING = '⚠'
 
+    ##
+    # Initialize object extending JSONable
+    #
+    # Params:
+    # +hash+:: Hash
     def initialize(hash)
       if hash.is_a? Hash
         hash.each do |k, v|
@@ -46,6 +51,11 @@ module StatModule
       end
     end
 
+    ##
+    # Get object in pretty json format
+    #
+    # Params:
+    # +excluded_fields+:: array of String - attributes to exclude
     def to_json(excluded_fields = [])
       hash = {}
       self.instance_variables.each do |var|
@@ -54,7 +64,9 @@ module StatModule
       JSON.pretty_generate(hash)
     end
 
-    def self.from_json! string
+    ##
+    # Generate Hash from json string
+    def self.from_json!(string)
       JSON.load(string).each do |var, val|
         self.instance_variable_set '@' + var, val
       end

data/lib/category.rb

@@ -1,6 +1,16 @@
 module StatModule
   require 'enum'
 
+  ##
+  # Category can be:
+  # * Bug Risk — the meaning is likely to not be what the author intended
+  # * Clarity — the meaning is unclear
+  # * Compatibility — the meaning has changed and is no longer valid
+  # * Complexity — the meaning should be broken into smaller pieces
+  # * Duplication — unnecessary duplication was found
+  # * Performance — an inefficient approach was used
+  # * Security — a situation may allow access to something that should be allowed
+  # * Style — the style could be improved
   class Category < Enum::Base
     values 'Bug Risk', 'Clarity', 'Associative', 'Compatibility', 'Complexity', 'Duplication', 'Performance', 'Security', 'Style'
   end

data/lib/detail.rb

@@ -3,24 +3,43 @@ module StatModule
 
   class Detail < JSONable
 
+    ##
+    # Initialize new Detail object
+    #
+    # Params:
+    # +body+:: String, required
+    # +hash+:: Hash, can be null
     def initialize(body, hash = nil)
       if hash.is_a? Hash
         super(hash)
         return
       end
 
+      raise TypeException unless body.is_a?(String)
       @body = body
     end
 
+    ##
+    # Set body
+    #
+    # Params:
+    # +body+:: String
     def body=(body)
       raise TypeException unless body.is_a?(String)
       @body = body
     end
 
+    ##
+    # Get body
     def body
       @body
     end
 
+    ##
+    # Set trace
+    #
+    # Params:
+    # +trace+:: array of StatModule::Location objects
     def trace=(trace)
       raise TypeException unless trace.is_a?(Array)
       trace.each { |item|
@@ -30,6 +49,8 @@ module StatModule
       }
     end
 
+    ##
+    # Get trace
     def trace
       @trace
     end

data/lib/duplicate_element_exception.rb

@@ -1,4 +1,6 @@
 module StatModule
+  ##
+  # Duplicated element in array exception
   class DuplicateElementException < Exception
   end
 end

data/lib/finding.rb

@@ -3,6 +3,14 @@ module StatModule
 
   class Finding < JSONable
 
+    ##
+    # Initialize new Finding object
+    #
+    # Params:
+    # +failure+:: boolean, required
+    # +rule+:: String, required
+    # +description+:: String, required
+    # +hash+:: Hash, can be null
     def initialize(failure, rule, description, hash = nil)
       if hash.is_a? Hash
         super(hash)
@@ -15,32 +23,58 @@ module StatModule
       @description = description
     end
 
+    ##
+    # Set failure
+    #
+    # Params:
+    # +failure+:: boolean
     def failure=(failure)
       @failure = failure
     end
 
+    ##
+    # Get failure
     def failure
       @failure
     end
 
+    ##
+    # Set rule
+    #
+    # Params:
+    # +rule+:: String
     def rule=(rule)
       raise TypeException unless rule.is_a?(String)
       @rule = rule
     end
 
+    ##
+    # Get rule
     def rule
       @rule
     end
 
+    ##
+    # Set description
+    #
+    # Params:
+    # +description+:: String
     def description=(description)
       raise TypeException unless description.is_a?(String)
       @description = description
     end
 
+    ##
+    # Get description
     def description
       @description
     end
 
+    ##
+    # Set detail
+    #
+    # Params:
+    # +detail+:: StatModule::Detail
     def detail=(detail)
       raise TypeException unless detail.is_a?(StatModule::Detail)
       @detail = detail
@@ -50,6 +84,11 @@ module StatModule
       @detail
     end
 
+    ##
+    # Set array of categories
+    #
+    # Params:
+    # +categories+:: array of StatModule::Category
     def categories=(categories)
       raise TypeException unless categories.is_a?(Array)
       categories.each { |item|
@@ -59,37 +98,65 @@ module StatModule
       }
     end
 
+    ##
+    # Get array of StatModule::Category objects
     def categories
       @categories
     end
 
+    ##
+    # Set location
+    #
+    # Params:
+    # +location+:: StatModule::Location
     def location=(location)
       raise TypeException unless location.is_a?(Location)
       @location = location
     end
 
+    ##
+    # Get location
     def location
       @location
     end
 
+    ##
+    # Set time to fix
+    #
+    # Params:
+    # +time_to_fix+:: Integer
     def time_to_fix=(time_to_fix)
       raise TypeException unless time_to_fix.is_a?(Integer)
       @timeToFix = time_to_fix
     end
 
+    ##
+    # Get time to fix
     def time_to_fix
       @timeToFix
     end
 
+    ##
+    # Set recommendation
+    #
+    # Params:
+    # +recommendation+:: String
     def recommendation=(recommendation)
       raise TypeException unless recommendation.is_a?(String)
       @recommendation = recommendation
     end
 
+    ##
+    # Get recommendation
     def recommendation
       @recommendation
     end
 
+    ##
+    # Set fixes
+    #
+    # Params:
+    # +fixes+:: array of StatModule::Fix
     def fixes=(fixes)
       raise TypeException unless fixes.is_a?(Array)
       fixes.each { |item|
@@ -99,10 +166,18 @@ module StatModule
       }
     end
 
+    ##
+    # Get array of StatModule::Fix objects
     def fixes
       @fixes
     end
 
+    ##
+    # Get formatted information about findings
+    #
+    # Params:
+    #
+    # +formatted+:: indicate weather print boring or pretty colorful finding
     def print(formatted = false)
       result = "#{rule}, #{description}"
       if formatted

data/lib/fix.rb

@@ -3,6 +3,12 @@ module StatModule
 
   class Fix < JSONable
 
+    ##
+    # Initialize new Fix object
+    #
+    # Params:
+    # +location+:: StatModule::Location, required
+    # +hash+:: Hash, can be null
     def initialize(location, hash = nil)
       if hash.is_a? Hash
         super(hash)
@@ -11,20 +17,34 @@ module StatModule
       @location = location
     end
 
+    ##
+    # Set location
+    #
+    # Params:
+    # +location+:: StatModule::Location
     def location=(location)
       raise TypeException unless location.is_a?(StatModule::Location)
       @location = location
     end
 
+    ##
+    # Get location
     def location
       @location
     end
 
+    ##
+    # Set new text
+    #
+    # Params:
+    # +new_text+:: String
     def new_text=(new_text)
       raise TypeException unless new_text.is_a?(String)
       @newText = new_text
     end
 
+    ##
+    # Get new text
     def new_text
       @newText
     end

data/lib/index_out_of_bound_exception.rb

@@ -1,4 +1,6 @@
 module StatModule
+  ##
+  # Index out of array bound exception
   class IndexOutOfBoundException < Exception
   end
 end

data/lib/location.rb

@@ -3,59 +3,103 @@ module StatModule
 
   class Location < JSONable
 
+    ##
+    # Initialize new Location object
+    #
+    # Params:
+    # +process+:: String, required
+    # +hash+:: Hash, can be null
     def initialize(path, hash = nil)
       if hash.is_a? Hash
         super(hash)
         return
       end
+      raise TypeException unless path.is_a?(String)
       @path = path
     end
 
+    ##
+    # Set path
+    #
+    # Params:
+    # +path+:: String
     def path=(path)
       raise TypeException unless path.is_a?(String)
       @path = path
     end
 
+    ##
+    # Get path
     def path
       @path
     end
 
+    ##
+    # Set begin line
+    #
+    # Params:
+    # +begin_line+:: Integer
     def begin_line=(begin_line)
       raise TypeException unless begin_line.is_a?(Integer)
       @beginLine = begin_line
     end
 
+    ##
+    # Get begin line number
     def begin_line
       @beginLine
     end
 
+    ##
+    # Set begin column
+    #
+    # Params:
+    # +begin_column+:: Integer
     def begin_column=(begin_column)
       raise TypeException unless begin_column.is_a?(Integer)
       @beginColumn = begin_column
     end
 
+    ##
+    # Get begin column number
     def begin_column
       @beginColumn
     end
 
+    ##
+    # Set end line
+    #
+    # Params:
+    # +end_line+:: Integer
     def end_line=(end_line)
       raise TypeException unless end_line.is_a?(Integer)
       @endLine = end_line
     end
 
+    ##
+    # Get end line number
     def end_line
       @endLine
     end
 
+    ##
+    # Set end column
+    #
+    # Params:
+    # +end_column+:: Integer
     def end_column=(end_column)
       raise TypeException unless end_column.is_a?(Integer)
       @endColumn = end_column
     end
 
+    ##
+    # Get end column number
     def end_column
       @endColumn
     end
 
+    ##
+    # Get formatted information about location
     def print
       result = "in #{path}"
       if !begin_line.nil? && !end_line.nil?

data/lib/process.rb

@@ -4,6 +4,12 @@ module StatModule
 
   class Process < JSONable
 
+    ##
+    # Initialize new Process object
+    #
+    # Params:
+    # +name+:: String, name of the process, required
+    # +hash+:: Hash, can be null
     def initialize(name, hash = nil)
       if hash.is_a? Hash
         super(hash)
@@ -14,69 +20,124 @@ module StatModule
       @name = name
     end
 
+    ##
+    # Set name of the process
+    #
+    # Params:
+    # +name+:: String, name of the process, required
     def name=(name)
       raise TypeException unless name.is_a?(String)
       @name = name
     end
 
+    ##
+    # Get name of the process
     def name
       @name
     end
 
+    ##
+    # Set version
+    #
+    # Params:
+    # +version+:: String
     def version=(version)
       raise TypeException unless version.is_a?(String)
       @version = version
     end
 
+    ##
+    # Get version of the process
     def version
       @version
     end
 
+    ##
+    # Set description
+    #
+    # Params:
+    # +description+:: String
     def description=(description)
       raise TypeException unless description.is_a?(String)
       @description = description
     end
 
+    ##
+    # Get description
     def description
       @description
     end
 
+    ##
+    # Set maintainer
+    #
+    # Params:
+    # +maintainer+:: String
     def maintainer=(maintainer)
       raise TypeException unless maintainer.is_a?(String)
       @maintainer = maintainer
     end
 
+    ##
+    # Get maintainer
     def maintainer
       @maintainer
     end
 
+    ##
+    # Set email
+    #
+    # Params:
+    # +email+:: String
     def email=(email)
       raise TypeException unless email.is_a?(String)
       @email = email
     end
 
+    ##
+    # Get email
     def email
       @email
     end
 
+    ##
+    # Set website
+    #
+    # Params:
+    # +website+:: String
     def website=(website)
       raise TypeException unless website.is_a?(String)
       @website = website
     end
 
+    ##
+    # Get website
     def website
       @website
     end
 
+    ##
+    # Set repeatability
+    #
+    # Params:
+    # +repeatability+:: String
     def repeatability=(repeatability)
       raise TypeException unless Repeatability.all.include?(repeatability)
       @repeatability = repeatability
     end
 
+    ##
+    # Get repeatability
     def repeatability
       @repeatability
     end
 
+    ##
+    # Get formatted information about process
+    #
+    # Params:
+    #
+    # +formatted+:: indicate weather print boring or pretty colorful process
     def print(formatted = nil)
       result = name
       unless version.nil?

data/lib/repeatability.rb

@@ -1,6 +1,11 @@
 module StatModule
   require 'enum'
 
+  ##
+  # Repeatability can be:
+  # * Volatile — findings MAY change when repeating validation on the identical targets
+  # * Repeatable — Findings MUST be identical if the program is run again with the same inputs
+  # * Associative — Findings for targets [a, b] MUST equal the union of findings for [a] and [b] -- in other words, if only one file is changed, only that file need be tested
   class Repeatability < Enum::Base
     values 'Volatile', 'Repeatable', 'Associative'
   end

data/lib/{stat.rb → structured-acceptance-test.rb}

@@ -15,6 +15,12 @@ module StatModule
   class Stat < JSONable
     attr_reader :statVersion
 
+    ##
+    # Initialize new Stat object
+    #
+    # Params:
+    # +process+:: StatModule::Process, required
+    # +hash+:: Hash, can be null
     def initialize(process, hash = nil)
       @finding_print_index = 0
       @findings = []
@@ -29,6 +35,11 @@ module StatModule
       @process = process
     end
 
+    ##
+    # Set array of findings
+    #
+    # Params:
+    # +findings+:: Array of StatModule::Finding
     def findings=(findings)
       raise TypeException unless findings.is_a?(Array)
       findings.each { |item|
@@ -38,19 +49,31 @@ module StatModule
       }
     end
 
+    ##
+    # Get array of findings
     def findings
       @findings
     end
 
+    ##
+    # Set process
+    #
+    # Params:
+    # +process+:: instance of StatModule::Process
     def process=(process)
       raise TypeException unless process.is_a?(StatModule::Process)
       @process = process
     end
 
+    ##
+    # Get process
     def process
       @process
     end
 
+    ##
+    # Prints header of STAT object in json format
+    # Header contains statVersion, process and optional array of findings
     def print_header
       @finding_print_index = 0
       hash = {}
@@ -64,6 +87,8 @@ module StatModule
       $stdout.flush
     end
 
+    ##
+    # Prints one finding in json format.
     def print_finding
       if @finding_print_index < @findings.length
         result = @findings[@finding_print_index].to_json
@@ -77,6 +102,8 @@ module StatModule
       end
     end
 
+    ##
+    # Prints footer of STAT object in json format
     def print_footer
       @finding_print_index = 0
       puts ']}'
@@ -84,10 +111,18 @@ module StatModule
       $stdout.flush
     end
 
+    ##
+    # Get STAT object in json format
     def to_json(options = {})
       super(['finding_print_index'])
     end
 
+    ##
+    # Get statistic information about findings
+    #
+    # Params:
+    #
+    # +formatted+:: indicate weather print boring or pretty colorful statistic
     def summary_print(formatted = false)
       errors = 0
       warnings = 0

data/lib/type_exception.rb

@@ -1,4 +1,6 @@
 module StatModule
+  ##
+  # Wrong type exception
   class TypeException < Exception
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: structured-acceptance-test
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - William Entriken
 - Ilia Grabko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe-enum
@@ -37,20 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -87,13 +81,13 @@ files:
 - lib/location.rb
 - lib/process.rb
 - lib/repeatability.rb
-- lib/stat.rb
+- lib/structured-acceptance-test.rb
 - lib/type_exception.rb
 homepage: https://github.com/fulldecent/structured-acceptance-test
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: Structured acceptance test
 test_files: []