restspec 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1403eca3180dfa8f249ce3fead22bb161ff7d20
-  data.tar.gz: d0570bf19544f321eb35109802e8366d87cbc466
+  metadata.gz: 4d41fb030fd5379b0d4b7ebfa5b11f4ca75bdfbe
+  data.tar.gz: c911b0e8737d4101434572e183124c1cc556d694
 SHA512:
-  metadata.gz: beff9885cf2d3aa080a65c65eb93926bb69f8c61d2c48fe93bfdb5b1a3e85b9ee7ff8a4e0da032d55b1a7bd423810415532247283c285b5dc0ce3891e4c67950
-  data.tar.gz: a8181a79efd09bf428094c34ac7f5c184cab60c2222e897f1416768b25e1e7ef80a15830dbc9d76f601602223add6384e19abb24c63a1cb575797c9f490513c3
+  metadata.gz: 12f39219a3aab6c2d7bbddafc5c13ef0d61ce689d34305363a46fbb9d75134c790f4f1ddd0cf4bdd62b988c43d485b881e9e2ca2cd8641ca862e438927584b4a
+  data.tar.gz: 4517a6136fe97b44156ece0da456fccc122be6bfcaa9fa04217ba255ced88709ef69df7dbaa634b2d63bdea5fd175743ebd0e173c4dee0e4751adf79dd0b2109

data/examples/store-api-tests/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ~/dev/projects/ruby/restspec
   specs:
-    restspec (0.2.4)
+    restspec (0.2.6)
       activesupport (~> 4.0)
       faker (~> 1.4)
       hashie (~> 3.3)

data/lib/restspec/schema/checker.rb

@@ -24,6 +24,11 @@ module Restspec
       # @raise NoObjectError if parameter passed is not a hash.
       def check!(object)
         raise NoObjectError.new(object) unless object.is_a?(Hash)
+        raise NoRootFoundError.new(object, schema) if schema.root? && !object.has_key?(schema.root_name)
+
+        if schema.root?
+          object = object.fetch(schema.root_name)
+        end
 
         schema.attributes.each do |_, attribute|
           if attribute.can_be_checked?
@@ -129,6 +134,19 @@ module Restspec
         end
       end
 
+      class NoRootFoundError < StandardError
+        attr_accessor :object, :schema
+
+        def initialize(object, schema)
+          self.object = object
+          self.schema = schema
+        end
+
+        def to_s
+          "The object #{object}:#{object.class} does not contain a root called #{schema.root_name}"
+        end
+      end
+
       class NoObjectError < StandardError
         attr_accessor :object
 

data/lib/restspec/schema/dsl.rb

@@ -11,16 +11,17 @@ module Restspec
       # instance for further definitions.
       #
       # @example
-      #   schema :book do
+      #   schema :book, root: true do
       #     puts self.class # SingleSchemaDSL
       #     puts self.schema.class # Schema
       #   end
       #
       # @param name {Symbol} the schema's name
+      # @param options {Hash} a set of options for {Schema#initialize}
       # @param definition A block that will be executed inside the context
       #   of a {SingleSchemaDSL} object.
-      def schema(name, &definition)
-        dsl = SingleSchemaDSL.new(name, mixins)
+      def schema(name, options = {}, &definition)
+        dsl = SingleSchemaDSL.new(name, options, mixins)
         dsl.instance_eval(&definition)
         Restspec::SchemaStore.store(dsl.schema)
       end
@@ -66,8 +67,8 @@ module Restspec
       # @return {Schema} the current schema
       attr_reader :schema
 
-      def initialize(name, mixins = {})
-        self.schema = Schema.new(name)
+      def initialize(name, options = {}, mixins = {})
+        self.schema = Schema.new(name, options)
         self.mixins = mixins
       end
 

data/lib/restspec/schema/schema.rb

@@ -10,15 +10,22 @@ module Restspec
       # The set of attributes that conforms the schema.
       attr_reader :attributes
 
+      # The root raw value
+      attr_reader :root
+
       # TODO: Document
       attr_accessor :intention
       attr_accessor :original_schema
 
       # @param name [Symbol] The name of the schema
+      # @param options [Hash] Some options:
+      #   - root: If the schema should have a root `{ schema: }` around the object. If this
+      #     attribute is a symbol or string, that will be the schema root to use.
       # @return a new {Restspec::Schema::Schema Schema} object
-      def initialize(name)
+      def initialize(name, options = {})
         self.name = name
         self.attributes = {}
+        self.root = options[:root]
       end
 
       # @param without [Array] An array of attributes that should be removed from the schema.
@@ -37,9 +44,19 @@ module Restspec
         end
       end
 
+      #
+      # @return [true, false] if the schema must include a root.
+      def root?
+        !!root
+      end
+
+      def root_name
+        root == true ? name.to_sym : root.to_sym
+      end
+
       private
 
-      attr_writer :name, :attributes
+      attr_writer :name, :attributes, :root
     end
   end
 end

