steplib 0.0.0.0 → 0.9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e3c30d11a10f40220b04db01b9a8123c746eb46
-  data.tar.gz: 7f519032f630ab11195cf9e6ebad91b76b1409c4
+  metadata.gz: c0532328cd85829decb7abc6f975c613bf779c5b
+  data.tar.gz: 068bb9377741bb74f22a463edc3d1a35675bbba0
 SHA512:
-  metadata.gz: 6079617bd9a1ab65ec3bb4e48b9b2ea1a940a24aeca7041e251c9dff2e96c397319e6ac1534c0a26925756194fe39ac1c68f4adcb15c76df17049f58ece7e909
-  data.tar.gz: 0dc7cd1493257d6731e4e537e62a7231170f6a0ec61b7ba44a850cd168959d3ce22e7f17e8143633dcbe0f4897812cbd024ed1ce985c1984565fbae745ad8a49
+  metadata.gz: 75730c68760bc91caf0da54870b73789621929425161036c26ed73aeca204471da68b2579c4a7b98f24258732420c101c98a3db3dc08440514474c7845c2d14b
+  data.tar.gz: a4b16e7993fcede8fe53bfe5875346cfbd0bf10fce36b3c573f35b8aea6e627fe53036d410ffb5f5a572aa599414bf2eb28e237a94b928a596dd90c6426b2f53

data/lib/steplib/hash_utils.rb

@@ -7,20 +7,90 @@ class FalseClass; include ABooleanValue; end
 
 module Steplib
 	class HashUtils
-		def self.check_required_attributes_and_types!(hash_to_check, attribute_type_array)
-			attribute_type_array.each do |a_attribute_type_itm|
-				attribute_key = a_attribute_type_itm[0]
-				attribute_type = a_attribute_type_itm[1]
-				#
-				attr_value = hash_to_check[attribute_key]
-				if attr_value.nil?
-					raise "Attribute (#{attribute_key}) not found in hash"
+		class << self
+
+			def deep_copy(hsh)
+				return Marshal.load(Marshal.dump(hsh))
+			end
+
+			def check_required_attributes_and_types!(hash_to_check, attribute_type_array)
+				attribute_type_array.each do |a_attribute_type_itm|
+					attribute_key = a_attribute_type_itm[0]
+					attribute_type = a_attribute_type_itm[1]
+					#
+					attr_value = hash_to_check[attribute_key]
+					if attr_value.nil?
+						raise "Attribute (#{attribute_key}) not found in hash"
+					end
+					unless attr_value.is_a? attribute_type
+						raise "Attribute (#{attribute_key}) found, but it's type (#{attr_value.class}) doesn't match the required (#{attribute_type})"
+					end
 				end
-				unless attr_value.is_a? attribute_type
-					raise "Attribute (#{attribute_key}) found, but it's type (#{attr_value.class}) doesn't match the required (#{attribute_type})"
+				return true
+			end
+
+			#
+			# Sets the provided default value for the specified
+			#  key if the key is missing.
+			# Defaults_arr is an array of {:key=>,:value=>} hashes
+			# Doesn't do a copy of input hash, will inline-set
+			#  the attributes / modify the input hash!
+			def set_missing_defaults(hsh, defaults_arr)
+				defaults_arr.each do |a_def|
+					a_def_key = a_def[:key]
+					a_def_value = a_def[:value]
+					if hsh[a_def_key].nil?
+						hsh[a_def_key] = a_def_value
+					end
 				end
+				return hsh
+			end
+			# Deep-copy version
+			# Returns a new hash, the original input hash will be kept unchanged!
+			def set_missing_defaults_dcopy(in_hsh, defaults_arr)
+				hsh = deep_copy(in_hsh)
+				return set_missing_defaults(hsh, defaults_arr)
 			end
