attributor 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcf6ceb7deb1d4db6a3370de07f1af676c4ffd27
-  data.tar.gz: 28e0d3d5091ab8c1663275ae4f5c2c46927cd186
+  metadata.gz: 28036c8d33153157e7118cae29dd5d0736248cb2
+  data.tar.gz: ea81f5e962a1f8f63f34dad0e41e4bd1899aebb2
 SHA512:
-  metadata.gz: 322a5d22a2b1fcc8166c011b88fb09f4367f585e1c1fab94ef457a3132c2e0427b1a1cdf1aaeae67d5c653c813d4a11212f8f2be77250cab15e1bed711981cf4
-  data.tar.gz: 83e5bee88b8119a4af387a767ba8a64580cbc79feb72cd7fe3870be707c2a7fb9d78a91ddcc0227a6b05c549980851b5a863b05c47862c312e9cd35b9fb1b075
+  metadata.gz: dacc030e86045803473c59ad89fce1d3ae1e7dd12fab67d42dbcde02e23477861e4cd45b0fdd3fd0d9628daec92b57d812d55f3ed2b60d10f86a2372446ff8c3
+  data.tar.gz: 27c876734a439ff0df35a2970dbd57b90821b16ab9710d99391b2948be0052ffb91d18b2730d99fbbb827739ad742aaedffa2c66b5a388de12b90e9e84ec58b5

data/CHANGELOG.md

@@ -1,14 +1,28 @@
 # Attributor Changelog
 
-## next 
-
+## next
+
+## 4.1.0
+
+* Added a `Class` type (useful to avoid demodulization coercions etc...)
+* Added `Attributor::FieldSelector` type for parsing hierarchical field
+  selection hashes from a string. This is similar to the partial `fields`
+  parameter in Google APIs, or the `fields` parameter in the Facebook's Graph
+  API.
+    * For example: the string `'one,two(a,b)'` would select two top-level fields
+      named 'one' and 'two', retrieving the entire contents of 'one', and only
+      the 'a' and 'b' sub-fields for 'two'. The type will parse the above string
+      into the hash: `{one: true, two: {a: true, b: true}}`.
+    * This type is not automatically required by Attributor. To require it use:
+      `require 'attributor/extras/field_selector'.
+    * This type also depends upon the 'parslet' gem.
 
 ## 4.0.1
 
 * `Attribute#check_option!` now calls `load` on any provided value.
 
 
-## 4.0.0 next
+## 4.0.0
 
 * Changed the expectation of the value for an `:example` option of an attribute:
   * Before, passing an array of values would indicate that those were a few possible examples for it.
@@ -154,4 +168,3 @@
   * procs that take 2 arguments now receive the context as the second argument.
 * Circular references are now detected and handled in validation and dumping.
 * Fixed bug with Model attribute accessors when using false values.
-

data/README.md

@@ -1,7 +1,11 @@
-# Attributor [![TravisCI][travis-img-url]][travis-ci-url] 
+# Attributor [![TravisCI][travis-img-url]][travis-ci-url] [![Coverage Status][coveralls-img-url]][coveralls-url] [![Dependency Status][gemnasium-img-url]][gemnasium-url]
 
 [travis-img-url]: https://travis-ci.org/rightscale/attributor.svg?branch=master
 [travis-ci-url]:https://travis-ci.org/rightscale/attributor
+[coveralls-img-url]:https://coveralls.io/repos/rightscale/attributor/badge.svg?branch=master&service=github
+[coveralls-url]:https://coveralls.io/github/rightscale/attributor?branch=master
+[gemnasium-img-url]:https://gemnasium.com/rightscale/attributor.svg
+[gemnasium-url]:https://gemnasium.com/rightscale/attributor
 
 An Attribute management, self documenting framework, designed for getting rid of most of your parameter handling boilerplate.
 While initially designed to be the backbone for parameter handling in REST services, attribute management can be applied in many other areas.

data/attributor.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   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"])
@@ -29,12 +30,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency(%q<redcarpet>, ["< 3.0"])
   spec.add_development_dependency(%q<bundler>, [">= 0"])
   spec.add_development_dependency(%q<rake-notes>, ["~> 0"])
-  spec.add_development_dependency(%q<simplecov>, ["~> 0"])
+  spec.add_development_dependency(%q<coveralls>)
   spec.add_development_dependency(%q<guard>, ["~> 2"])
   spec.add_development_dependency(%q<guard-rspec>, ["~> 4"])
   spec.add_development_dependency(%q<pry>, ["~> 0"])
   spec.add_development_dependency(%q<pry-byebug>, ["~> 1"])
   spec.add_development_dependency(%q<pry-stack_explorer>, ["~> 0"])
   spec.add_development_dependency(%q<fuubar>, ["~> 1"])