data/lib/restspec/schema/schema_example.rb

@@ -15,9 +15,15 @@ module Restspec
       # It returns the generated example.
       # @return [Restspec::Values::SuperHash] generated example.
       def value
-        attributes.inject({}) do |sample, (_, attribute)|
+        example_attributes = attributes.inject({}) do |sample, (_, attribute)|
           sample.merge(attribute.name => AttributeExample.new(attribute).value)
         end.merge(extensions)
+
+        if schema.root?
+          wrap_in_root(example_attributes)
+        else
+          example_attributes
+        end
       end
 
       private
@@ -25,6 +31,10 @@ module Restspec
       def attributes
         schema.attributes_for_intention
       end
+
+      def wrap_in_root(hash)
+        { schema.root_name => hash }
+      end
     end
   end
 end

data/lib/restspec/version.rb

@@ -1,3 +1,3 @@
 module Restspec
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/spec/restspec/schema/checker_spec.rb

@@ -3,8 +3,9 @@ require 'spec_helper'
 include Restspec::Schema
 
 describe Checker do
+  let(:options) { {} }
   let(:schema) do
-    Schema.new(:product).tap do |schema|
+    Schema.new(:product, options).tap do |schema|
       schema.attributes[:name] = Attribute.new(:name, Types::StringType.new)
     end
   end
@@ -20,6 +21,26 @@ describe Checker do
       end
     end
 
+    context 'when the schema is root?' do
+      let(:options) { { root: 'monkey' } }
+
+      context 'when no root is present' do
+        it 'raises a Checker::NoRootFoundError' do
+          expect do
+            checker.check!(age: 10)
+          end.to raise_error(Checker::NoRootFoundError, /monkey/)
+        end
+      end
+
+      context 'when the root is present' do
+        it 'does not raises a Checker::NoRootFoundError' do
+          expect do
+            checker.check!(monkey: { name: 'Apu' })
+          end.to_not raise_error
+        end
+      end
+    end
+
     context 'when no attribute is present' do
       it 'raises a Checker::NoAttributeError' do
         expect do

data/spec/restspec/schema/dsl_spec.rb

@@ -7,12 +7,10 @@ describe DSL do
 
   describe '#schema' do
     let(:single_dsl) { double }
-    let(:schema) { double(name: 'name') }
+    let(:schema) { Schema.new(name: 'name') }
 
     before do
-      allow(SingleSchemaDSL).to receive(:new).and_return(single_dsl)
-      allow(single_dsl).to receive(:instance_eval).and_return(single_dsl)
-      allow(single_dsl).to receive(:schema).and_return(schema)
+      allow(SingleSchemaDSL).to receive(:new).and_call_original
     end
 
     it 'creates a SingleSchemaDSL with the given name' do
@@ -24,6 +22,18 @@ describe DSL do
       dsl.schema('name') { }
       expect(Restspec::SchemaStore.get('name')).to be_present
     end
+
+    it 'stores a schema with the root attribute set to false' do
+      dsl.schema('dog') { }
+      expect(Restspec::SchemaStore.get('name').root?).to eq(false)
+    end
+
+    context 'with the root option set to true' do
+      it 'creates a schema with the root option set to true' do
+        dsl.schema('dog', root: true) { }
+        expect(Restspec::SchemaStore.get('dog').root?).to eq(true)
+      end
+    end
   end
 end
 
@@ -54,7 +64,7 @@ describe SingleSchemaDSL do
 
   describe '#include_attributes' do
     let(:main_dsl) { DSL.new }
-    let(:schema_dsl) { SingleSchemaDSL.new(:name, main_dsl.send(:mixins)) }
+    let(:schema_dsl) { SingleSchemaDSL.new(:name, {}, main_dsl.send(:mixins)) }
 
     before do
       main_dsl.mixin :test_mixin do

data/spec/restspec/schema/schema_example_spec.rb

@@ -15,6 +15,28 @@ describe SchemaExample do
     schema.attributes['age'] = Attribute.new(:age, integer_type)
   end
 
+  describe 'root cases' do
+    let(:schema_example) { SchemaExample.new(schema) }
+
+    context 'with a schema that root? with a value' do
+      let(:schema) { Schema.new(:dog, root: 'monkey') }
+
+      it 'generates an example wrapped in the root value' do
+        expect(schema_example.value).to have_key(:monkey)
+        expect(schema_example.value[:monkey]).to have_key(:name)
+        expect(schema_example.value[:monkey]).to have_key(:age)
+      end
+    end
+
+    context 'with a schema that root? with true' do
+      let(:schema) { Schema.new(:dog, root: true) }
+
+      it 'generates an example wrapped in the schema name' do
+        expect(schema_example.value).to have_key(:dog)
+      end
+    end
+  end
+
   context 'without extensions' do
     let(:schema_example) { SchemaExample.new(schema) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restspec
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - juliogarciag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake