json-spec 0.1.0

data/examples/example-5-custom-expectations.rb

@@ -0,0 +1,153 @@
+require 'cabeza-de-termo/json-spec/json-spec'
+require_relative 'fixtures'
+require_relative 'validation-printer'
+
+# To run self example do
+# 		ruby -I lib examples/example-5-custom-expectations.rb
+#
+class Example_5_CustomExpectations
+	def self.run()
+		self.new.run
+	end
+
+	def run()
+		# Define our custom Expectations
+		CabezaDeTermo::JsonSpec::ExpectationsLibrary.define do
+			expectations do
+				define :to_be_valid_lincense do
+				  expecting :to_be_in, ComposerJson.valid_licenses
+				  message "'<%= format value %>' is not a valid lincense."
+			 	end
+
+				define :to_be_version do
+				  with_class IsVersionExpectation
+				  message "'<%= format value %>' is not a valid version."
+			 	end
+
+				define :to_be_namespace do
+				  expecting :to_match, /^[a-zA-Z_\\]+\\/
+				  message "'<%= format value %>' is not a valid namespace."
+			 	end
+
+				define :to_be_psr4_key do
+				  expecting_any_of :to_be_equal_to, '' 
+				  or_also :to_be_namespace
+
+				  message "'<%= format value %>' is not a valid PSR4 key."
+			 	end
+
+				define :to_end_with_slash do
+				  expecting :to_match, /^.+\//
+				  message "'<%= format value %>' does not end with a slash."
+			 	end
+
+				define :to_be_folder do
+				  expecting :to_end_with_slash
+				  message "'<%= format value %>' is not a valid folder."
+			 	end
+			end
+		end
+
+		validator = ComposerJson.new.spec.validate_string(Fixtures.named :simple)
+
+		ValidationPrinter.new.print_report_of validator
+	end
+end
+
+class IsVersionExpectation <  CabezaDeTermo::JsonSpec::Expectation
+	def is_satisfied_by?(value_holder)
+		# left as exercise to the reader :P
+		true
+	end
+end
+
+class ComposerJson
+	def spec()
+		CabezaDeTermo::JsonSpec::JsonSpec.new do |json_spec|
+			json_spec.expect_an(:object) do |object|
+				object.expect('name') .not_blank
+				object.expect('type') .not_blank
+				object.expect('description') .not_blank
+				object.expect('keywords') .to_be_as_defined_in(self, :keywords_spec)
+				object.expect('homepage').to_be_url
+				object.expect('license') .to_be_in(self.class.valid_licenses)
+				object.expect('authors') .to_be_as_defined_in(self, :authors_spec)
+				object.expect('require') .to_be_as_defined_in(self, :require_spec)
+				object.expect('require-dev') .to_be_as_defined_in(self, :require_spec)
+				object.expect('autoload') .to_be_as_defined_in(self, :autoload_spec)
+			end
+		end
+	end
+
+	def keywords_spec(json_spec)
+		json_spec .to_be_a(:list) .can_be_absent .not_empty do
+			each do
+				expect_a(:scalar) .not_blank
+			end
+		end
+	end
+
+	def authors_spec(json_spec)
+		json_spec .to_be_a(:list) .not_empty do |list|
+			list.each do |each|
+				each.to_be_as_defined_in(self, :author_spec)
+			end
+		end
+	end
+
+	def author_spec(json_spec)
+		json_spec .expect_an(:object) do
+			expect('name') .not_blank
+			expect('email') .to_be_email
+		end
+	end
+
+	def require_spec(json)
+		json .to_be_an(:object) .can_be_absent do
+			each_field do
+				expect_name .not_blank
+				expect_a(:scalar) .not_blank
+			end
+		end
+	end
+
+	def autoload_spec(json)
+		json .to_be_an(:object) do |object|
+			object.expect('psr-0') .to_be_as_defined_in(self, :psr_spec)
+			object.expect('psr-4') .to_be_as_defined_in(self, :psr_spec)
+			object.expect('classmap') .to_be_as_defined_in(self, :classmaps_spec)
+			object.expect('files') .to_be_as_defined_in(self, :files_spec)
+		end
+	end
+
+	def psr_spec(json_spec)
+		json_spec .to_be_an(:object) .can_be_absent do
+			each_field do
+				expect_name
+
+				expect_a(:list) .not_empty do
+					each do
+						expect_a(:scalar) .not_blank
+					end
+				end
+			end
+		end
+	end
+
+	def classmaps_spec(json_spec)
+		json_spec .to_be_a(:list) .can_be_absent .not_empty
+	end
+
+	def files_spec(json_spec)
+		json_spec .to_be_a(:list) .can_be_absent .not_empty
+	end
+
+	def self.valid_licenses()
+		['Apache-2.0', 'BSD-2-Clause', 'BSD-3-Clause', 
+		 'BSD-4-Clause' ,'GPL-2.0', 'GPL-2.0+', 'GPL-3.0', 
+		 'GPL-3.0+', 'LGPL-2.1', 'LGPL-2.1+', 'LGPL-3.0',
+		 'LGPL-3.0+', 'MIT']
+	end
+end
+
+Example_5_CustomExpectations::run

