json-spec 0.1.0

data/examples/validation-printer.rb

@@ -0,0 +1,47 @@
+require 'colorize'
+
+class ValidationPrinter
+	def print_report_of(validator)
+		@validator = validator
+
+		report_errors
+
+		separator
+
+		report_unexpected_fields
+
+		separator
+	end
+
+	def validator()
+		@validator
+	end
+
+	def report_errors()
+		puts "- Failed expectations: #{validator.errors_count}".colorize(errors_color)
+
+		validator.errors.each do |error|
+			puts "\tField: '#{error.accessors_chain}'\t message: \"#{error.message}\"".colorize(errors_color)
+		end
+	end
+
+	def report_unexpected_fields()
+		puts "- Unexpected fields: #{validator.unexpected_fields_count}".colorize(unexpected_fields_color)
+
+		validator.unexpected_fields.each do |error|
+			puts "\tField: '#{error.accessors_chain}'\t message: \"#{error.message}\"".colorize(unexpected_fields_color)
+		end
+	end
+
+	def separator()
+		puts "\n"
+	end
+
+	def errors_color()
+		validator.has_errors? ? :red : :green
+	end
+
+	def unexpected_fields_color()
+		validator.has_unexpected_fields? ? :yellow : :green
+	end
+end

data/json-spec.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cabeza-de-termo/json-spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-spec"
+  spec.version       = CabezaDeTermo::JsonSpec::VERSION
+  spec.authors       = ["Martin Rubi"]
+  spec.email         = ["martin.rubi@gmail.com"]
+
+  spec.summary       = %q{A framework to declare expectations on a json format and validate that a json object satisfies those expectations.}
+  spec.description   = %q{You can use this json expectations to validate jsons you send or receive in your application, or to test your API with unit tests.}
+  spec.homepage      = "https://github.com/cabeza-de-termo/ruby-json-spec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "validates_email_format_of", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "colorize"
+  spec.add_development_dependency "simplecov"
+end

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

@@ -0,0 +1,6 @@
+module CabezaDeTermo
+	module JsonSpec
+		class Error < StandardError
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/errors/expectation-not-found-error.rb

@@ -0,0 +1,8 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module JsonSpec
+		class ExpectationNotFoundError < Error
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/errors/modifier-not-found-error.rb

@@ -0,0 +1,8 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module JsonSpec
+		class ModifierNotFoundError < Error
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/errors/unkown-json-type-error.rb

@@ -0,0 +1,8 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module JsonSpec
+		class UnkownJsonTypeError < Error
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/errors/validation-error.rb

@@ -0,0 +1,8 @@
+require_relative 'error'
+
+module CabezaDeTermo
+	module JsonSpec
+		class ValidationError < Error
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/default-expectations/default-expectation-builder.rb

@@ -0,0 +1,29 @@
+require 'cabeza-de-termo/json-spec/metaprogramming/message'
+
+module CabezaDeTermo
+	module JsonSpec
+		class DefaultExpectationBuilder
+			def initialize(expectations_mapping, json_expression_type)
+				@expectations_mapping = expectations_mapping
+				@json_expression_type = json_expression_type
+			end
+
+			def expectations_mapping
+				@expectations_mapping
+			end
+
+			def json_expression_type
+				@json_expression_type
+			end
+
+			def method_missing(method_name, *args)
+				expectations_mapping.add_expectation(
+					json_expression_type, 
+					Message.new(method_name.to_sym, *args)
+				)
+
+				self
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/default-expectations/default-expectations-mapping.rb

@@ -0,0 +1,54 @@
+require_relative "default-expectation-builder"
+
+module CabezaDeTermo
+	module JsonSpec
+		class DefaultExpectationsMapping
+			def initialize()
+				@default_expectations = {}
+
+				drop_all_expectations
+			end
+
+			def drop_all_expectations()
+				drop_expectations_for(:objects)
+				drop_expectations_for(:lists)
+				drop_expectations_for(:fields)
+				drop_expectations_for(:scalars)
+			end
+
+			def add_expectation(json_expression_type, message)
+				@default_expectations[json_expression_type] << message
+				self
+			end
+
+			def expectations_for(json_expression_type)
+				@default_expectations[json_expression_type]
+			end
+
+			def drop_expectations_for(json_expression_type)
+				@default_expectations[json_expression_type] = []
+				self
+			end
+
+			def for_every_object(&block)
+				for_every_expression_of(:objects, &block)
+			end
+
+			def for_every_list(&block)
+				for_every_expression_of(:lists, &block)
+			end
+
+			def for_every_field(&block)
+				for_every_expression_of(:fields, &block)
+			end
+
+			def for_every_scalar(&block)
+				for_every_expression_of(:scalars, &block)
+			end
+
+			def for_every_expression_of(json_expression_type, &block)
+				Bind.evaluation of: block, to: DefaultExpectationBuilder.new(self, json_expression_type)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/definition-builders/expectation-builders/block-expectation-definition.rb

@@ -0,0 +1,16 @@
+require_relative "expectation-definition"
+require 'cabeza-de-termo/json-spec/instantiators/block-expectation-instantiator'
+
+module CabezaDeTermo
+	module JsonSpec
+		class BlockExpectationDefinition < ExpectationDefinition
+			def block(block)
+				@block = block
+			end
+
+			def expectation_instantiator()
+				BlockExpectationInstantiator.new(@block)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/definition-builders/expectation-builders/class-expectation-definition.rb

@@ -0,0 +1,15 @@
+require_relative "expectation-definition"
+
+module CabezaDeTermo
+	module JsonSpec
+		class ClassExpectationDefinition < ExpectationDefinition
+			def klass(klass)
+				@klass = klass
+			end
+
+			def expectation_instantiator()
+				@klass
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/definition-builders/expectation-builders/expectation-definition.rb

@@ -0,0 +1,19 @@
+module CabezaDeTermo
+	module JsonSpec
+		class ExpectationDefinition
+			def initialize(expectations_library)
+				@expectations_library = expectations_library
+			end
+
+			def modifier_instantiator
+				raise 'Subclass responsibility'
+			end
+
+			protected
+
+			def expectation_instantiator_for(expectation_method)
+				@expectations_library.expectation_instantiator_for(expectation_method)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/definition-builders/expectation-builders/expectations-definition-builder.rb

