attributary 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 521f68ae59d9b4342cf782032031b3b3f89783a9
-  data.tar.gz: 1c90025b9fa2c89e2b3fe840f09a401933fdc6ea
+  metadata.gz: 1190641b6ffb55723ee8b6dd0f609d118401ce65
+  data.tar.gz: 457ed2b996317eadcc8fb6f69a0b3afa6f39621b
 SHA512:
-  metadata.gz: d8ca0e1373df36cba4a85ab7070afd78bd80f6f28fb8bbd8d58d9185e5c781f68c70fa6cb53708927ccc37a0bfda69bb43d9f35f8dfb755184ab5a8b5c4143cf
-  data.tar.gz: fdacaca03e9e2ffca3de0de4ea09ccc3bbfda882151389ab731b76ebe612c1c8c8ce7a18b6f89ee067898e6e43b5a1773486fb75222a69e5c5c352e222ff2446
+  metadata.gz: 43e610ac006d26a6f4925fd73d7fea45bcfaf3a4ed07f268e6656f3be91206515bc27d0cf750e2bbdd229674fa71b602dab30909a64c152d14be1fada0829929
+  data.tar.gz: 5e7a9183f0184160c99ff4762ae2a95161339308a866735f8f7581e17a8141c65d3eb64618d1ad3f0800984ea9b9cd3224f445427a5e3e49464aa6edf2ef1a5b

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.rspec_status

@@ -1,15 +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:1:1] | passed | 0.00045 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:1:2] | passed | 0.00012 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:1:3] | passed | 0.00016 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:1:4] | passed | 0.0001 seconds  |
+./spec/unit/attributary/attribute_spec.rb[1:2:1] | passed | 0.00012 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:2:2] | passed | 0.0001 seconds  |
+./spec/unit/attributary/attribute_spec.rb[1:3:1] | passed | 0.00103 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  |
+./spec/unit/attributary/attribute_spec.rb[1:4:1] | passed | 0.00014 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:4:2] | passed | 0.00013 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:5:1] | passed | 0.00015 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:6:1] | passed | 0.00013 seconds |
+./spec/unit/attributary/attribute_spec.rb[1:7:1] | passed | 1.03 seconds    |

data/README.md

@@ -1,6 +1,6 @@
 # Attributary
 
-Like `ActiveModel::Attributes` but not. No dependencies.
+Like `ActiveModel::Attributes` or `Virtus` but not. No dependencies.
 
 ## Installation
 
@@ -20,144 +20,38 @@ Or install it yourself as:
 
 ## Usage
 
-### Configuration
-
-    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
-
-    class Character
-      include Attributary::DSL
-      
-      donkey :gender, :symbol, default: :male 
-    end
-     
-    character = Character.new
-    puts character.gender # :male 
-    character.gender = 'female'
-    puts character.gender # :female
-
-### Initializing
-
-Want to initialize? Cool.
-
-    class Character
-      include Attributary::Initializer
-      include Attributary::DSL
-      
-      donkey :gender, :symbol, default: :male 
-    end
-    
-    character = Character.new(gender: :male)
-    puts character.gender # :male 
-    
-Have to initialize other stuff? Send a hash to attributary_initialize
-
-    class Character
-      include Attributary::Initializer
-      include Attributary::DSL
-      
-      attributary do |c|
-        c.raise_errors = true 
-      end
-            
-      donkey :gender, :symbol, default: :male 
-      
-      def initialize(name, attributary_attributes = {})
-        @name = name 
-        attributary_initialize(attributary_attributes)
-      end  
-    end
-    
-    character = Character.new("Charlie", gender: :male)
-    puts character.gender # :male 
-
-### Validations
-
-There are two types of validations. You can pass a `:collection` option, and/or you can pass a `:validates` option.
-
-#### Using `:collection`
-
-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
-    
-    character = Character.new("Charlie", gender: :male)
-    puts character.gender # :male 
-    character.gender = :left # raises CollectionValidationError
-    character.gender = :female 
-    puts character.gender # :female 
-    character.gender = 'male' # gets casted correctly, and doesn't raise an error. Turn this off with strict_mode
-    
-#### Using `:validates`
-
-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
-    
-    character = Character.new("Charlie", gender: :male)
-    puts character.gender # :male 
-    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`
-
-    module Attributary
-      module Types
-        class FriendType < Type
-          def self.cast_to(value)
-            Foe.new(value)
-          end
-        end
-      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}`
+```Ruby 
+class Character
+  include Attributary::DSL
+  include Attributary::Initializer
+  
+  attribute :age, :integer
+  attribute :description, :string, :validate => :check_description
+  attribute :gender, :string, :collection => ['male', 'female', 'other']
+  
+  # if you don't need to initialize anything yourself, you can omit this
+  def initialize(name, options = {})
+    @name = name 
+    attributary_attributes(options)
+  end
+  
+  private
+  
+  def check_description
+    description.length <= 1024
+  end
+end
+
+character = Character.new("Tommy", :age => 16, :description => "Hi I am Tommy", :gender => 'male')
+character.age # 16
+character.description # Hi I am Tommy
+character.gender # male 
+
+character.age = 18
+character.age # 18
+```
 
-    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
-    
+Lots more info on the [Wiki](https://github.com/joshmn/attributary/wiki)
 
 ## Contributing
 

data/lib/attributary.rb

@@ -2,14 +2,6 @@ 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'

data/lib/attributary/dsl/accessors.rb

@@ -18,9 +18,13 @@ module Attributary
           if options[:validate].is_a?(Symbol)
             unless send(options[:validate])
               self.class._attributary_handle_error(name, value, :validation)
+              write = false
             end
           end
-          instance_variable_set(:"@#{name}", value) if write
+          if write
+            instance_variable_set(:"@#{name}", value)
+            self.class._attributary_errors.delete(name)
+          end
         end
       end
 

data/lib/attributary/dsl/validations.rb

@@ -18,8 +18,9 @@ module Attributary
       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
+          return false
         end
+        true
       end
 
       def _attributary_validate_attribute(attribute, value, validator)
@@ -28,6 +29,7 @@ module Attributary
           _attributary_handle_error(attribute, value, :validation)
           false
         end
+        true
       end
 
       def _add_attributary_error(name, klass, message)

data/lib/attributary/type.rb

@@ -7,3 +7,12 @@ module Attributary
     end
   end
 end
+
+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'

data/lib/attributary/types/fixnum_type.rb

@@ -0,0 +1,9 @@
+module Attributary
+  module Types
+    class FixnumType < IntegerType
+      def self.cast_to(value)
+        value.to_f
+      end
+    end
+  end
+end

data/lib/attributary/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributary
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Josh Brody
@@ -101,6 +101,7 @@ files:
 - lib/attributary/types/array_type.rb
 - lib/attributary/types/big_decimal_type.rb
 - lib/attributary/types/boolean_type.rb
+- lib/attributary/types/fixnum_type.rb
 - lib/attributary/types/float_type.rb
 - lib/attributary/types/hash_type.rb
 - lib/attributary/types/integer_type.rb