attributor 5.6 → 5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e7a4d30473d5e7e9dbd37f0e028b9b5dd5b17cf0ceb89593f0aed60dab20de
-  data.tar.gz: 59cc3458cd723c43733ea6a128fb4032c8aa8c7cd2ac41ea620c31842da35db6
+  metadata.gz: 72e523c77927ca8972951fa08ca3d9171f7601053d2a6d2ead46da6a9a1e2c4b
+  data.tar.gz: d6e008f822dfd90cb035dfdf66fd52d9fbea8bba35f02073dd2363aa4714ec64
 SHA512:
-  metadata.gz: 10da45417633b8f159db72d33a81101f25bd90cf8282e3a10e80d3cfb92de90639642dcf51d12d8f8ce4237acd1e2e4e562c97173480b1525cb4914f237d8ce4
-  data.tar.gz: e5c2ebc2dd2a214ffb4254332e56366bd825f1dbc93499d26476ed73226dc0e698be75918dab0a5d9853550ba8c88c83ba02afeeae22885254f828d2ac52040e
+  metadata.gz: 3404afef9afcc264b5394357c292155faa8ccf231e2f266b8e986d4234a16336a9d85b9e457d2bd16515bd01c95523460f1842dcdbde721d888dd3d80560c2b2
+  data.tar.gz: 65bc2b01956e42002e0b4a2e6fa54e93edd033dac3dae883225595f186b4f460823ffc82d32d5a6c9eba1a2ee7116325ca3d4af31e27f536462e6fd14fdc68fb

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Attributor Changelog
 
-## next
+## 5.7 (1/7/2021)
+
+- added `custom_option` to Attributor::Attribute class, accepting a name and Attribute arguments that will be used to validate the option value(s) provided.
 
 ## 5.6 (11/02/2020)
 

data/lib/attributor/attribute.rb

@@ -17,11 +17,25 @@ module Attributor
       FakeParent
     end
   end
+
   # It is the abstract base class to hold an attribute, both a leaf and a container (hash/Array...)
   # TODO: should this be a mixin since it is an abstract class?
   class Attribute
     attr_reader :type, :options
 
+    @custom_options = {}
+
+    class << self
+      attr_accessor :custom_options
+    end    
+
+    def self.custom_option(name, attr_type, options = {}, &block)
+      if TOP_LEVEL_OPTIONS.include?(name) || INTERNAL_OPTIONS.include?(name)
+        raise ArgumentError, "can not define custom_option with name #{name.inspect}, it is reserved by Attributor"
+      end
+      self.custom_options[name] = Attributor::Attribute.new(attr_type, options, &block)
+    end
+
     # @options: metadata about the attribute
     # @block: code definition for struct attributes (nil for predefined types or leaf/simple types)
     def initialize(type, options = {}, &block)
@@ -175,6 +189,11 @@ module Attributor
       # TODO: not sure if that's correct (we used to get it from the described hash...
       description[:example] = self.dump(example) if example
 
+      # add custom options as x-optionname
+      self.class.custom_options.each do |name, _|
+        description["x-#{name}".to_sym] = self.options[name] if self.options.key?(name)
+      end
+
       description
     end
 
@@ -296,6 +315,8 @@ module Attributor
 
     # TODO: override in type subclass
     def check_option!(name, definition)
+      return check_custom_option(name, definition) if self.class.custom_options.include? name
+
       case name
       when :values
         raise AttributorException, "Allowed set of values requires an array. Got (#{definition})" unless definition.is_a? ::Array
@@ -322,5 +343,14 @@ module Attributor
 
       :ok # passes
     end
+
+    def check_custom_option(name, definition) 
+      attribute = self.class.custom_options.fetch(name) 
+
+      errors = attribute.validate(definition)
+      raise AttributorException, "Custom option #{name.inspect} is invalid: #{errors.inspect}" if errors.any?
+
+      :ok
+    end
   end
 end

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = '5.6'.freeze
+  VERSION = '5.7'.freeze
 end

data/spec/attribute_spec.rb

@@ -62,6 +62,7 @@ describe Attributor::Attribute do
       it 'as well as the type-specific ones' do
         expect(js[:type]).to eq(:integer)
       end
+
     end
 
   end
@@ -194,6 +195,49 @@ describe Attributor::Attribute do
         end.not_to raise_error
       end
     end
+
+    context 'custom_options' do
+      let(:option_name) { :foo }
+      let(:custom_option_args) { [option_name, String] }
+
+      around do |example|
+        Attributor::Attribute.custom_option *custom_option_args
+        example.run
+        Attributor::Attribute.custom_options.delete option_name
+      end
+
+      it 'raises ArgumentError if given an existing option' do
+        expect {
+          Attributor::Attribute.custom_option :default, Object
+        }.to raise_error(ArgumentError)
+      end
+
+      it 'accepts custom options' do
+        expect do
+          Attributor::Attribute.new(Integer, foo: 'unvalidated')
+        end.not_to raise_error
+      end
+
+      context 'can validate the custom option value' do 
+        let(:custom_option_args) { [option_name, String, values: ['valid']] }
+        it 'does not raise with a valid option value' do
+          expect do
+            Attributor::Attribute.new(Integer, foo: 'valid')
+          end.not_to raise_error
+        end
+        it 'raises with an invalid option value' do
+          expect do
+            Attributor::Attribute.new(Integer, foo: 'invalid')
+          end.to raise_error(Attributor::AttributorException)
+        end
+      end
+
+      it 'appear in as_json_schema' do
+        attribute = Attributor::Attribute.new(Integer, foo: 'valid')
+        json_schema = attribute.as_json_schema
+        expect(json_schema[:'x-foo']).to eq 'valid'
+      end
+    end
   end
 
   context 'example' do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: '5.6'
+  version: '5.7'
 platform: ruby
 authors:
 - Josep M. Blanquer
 - Dane Jensen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -291,7 +291,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - blanquer@gmail.com
 - dane.jensen@gmail.com
@@ -392,7 +392,7 @@ homepage: https://github.com/rightscale/attributor
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -408,7 +408,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A powerful attribute and type management library for Ruby
 test_files: