attributor 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64d1a212c179718aacc7837f4484062a4987e4d3
-  data.tar.gz: 5d2f971e22f191497e2f29bb95e8f84e73a8a52f
+  metadata.gz: bcf6ceb7deb1d4db6a3370de07f1af676c4ffd27
+  data.tar.gz: 28e0d3d5091ab8c1663275ae4f5c2c46927cd186
 SHA512:
-  metadata.gz: f33c468a57b20fd6e91bf58747513b19856d9c62b2c61ddf96e718a91bb0cfa9e3fa1f85c62442e5735df3280707d3adc70bf1b11c4f9c90b7ff5511668affe3
-  data.tar.gz: 14084572c335799325e89195620520176ff57360bf1732a3eee9c86a00fce331a842ca8790a2aaa2743eccd49cc012a84bc7d5aec5f525659a108885ef54543e
+  metadata.gz: 322a5d22a2b1fcc8166c011b88fb09f4367f585e1c1fab94ef457a3132c2e0427b1a1cdf1aaeae67d5c653c813d4a11212f8f2be77250cab15e1bed711981cf4
+  data.tar.gz: 83e5bee88b8119a4af387a767ba8a64580cbc79feb72cd7fe3870be707c2a7fb9d78a91ddcc0227a6b05c549980851b5a863b05c47862c312e9cd35b9fb1b075

data/.gitignore

@@ -16,3 +16,5 @@ doc
 
 Gemfile.lock
 pkg
+
+*.swp

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Attributor Changelog
 
-## next
+## next 
+
+
+## 4.0.1
+
+* `Attribute#check_option!` now calls `load` on any provided value.
 
 
 ## 4.0.0 next

data/Rakefile

@@ -14,6 +14,14 @@ RSpec::Core::RakeTask.new do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
+desc "console"
+task :console do
+  require 'bundler'
+  Bundler.require(:default, :development, :test)
+  require_relative 'lib/attributor'
+  pry
+end
+
 task :default => :spec
 
 require 'yard'

data/attributor.gemspec

@@ -10,17 +10,18 @@ Gem::Specification.new do |spec|
   spec.authors = ["Josep M. Blanquer","Dane Jensen"]
   spec.summary = "A powerful attribute and type management library for Ruby"
   spec.email = ["blanquer@gmail.com","dane.jensen@gmail.com"]
-  
+
   spec.homepage = "https://github.com/rightscale/attributor"
   spec.license = "MIT"
   spec.required_ruby_version = ">=2.1"
-  
+
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  
+
   spec.add_runtime_dependency(%q<hashie>, ["~> 3"])
   spec.add_runtime_dependency(%q<randexp>, ["~> 0"])
+  spec.add_runtime_dependency(%q<activesupport>, ['>= 3'])
   spec.add_development_dependency(%q<rspec>, ["< 2.99"])
   spec.add_development_dependency(%q<yard>, ["~> 0.8.7"])
   spec.add_development_dependency(%q<backports>, ["~> 3"])

data/lib/attributor.rb

@@ -45,7 +45,7 @@ module Attributor
   end
 
   def self.type_name(type)
-    return self.type_name(type.class) unless type.kind_of?(Class)
+    return self.type_name(type.class) unless type.kind_of?(::Class)
 
     type.ancestors.find { |k| k.name && !k.name.empty? }.name
   end
@@ -75,7 +75,7 @@ module Attributor
   end
 
   MODULE_PREFIX       = "Attributor\:\:".freeze
-  MODULE_PREFIX_REGEX = Regexp.new(MODULE_PREFIX)
+  MODULE_PREFIX_REGEX = ::Regexp.new(MODULE_PREFIX)
 
   require_relative 'attributor/families/numeric'
   require_relative 'attributor/families/temporal'
@@ -91,11 +91,13 @@ module Attributor
   require_relative 'attributor/types/time'
   require_relative 'attributor/types/date'
   require_relative 'attributor/types/date_time'
+  require_relative 'attributor/types/regexp'
   require_relative 'attributor/types/float'
   require_relative 'attributor/types/collection'
   require_relative 'attributor/types/hash'
   require_relative 'attributor/types/model'
   require_relative 'attributor/types/struct'
+  require_relative 'attributor/types/class'
 
 
   require_relative 'attributor/types/csv'

data/lib/attributor/attribute.rb

@@ -67,7 +67,7 @@ module Attributor
             defined_val.call
           end
         else
-            defined_val
+          defined_val
         end
         value = val #Need to load?
       end
@@ -124,7 +124,7 @@ module Attributor
       description[:type] = self.type.describe(shallow, example: example )
       # Move over any example from the type, into the attribute itself
       if ( ex = description[:type].delete(:example) )
-        description[:example] = self.dump( ex ).to_s
+        description[:example] = self.dump(ex)
       end
 
       description
@@ -286,6 +286,7 @@ module Attributor
         raise AttributorException.new("Allowed set of values requires an array. Got (#{definition})") unless definition.is_a? ::Array
       when :default
         raise AttributorException.new("Default value doesn't have the correct attribute type. Got (#{definition.inspect})") unless self.type.valid_type?(definition) || definition.kind_of?(Proc)
+        self.options[:default] = self.load(definition) unless definition.kind_of?(Proc)
       when :description
         raise AttributorException.new("Description value must be a string. Got (#{definition})") unless definition.is_a? ::String
       when :required

data/lib/attributor/types/class.rb

@@ -0,0 +1,56 @@
+require 'active_support'
+
+require_relative '../exceptions'
+
+
+module Attributor
+  class Class
+    include Type
+
+    def self.native_type
+      return ::Class
+    end
+
+    def self.load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      return @klass || nil if value.nil?
+
+      # Must be given a String object or nil
+      unless value.kind_of?(::String) || value.nil?
+        raise IncompatibleTypeError,  context: context, value_type: value.class, type: self
+      end
+
+      value = "::" + value if value[0..1] != '::'
+      result = value.constantize
+
+      # Class given must match class specified when type created using .of() method
+      unless @klass.nil? || result == @klass
+        raise LoadError, "Error loading class #{value} for attribute with " +
+          "defined class #{@klass} while loading #{Attributor.humanize_context(context)}."
+      end
+
+      result
+    end
+
+    def self.example(context=nil, options:{})
+      @klass.nil? ? "MyClass" : @klass.name
+    end
+
+    # Create a Class attribute type of a specific Class.
+    #
+    # @param klass [Class] optional, defines the class of this attribute, if constant
+    #
+    # @return anonymous class with specified type of collection members
+    #
+    # @example Class.of(Factory)
+    #
+    def self.of(klass)
+      ::Class.new(self) do
+        @klass = klass
+      end
+    end
+
+    def self.family
+      'string'
+    end
+  end
+end

data/lib/attributor/types/collection.rb

@@ -16,7 +16,7 @@ module Attributor
       unless resolved_type.ancestors.include?(Attributor::Type)
         raise Attributor::AttributorException.new("Collections can only have members that are Attributor::Types")
       end
-      Class.new(self) do
+      ::Class.new(self) do
         @member_type = resolved_type
       end
     end
@@ -53,7 +53,7 @@ module Attributor
     def self.member_attribute
       @member_attribute ||= begin
         self.construct(nil,{})
-        
+
         @member_attribute
       end
     end

data/lib/attributor/types/hash.rb

@@ -129,7 +129,7 @@ module Attributor
 
     # @example Hash.of(key: String, value: Integer)
     def self.of(key: @key_type, value: @value_type)
-      Class.new(self) do
+      ::Class.new(self) do
         self.key_type = key
         self.value_type = value
         @keys = {}
@@ -164,8 +164,8 @@ module Attributor
       example_depth = context.size
 
       self.keys.each do |sub_attribute_name, sub_attribute|
-        
-        
+
+
         if sub_attribute.attributes
           # TODO: add option to raise an exception in this case?
           next if example_depth > MAX_EXAMPLE_DEPTH

data/lib/attributor/types/ids.rb

@@ -12,7 +12,7 @@ module Attributor
         raise AttributorException, "#{type.name} does not have attribute with name '#{identity_name}'"
       end
 
-      Class.new(self) do
+      ::Class.new(self) do
         @member_attribute = identity_attribute
         @member_type = identity_attribute.type
       end

data/lib/attributor/types/regexp.rb

@@ -0,0 +1,30 @@
+require_relative '../exceptions'
+
+module Attributor
+  class Regexp
+    include Type
+
+    def self.native_type
+      return ::Regexp
+    end
+
+    def self.load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      unless value.kind_of?(::String) || value.nil?
+        raise IncompatibleTypeError,  context: context, value_type: value.class, type: self
+      end
+
+      value && ::Regexp.new(value)
+    rescue
+      super
+    end
+
+    def self.example(context=nil, options:{})
+      ::Regexp.new(/^pattern\d{0,3}$/).to_s
+    end
+
+    def self.family
+      'string'
+    end
+
+  end
+end

data/lib/attributor/types/struct.rb

@@ -1,8 +1,8 @@
 
 module Attributor
   class Struct < Attributor::Model
-    
-    def self.constructable? 
+
+    def self.constructable?
       true
     end
 
@@ -26,7 +26,7 @@ module Attributor
         end
       end
 
-      Class.new(self) do
+      ::Class.new(self) do
         attributes options, &attribute_definition
       end
 

data/lib/attributor/types/uri.rb