data/examples/example-6-custom-messages.rb

@@ -0,0 +1,36 @@
+require 'cabeza-de-termo/json-spec/json-spec'
+require_relative 'fixtures'
+require_relative 'validation-printer'
+
+# To run this example do
+# 		ruby -I lib examples/example-6-custom-messages.rb
+#
+class Example_6_CustomMessages
+	def self.run()
+		self.new.run
+	end
+
+	def run()
+		json_spec = CabezaDeTermo::JsonSpec::JsonSpec.new do
+			expect_an(:object) do
+				expect('name') .to_be_defined .not_blank
+				expect('type') .to_be_defined .not_blank
+			end
+		end
+
+		CabezaDeTermo::JsonSpec::ExpectationsLibrary.define do
+			expectations do
+				define :not_blank do
+					message "composer.json does not allow <%= field %> to be blank."
+				end
+			end
+		end
+
+		validator = json_spec.validate_string( '{ "name": "" }' )
+
+		ValidationPrinter.new.print_report_of validator
+	end
+end
+
+
+Example_6_CustomMessages.run

data/examples/example-7-full-example.rb

@@ -0,0 +1,231 @@
+require 'cabeza-de-termo/json-spec/json-spec'
+require_relative 'fixtures'
+require_relative 'validation-printer'
+
+#
+# To run self example do
+# 		ruby -I lib examples/example-7-full-example.rb
+#
+class Example_7_FullExample
+	def self.run()
+		self.new.run
+	end
+
+	def run()
+		# Set our ExpectationsLibrary initializer before using it
+		CabezaDeTermo::JsonSpec::ExpectationsLibrary
+			.set_default_library_initializer( ComposerLibraryInitializer.new )
+
+		fixtures = [:simple, :empty, :'with-errors-and-non-expected-fields']
+		fixtures.each do |eachFixture|
+			runFixture(eachFixture)
+		end
+	end
+
+	def runFixture(fixture_name)
+		puts "--- Running the fixture '#{fixture_name}' ---\n".colorize(:blue)
+
+		validator = ComposerJson.new.spec.validate_string( Fixtures.named(fixture_name) )
+
+		ValidationPrinter.new.print_report_of validator
+	end
+
+end
+
+#
+# This is a custom Expectation we implement and use to validate the composer.json version values.
+#
+class IsVersionExpectation < CabezaDeTermo::JsonSpec::Expectation
+	def is_satisfied_by?(value_holder)
+		# left as exercise to the reader :P
+		true
+	end
+end
+
+#
+# This is the object that defines all the expectations, messages and modifiers that we
+# need to validate a composer.json.
+#
+class ComposerLibraryInitializer
+	def new_library()
+		library = CabezaDeTermo::JsonSpec::DefaultLibraryInitializer.new.new_library
+		define_library(library)
+	end
+
+	def define_library(library)
+		library.define do
+			expectations do
+				# Custom expectations
+
+				define :to_be_valid_lincense do
+					expecting :to_be_in, ComposerJson.valid_licenses
+					message "'<%= format value %>' is not a valid lincense."
+				end
+
+				define :to_be_version do
+					with_class IsVersionExpectation
+					message "'<%= format value %>' is not a valid version."
+				end
+
+				define :to_be_namespace do
+					expecting :to_match, /^[a-zA-Z_\\]+\\$/
+					message "'<%= format value %>' is not a valid namespace."
+				end
+
+				define :to_be_psr4_key do
+					expecting_any_of :to_be_equal_to, ''
+					or_also :to_be_namespace
+
+					message "'<%= format value %>' is not a valid PSR4 key."
+				end
+
+				define :to_end_with_slash do
+					expecting :to_match, /^.+\/$/
+					message "'<%= format value %>' does not end with a slash."
+				end
+
+			 	define :to_be_folder do
+			   	expecting_all_of :to_be_string
+			   	and_also :to_end_with_slash
+
+			 		message "'<%= format value %>' is not a valid folder."
+				end
+
+				# Custom messages
+				define :to_be_defined do
+					message "composer.json expects <%= field %> to be defined."
+				end
+				
+				define :not_blank do 
+					message "composer.json expects <%= field %> to be a not blank."
+				end
+
+				define :to_be_email do 
+					message "composer.json expects <%= field %> to be a valid email."
+				end
+			end
+
+			# I'll add some ExpressionModifier examples someday ...
+			modifiers do
+			end
+		end
+
+		library
+	end
+end
+
+#
+# This is the class where we define all the sections of the composer.json we are going 
+# to validate.
+#
+class ComposerJson
+	def spec()
+		CabezaDeTermo::JsonSpec::JsonSpec.new do |spec|
+			spec.expect_an(:object) do |object|
+				object.expect('name') .not_blank
+				object.expect('type') .not_blank
+				object.expect('description') .not_blank
+				object.expect('keywords') .to_be_as_defined_in(self, :keywords_spec)
+				object.expect('homepage') .to_be_url
+				object.expect('license') .to_be_valid_lincense
+				object.expect('authors') .to_be_as_defined_in(self, :authors_spec)
+				object.expect('require') .to_be_as_defined_in(self, :require_spec)
+				object.expect('require-dev') .to_be_as_defined_in(self, :require_spec)
+				object.expect('autoload') .to_be_as_defined_in(self, :autoload_spec)
+			end
+		end
+	end
+
+	def keywords_spec(json_spec)
+		 json_spec.to_be_a(:list) .can_be_absent .not_empty do
+			each do
+				expect_a(:scalar) .not_blank
+			end
+		end
+	end
+
+	def authors_spec(json_spec)
+		json_spec .to_be_a(:list) .not_empty do |list|
+			list.each do |each|
+				each.to_be_as_defined_in(self, :author_spec)
+			end
+		end
+	end
+
+	def author_spec(json_spec)
+		json_spec
+			.expect_an(:object) do
+				expect('name') .not_blank
+				expect('email') .to_be_email
+			end
+	end
+
+	def require_spec(json_spec)
+		json_spec .to_be_an(:object) .can_be_absent do
+			each_field do
+				expect_name .not_blank
+
+				expect_a(:scalar) .to_be_version
+			end
+		end
+	end
+
+	def autoload_spec(json_spec)
+		json_spec .to_be_an(:object) do |object|
+			object.expect('psr-0') .to_be_as_defined_in(self, :psr0_spec)
+			object.expect('psr-4') .to_be_as_defined_in(self, :psr4_spec)
+			object.expect('classmap') .to_be_as_defined_in(self, :classmaps_spec)
+			object.expect('files') .to_be_as_defined_in(self, :files_spec)
+		end
+	end
+
+	def psr4_spec(json_spec)
+		json_spec .to_be_an(:object) .can_be_absent do |object|
+			object.each_field do |field|
+				field.expect_name .to_be_psr4_key
+
+				field.to_be_as_defined_in(self, :folder_or_folder_list_spec)
+			end
+		end
+	end
+
+	def psr0_spec(json_spec)
+		json_spec .to_be_an(:object) .can_be_absent do |object|
+			object.each_field do |field|
+				field.expect_name .to_be_string
+
+				field.to_be_as_defined_in(self, :folder_or_folder_list_spec)
+			end
+		end
+	end
+
+	def folder_or_folder_list_spec(json_spec)
+		json_spec
+			.expect(:any_of) do
+				expect_a(:scalar) .to_be_folder
+			or_also
+				expect_a(:list) .not_empty do
+					each do
+						expect_a(:scalar) .to_be_folder
+					end
+				end
+			end
+	end
+
+	def classmaps_spec(json_spec)
+		json_spec .to_be_a(:list) .can_be_absent .not_empty
+	end
+
+	def files_spec(json_spec)
+		json_spec .to_be_a(:list) .can_be_absent .not_empty
+	end
+
+	def self.valid_licenses()
+		['Apache-2.0', 'BSD-2-Clause', 'BSD-3-Clause', 
+		 'BSD-4-Clause' ,'GPL-2.0', 'GPL-2.0+', 'GPL-3.0', 
+		 'GPL-3.0+', 'LGPL-2.1', 'LGPL-2.1+', 'LGPL-3.0',
+		 'LGPL-3.0+', 'MIT']
+	end
+end
+
+Example_7_FullExample.run

data/examples/fixtures.rb

@@ -0,0 +1,77 @@
+class Fixtures
+	def self.all
+		{
+			simple:
+'{
+	"name": "cabeza-de-termo/json-spec",
+	"type": "library",
+	"description": "A framework to declare expectations on a json format, and verify that a json object complies with those expectations. All using a very understandable, customizable and extensible idiom made entirely with PHP plain old objects.",
+	"keywords": ["json", "assertions", "expectations", "validation", "test"],
+	"homepage": "https://github.com/cabeza-de-termo/php-json-spec",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Martin Rubi",
+			"email": "martin.rubi@martinrubi.com"
+		}
+	],
+	"require": {
+		"php": ">=5.4.0"
+	},
+	"require-dev": {
+		"phpunit/phpunit": "^4",
+		"phpdocumentor/phpdocumentor": "2.*"
+	},
+	"autoload": {
+		"psr-4": {
+			"CabezaDeTermoJsonSpec\\\\": ["src/"],
+			"CabezaDeTermo\\\\JsonSpec\\\\Tests\\\\": ["tests/"]
+		}
+	}
+}',
+
+		empty: 
+'{}',
+
+		:'with-errors-and-non-expected-fields' =>
+'{
+	"name": "cabeza-de-termo/json-spec",
+	"type": "library",
+	"description": "A framework to declare expectations on a json format, and verify that a json object complies with those expectations. All using a very understandable, customizable and extensible idiom made entirely with PHP plain old objects.",
+	"keywords": ["json", "Expectations", "expectations", "validation", "phpunit"],
+	"homepage": "https://github.com/cabeza-de-termo/php-json-spec",
+	"time": "2015-10-31",
+	"license": "None",
+	"authors": [
+		{
+			"name": "Martin Rubi",
+			"email": "martin.rubi@martinrubi.com."
+		}
+	],
+	"require": {
+		"php": ">=5.4.0"
+	},
+	"require-dev": {
+		"phpunit/phpunit": "^4",
+		"phpdocumentor/phpdocumentor": "2.*"
+	},
+	"autoload": {
+		"psr-4": {
+			"CabezaDeTermoJsonSpec\\\\": "src/",
+			"CabezaDeTermo\\\\JsonSpec\\\\Tests\\\\": ["tests/"],
+			"AClassWithNoNamespace": ["src/"],
+			"": 123
+		},
+
+		"psr-0": {
+			"CabezaDeTermoJsonSpec": [123]
+		}
+	}
+}'
+		}
+	end
+
+	def self.named(fixture_name)
+		all[fixture_name]
+	end
+end