json-spec 0.1.0

data/lib/cabeza-de-termo/json-spec/walkers/json-expression-explainer.rb

@@ -0,0 +1,183 @@
+require_relative "expression-walker"
+
+module CabezaDeTermo
+	module JsonSpec
+		class JsonExpressionExplainer < ExpressionWalker
+			def initialize()
+				reset
+			end
+
+			def reset
+				@text = ''
+				@tabs = 0
+			end
+
+			def text
+				@text
+			end
+
+			def explain(json_walkable)
+				reset
+				walk_on(json_walkable)
+				text
+			end
+
+			def walk_on(json_walkable)
+				json_walkable.accept_walker(self)
+			end
+
+			def walk_json_spec(json_spec)
+				walk_on(json_spec.root_expression)
+			end
+
+			def walk_json_object(json_object)
+				append_with_tabs('{')
+
+				during_tab do
+					walk_each_defined_field_of(json_object)
+				end
+
+				if json_object.has_each_field?
+					during_tab do
+						cr
+						walk_on(json_object.each_field_expression)
+					end
+				end
+
+				append_in_new_line('}')
+
+				walk_on_expectations_of(json_object)
+			end
+
+			def walk_each_defined_field_of(json_object)
+				json_object.fields.each do |field|
+					cr
+					walk_on(field)
+				end
+			end
+
+			def walk_json_each_field(json_each_field)
+				append_with_tabs('each field')
+
+				during_tab do
+					append_in_new_line('name')
+					walk_on( json_each_field.name_expression )
+				end
+
+				during_tab do
+					append_in_new_line('value')
+					cr
+
+					during_tab do
+						walk_on(json_each_field.value_expression)
+					end
+				end
+			end
+
+			def walk_json_field_name(json_field_name)
+				walk_on_expectations_of(json_field_name)
+			end
+
+			def walk_json_list(json_list_expression)
+				append_with_tabs('[')
+
+				walk_on(json_list_expression.each_expression)
+
+				append_in_new_line(']')
+
+				walk_on_expectations_of(json_list_expression)
+			end
+
+			def walk_json_each(json_each_expression)
+				return unless json_each_expression.has_each_item_expression?
+
+				cr
+				during_tab do
+					walk_on(json_each_expression.each_item_expression)
+				end
+			end
+
+			def walk_json_field(json_field_expression)
+				append_with_tabs('"' + json_field_expression.name + '":')
+
+				during_tab do
+					cr
+					walk_on(json_field_expression.value_expression)
+				end
+			end
+
+			def walk_json_anything(json_anything)
+				append_with_tabs('anything')
+				walk_on_expectations_of(json_anything)
+			end
+
+			def walk_json_scalar(json_scalar)
+				append_with_tabs('scalar')
+				walk_on_expectations_of(json_scalar)
+			end
+
+			def walk_json_any_of(any_of)
+				append_with_tabs('any of')
+
+				isFirst = true
+
+				any_of.possible_expressions.each do |expression|
+					append_in_new_line('or') unless isFirst
+
+					during_tab do
+						cr
+						walk_on(expression)				
+					end
+
+					isFirst = false
+				end
+			end
+
+			def walk_on_expectations_of(expression)
+				walk_on(expression.expectations_runner)
+			end
+
+			def walk_expectation_runner(expectation_runner)
+				expectation_runner.explain_with(self)
+			end
+
+			def walk_expectation(expectation)
+				append(' .' + expectation.explain)
+			end
+
+			# Text
+
+			def append_with_tabs(text)
+				append_tabs
+				append(text)
+			end
+
+			def append_in_new_line(text)
+				cr
+				append_with_tabs(text)
+			end
+
+			def append_tabs()
+				@tabs.times { |i| tab }
+			end
+
+			def append(text)
+				@text += text
+			end
+
+			def cr()
+				append("\n")
+			end
+
+			def tab()
+				append("\t")
+			end
+
+			def during_tab(&block)
+				@tabs += 1
+				block.call
+				@tabs -= 1
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/walkers/reporter/expectation-report.rb

