json-spec 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7c5b0ef1b9b89e5fc9b8a67cea2b1b73eb6a82e
-  data.tar.gz: 0a6e0a666f87d2d67f39d9670784ed97cca370d2
+  metadata.gz: 2136aa485a249788e83e6b962ae039d5cf3ceac9
+  data.tar.gz: 4786b07cf34a2c1045fcd64a8901e20709cc136a
 SHA512:
-  metadata.gz: 0fd7aab56ea788ef106e904274ce45118418981f7dfb132823ff11f3f1dd36f57dec2724a7f1bdfd9fbae7c4f2ec6d9a600dc445db8ac831a7b21011321f98d2
-  data.tar.gz: f29dde5f94bdd8e5e9b167ddb91074cb8f3ab3c54e00812e6696b2ca37d4ee8faf11b284ef93a5e6ae8b4581d96e0065c171ba7d7d6f47575bf71e93b08ac137
+  metadata.gz: 74cc87284c78691d63eeca202be7b6216e1591bf047efa885fb99366956686db57c0ce31014fa1418ee11bd90bb22a25a1eb2864c606868047ec8a19f7179243
+  data.tar.gz: f77c2df721f9c977958774551650a6fe16098fbefd0bab75f826a2d92a6aacaf166bb3915e4d1c4ffd2e1dd8c884776b01100edc4980398cb523fac572dc2ff3

data/README.md

@@ -13,7 +13,7 @@ A framework to declare expectations and verify that a json object satisfies thos
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'json-spec', '~> 0.1'
+gem 'json-spec', '~> 0.2'
 ```
 
 And then execute:
@@ -394,6 +394,10 @@ So now we have the class
 
 ```ruby
 class ComposerJson
+	def self.validate_string(json_string)
+		self.new.spec.validate_string(json_string)
+	end
+
 	def spec()
 		CabezaDeTermo::JsonSpec::JsonSpec.new do |json_spec|
 			json_spec.expect_an(:object) do |object|
@@ -486,7 +490,7 @@ end
 and to run the validation all we have to do is
 
 ```ruby
-validator = ComposerJson.new.spec.validate_string(json_string)
+validator = ComposerJson.validate_string(json_string)
 ```
 
 If you want to validate a not very complex json, you can get away with it without factorizing the expectations. But as soon as the validation gets more complex, you can refactor the expectations using `:to_be_as_defined_in(some_object, :some_method)`.
@@ -803,8 +807,12 @@ Something like this:
 
 ```ruby
 class ComposerLibraryInitializer
+	def self.new_library()
+		self.new.new_library
+	end
+
 	def new_library()
-		initialize_library CabezaDeTermo::JsonSpec::DefaultLibraryInitializer.new.new_library
+		initialize_library CabezaDeTermo::JsonSpec::DefaultLibraryInitializer.new_library
 	end
 
 	def initialize_library(library)
@@ -815,14 +823,23 @@ class ComposerLibraryInitializer
 end
 ```
 
-and now plug the initializer into the ExpectationsLibrary at your application bootstrap with
+and now plug your library in the spec that will use it:
 
 ```ruby
-CabezaDeTermo::JsonSpec::ExpectationsLibrary
-	.set_default_library_initializer( ComposerLibraryInitializer.new )
+CabezaDeTermo::JsonSpec::JsonSpec.new do
+	use_expectations_library ComposerLibraryInitializer.new_library
+
+	expect_an(:object) do
+		...
+	end
+end
 ```
 
-and that's it, now you can use the ExpectationsLibrary with all your custom additions.
+or, if you are going to use that library all around in your application, you can set it globally:
+
+```ruby
+CabezaDeTermo::JsonSpec::ExpectationsLibrary.set_current ComposerLibraryInitializer.new_library
+```
 
 To see how all the pieces fitted together, check and run the [seventh example](examples/example-7-full-example.rb) in the `examples/` folder.
 
@@ -950,7 +967,7 @@ and that's it. You have a fully prepared, ready to use development environment.
 # Running the tests
 
 * `bundle install`
-* `rake test`
+* `bundle exec rake`
 
 ## Contributing
 

data/examples/example-4-to-be-as-defined-in.rb

@@ -19,13 +19,17 @@ class Example_4_ToBeAsDefinedIn
 			end
 		end
 
-		validator = ComposerJson.new.spec.validate_string(Fixtures.named :simple)
+		validator = ComposerJson.validate_string(Fixtures.named :simple)
 
 		ValidationPrinter.new.print_report_of validator
 	end
 end
 
 class ComposerJson
+	def self.validate_string(json_string)
+		self.new.spec.validate_string(json_string)
+	end
+
 	def spec()
 		CabezaDeTermo::JsonSpec::JsonSpec.new do |json_spec|
 			json_spec.expect_an(:object) do |object|

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

@@ -48,7 +48,7 @@ class Example_5_CustomExpectations
 			end
 		end
 
-		validator = ComposerJson.new.spec.validate_string(Fixtures.named :simple)
+		validator = ComposerJson.validate_string(Fixtures.named :simple)
 
 		ValidationPrinter.new.print_report_of validator
 	end
@@ -62,6 +62,10 @@ class IsVersionExpectation <  CabezaDeTermo::JsonSpec::Expectation
 end
 
 class ComposerJson
+	def self.validate_string(json_string)
+		self.new.spec.validate_string(json_string)
+	end
+
 	def spec()
 		CabezaDeTermo::JsonSpec::JsonSpec.new do |json_spec|
 			json_spec.expect_an(:object) do |object|

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

@@ -12,10 +12,6 @@ class Example_7_FullExample
 	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)
@@ -25,7 +21,7 @@ class Example_7_FullExample
 	def runFixture(fixture_name)
 		puts "--- Running the fixture '#{fixture_name}' ---\n".colorize(:blue)
 
-		validator = ComposerJson.new.spec.validate_string( Fixtures.named(fixture_name) )
+		validator = ComposerJson.validate_string( Fixtures.named(fixture_name) )
 
 		ValidationPrinter.new.print_report_of validator
 	end
@@ -47,8 +43,12 @@ end
 # need to validate a composer.json.
 #
 class ComposerLibraryInitializer
+	def self.new_library()
+		self.new.new_library
+	end
+
 	def new_library()
-		library = CabezaDeTermo::JsonSpec::DefaultLibraryInitializer.new.new_library
+		library = CabezaDeTermo::JsonSpec::DefaultLibraryInitializer.new_library
 		define_library(library)
 	end
 
@@ -119,8 +119,14 @@ end
 # to validate.
 #
 class ComposerJson
+	def self.validate_string(json_string)
+		self.new.spec.validate_string(json_string)
+	end
+
 	def spec()
 		CabezaDeTermo::JsonSpec::JsonSpec.new do |spec|
+			spec.use_expectations_library ComposerLibraryInitializer.new_library
+
 			spec.expect_an(:object) do |object|
 				object.expect('name') .not_blank
 				object.expect('type') .not_blank

