attributary 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ebdff0c364b0480e2c79d90df50064f2b015400
-  data.tar.gz: cef7eccd653b8c77ea68aa3f08a40ab89787ab63
+  metadata.gz: 521f68ae59d9b4342cf782032031b3b3f89783a9
+  data.tar.gz: 1c90025b9fa2c89e2b3fe840f09a401933fdc6ea
 SHA512:
-  metadata.gz: 0aa7ee051f7a870076ff468b1f6b1a9b4ab91a1342e2e3c5f876c3fb7a024affd4b8a3b279cc933a2a340161444082f9702025a4d6b4e725d3682f747a707e51
-  data.tar.gz: d13c1daefa1c490e0a9fe70ac1dfbb626c477525716013bf1467212688b7c1f72b17821b857fa7679b5c05a730db844da493fa8923464e5556181199ee56a3b3
+  metadata.gz: d8ca0e1373df36cba4a85ab7070afd78bd80f6f28fb8bbd8d58d9185e5c781f68c70fa6cb53708927ccc37a0bfda69bb43d9f35f8dfb755184ab5a8b5c4143cf
+  data.tar.gz: fdacaca03e9e2ffca3de0de4ea09ccc3bbfda882151389ab731b76ebe612c1c8c8ce7a18b6f89ee067898e6e43b5a1773486fb75222a69e5c5c352e222ff2446

data/.rspec_status

@@ -0,0 +1,15 @@
+example_id                                       | status | run_time        |
+------------------------------------------------ | ------ | --------------- |
+./spec/unit/attributary/attribute_spec.rb[1:1:1] | passed | 0.00034 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:1:2] | passed | 0.00008 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:1:3] | passed | 0.00012 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:1:4] | passed | 0.00013 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:2:1] | passed | 0.00009 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:2:2] | passed | 0.00007 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:3:1] | passed | 0.00081 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:3:2] | passed | 0.00012 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:4:1] | passed | 0.0001 seconds  |
+./spec/unit/attributary/attribute_spec.rb[1:4:2] | passed | 0.0001 seconds  |
+./spec/unit/attributary/attribute_spec.rb[1:5:1] | passed | 0.00012 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:6:1] | passed | 0.00011 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:7:1] | passed | 0.0001 seconds  |

data/Gemfile

@@ -1,6 +1,3 @@
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in attributary.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Josh Brody
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -25,6 +25,16 @@ Or install it yourself as:
     Attributary.configure do |c|
       c.dsl_name = :donkey # defaults to :attrubute
       c.strict_mode = false # set this to `true` to skip casting in the writer method (raises TypeError)
+      c.raise_errors = false # set this to true to raise errors when collection/validation fails
+    end
+    
+You can also set this on an object-by-object basis.
+    
+    class Character 
+      include Attributary::DSL
+      attributary do |c|
+        c.raise_errors = true 
+      end
     end
     
 ### Actually using it
@@ -60,6 +70,10 @@ Have to initialize other stuff? Send a hash to attributary_initialize
       include Attributary::Initializer
       include Attributary::DSL
       
+      attributary do |c|
+        c.raise_errors = true 
+      end
+            
       donkey :gender, :symbol, default: :male 
       
       def initialize(name, attributary_attributes = {})
@@ -82,6 +96,10 @@ Simply pass an array of the possible options for the attribute.
     class Character
       include Attributary::DSL
       
+      attributary do |c|
+        c.raise_errors = true 
+      end
+            
       donkey :gender, :symbol, default: :male, collection: [:male, :female]
     end
     
@@ -99,6 +117,10 @@ Pass a proc or a method name.
     class Character
       include Attributary::DSL
       
+      attributary do |c|
+        c.raise_errors = true 
+      end
+      
       donkey :gender, :symbol, default: :male, validates: proc { |value| [:male, :female].include?(value) }
     end
     
@@ -107,7 +129,6 @@ Pass a proc or a method name.
     character.gender = :left # raises CollectionValidationError
     character.gender = 'female' # gets casted correctly, and doesn't raise an error
     