-end
 
+  spec.add_development_dependency(%q<parslet>, [">= 0"])
+end

data/lib/attributor/extras/field_selector.rb

@@ -0,0 +1,44 @@
+begin
+  require 'parslet'
+rescue LoadError
+  warn "Attributor::FieldSelector requires the 'parslet' gem, which can not be found. " +
+    "Please make sure it's in your Gemfile or installed in your system."
+end
+
+module Attributor
+  class FieldSelector
+    require 'attributor/extras/field_selector/parser'
+    require 'attributor/extras/field_selector/transformer'
+
+    include Attributor::Type
+
+    def self.native_type
+      ::Hash
+    end
+
+    def self.example(_context = nil, _options = {})
+      3.times.each_with_object([]) do |_i, array|
+        array << /\w{5,8}/.gen
+      end.join(',')
+    end
+
+    def self.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
+      return nil if value.nil?
+      return value if self.valid_type? value
+      return {} if value.empty?
+
+      parsed = Parser.new.parse(value)
+      Transformer.new.apply(parsed)
+    rescue
+      raise CoercionError, context: context, from: value.class, to: self, value: value
+    end
+
+    def self.validate(_value, _context = nil, _attribute)
+      [].freeze
+    end
+
+    def self.valid_type?(value)
+      return true if value.is_a?(native_type) || value.is_a?(self.class)
+    end
+  end
+end

data/lib/attributor/extras/field_selector/parser.rb

@@ -0,0 +1,11 @@
+module Attributor
+  class FieldSelector
+    class Parser < Parslet::Parser
+      rule(:simple_name) { match('[a-zA-Z0-9_]').repeat(1) }
+      rule(:item) { simple_name.as(:field) >> parenthesized.repeat(0).as(:children) }
+      rule(:parenthesized) { str('(') >> csv >> str(')') }
+      rule(:csv) { (item >> (str(',') >> item).repeat(0)).as(:csv) }
+      root(:csv)
+    end
+  end
+end

data/lib/attributor/extras/field_selector/transformer.rb

@@ -0,0 +1,30 @@
+module Attributor
+  class FieldSelector
+    class Transformer < Parslet::Transform
+
+      rule(field: simple(:field_token), children: subtree(:children_tree)) do
+        cs = if children_tree.empty?
+          true
+        else
+          children_tree.each_with_object({}) do |item, hash|
+            hash.merge! item
+          end
+        end
+        { field_token.to_sym => cs }
+      end
+
+      rule(csv: subtree(:csv_tree)) do
+        case csv_tree
+        when ::Hash
+          csv_tree
+        when Array
+          csv_tree.each_with_object({}) do |item, hash|
+            hash.merge! item
+          end
+        else
+          raise "Oops...didn't know this could happen! (this is not a Hash or an Array?). Got a #{csv_tree.class.name} : #{csv_tree.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/attributor/type.rb

@@ -4,11 +4,10 @@ module Attributor
   # TODO: should this be a mixin since it is an abstract class?
   module Type
 
-    def self.included( klass )
+    def self.included(klass)
       klass.extend(ClassMethods)
     end
 
-
     module ClassMethods
 
       # Does this type support the generation of subtypes?
@@ -58,13 +57,6 @@ module Attributor
       # Default, overridable example function
       def example(context=nil, options:{})
         raise AttributorException.new("#{self} must implement #example")
-        # return options[:example] if options.has_key? :example
-        # return options[:default] if options.has_key? :default
-        # if options.has_key? :values
-        #   vals = options[:values]
-        #   return vals[rand(vals.size)]
-        # end
-        # return  nil
       end
 
 

data/lib/attributor/types/class.rb