@@ -0,0 +1,63 @@
+module CabezaDeTermo
+	module JsonSpec
+		class ExpectationReport
+			def initialize()
+				super()
+
+				@expectation_method = nil
+				@failed_message = nil
+				@status = nil
+			end
+
+			def set_expectation_method(expectation_method)
+				@expectation_method = expectation_method
+
+				self
+			end
+
+			def expectation_method()
+				@expectation_method
+			end
+
+			def set_failed_message(failed_message)
+				@failed_message = failed_message
+
+				self
+			end
+
+			def failed_message()
+				@failed_message
+			end
+
+			def set_status(status)
+				@status = status
+
+				self
+			end
+
+			def status()
+				@status
+			end
+
+			def set_was_satisfied(was_satisfied)
+				set_status(was_satisfied ? :was_satisfied : :failed)
+			end
+
+			def failed?()
+				status == :failed
+			end
+
+			def was_satisfied?()
+				status == :was_satisfied
+			end
+
+			def to_array()
+				[
+					expectation_method,
+					status,
+					failed_message
+				]
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/walkers/reporter/json-expectations-reporter.rb

@@ -0,0 +1,111 @@
+require_relative "../json-expectations-runner"
+require_relative "expectation-report"
+require 'json'
+
+module CabezaDeTermo
+	module JsonSpec
+		class JsonExpectationsReporter < JsonExpectationsRunner
+			def initialize()
+				super()
+
+				@expectation_reports = []
+			end
+
+			def run_on_json_string(json_expression, json_string)
+				run_on(json_expression, JSON.parse(json_string))
+			end
+
+			def run_on(json_expression, json)
+				walk_with_json(json_expression, json)
+			end
+
+			# Accessing
+
+			def expectation_reports()
+				@expectation_reports
+			end
+
+			def expectation_reports_as_array()
+				arrays = []
+				expectation_reports.each do |expectation_report|
+					arrays << expectation_report.to_array
+				end
+
+				arrays
+			end
+
+			# Asking
+
+			#
+			# Answer true if all the walked Expectations were satisfied.
+			#
+			def no_errors?()
+				expectation_reports.all? { |expectation_report| expectation_report.was_satisfied? }
+			end
+
+			# Instance creation
+
+			def new_expectation_report()
+				ExpectationReport.new
+			end
+
+			# Logging Expectations reports
+
+			def log_expectation(expectation, value_holder, was_satisfied)
+				expectation_report = new_expectation_report
+								.set_expectation_method(expectation.expectation_method)
+								.set_was_satisfied(was_satisfied)
+								.set_failed_message( expectation.failed_message_on(value_holder) )
+
+				add_expectation_report(expectation_report)
+			end
+
+			def log_unwalked_field(field)
+				access_chain = @value_holder.accessors_chain.append_accessor(field).to_s
+
+				expectation_report = new_expectation_report
+								.set_expectation_method(:unexpected_field)
+								.set_status(:unexpected_field)
+								.set_failed_message("Unexpected field '#{access_chain}'.")
+
+				add_expectation_report(expectation_report)
+			end
+
+			def add_expectation_report(expectation_report)
+				@expectation_reports << expectation_report
+			end
+
+			def add_all_expectation_reports(expectation_reports)
+				expectation_reports.each do |report|
+					add_expectation_report(report)
+				end
+			end
+
+			# Hooks
+
+			def on_unwalked_field(field_name, value_holder)
+				log_unwalked_field(field_name)
+			end
+
+			def on_json_any_of_was_satisfied_with_runner(expectations_runner)
+				add_all_expectation_reports(expectations_runner.expectation_reports)
+			end
+
+			def on_json_any_of_failed_with_all_runners(expectations_runners)
+				expectations_runners.each do |each_runner|
+					add_all_expectation_reports(each_runner.expectation_reports)
+				end
+			end
+
+			def on_walked_expectation(expectation, value_holder, was_satisfied)
+				log_expectation(expectation, value_holder, was_satisfied)
+			end
+
+			# Instance creation
+
+			def new_json_expectations_runner()
+				self.class.new
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/walkers/validator/json-validator-error.rb

