json-spec 0.1.0

data/lib/cabeza-de-termo/json-spec/expressions/json-field-name.rb

@@ -0,0 +1,16 @@
+require_relative "json-expression"
+
+module CabezaDeTermo
+	module JsonSpec
+		#
+		# A JsonExpression representing a field name in a json parse tree.
+		#
+		class JsonFieldName < JsonExpression
+			# Walking expressions
+
+			def accept_walker(expression_walker)
+				expression_walker.walk_json_field_name(self)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expressions/json-field.rb

@@ -0,0 +1,76 @@
+require_relative "json-expression"
+
+module CabezaDeTermo
+	module JsonSpec
+		#
+		# A JsonExpression representing an objects field in a json parse tree.
+		#
+		class JsonField < JsonExpression
+			#
+			# @param JsonExpression parent_expression The parent expression of self field
+			#
+			# @param string name The name of the field
+			#
+			def initialize(parent_expression, name)
+				@name = name
+				@value_expression = new_anything_expression
+
+				super(parent_expression)
+			end
+
+			def default_expectations
+				default_expectations_for(:fields)
+			end
+
+			# Expectations
+
+			def to_be(type, &block)
+				to_be_a(type, &block)
+			end
+
+			def to_be_an(type, &block)
+				to_be_a(type, &block)
+			end
+
+			def to_be_a(type, &block)
+				expression = set_value_expression( new_expression_for(type) )
+				Bind.evaluation of: block, to: expression unless block.nil?
+				expression
+			end
+
+			def add_expectation(expectation)
+				value_expression.add_expectation(expectation)
+				self
+			end
+
+			def run_modifier(modifier)
+				value_expression.run_modifier(modifier)
+			end
+
+			# Accessing
+
+			def name()
+				@name
+			end
+
+			def value_expression()
+				@value_expression
+			end
+
+			def set_value_expression(expression)
+				expression.set_parent_expression(self)
+				@value_expression = expression
+
+				add_default_expectations
+
+				expression
+			end
+
+			# Walking expressions
+
+			def accept_walker(expression_walker)
+				expression_walker.walk_json_field(self)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expressions/json-list.rb

@@ -0,0 +1,40 @@
+require_relative "json-expression"
+
+module CabezaDeTermo
+	module JsonSpec
+		#
+		# A JsonExpression representing a list in a json parse tree.
+		#
+		class JsonList < JsonExpression
+			def initialize(parent_expression)
+				@each_expression = new_json_each_expression
+
+				super(parent_expression)
+			end
+
+			def default_expectations()
+				default_expectations_for(:lists)
+			end
+
+			# Accessing
+
+			def each_expression()
+				@each_expression
+			end
+
+			# Defining Expectations
+
+			def each(&block)
+				Bind.evaluation of: block, to: each_expression unless block.nil? 
+
+				each_expression
+			end
+
+			# Walking expressions
+
+			def accept_walker(expression_walker)
+				expression_walker.walk_json_list(self)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expressions/json-object.rb

@@ -0,0 +1,82 @@
+require_relative "json-expression"
+
+module CabezaDeTermo
+	module JsonSpec
+		#
+		# A JsonExpression representing an object in a json parse tree.
+		#
+		class JsonObject < JsonExpression
+			def initialize(parent_expression)
+				super(parent_expression)
+
+				@fields = []
+				@each_field_expression = nil
+			end
+
+			def default_expectations
+				default_expectations_for(:objects)
+			end
+
+			# Accessing
+
+			#
+			# Answer the fields of self json object.
+			#
+			# @return JsonField[]
+			#
+			def fields()
+				@fields
+			end
+
+			#
+			# Answer the each_field expression of self object.
+			#
+			# @return JsonEachField
+			#
+			def each_field_expression()
+				@each_field_expression
+			end
+
+			# Asking
+
+			#
+			# Answer whether self object has a each_field expression defined or no.
+			#
+			# @return JsonEachField
+			#
+			def has_each_field?()
+				!each_field_expression.nil?
+			end
+
+			# Creating fields
+
+			def expect(field_name)
+				field_expression = new_named_field_expression(field_name)
+
+				add_field_expression(field_expression)
+
+				field_expression
+			end
+
+			def each_field(&block)
+				@each_field_expression = new_each_field
+
+				Bind.evaluation of: block, to: @each_field_expression unless block.nil?
+
+				@each_field_expression
+			end
+
+			def add_field_expression(field_expression)
+				fields << field_expression
+
+				self
+			end
+
+			# Walking expressions
+
+			def accept_walker(expression_walker)
+				expression_walker.walk_json_object(self)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expressions/json-scalar.rb

@@ -0,0 +1,20 @@
+require_relative "json-expression"
+
+module CabezaDeTermo
+	module JsonSpec
+		#
+		# A JsonExpression representing a scalar value in a json parse tree.
+		#
+		class JsonScalar < JsonExpression
+			def default_expectations()
+				default_expectations_for(:scalars)
+			end
+
+			# Walking expressions
+
+			def accept_walker(expression_walker)
+				expression_walker.walk_json_scalar(self)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expressions/json-spec.rb

@@ -0,0 +1,174 @@
+require 'json'
+require "cabeza-de-termo/json-spec/utilities/bind"
+require "cabeza-de-termo/json-spec/expectations-library/expectations-library"
+require "cabeza-de-termo/json-spec/walkers/validator/json-validator"
+
+require_relative "json-any-of"
+require_relative "json-each-field"
+require_relative "json-each"
+require_relative "json-field-name"
+require_relative "json-field"
+require_relative "json-list"
+require_relative "json-object"
+require_relative "json-scalar"
+require_relative "json-anything"
+
+module CabezaDeTermo
+	module JsonSpec
+		#
+		# This is the main object to define the expectations on a Json object.
+		# A JsonSpec is a tree of Json expressions.
+		#
+		class JsonSpec
+			def initialize(&block)
+				@root_expression = nil
+				@expectation_messages_mapping = new_expectations_messages_mapping
+				@default_expectations = new_default_expectations_mapping
+
+				Bind.evaluation of: block, to: self unless block.nil?
+			end
+
+			# Accessing
+
+			def json_spec()
+				self
+			end
+
+			def default_expectations()
+				@default_expectations
+			end
+
+			def global_expectations_library()
+				ExpectationsLibrary.current
+			end
+
+			def root_expression()
+				@root_expression
+			end
+
+			# Default expectations
+
+			def define(&block)
+				Bind.evaluation of: block, to: ExpectationLibraryDefinitionBuilder.new(self)
+			end
+
+			# Expectations
+
+			def expect_an(type, &block)
+				expect_a(type, &block)
+			end
+
+			def expect(type, &block)
+				expect_a(type, &block)
+			end
+
+			def expect_a(type, &block)
+				@root_expression = new_expression_for(type)
+
+				Bind.evaluation of: block, to: @root_expression unless block.nil?
+
+				@root_expression
+			end
+
+			def new_expression_for(type)
+				return new_object_expression if type == :object
+				return new_list_expression if type == :list
+				return new_any_of_expression if type == :any_of
+
+				raise "Invalid expected type: #{type.inspect}"
+			end
+
+			def new_object_expression()
+				JsonObject.new(self)
+			end
+
+			def new_list_expression()
+				JsonList.new(self)
+			end
+
+			def new_any_of_expression()
+				JsonAnyOf.new(self)
+			end
+
+			# Walking expressions
+
+			def accept_walker(expression_walker)
+				expression_walker.walk_json_spec(self)
+			end
+
+			# Helpers
+
+			def new_expectations_messages_mapping()
+				ExpectationMessagesMapping.new
+			end
+
+			def new_default_expectations_mapping()
+				DefaultExpectationsMapping.new
+			end
+
+			def new_expression_explainer()
+				JsonExpressionExplainer.new
+			end
+
+			def new_validator()
+				JsonValidator.new
+			end
+
+			# Expectation messages
+
+			def message_formatter_for(expectation_method)
+				if @expectation_messages_mapping.has_message_formatter_for?(expectation_method)
+					return @expectation_messages_mapping.message_formatter_for(expectation_method)
+				end
+
+				global_expectations_library.message_formatter_for(expectation_method)
+			end
+
+			def define_message_formatter_for(expectation_method, message_block)
+				@expectation_messages_mapping.define_message_formatter_for(expectation_method, message_block)
+				self
+			end
+
+			# Default Expectations
+
+			def default_expectations_for(json_expression_type)
+				messages = []
+				messages.concat global_default_expectations_for(json_expression_type)
+				messages.concat spec_default_expectations_for(json_expression_type)
+
+				messages
+			end
+
+			def spec_default_expectations_for(json_expression_type)
+				default_expectations.expectations_for(json_expression_type)
+			end
+
+			def global_default_expectations_for(json_expression_type)
+				global_expectations_library.default_expectations.expectations_for(json_expression_type)
+			end
+
+			# Validating
+
+			def parse_json_string(json_string)
+				JSON.parse(json_string)
+			end
+
+			def validate_string(json_string)
+				validate parse_json_string(json_string)
+			end
+
+			def validate(json)
+				validator = new_validator
+				validator.validate(self, json)
+				
+				validator
+			end
+
+			# Explaining
+
+			def explain()
+				new_expression_explainer.explain(self)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/instantiators/abstract-instantiator.rb

@@ -0,0 +1,9 @@
+module CabezaDeTermo
+	module JsonSpec
+		class AbstractInstantiator
+			def new(*args)
+				raise 'Subclass responsibility'
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/instantiators/all-expectations-composite-instantiator.rb

@@ -0,0 +1,12 @@
+require_relative "composite-instantiator"
+require "cabeza-de-termo/json-spec/expectations/all-expectations-composite"
+
+module CabezaDeTermo
+	module JsonSpec
+		class AllExpectationsCompositeInstantiator < CompositeInstantiator
+			def new_composite_expectation()
+				AllExpectationsComposite.new
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/instantiators/any-expectation-composite-instantiator.rb

@@ -0,0 +1,12 @@
+require_relative "composite-instantiator"
+require "cabeza-de-termo/json-spec/expectations/any-expectation-composite"
+
+module CabezaDeTermo
+	module JsonSpec
+		class AnyExpectationCompositeInstantiator < CompositeInstantiator
+			def new_composite_expectation()
+				AnyExpectationComposite.new
+			end
+		end
+	end
+end