@@ -0,0 +1,136 @@
+require_relative "class-expectation-definition"
+require_relative "block-expectation-definition"
+require_relative "negating-expectation-definition"
+require_relative "expecting-expectation-definition"
+require_relative "expecting-any-of-expectation-definition"
+require_relative "expecting-all-of-expectation-definition"
+
+require "cabeza-de-termo/json-spec/message-formatters/block-message-formatter"
+require "cabeza-de-termo/json-spec/message-formatters/erb-message-formatter"
+
+module CabezaDeTermo
+	module JsonSpec
+		class ExpectationsDefinitionBuilder
+			def self.for(expectations_library, &block)
+				new(expectations_library, &block)
+			end
+
+			def initialize(expectations_library, &block)
+				@expectations_library = expectations_library
+				reset_current_definition
+
+				Bind.evaluation of: block, to: self
+			end
+
+			# Accessing
+
+			def expectations_library 
+				@expectations_library
+			end
+
+			def method_name 
+				@method_name
+			end
+
+			def definition 
+				@definition
+			end
+
+			# Asking
+
+			def has_expectation_definition?
+				!@definition.nil?
+			end
+
+			def has_message_definition?
+				!@message_formatter.nil?
+			end
+
+			# Building definition
+
+			def reset_current_definition
+				@method_name = nil
+				@definition = nil
+				@message_formatter = nil
+			end
+
+			def define(method_name, &block)
+				@method_name = method_name.to_sym
+
+				Bind.evaluation of: block, to: self
+
+				define_expectation_in_library
+				define_expectation_message_in_library
+
+				reset_current_definition
+			end
+
+			def with_class(klass)
+				@definition = ClassExpectationDefinition.new(expectations_library)
+				@definition.klass klass
+			end
+
+			def with_block(&block)
+				@definition = BlockExpectationDefinition.new(expectations_library)
+				@definition.block block
+			end
+
+			def negating(expectation_method)
+				@definition = NegatingExpectationDefinition.new(expectations_library)
+				@definition.negate expectation_method
+			end
+
+			def expecting(expectation_method, *args)
+				@definition = ExpectingExpectationDefinition.new(expectations_library)
+				@definition.expect(expectation_method, *args)
+			end
+
+			def expecting_any_of(expectation_method, *args)
+				@definition = ExpectingAnyOfExpectationDefinition.new(expectations_library)
+				@definition.or_also(expectation_method, *args)
+			end
+
+			def expecting_all_of(expectation_method, *args)
+				@definition = ExpectingAllOfExpectationDefinition.new(expectations_library)
+				@definition.and_also(expectation_method, *args)
+			end
+
+			# Message block definition
+
+			def message_formatter(message_formatter)
+				@message_formatter = message_formatter
+			end
+
+			def message(message)
+				message_formatter ErbMessageFormatter.new(message)
+			end
+
+			def message_block(&block)
+				message_formatter BlockMessageFormatter.new(block)
+			end
+
+			def define_expectation_in_library
+				return unless has_expectation_definition?
+
+				expectations_library.define_expectation(method_name, expectation_instantiator)
+			end
+
+			def define_expectation_message_in_library
+				return unless has_message_definition?
+
+				expectations_library.define_message_formatter_for(method_name, @message_formatter)
+			end
+
+			def expectation_instantiator
+				definition.expectation_instantiator
+			end
+
+			# Messages delegation
+
+			# Delegate every method to the current definition builder
+			def method_missing(method_name, *args, &block)
+				@definition.send(method_name, *args, &block)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/definition-builders/expectation-builders/expecting-all-of-expectation-definition.rb

@@ -0,0 +1,23 @@
+require_relative "expectation-definition"
+require 'cabeza-de-termo/json-spec/instantiators/all-expectations-composite-instantiator'
+require "cabeza-de-termo/json-spec/instantiators/patial-application-instantiator"
+
+module CabezaDeTermo
+	module JsonSpec
+		class ExpectingAllOfExpectationDefinition < ExpectationDefinition
+			def initialize(*args)
+				super(*args)
+
+				@expectation_instantiatiors = []
+			end
+
+			def and_also(expectation_method, *args)
+				@expectation_instantiatiors << PartialApplicationInstantiator.new(expectation_instantiator_for(expectation_method), args)
+			end
+
+			def expectation_instantiator()
+				AllExpectationsCompositeInstantiator.with_all(@expectation_instantiatiors)
+			end
+		end
+	end
+end

data/lib/cabeza-de-termo/json-spec/expectations-library/definition-builders/expectation-builders/expecting-any-of-expectation-definition.rb

@@ -0,0 +1,23 @@
+require_relative "expectation-definition"
+require 'cabeza-de-termo/json-spec/instantiators/any-expectation-composite-instantiator'
+require "cabeza-de-termo/json-spec/instantiators/patial-application-instantiator"
+
+module CabezaDeTermo
+	module JsonSpec
+		class ExpectingAnyOfExpectationDefinition < ExpectationDefinition
+			def initialize(*args)
+				super(*args)
+
+				@expectation_instantiatiors = []
+			end
+
+			def or_also(expectation_method, *args)
+				@expectation_instantiatiors << PartialApplicationInstantiator.new(expectation_instantiator_for(expectation_method), args)
+			end
+
+			def expectation_instantiator()
+				AnyExpectationCompositeInstantiator.with_all(@expectation_instantiatiors)
+			end
+		end
+	end
+end