paradocs 1.0.22 → 1.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e89cffb387938580ebcb23782856781be60903c
-  data.tar.gz: 8bb05339c65e90d579f86ec103e055d3b3965d29
+  metadata.gz: 46df9e6a68b9d5574d7923e38646fbaeedc20a61
+  data.tar.gz: 96ac7dda4da79eb1aa56c13adf003f1f9b6c0585
 SHA512:
-  metadata.gz: 4f1f47dce1ccdf9bd688fdc754b5759ad74051b8c976d70344ddde239badab52ce764c077b48aa0b29155ab0f81caa8645d818d5482367e3b1217bcc3230e039
-  data.tar.gz: fb12f58e2d16b2f3471576aa76020cec0dcc0f5b994b06a66f402f8411b17e14922aa8026b6600d157a6590c3a0fadf3cd2d0687c9cf3f847104c83dcdf9b70c
+  metadata.gz: b24241e65b44f94a431e47780f8e9932ff3b0f2da288d57ae483d7663f9c9a9286467799d3b35fd8ee8730cc9a57faf475c9cc25aa51d38690ac37af61e2c2e5
+  data.tar.gz: be37a51df5961b6e1d73f3c9c126a2a112d8cc6482451459ec0efd11af4a8a3a715f47e8427a01f3d5137e9e5164ca205fe575d9c8d5a49a2ea805bdcde89996

data/README.md

@@ -6,9 +6,13 @@ Declaratively define data schemas in your Ruby objects, and use them to whitelis
 
 Useful for building self-documeting APIs, search or form objects. Or possibly as an alternative to Rails' _strong parameters_ (it has no dependencies on Rails and can be used stand-alone).
 ## Installation
+```sh
+$ gem install paradocs
+```
 
+Or with Bundler in your Gemfile.
 ```rb
-gem 'paradocs', git: 'https://github.com/mtkachenk0/paradocs'
+gem 'paradocs'
 ```
 
 ## Getting Started

data/lib/paradocs/struct.rb

@@ -18,8 +18,8 @@ module Paradocs
       base.extend ClassMethods
     end
 
-    def initialize(attrs = {})
-      @_results = self.class.schema.resolve(attrs)
+    def initialize(attrs = {}, environment = {})
+      @_results = self.class.schema.resolve(attrs, environment)
       @_graph = self.class.build(@_results.output)
     end
 
@@ -48,8 +48,8 @@ module Paradocs
     attr_reader :_graph, :_results
 
     module ClassMethods
-      def new!(attrs = {})
-        st = new(attrs)
+      def new!(attrs = {}, environment = {})
+        st = new(attrs, environment)
         raise InvalidStructError.new(st) unless st.valid?
         st
       end

data/lib/paradocs/version.rb

@@ -1,3 +1,3 @@
 module Paradocs
-  VERSION = "1.0.22"
+  VERSION = "1.0.23"
 end

data/paradocs.gemspec

@@ -6,8 +6,8 @@ require 'paradocs/version'
 Gem::Specification.new do |spec|
   spec.name          = "paradocs"
   spec.version       = Paradocs::VERSION
-  spec.authors       = ["Ismael Celis", "Maxim Tkachenko"]
-  spec.email         = ["ismaelct@gmail.com", "tkachenko.maxim.w@gmail.com"]
+  spec.authors       = ["Maxim Tkachenko", "Ismael Celis"]
+  spec.email         = ["tkachenko.maxim.w@gmail.com", "ismaelct@gmail.com"]
   spec.description   = %q{Flexible DSL for declaring allowed parameters focused on DRY validation that gives you opportunity to generate API documentation on-the-fly.}
   spec.summary       = %q{A huge add-on for original gem mostly focused on retrieving the more metadata from declared schemas as possible.}
   spec.homepage      = "https://github.com/mtkachenk0/paradocs"
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.1"
-  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", '3.4.0'
   spec.add_development_dependency "pry", "~> 0"
 end

data/spec/struct_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'paradocs/struct'
 
 describe Paradocs::Struct do
-  it "works" do
+  it 'works' do
     friend_class = Class.new do
       include Paradocs::Struct
 
@@ -53,7 +53,7 @@ describe Paradocs::Struct do
     expect(invalid_instance.friends[1].errors['$.name']).not_to be_nil
   end
 
-  it "is inmutable by default" do
+  it 'is inmutable by default' do
     klass = Class.new do
       include Paradocs::Struct
 
@@ -66,7 +66,7 @@ describe Paradocs::Struct do
 
     instance = klass.new
     expect {
-      instance.title = "foo"
+      instance.title = 'foo'
     }.to raise_error NoMethodError
 
     expect {
@@ -74,7 +74,7 @@ describe Paradocs::Struct do
     }.to raise_error RuntimeError
   end
 
-  it "works with anonymous nested schemas" do
+  it 'works with anonymous nested schemas' do
     klass = Class.new do
       include Paradocs::Struct
 
@@ -125,7 +125,7 @@ describe Paradocs::Struct do
     expect(user.friends.first.salutation).to eq 'my age is 43'
   end
 
-  it "wraps regular schemas in structs" do
+  it 'wraps regular schemas in structs' do
     friend_schema = Paradocs::Schema.new do
       field(:name)
     end
@@ -147,7 +147,7 @@ describe Paradocs::Struct do
     expect(instance.friends.first.name).to eq 'Ismael'
   end
 
-  it "#to_h" do
+  it '#to_h' do
     klass = Class.new do
       include Paradocs::Struct
 
@@ -185,7 +185,7 @@ describe Paradocs::Struct do
     expect(new_instance.to_h[:title]).to eq 'foo'
   end
 
-  it "works with inheritance" do
+  it 'works with inheritance' do
     klass = Class.new do
       include Paradocs::Struct
 
@@ -218,7 +218,7 @@ describe Paradocs::Struct do
     expect(instance.friends.size).to eq 2
   end
 
-  it "implements deep struct equality" do
+  it 'implements deep struct equality' do
     klass = Class.new do
       include Paradocs::Struct
 
@@ -268,7 +268,7 @@ describe Paradocs::Struct do
     expect(s1 == s4).to be false
   end
 
-  it "#merge returns a new instance" do
+  it '#merge returns a new instance' do
     klass = Class.new do
       include Paradocs::Struct
 
@@ -301,6 +301,20 @@ describe Paradocs::Struct do
     expect(copy.friends.first.name).to eq 'jane'
   end
 
+  it 'passes the environment to the schema' do
+    klass = Class.new do
+      include Paradocs::Struct
+
+      schema do
+        field(:age).type(:integer)
+      end
+    end
+
+    new_instance = klass.new({}, { key: :value })
+
+    expect(new_instance.send(:_results).environment).to eq({ key: :value })
+  end
+
   describe '.new!' do
     it 'raises a useful exception if invalid data' do
       klass = Class.new do
@@ -320,5 +334,19 @@ describe Paradocs::Struct do
       valid = klass.new!(title: 'foo')
       expect(valid.title).to eq 'foo'
     end
+
+    it 'passes the environment to the schema' do
+      klass = Class.new do
+        include Paradocs::Struct
+
+        schema do
+          field(:title).type(:string).present
+        end
+      end
+
+      new_instance = klass.new!({ title: 'test' }, { key: :value })
+
+      expect(new_instance.send(:_results).environment).to eq({ key: :value })
+    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: paradocs
 version: !ruby/object:Gem::Version
-  version: 1.0.22
+  version: 1.0.23
 platform: ruby
 authors:
-- Ismael Celis
 - Maxim Tkachenko
+- Ismael Celis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -29,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,8 +70,8 @@ dependencies:
 description: Flexible DSL for declaring allowed parameters focused on DRY validation
   that gives you opportunity to generate API documentation on-the-fly.
 email:
-- ismaelct@gmail.com
 - tkachenko.maxim.w@gmail.com
+- ismaelct@gmail.com
 executables:
 - console
 extensions: []