@@ -39,12 +39,26 @@ module Attributor
     end
 
     def self.validate(value,context=Attributor::DEFAULT_ROOT_CONTEXT,attribute)
-      []
+      errors = []
+
+      if attribute && (definition = attribute.options[:path])
+        unless value.path =~ attribute.options[:path]
+          errors << "#{Attributor.humanize_context(context)} value (#{value}) does not match path (#{definition.inspect})"
+        end
+      end
+      errors
     end
 
-    def check_option!(name, definition)
-      # No options are supported
-      :unknown
+    def self.check_option!(name, definition)
+      case name
+      when :path
+        unless definition.is_a? ::Regexp
+          raise AttributorException.new("Value for option :path is not a Regexp object. Got (#{definition.inspect})")
+        end
+        :ok
+      else
+        :unknown
+      end
     end
 
   end

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

data/spec/support/models.rb

@@ -87,3 +87,10 @@ class Address < Attributor::Model
 end
 
 
+class Post < Attributor::Model
+  attributes do
+    attribute :title, String
+    attribute :tags, Attributor::Collection.of(String)
+  end
+end
+

data/spec/types/class_spec.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+require 'backports'
+
+describe Attributor::Class do
+
+  subject(:type) { Attributor::Class }
+
+  its(:native_type) { should be(::Class) }
+  its(:family) { should == 'string' }
+
+  context '.example' do
+    its(:example) { should be_a(::String) }
+
+    context 'when created using .of method' do
+      let(:klass) { Integer }
+      subject(:type) { Attributor::Class.of(klass) }
+
+      its(:example) { should eq(klass.to_s) }
+    end
+  end
+
+  context '.load' do
+    let(:value) { nil }
+
+    context 'for incoming String values' do
+      ['Object', '::Object', '::Hash', 'Attributor::Struct'].each do |value|
+        it "loads '#{value}' as #{eval(value)}" do
+          type.load(value).should eq(value.constantize)
+        end
+      end
+    end
+
+    context 'when created using .of method' do
+      let(:klass) { Integer }
+      subject(:type) { Attributor::Class.of(klass) }
+
+      it "loads 'Integer' as Integer" do
+        type.load('Integer').should eq(Integer)
+      end
+
+      it "returns specified class for nil" do
+        type.load(nil).should be(klass)
+      end
+
+      it "raises when given a class that doesn't match specified class" do
+        expect { type.load('Float') }.to raise_exception(Attributor::LoadError)
+      end
+    end
+
+    it 'returns nil for nil' do
+      type.load(nil).should be(nil)
+    end
+
+    it 'raises when given a non-String' do
+      expect {type.load(1)}.to raise_exception(Attributor::IncompatibleTypeError)
+    end
+  end
+end

data/spec/types/hash_spec.rb

@@ -564,8 +564,8 @@ context 'attributes' do
           description[:attributes].keys.should =~ type.keys.keys
           description[:attributes].each do |name,sub_description|
             sub_description.should have_key(:example)
-            val = type.attributes[name].dump( example[name] ).to_s
-            sub_description[:example].should eq( val )
+            val = type.attributes[name].dump(example[name])
+            sub_description[:example].should eq val
           end
         end
       end

data/spec/types/model_spec.rb

@@ -242,6 +242,30 @@ describe Attributor::Model do
             #raise_error(Attributor::AttributorException, /Unknown attributes.*#{context.join('.')}/)
           end
         end
+
+        context 'loading with default values' do
+          let(:reference) { Post }
+          let(:options) { {reference: reference} }
+          
+          let(:attribute_definition) do
+            proc do
+              attribute :title
+              attribute :tags, default: ['stuff', 'things']
+            end
+          end
+
+          let(:struct) { Attributor::Struct.construct(attribute_definition, options)}
+          
+          let(:data) { {title: 'my post'} }
+          
+          subject(:loaded)  { struct.load(data) }    
+
+
+          it 'validates' do
+            expect(loaded.validate).to be_empty
+          end
+
+        end
       end
 
     end

data/spec/types/regexp_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe Attributor::Regexp do
+
+  subject(:type) { Attributor::Regexp }
+
+  its(:native_type) { should be(::Regexp) }
+  its(:example) { should be_a(::String) }
+  its(:family) { should == 'string' }
+
+  context '.load' do
+    let(:value) { nil }
+
+    it 'returns nil for nil' do
+      type.load(nil).should be(nil)
+    end
+
+    context 'for incoming String values' do
+
+      { 'foo' => /foo/, '^pattern$' => /^pattern$/ }.each do |value, expected|
+        it "loads '#{value}' as #{expected.inspect}" do
+          type.load(value).should eq(expected)
+        end
+      end
+
+    end
+  end
+end

data/spec/types/uri_spec.rb