-			return true
+
+			#
+			# Copies the listed attributes from the copy_from hash
+			#  to the copy_to hash in case the attribute is missing
+			#  from copy_to hash.
+			# Doesn't do a copy of input hash, will inline-set
+			#  the attributes / modify the input hash!
+			def copy_missing_defaults(hsh_copy_to, hsh_copy_from, attr_to_copy_list)
+				attr_to_copy_list.each do |a_attr_to_copy|
+					if hsh_copy_to[a_attr_to_copy].nil?
+						hsh_copy_to[a_attr_to_copy] = hsh_copy_from[a_attr_to_copy]
+					end
+				end
+				return hsh_copy_to
+			end
+			# Deep-copy version
+			# Returns a new hash, the original input hash will be kept unchanged!
+			def copy_missing_defaults_dcopy(in_hsh_copy_to, hsh_copy_from, attr_to_copy_list)
+				hsh_copy_to = deep_copy(in_hsh_copy_to)
+				return copy_missing_defaults(hsh_copy_to, hsh_copy_from, attr_to_copy_list)
+			end
+
+			#
+			# Copies the listed attributes from the copy_from hash
+			#  to the copy_to hash.
+			# Doesn't do a copy of input hash, will inline-set
+			#  the attributes / modify the input hash!
+			def copy_attributes(hsh_copy_to, hsh_copy_from, attr_to_copy_list)
+				attr_to_copy_list.each do |a_attr_to_copy|
+					hsh_copy_to[a_attr_to_copy] = hsh_copy_from[a_attr_to_copy]
+				end
+				return hsh_copy_to
+			end
+			# Deep-copy version
+			# Returns a new hash, the original input hash will be kept unchanged!
+			def copy_attributes_dcopy(in_hsh_copy_to, hsh_copy_from, attr_to_copy_list)
+				hsh_copy_to = deep_copy(in_hsh_copy_to)
+				return copy_attributes(hsh_copy_to, hsh_copy_from, attr_to_copy_list)
+			end
+
 		end
 	end
 end

data/lib/steplib/steplib_validator.rb

@@ -0,0 +1,114 @@
+require_relative 'hash_utils'
+
+module Steplib
+	class SteplibValidator
+		class << self
+
+			def validate_steplib!(steplib_data)
+				expected_format_version = '0.9.0'
+
+				if steplib_data['format_version'] != expected_format_version
+					raise "Invalid format_version, expected (#{expected_format_version}) got (#{steplib_data['format_version']})"
+				end
+
+				HashUtils.check_required_attributes_and_types!(steplib_data, [
+					['format_version', String],
+					['generated_at_timestamp', Fixnum],
+					['steplib_source', String],
+					['steps', Hash]
+					])
+
+				steps_arr = steplib_data['steps']
+				steps_arr.each do |a_step_id, a_step_data|
+					validate_step!(a_step_data)
+				end
+			end
+
+			def validate_step!(step_data)
+				HashUtils.check_required_attributes_and_types!(step_data, [
+					['id', String],
+					['versions', Array],
+					['latest', Hash]
+					])
+
+				# validate the versions
+				step_version_datas = step_data['versions']
+				step_version_datas.each do |a_step_version_data|
+					validate_step_version!(a_step_version_data)
+				end
+
+				# also validate the 'latest' item
+				validate_step_version!(step_data['latest'])
+			end
+
+			def validate_step_version!(step_version_data)
+				HashUtils.check_required_attributes_and_types!(step_version_data, [
+					# auto generated
+					['id', String],
+					['steplib_source', String],
+					['version_tag', String],
+					# data from step.yml
+					['name', String],
+					['description', String],
+					['website', String],
+					['fork_url', String],
+					['source', Hash],
+					['host_os_tags', Array],
+					['project_type_tags', Array],
+					['type_tags', Array],
+					['is_requires_admin_user', ABooleanValue],
+					['inputs', Array],
+					['outputs', Array],
+					])
+
+					HashUtils.check_required_attributes_and_types!(step_version_data['source'], [
+						['git', String]
+						])
+
+					a_host_os_tags = step_version_data['host_os_tags']
+					a_host_os_tags.each { |a_tag|
+						raise "Invalid host-os-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
+					}
+
+					a_project_type_tags = step_version_data['project_type_tags']
+					a_project_type_tags.each { |a_tag|
+						raise "Invalid project-type-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
+					}
+
+					a_type_tags = step_version_data['type_tags']
+					a_type_tags.each { |a_tag|
+						raise "Invalid type-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
+					}
+
+					a_inputs = step_version_data['inputs']
+					a_inputs.each do |a_input_itm|
+						HashUtils.check_required_attributes_and_types!(a_input_itm, [
+						['title', String],
+						['description', String],
+						['mapped_to', String],
+						['is_expand', ABooleanValue],
+						['is_required', ABooleanValue],
+						['value_options', Array],
+						['value', String],
+						['is_dont_change_value', ABooleanValue]
+						])
+
+						a_value_options = a_input_itm['value_options']
+						a_value_options.each { |a_value_option|
+							raise "Invalid value-option (#{a_value_option}), not a String (class: #{a_value_option.class})!" unless a_value_option.is_a? String
+						}
+					end
+
+					a_outputs = step_version_data['outputs']
+					a_outputs.each do |a_output_itm|
+						HashUtils.check_required_attributes_and_types!(a_output_itm, [
+						['title', String],
+						['description', String],
+						['mapped_to', String]
+						])
+					end
+			end
+
+		end
+	end
+end

data/lib/steplib/workflow_updater.rb

@@ -0,0 +1,96 @@
+require_relative 'steplib_validator'
+require_relative 'hash_utils'
+
+module Steplib
+	class WorkflowUpdater
+		class << self
+
+			#
+			# The input steplib_step_version have to be a valid step-version!
+			# The input workflow_step is not copied, modified in-inline!
+			# Also: inputs which can't be found in the steplib-step-version
+			#  WILL BE REMOVED and inputs which can be found in the steplib-step-version
+			#  but not in the workflow-step inputs WILL BE ADDED
+			# Because of the potential destructive nature of this method you
+			#  should use it carefully and you can expect an exception/error raised for:
+			#  * steplib-step-version is not valid
+			#  * steplib-step-version's version_tag doesn't match the workflow_step's version_tag
+			#  * missing 'version_tag' in workflow_step
+			def update_workflow_step_with_steplib_step_version!(workflow_step, steplib_step_version)
+				#
+				SteplibValidator.validate_step_version!(steplib_step_version)
+				raise "Missing 'version_tag'" if workflow_step['version_tag'].nil?
+				if workflow_step['version_tag'] != steplib_step_version['version_tag']
+					raise "Workflow-step 'version_tag' doesn't match the steplib-step-version's"
+				end
+				#
+				# copy all except:
+				# * name
+				# * version_tag
+				workflow_step = HashUtils.copy_attributes(
+					workflow_step,
+					steplib_step_version,
+					[
+						'id', 'steplib_source', 'description',
+						'website', 'fork_url', 'source', 'host_os_tags',
+						'project_type_tags', 'type_tags', 'is_requires_admin_user'
+					]
+					)
+
+				# update inputs and remove the ones which can't be
+				#  found in the steplib step version's inputs
+				#  and add the missing ones
+				# update except:
+				#  * mapped_to
+				#  * value
+				steplib_step_version_inputs = steplib_step_version['inputs']
+				workflow_step['inputs'] = workflow_step['inputs'].map { |a_wf_step_inp|
+					# search for the same input in the steplib-step-version
+					related_steplib_input = steplib_step_version_inputs.find do |possible_inp|
+						if possible_inp['mapped_to'] == a_wf_step_inp['mapped_to']
+							true
+						else
+							false
+						end
+					end
+					if related_steplib_input.nil?
+						# not found - remove (w/ .compact)
+						# return:
+						nil
+					else
+						a_wf_step_inp = HashUtils.copy_attributes(
+							a_wf_step_inp,
+							related_steplib_input,
+							['title', 'description', 'is_expand',
+								'is_required', 'value_options', 'is_dont_change_value']
+							)
+						# return:
+						a_wf_step_inp
+					end
+				}.compact # .compact removes nil elements
+				# add missing ones
+				wf_step_inputs = workflow_step['inputs']
+				missing_inputs = steplib_step_version_inputs.select { |a_steplib_input|
+					wf_step_input = wf_step_inputs.find do |a_wf_inp|
+						if a_wf_inp['mapped_to'] == a_steplib_input['mapped_to']
+							true
+						else
+							false
+						end
+					end
+					# add, if not found
+					# return:
+					wf_step_input.nil?
+				}
+				workflow_step['inputs'] = wf_step_inputs.concat(missing_inputs)
+
+				# update outputs to match the steplib-step-version's
+				#  output list
+				workflow_step['outputs'] = Steplib::HashUtils.deep_copy(steplib_step_version['outputs'])
+
+				return workflow_step
+			end
+
+		end
+	end
+end

data/lib/steplib/workflow_utils.rb

@@ -0,0 +1,45 @@
+require_relative 'hash_utils'
+
+module Steplib
+	class WorkflowUtils
+		class << self
+
+			def create_workflow_environment_item(title, mapped_to, value, is_expand)
+				return {
+					'title' => title.to_s,			 	# string
+					'mapped_to' => mapped_to.to_s,		# string
+					'value' => value.to_s,				# string
+					'is_expand' => !!is_expand			# bool
+				}
+			end
+
+			def create_workflow_base_template
+				workflow_base_template = {
+					'format_version' => '0.9.0',
+					'environments' => [],
+					'steps' => []
+				}
+				return workflow_base_template
+			end
+
+			def create_workflow_step_from_steplib_step(steplib_step, position_in_workflow, is_always_run=false)
+				wf_step = HashUtils.deep_copy(steplib_step).merge({
+					'position_in_workflow' => position_in_workflow.to_i,
+					'is_always_run' => !!is_always_run,
+					})
+				return wf_step
+			end
+
+			def create_workflow_from_step_versions(steplib_step_versions, workflow_environments=[])
+				workflow_data = create_workflow_base_template()
+				workflow_data['steps'] = steplib_step_versions.map.with_index { |steplib_step_ver, idx|
+					# return:
+					create_workflow_step_from_steplib_step(steplib_step_ver, idx, false)
+				}
+				workflow_data['environments'] = workflow_environments
+				return workflow_data
+			end
+
+		end
+	end
+end

data/lib/steplib/workflow_validator.rb

@@ -0,0 +1,111 @@
+require_relative 'hash_utils'
+
+module Steplib
+	class WorkflowValidator
+		class << self
+
+			def validate_workflow!(workflow_data)
+				expected_format_version = '0.9.0'
+				if workflow_data['format_version'] != expected_format_version
+					raise "Invalid format_version, expected (#{expected_format_version}) got (#{workflow_data['format_version']})"
+				end
+
+				HashUtils.check_required_attributes_and_types!(workflow_data, [
+					['format_version', String],
+					['environments', Array],
+					['steps', Array]
+					])
+
+				envs_arr = workflow_data['environments']
+				envs_arr.each do |a_env_data|
+					validate_workflow_environment!(a_env_data)
+				end
+
+				steps_arr = workflow_data['steps']
+				steps_arr.each do |a_step_data|
+					validate_workflow_step!(a_step_data)
+				end
+			end
+
+			def validate_workflow_environment!(env_item_data)
+				HashUtils.check_required_attributes_and_types!(env_item_data, [
+					['title', String],
+					['mapped_to', String],
+					['is_expand', ABooleanValue],
+					['value', String],
+					])
+			end
+
+			def validate_workflow_step!(workflow_step_data)
+				HashUtils.check_required_attributes_and_types!(workflow_step_data, [
+					['position_in_workflow', Fixnum],
+					['is_always_run', ABooleanValue],
+					# auto generated
+					['id', String],
+					['steplib_source', String],
+					['version_tag', String],
+					# data from step.yml
+					['name', String],
+					['description', String],
+					['website', String],
+					['fork_url', String],
+					['source', Hash],
+					['host_os_tags', Array],
+					['project_type_tags', Array],
+					['type_tags', Array],
+					['is_requires_admin_user', ABooleanValue],
+					['inputs', Array],
+					['outputs', Array],
+					])
+
+					HashUtils.check_required_attributes_and_types!(workflow_step_data['source'], [
+						['git', String]
+						])
+
+					a_host_os_tags = workflow_step_data['host_os_tags']
+					a_host_os_tags.each { |a_tag|
+						raise "Invalid host-os-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
+					}
+
+					a_project_type_tags = workflow_step_data['project_type_tags']
+					a_project_type_tags.each { |a_tag|
+						raise "Invalid project-type-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
+					}
+
+					a_type_tags = workflow_step_data['type_tags']
+					a_type_tags.each { |a_tag|
+						raise "Invalid type-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
+					}
+
+					a_inputs = workflow_step_data['inputs']
+					a_inputs.each do |a_input_itm|
+						HashUtils.check_required_attributes_and_types!(a_input_itm, [
+						['title', String],
+						['description', String],
+						['mapped_to', String],
+						['is_expand', ABooleanValue],
+						['is_required', ABooleanValue],
+						['value_options', Array],
+						['value', String],
+						['is_dont_change_value', ABooleanValue]
+						])
+
+						a_value_options = a_input_itm['value_options']
+						a_value_options.each { |a_value_option|
+							raise "Invalid value-option (#{a_value_option}), not a String (class: #{a_value_option.class})!" unless a_value_option.is_a? String
+						}
+					end
+
+					a_outputs = workflow_step_data['outputs']
+					a_outputs.each do |a_output_itm|
+						HashUtils.check_required_attributes_and_types!(a_output_itm, [
+						['title', String],
+						['description', String],
+						['mapped_to', String]
+						])
+					end
+			end
+
+		end
+	end
+end

data/lib/steplib.rb

@@ -1,2 +1,5 @@
 require_relative 'steplib/hash_utils'
-require_relative 'steplib/validator'
+require_relative 'steplib/steplib_validator'
+require_relative 'steplib/workflow_updater'
+require_relative 'steplib/workflow_utils'
+require_relative 'steplib/workflow_validator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steplib
 version: !ruby/object:Gem::Version
-  version: 0.0.0.0
+  version: 0.9.0.1
 platform: ruby
 authors:
 - Bitrise
@@ -20,10 +20,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/steplib.rb
-- lib/steplib/format_corrector.rb
 - lib/steplib/hash_utils.rb
-- lib/steplib/validator.rb
-homepage: https://github.com/steplib/steplib
+- lib/steplib/steplib_validator.rb
+- lib/steplib/workflow_updater.rb
+- lib/steplib/workflow_utils.rb
+- lib/steplib/workflow_validator.rb
+homepage: https://github.com/steplib/steplib_gem
 licenses:
 - MIT
 metadata: {}
@@ -46,5 +48,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: StepLib.com's validator and other utilities
+summary: StepLib.com's validator and other utilities GEM
 test_files: []

data/lib/steplib/format_corrector.rb

@@ -1,16 +0,0 @@
-require_relative 'validator'
-
-module Steplib
-	class FormatCorrector
-
-		def initialize(workflow_data)
-			@workflow_data = workflow_data
-		end
-
-		def inject_missing_default_values_from_step_version(step_version_data)
-			
-			return step_version_data
-		end
-
-	end
-end

data/lib/steplib/validator.rb

@@ -1,114 +0,0 @@
-require_relative 'hash_utils'
-
-module Steplib
-	class Validator
-
-		def initialize(workflow_data)
-			@workflow_data = workflow_data
-			#
-			@expected_format_version = '0.9.0'
-		end
-
-		def validate!
-			if @workflow_data['format_version'] != @expected_format_version
-				raise "Invalid format_version, expected (#{@expected_format_version}) got (#{@workflow_data['format_version']})"
-			end
-
-			HashUtils.check_required_attributes_and_types!(@workflow_data, [
-				['format_version', String],
-				['environments', Array],
-				['steps', Array]
-				])
-
-			envs_arr = @workflow_data['environments']
-			envs_arr.each do |a_env_data|
-				validate_workflow_environment!(a_env_data)
-			end
-
-			steps_arr = @workflow_data['steps']
-			steps_arr.each do |a_step_data|
-				validate_workflow_step!(a_step_data)
-			end
-		end
-
-		def validate_workflow_environment!(env_item_data)
-			HashUtils.check_required_attributes_and_types!(env_item_data, [
-				['title', String],
-				['mapped_to', String],
-				['is_expand', ABooleanValue],
-				['value', String],
-				])
-		end
-
-		def validate_workflow_step!(workflow_step_data)
-			HashUtils.check_required_attributes_and_types!(workflow_step_data, [
-				['position_in_workflow', Fixnum],
-				['is_always_run', ABooleanValue],
-				# auto generated
-				['id', String],
-				['steplib_source', String],
-				['version_tag', String],
-				# data from step.yml
-				['name', String],
-				['description', String],
-				['website', String],
-				['fork_url', String],
-				['source', Hash],
-				['host_os_tags', Array],
-				['project_type_tags', Array],
-				['type_tags', Array],
-				['is_requires_admin_user', ABooleanValue],
-				['inputs', Array],
-				['outputs', Array],
-				])
-
-				HashUtils.check_required_attributes_and_types!(workflow_step_data['source'], [
-					['git', String]
-					])
-
-				a_host_os_tags = workflow_step_data['host_os_tags']
-				a_host_os_tags.each { |a_tag|
-					raise "Invalid host-os-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
-				}
-
-				a_project_type_tags = workflow_step_data['project_type_tags']
-				a_project_type_tags.each { |a_tag|
-					raise "Invalid project-type-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
-				}
-
-				a_type_tags = workflow_step_data['type_tags']
-				a_type_tags.each { |a_tag|
-					raise "Invalid type-tag (#{a_tag}), not a String (class: #{a_tag.class})!" unless a_tag.is_a? String
-				}
-
-				a_inputs = workflow_step_data['inputs']
-				a_inputs.each do |a_input_itm|
-					HashUtils.check_required_attributes_and_types!(a_input_itm, [
-					['title', String],
-					['description', String],
-					['mapped_to', String],
-					['is_expand', ABooleanValue],
-					['is_required', ABooleanValue],
-					['value_options', Array],
-					['value', String],
-					['is_dont_change_value', ABooleanValue]
-					])
-
-					a_value_options = a_input_itm['value_options']
-					a_value_options.each { |a_value_option|
-						raise "Invalid value-option (#{a_value_option}), not a String (class: #{a_value_option.class})!" unless a_value_option.is_a? String
-					}
-				end
-
-				a_outputs = workflow_step_data['outputs']
-				a_outputs.each do |a_output_itm|
-					HashUtils.check_required_attributes_and_types!(a_output_itm, [
-					['title', String],
-					['description', String],
-					['mapped_to', String]
-					])
-				end
-		end
-
-	end
-end