@@ -12,6 +12,7 @@ module Attributor
     end
 
     def self.load(value, context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+      return value if value.is_a?(self.native_type)
       return @klass || nil if value.nil?
 
       # Must be given a String object or nil

data/lib/attributor/types/hash.rb

@@ -388,11 +388,11 @@ module Attributor
         hash.set(self.extra_keys, v, context: sub_context, recurse: recurse)
       end
 
-      object.each do |k,v|
+      object.each do |k,val|
         next if k == self.extra_keys
 
         sub_context = self.generate_subcontext(context,k)
-        hash.set(k, v, context: sub_context, recurse: recurse)
+        hash.set(k, val, context: sub_context, recurse: recurse)
       end
 
       # handle default values for missing keys
@@ -447,6 +447,10 @@ module Attributor
       @contents[k]
     end
 
+    def _get_attr(k)
+      self[k]
+    end
+
     def []=(k,v)
       @contents[k] = v
     end

data/lib/attributor/types/string.rb

@@ -18,8 +18,12 @@ module Attributor
 
     def self.example(context=nil, options:{})
       if options[:regexp]
-        # It may fail to generate an example, see bug #72.
-        options[:regexp].gen rescue ('Failed to generate example for %s' % options[:regexp].inspect)
+        begin
+          # It may fail to generate an example, see bug #72.
+          options[:regexp].gen
+        rescue => e
+          'Failed to generate example for %s : %s' % [ options[:regexp].inspect, e.message]
+        end
       else
         /\w+/.gen
       end

data/lib/attributor/types/struct.rb

@@ -45,7 +45,7 @@ module Attributor
 
     # Two structs are equal if their attributes are equal
     def ==(other_object)
-      return false if other_object == nil
+      return false if other_object == nil || !other_object.respond_to?(:attributes)
       self.attributes == other_object.attributes
     end
 

data/lib/attributor/types/uri.rb

@@ -38,6 +38,10 @@ module Attributor
       end
     end
 
+    def self.dump(value, **opts)
+      value.to_s
+    end
+
     def self.validate(value,context=Attributor::DEFAULT_ROOT_CONTEXT,attribute)
       errors = []
 

data/lib/attributor/version.rb

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

data/spec/extras/field_selector/field_selector_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'attributor/extras/field_selector'
+
+describe Attributor::FieldSelector do
+  subject(:type) { Attributor::FieldSelector }
+
+  it 'loads a Hash' do
+    expect(subject.load('one,two')).to be_kind_of(::Hash)
+  end
+
+  context 'loading all the test combinations' do
+    cases = {
+      nil => nil,
+      '' => {},
+      'one' => { one: true },
+      'one,two,three' => { one: true, two: true, three: true },
+      'one,two(a,b),three' => { one: true, two: { a: true, b: true }, three: true },
+      'one,two(a,b,c(A,B)),three' => {
+        one: true,
+        two: {
+          a: true,
+          b: true,
+          c: { A: true, B: true }
+        },
+        three: true
+      }
+    }
+    
+    cases.each do |fields, result|
+      it "loads #{fields.inspect}" do
+        loaded = subject.load(fields)
+        loaded.should eq result
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,8 +4,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 # Configure simplecov gem (must be here at top of file)
-require 'simplecov'
-SimpleCov.start do
+require 'coveralls'
+Coveralls.wear! do
   add_filter 'spec' # Don't include RSpec stuff
   add_group 'Types', 'lib/attributor/types'
 end

data/spec/types/class_spec.rb

@@ -30,6 +30,14 @@ describe Attributor::Class do
       end
     end
 
+    context 'for incoming Class values' do
+      [Object, ::Object, ::Hash, Attributor::Struct].each do |value|
+        it "loads '#{value}' as #{value}" do
+          type.load(value).should eq(value)
+        end
+      end
+    end
+
     context 'when created using .of method' do
       let(:klass) { Integer }
       subject(:type) { Attributor::Class.of(klass) }

data/spec/types/string_spec.rb

@@ -24,6 +24,7 @@ describe Attributor::String do
       expect {
         val = Attributor::String.example(options:{regexp: regex})
         val.should be_a(::String)
+        val.should =~ /Failed to generate.+is too vague/
       }.to_not raise_error
     end
 

data/spec/types/uri_spec.rb

@@ -12,6 +12,12 @@ describe Attributor::URI do
     end
   end
 
+  context '.dump' do
+    let(:example){ type.example }
+    it 'uses the underlying URI to_s' do
+      expect(type.dump(example)).to eq(example.to_s)
+    end
+  end
   context '.load' do
     subject(:load) { type.load(value) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -152,17 +152,17 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -249,6 +249,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - blanquer@gmail.com
@@ -274,6 +288,9 @@ files:
 - lib/attributor/example_mixin.rb
 - lib/attributor/exceptions.rb
 - lib/attributor/extensions/randexp.rb
+- lib/attributor/extras/field_selector.rb
+- lib/attributor/extras/field_selector/parser.rb
+- lib/attributor/extras/field_selector/transformer.rb
 - lib/attributor/families/numeric.rb
 - lib/attributor/families/temporal.rb
 - lib/attributor/type.rb
@@ -304,6 +321,7 @@ files:
 - spec/attribute_spec.rb
 - spec/attributor_spec.rb
 - spec/dsl_compiler_spec.rb
+- spec/extras/field_selector/field_selector_spec.rb
 - spec/families_spec.rb
 - spec/spec_helper.rb
 - spec/support/hashes.rb
@@ -349,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A powerful attribute and type management library for Ruby
@@ -358,6 +376,7 @@ test_files:
 - spec/attribute_spec.rb
 - spec/attributor_spec.rb
 - spec/dsl_compiler_spec.rb
+- spec/extras/field_selector/field_selector_spec.rb
 - spec/families_spec.rb
 - spec/spec_helper.rb
 - spec/support/hashes.rb