@@ -1,12 +1,103 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
 describe Attributor::URI do
 
   subject(:type) { Attributor::URI }
 
   its(:native_type) { should be ::URI::Generic }
 
-  it 'check_option!' do
-    # No options supported thus far
-    expect(type.check_option!(:foo, nil )).to be(:unknown)
+  context '.example' do
+    it 'returns a valid URI' do
+      expect(type.example).to be_kind_of(URI)
+    end
   end
 
+  context '.load' do
+    subject(:load) { type.load(value) }
+
+    context 'given a nil' do
+      let(:value) { nil }
+      it 'returns a nil' do
+        expect(subject).to be_nil
+      end
+    end
+
+    context 'given a string' do
+      let(:value) { 'string' }
+      it 'returns a URI object' do
+        expect(subject).to be_kind_of(URI)
+      end
+    end
+
+    context 'given a URI object' do
+      let(:value) { URI.parse('string') }
+      it 'returns itself' do
+        expect(subject).to eq(value)
+      end
+    end
+
+    context 'given a value not its native_type' do
+      let(:value) { Class.new }
+      it 'raises an error' do
+        expect { subject }.to raise_error(Attributor::CoercionError)
+      end
+    end
+  end
+
+  context '.validate' do
+    let(:uri) { URI.parse('http://www.example.com/something/foo') }
+    let(:attribute) { nil }
+    subject(:validate) { type.validate(uri, ['root'], attribute) }
+
+    context 'when given a valid URI' do
+      it 'does not return any errors' do
+        expect(subject).to be_empty
+      end
+
+      context 'when given a path option' do
+        let(:attribute) { Attributor::Attribute.new(type, path: /^\//) }
+
+        context 'given a URI that matches the path regex' do
+          it 'does not return any errors' do
+            expect(subject).to be_empty
+          end
+        end
+
+        context 'given a URI that does not match the path regex' do
+          let(:uri) { URI.parse('www.example.com/something/foo') }
+          it 'returns an errors array' do
+            expect(subject).to_not be_empty
+          end
+        end
+      end
+    end
+  end
+
+  context '.check_option!' do
+    let(:options) { {} }
+    subject(:attribute) { Attributor::Attribute.new(type, options) }
+
+    context 'for path option' do
+      context 'given a regex definition' do
+        let(:options) { {path: Regexp.new('a-z')} }
+        it 'checks successfully' do
+          expect(subject).to be_kind_of(Attributor::Attribute)
+        end
+      end
+
+      context 'given any definition other than regex' do
+        let(:options) { {path: 1} }
+        it 'raises an exception' do
+          expect { subject }.to raise_error(Attributor::AttributorException)
+        end
+      end
+    end
+
+    context 'for any other option' do
+      let(:options) { {something: 1} }
+      it 'raises an exception' do
+        expect { subject }.to raise_error(Attributor::AttributorException)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +279,7 @@ files:
 - lib/attributor/type.rb
 - lib/attributor/types/bigdecimal.rb
 - lib/attributor/types/boolean.rb
+- lib/attributor/types/class.rb
 - lib/attributor/types/collection.rb
 - lib/attributor/types/container.rb
 - lib/attributor/types/csv.rb
@@ -277,6 +292,7 @@ files:
 - lib/attributor/types/integer.rb
 - lib/attributor/types/model.rb
 - lib/attributor/types/object.rb
+- lib/attributor/types/regexp.rb
 - lib/attributor/types/string.rb
 - lib/attributor/types/struct.rb
 - lib/attributor/types/symbol.rb
@@ -295,6 +311,7 @@ files:
 - spec/type_spec.rb
 - spec/types/bigdecimal_spec.rb
 - spec/types/boolean_spec.rb
+- spec/types/class_spec.rb
 - spec/types/collection_spec.rb
 - spec/types/container_spec.rb
 - spec/types/csv_spec.rb
@@ -306,6 +323,7 @@ files:
 - spec/types/ids_spec.rb
 - spec/types/integer_spec.rb
 - spec/types/model_spec.rb
+- spec/types/regexp_spec.rb
 - spec/types/string_spec.rb
 - spec/types/struct_spec.rb
 - spec/types/tempfile_spec.rb
@@ -347,6 +365,7 @@ test_files:
 - spec/type_spec.rb
 - spec/types/bigdecimal_spec.rb
 - spec/types/boolean_spec.rb
+- spec/types/class_spec.rb
 - spec/types/collection_spec.rb
 - spec/types/container_spec.rb
 - spec/types/csv_spec.rb
@@ -358,6 +377,7 @@ test_files:
 - spec/types/ids_spec.rb
 - spec/types/integer_spec.rb
 - spec/types/model_spec.rb
+- spec/types/regexp_spec.rb
 - spec/types/string_spec.rb
 - spec/types/struct_spec.rb
 - spec/types/tempfile_spec.rb