@@ -0,0 +1,29 @@
+module CabezaDeTermo
+	module JsonSpec
+		class JsonValidatorError
+			def initialize(accessors_chain, message)
+				@accessors_chain = accessors_chain
+				@message = message
+			end
+
+			# Accessing
+
+			def message()
+				@message
+			end
+
+			def accessors_chain()
+				@accessors_chain
+			end
+
+			# Converting
+
+			def to_hash()
+				{
+					access_chain: accessors_chain().to_s,
+					message: message
+				}
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/walkers/validator/json-validator.rb

@@ -0,0 +1,133 @@
+require_relative "json-validator-error"
+require_relative "../json-expectations-runner"
+
+module CabezaDeTermo
+	module JsonSpec
+		class JsonValidator < JsonExpectationsRunner
+			def initialize()
+				super()
+
+				@errors = []
+				@unexpected_field_errors = []
+				@treat_unexpected_fields_as_errors = false
+			end
+
+			def validate(json_expression, json)
+				walk_with_json(json_expression, json)
+
+				self
+			end
+
+			# Configuring
+
+			def treat_unexpected_fields_as_errors(boolean = true)
+				@treat_unexpected_fields_as_errors = boolean
+
+				self
+			end	
+
+			# Asking
+
+			def no_errors?()
+				errors.empty?
+			end
+
+			def no_unexpected_fields?()
+				unexpected_fields.empty?
+			end
+			
+			def has_unexpected_fields?()
+				!no_unexpected_fields?
+			end
+
+			def treat_unexpected_fields_as_errors?()
+				@treat_unexpected_fields_as_errors
+			end	
+
+			# Counting
+
+			def errors_count()
+				errors.size
+			end
+
+			def unexpected_fields_count()
+				unexpected_fields.size
+			end
+
+			# Accessing
+
+			def errors()
+				@errors
+			end
+
+			def unexpected_fields()
+				@unexpected_field_errors
+			end
+
+			# Hooks
+
+			def on_unwalked_field(field_name, value_holder)
+				error = new_validation_error(
+								value_holder,
+								"An unexpected '#{field_name}' field was found."
+							)
+
+				add_unexpected_field(error)
+
+				add_error(error) if treat_unexpected_fields_as_errors?
+			end
+
+			def on_json_any_of_was_satisfied_with_runner(expectations_runner)
+				add_all_unexpected_fields(expectations_runner.unexpected_fields)
+			end
+
+			def on_json_any_of_failed_with_all_runners(expectations_runners)
+				expectations_runners.each do |each_expectations_runner|
+					add_all_errors(each_expectations_runner.errors)
+				end
+
+				expectations_runners.each do |each_expectations_runner|
+					add_all_unexpected_fields(each_expectations_runner.unexpected_fields)
+				end
+			end
+
+			def on_walked_expectation(expectation, value_holder, was_satisfied)
+				return if was_satisfied
+
+				add_error( new_validation_error(value_holder, expectation.failed_message_on(value_holder)) )
+			end
+
+			# Instance creation
+
+			def new_json_expectations_runner()
+				self.class.new
+			end
+
+			def new_validation_error(value_holder, message)
+				JsonValidatorError.new(value_holder.accessors_chain, message)
+			end
+
+			# Logging
+
+			def add_error(error)
+				@errors << error
+			end
+
+			def add_all_errors(errors)
+				errors.each do |error|
+					add_error(error)
+				end
+			end
+
+			def add_unexpected_field(error)
+				@unexpected_field_errors << error
+			end
+
+			def add_all_unexpected_fields(errors)
+				errors.each do |error|
+					add_unexpected_field(error)
+				end
+			end
+		end
+	end
+end