data/json-spec.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{A framework to declare expectations on a json format and validate that a json object satisfies those expectations. 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"
 

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

@@ -11,7 +11,6 @@ module CabezaDeTermo
 	module JsonSpec
 		class ExpectationsLibrary
 			@current = nil
-			@default_library_initializer = nil
 
 			# Instance accessing
 
@@ -37,25 +36,8 @@ module CabezaDeTermo
 
 			# Initializing
 
-			def self.default_library_initializer()
-				set_default_library_initializer(new_default_library_initializer) if @default_library_initializer.nil?
-
-				@default_library_initializer
-			end
-
-			def self.set_default_library_initializer(library_initializer)
-				to_be_replaced = @default_library_initializer
-				@default_library_initializer = library_initializer
-
-				to_be_replaced
-			end
-
-			def self.new_default_library_initializer()
-				DefaultLibraryInitializer.new
-			end
-
 			def self.new_default()
-				default_library_initializer.new_library
+				DefaultLibraryInitializer.new_library
 			end
 
 			# Instance methods

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

@@ -10,6 +10,10 @@ require "cabeza-de-termo/json-spec/modifiers/can-be-null-modifier"
 module CabezaDeTermo
 	module JsonSpec
 		class DefaultLibraryInitializer < LibraryInitializer
+			def self.new_library()
+				self.new.new_library
+			end
+
 			def new_library()
 				library = ExpectationsLibrary.new
 				define_library(library)

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

@@ -71,8 +71,8 @@ module CabezaDeTermo
 			#
 			# @return JsonSpec
 			#
-			def global_expectations_library()
-				json_spec.global_expectations_library
+			def expectations_library()
+				json_spec.expectations_library
 			end
 
 			# Error handling
@@ -108,7 +108,7 @@ module CabezaDeTermo
 			# @return boolean
 			#
 			def is_an_expectations_library_method?(message)
-				global_expectations_library.has_expectation_for?(message.method_name)
+				expectations_library.has_expectation_for?(message.method_name)
 			end
 
 			#
@@ -119,7 +119,7 @@ module CabezaDeTermo
 			# @return boolean
 			#
 			def is_a_modifier_library_method?(message)
-				global_expectations_library.has_modifier_for?(message.method_name)
+				expectations_library.has_modifier_for?(message.method_name)
 			end
 
 			# Defining Expectations
@@ -151,7 +151,7 @@ module CabezaDeTermo
 			# @return JsonExpression
 			#
 			def add_expectation_from_library(message)
-				expectation = global_expectations_library.new_expectation_from_message(message)
+				expectation = expectations_library.new_expectation_from_message(message)
 
 				expectation.set_expectation_method(message.method_name)
 				expectation.set_json_spec(json_spec)
@@ -173,7 +173,7 @@ module CabezaDeTermo
 			# @return JsonExpression
 			#
 			def perform_modifier_from_library(message)
-				modifier = global_expectations_library
+				modifier = expectations_library
 									.new_modifier_from_message(message)
 
 				run_modifier(modifier)

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

@@ -26,6 +26,8 @@ module CabezaDeTermo
 				@expectation_messages_mapping = new_expectations_messages_mapping
 				@default_expectations = new_default_expectations_mapping
 
+				use_expectations_library(global_expectations_library)
+
 				CdT.bind_evaluation_of block, to: self unless block.nil?
 			end
 
@@ -39,14 +41,18 @@ module CabezaDeTermo
 				@default_expectations
 			end
 
-			def global_expectations_library()
-				ExpectationsLibrary.current
+			def expectations_library()
+				@expectations_library
 			end
 
 			def root_expression()
 				@root_expression
 			end
 
+			def use_expectations_library(expectations_library)
+				@expectations_library = expectations_library
+			end
+
 			# Default expectations
 
 			def define(&block)
@@ -122,7 +128,7 @@ module CabezaDeTermo
 					return @expectation_messages_mapping.message_formatter_for(expectation_method)
 				end
 
-				global_expectations_library.message_formatter_for(expectation_method)
+				expectations_library.message_formatter_for(expectation_method)
 			end
 
 			def define_message_formatter_for(expectation_method, message_block)
@@ -145,7 +151,7 @@ module CabezaDeTermo
 			end
 
 			def global_default_expectations_for(json_expression_type)
-				global_expectations_library.default_expectations.expectations_for(json_expression_type)
+				expectations_library.default_expectations.expectations_for(json_expression_type)
 			end
 
 			# Validating
@@ -170,6 +176,12 @@ module CabezaDeTermo
 			def explain()
 				new_expression_explainer.explain(self)
 			end
+
+			protected
+
+			def global_expectations_library()
+				ExpectationsLibrary.current
+			end
 		end
 	end
 end

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

@@ -1,5 +1,5 @@
 module CabezaDeTermo
 	module JsonSpec
-		VERSION = "0.1.2"
+		VERSION = "0.2.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Rubi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cdt-utilities
@@ -94,8 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: You can use this json expectations to validate jsons you send or receive
-  in your application, or to test your API with unit tests.
+description: A framework to declare expectations on a json format and validate that
+  a json object satisfies those expectations. You can use this json expectations to
+  validate jsons you send or receive in your application, or to test your API with
+  unit tests.
 email:
 - martin.rubi@gmail.com
 executables: []
@@ -240,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A framework to declare expectations on a json format and validate that a