-
 ### Types
 
 Supports some really naive typecasting. [See the supported types](https://github.com/joshmn/attributary/tree/master/lib/attributary/types). Create your own by inheriting from `Attributary::Types` and naming it like `ClassNameType`
@@ -122,6 +143,22 @@ Supports some really naive typecasting. [See the supported types](https://github
       end
     end
 
+## Error handling
+
+If the configuration `raise_errors` is false, the object will have their accessible errors on the `attributary_errors` instance method, which is a hash of `{attribute_name: error object}`
+
+    class Character
+      include Attributary::DSL
+      
+      donkey :gender, :symbol, default: :male, :collection => [:male, :female]
+    end
+    
+    character = Character.new 
+    character.attributary_errors # {}
+    character.gender = :left # raises CollectionValidationError
+    character.gender = 'female' # gets casted correctly, and doesn't raise an error
+    
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joshmn/attributary

data/attributary.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Attributary::VERSION
   spec.authors       = ['Josh Brody']
   spec.email         = ['josh@josh.mn']
+  spec.licenses      = ['MIT']
 
   spec.summary       = 'Like ActiveModel::Attributes but less fluffy and more attribute-y.'
   spec.description   = 'Like `ActiveModel::Attributes` but less fluffy and more attribute-y.'
@@ -18,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.files += Dir['lib/**/*.rb']
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/attributary.rb

@@ -1,9 +1,19 @@
-require_relative 'attributary/config'
-require_relative 'attributary/core_ext'
-require_relative 'attributary/type'
-require_relative 'attributary/initializer'
-require_relative 'attributary/dsl'
-require_relative 'attributary/version'
+require 'attributary/errors'
+require 'attributary/config'
+require 'attributary/core_ext'
+require 'attributary/type'
+require 'attributary/types/array_type'
+require 'attributary/types/big_decimal_type'
+require 'attributary/types/boolean_type'
+require 'attributary/types/float_type'
+require 'attributary/types/hash_type'
+require 'attributary/types/integer_type'
+require 'attributary/types/string_type'
+require 'attributary/types/symbol_type'
+require 'attributary/initializer'
+require 'attributary/serializer'
+require 'attributary/dsl'
+require 'attributary/version'
 
 module Attributary
 end

data/lib/attributary/all.rb

@@ -0,0 +1,7 @@
+module Attributary
+  module All
+    include Attributary::DSL
+    include Attributary::Initializer
+    include Attributary::Serializer
+  end
+end

data/lib/attributary/config.rb

@@ -13,11 +13,17 @@ module Attributary
   end
 
   class Config
-    attr_accessor :dsl_name, :strict_mode
-
+    attr_accessor :validation_error, :collection_error, :strict_mode, :dsl_name, :raise_errors
     def initialize
-      @dsl_name = :attribute
+      @validation_error = ::Attributary::ValidationError
+      @collection_error = ::Attributary::CollectionValidationError
       @strict_mode = false
+      @dsl_name = :attribute
+      @raise_errors = false
+    end
+
+    def raise_errors?
+      @raise_errors
     end
 
     def strict_mode?

data/lib/attributary/dsl.rb

@@ -1,87 +1,28 @@
+require 'attributary/dsl/accessors'
+require 'attributary/dsl/castings'
+require 'attributary/dsl/error'
+require 'attributary/dsl/helpers'
+require 'attributary/dsl/validations'
+
 module Attributary
   module DSL
-    class ValidationError < StandardError; end
-    class CollectionValidationError < StandardError; end
 
     def self.included(base)
       base.extend ClassMethods
+      base.include InstanceMethods
     end
 
-    module ClassMethods
-      def _attributary_attribute_set
-        @_attributary_attribute_set ||= {}
-      end
-
-      def _attributary_attributes
-        hash = {}
-        _attributary_attribute_set.keys.each do |k|
-          hash[k] = instance_variable_get(:"@#{k}")
-        end
-        hash
-      end
-
-      define_method(Attributary.configuration.dsl_name) do |name, type, options = {}|
-        options[:type] = type
-        _attributary_attribute_set[name] = options
-        _attributary_reader(name, type, options)
-        _attributary_writer(name, type, options)
-      end
-
-      def _attributary_reader(name, type, options)
-        define_method(name) do
-          instance_variable_get(:"@#{name}") || if options[:default].is_a?(Proc)
-                                                  options[:default].call
-                                                else
-                                                  options[:default]
-                                                end
-        end
-        if type == :boolean
-          define_method("#{name}?") do
-            send(name.to_s)
-          end
-        end
-      end
-
-      def _attributary_writer(name, type, options)
-        define_method("#{name}=") do |value|
-          value = self.class._attributary_cast_to(type, value) unless Attributary.configuration.strict_mode?
-          self.class._attributary_check_collection(value, options[:collection]) if options[:collection].is_a?(Array)
-          self.class._attributary_validate_attribute(value, options[:validates])
-          instance_variable_set(:"@#{name}", value)
-        end
-      end
-
-      def _attributary_check_collection(value, collection)
-        unless collection.include?(value)
-          raise CollectionValidationError, "Value `#{value}' is not in the collection #{collection}."
-        end
-      end
-
-      def _attributary_validate_attribute(value, validator)
-        return true if validator.nil?
-        raise ValidationError, 'Validator failed.' unless validator.call(value)
-      end
-
-      def _attributary_cast_to(type, value)
-        cast_klass = _attributary_cast_class(type)
-        cast_klass.cast_to(value)
-      end
-
-      def _attributary_cast_class(type)
-        cast_klass_name = _attributary_cast_class_name(type)
-        cast_klass = cast_klass_name.safe_constantize
-        if cast_klass.nil?
-          raise NameError, "#{cast_klass_name} is not a valid type."
-        end
-        unless cast_klass.respond_to?(:cast_to)
-          raise NoMethodError, "#{cast_klass} should have a class-method of cast_to"
-        end
-        cast_klass
+    module InstanceMethods
+      def attributary_errors
+        self.class._attributary_errors
       end
+    end
 
-      def _attributary_cast_class_name(type)
-        "Attributary::Types::#{type.to_s.split('_').map(&:capitalize).join}Type"
-      end
+    module ClassMethods
+      include Accessors
+      include Castings
+      include Helpers
+      include Validations
     end
   end
 end

data/lib/attributary/dsl/accessors.rb

@@ -0,0 +1,45 @@
+module Attributary
+  module DSL
+    module Accessors
+
+      define_method(Attributary.configuration.dsl_name) do |name, type, options = {}|
+        options[:type] = type
+        _attributary_attribute_set[name] = options
+        _attributary_writer(name, type, options)
+        _attributary_reader(name, type, options)
+      end
+
+      def _attributary_writer(name, type, options)
+        define_method("#{name}=") do |value|
+          value = self.class._attributary_cast_to(type, value) unless self.class._attributary_config.strict_mode?
+          write = true
+          write = self.class._attributary_check_collection(name, value, options[:collection]) if options[:collection].is_a?(Array)
+          write = self.class._attributary_validate_attribute(name, value, options[:validate]) if options[:validate].is_a?(Proc)
+          if options[:validate].is_a?(Symbol)
+            unless send(options[:validate])
+              self.class._attributary_handle_error(name, value, :validation)
+            end
+          end
+          instance_variable_set(:"@#{name}", value) if write
+        end
+      end
+
+      def _attributary_reader(name, type, options)
+        define_method(name) do
+          instance_variable_get(:"@#{name}") || self.class._attributary_default_for_method(type, options[:default])
+        end
+        if type == :boolean
+          define_method("#{name}?") do
+            send(name.to_s)
+          end
+        end
+      end
+
+      def _attributary_default_for_method(type, value)
+        return nil if value.nil?
+        _attributary_cast_to(type, value)
+      end
+
+    end
+  end
+end

data/lib/attributary/dsl/castings.rb

@@ -0,0 +1,28 @@
+module Attributary
+  module DSL
+    module Castings
+
+      def _attributary_cast_to(type, value)
+        cast_klass = _attributary_cast_class(type)
+        cast_klass.cast_to(value)
+      end
+
+      def _attributary_cast_class(type)
+        cast_klass_name = _attributary_cast_class_name(type)
+        cast_klass = cast_klass_name.safe_constantize
+        if cast_klass.nil?
+          raise NameError, "#{cast_klass_name} is not a valid type."
+        end
+        unless cast_klass.respond_to?(:cast_to)
+          raise NoMethodError, "#{cast_klass} should have a class-method of cast_to"
+        end
+        cast_klass
+      end
+
+      def _attributary_cast_class_name(type)
+        "Attributary::Types::#{type.to_s.split('_').map(&:capitalize).join}Type"
+      end
+
+    end
+  end
+end

data/lib/attributary/dsl/error.rb

@@ -0,0 +1,13 @@
+module Attributary
+  module DSL
+    class AttributaryError
+      attr_reader :name, :klass, :message
+      def initialize(name, klass, message)
+        @name = name
+        @klass = klass
+        @message = message
+      end
+    end
+
+  end
+end

data/lib/attributary/dsl/helpers.rb

@@ -0,0 +1,38 @@
+module Attributary
+  module DSL
+    module Helpers
+      def attributary(&block)
+        block.call(_attributary_config)
+      end
+
+      def _attributary_config
+        @_attributary_config ||= Attributary::Config.new
+      end
+
+      def _attributary_attribute_set
+        @_attributary_attribute_set ||= {}
+      end
+
+      def _attributary_errors
+        @_attributary_errors ||= {}
+      end
+
+      def attributary_errors
+        _attributary_errors
+      end
+
+      def _attributary_attributes
+        hash = {}
+        _attributary_attribute_set.keys.each do |k|
+          hash[k] = instance_variable_get(:"@#{k}")
+        end
+        hash
+      end
+
+      def _attributary_valid?
+        _attributary_errors.empty?
+      end
+
+    end
+  end
+end

data/lib/attributary/dsl/validations.rb

@@ -0,0 +1,42 @@
+module Attributary
+  module DSL
+    module Validations
+
+      def _attributary_handle_error(attribute, value, type, options = {})
+        message = options[:message] || "#{attribute} value #{value} is invalid."
+        error = _attributary_config.send("#{type}_error")
+        if error.is_a?(Proc)
+          error = error.call(attribute, value)
+        end
+        if quiet_errors?
+          _add_attributary_error(attribute, error.class, message)
+          return
+        end
+        raise error, message
+      end
+
+      def _attributary_check_collection(attribute, value, collection)
+        unless collection.include?(value)
+          _attributary_handle_error(attribute, value, :collection, :message => "Attribute #{attribute} `#{value}' is not in the collection #{collection}")
+          false
+        end
+      end
+
+      def _attributary_validate_attribute(attribute, value, validator)
+        return true if validator.nil?
+        unless validator.call(value)
+          _attributary_handle_error(attribute, value, :validation)
+          false
+        end
+      end
+
+      def _add_attributary_error(name, klass, message)
+        self._attributary_errors[name] = AttributaryError.new(name, klass, message)
+      end
+
+      def quiet_errors?
+        !_attributary_config.raise_errors?
+      end
+    end
+  end
+end

data/lib/attributary/errors.rb

@@ -0,0 +1,4 @@
+module Attributary
+  class ValidationError < StandardError; end
+  class CollectionValidationError < StandardError; end
+end

data/lib/attributary/initializer.rb

@@ -6,7 +6,7 @@ module Attributary
 
     def attributary_initialize(options = {})
       options.each do |k, v|
-        send("#{k}=", v) if attribute_set[k]
+        send("#{k}=", v) if self.class._attributary_attribute_set[k]
       end
     end
   end

data/lib/attributary/serializer.rb

@@ -0,0 +1,21 @@
+module Attributary
+  module Serializer
+    def self.included(base)
+      base.include InstanceMethods
+    end
+
+    module InstanceMethods
+      def read_attribute_for_serialization(attribute_name)
+        send(attribute_name)
+      end
+
+      def as_json
+        hash = {}
+        self.class._attributary_attribute_set.keys.each do |key|
+          hash[key] = read_attribute_for_serialization(key)
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/attributary/type.rb

@@ -7,12 +7,3 @@ module Attributary
     end
   end
 end
-
-require_relative 'types/array_type'
-require_relative 'types/big_decimal_type'
-require_relative 'types/boolean_type'
-require_relative 'types/float_type'
-require_relative 'types/hash_type'
-require_relative 'types/integer_type'
-require_relative 'types/string_type'
-require_relative 'types/symbol_type'

data/lib/attributary/version.rb

@@ -1,3 +1,3 @@
 module Attributary
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Like `ActiveModel::Attributes` but less fluffy and more attribute-y.
 email:
 - josh@josh.mn
@@ -46,7 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec_status"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - attributary.gemspec
@@ -55,10 +85,18 @@ files:
 - lib/.DS_Store
 - lib/attributary.rb
 - lib/attributary/.DS_Store
+- lib/attributary/all.rb
 - lib/attributary/config.rb
 - lib/attributary/core_ext.rb
 - lib/attributary/dsl.rb
+- lib/attributary/dsl/accessors.rb
+- lib/attributary/dsl/castings.rb
+- lib/attributary/dsl/error.rb
+- lib/attributary/dsl/helpers.rb
+- lib/attributary/dsl/validations.rb
+- lib/attributary/errors.rb
 - lib/attributary/initializer.rb
+- lib/attributary/serializer.rb
 - lib/attributary/type.rb
 - lib/attributary/types/array_type.rb
 - lib/attributary/types/big_decimal_type.rb
@@ -70,7 +108,8 @@ files:
 - lib/attributary/types/symbol_type.rb
 - lib/attributary/version.rb
 homepage: https://github.com/joshmn/attributary
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []