eapi 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8a6da6f094409d07aa648318c1134b587bee426
-  data.tar.gz: c9d3e9715481dc3d1be43324fef7f81e860f3f06
+  metadata.gz: 24226b6df180842850c926be63af60c33803e6e0
+  data.tar.gz: 1764202eb7a457a16bde2590b25909af05d4d17b
 SHA512:
-  metadata.gz: 46a2d8ccee0b0ccd1ca44756b6e7b5a7ed89801c0fd0192fa58367b4a55136df17689dcf13b59f4311bbe76b168e1f3ae84c80092d976467ae249cbb9ca7a5fe
-  data.tar.gz: 6e53f3f52a55fb714fbf48763f075afbb2bee60c77a40f72ed72b73cae1bab78025879b997362bf8b5036d1f15d5a4d5f7613955e32bf6b32a1f2a9657157a0b
+  metadata.gz: abef4e5a06756f1f32db42e60e0358451d524620ea0d7dc21af6f4929da5eea21f86a74a9930142164b219ba68ecb362cefe6f7115baffda67ba93a2477d7ec2
+  data.tar.gz: d67597321bb8c496167825f17b558c2e0e6e02b2bd75064eee1a7126146d2ffa0ecdb42742f5f912c19cce4ee45c5ef43e6d81158a5081dfbda353bab9960a09

data/.travis.yml

@@ -8,7 +8,6 @@ addons:
 
 rvm:
   - 2.1.1
-  - 2.0.0
 
 script: 'bundle exec rake spec'
 
@@ -17,4 +16,4 @@ notifications:
     recipients:
       - eturino@eturino.com
     on_failure: change
-    on_success: never
+    on_success: never

data/README.md

@@ -25,14 +25,15 @@ Or install it yourself as:
 
 ### Ruby version
 
-Works with ruby 2. Tested with MRI 2.1.1 and 2.0.0 
+Works with ruby 2.1, tested with MRI 2.1.1 
 
 ### Gem dependencies
 
-This gem uses ActiveSupport (version 4) and also the ActiveModel Validations (version 4)
+This gem uses ActiveSupport (version 4) and also the ActiveModel Validations (version 4). It also uses fluent_accessors gem.
 
 Extracted from the gemspec:
 ```
+spec.add_dependency 'fluent_accessors', '~> 1'
 spec.add_dependency 'activesupport', '~> 4'
 spec.add_dependency 'activemodel', '~> 4'
 ```
@@ -41,11 +42,11 @@ spec.add_dependency 'activemodel', '~> 4'
 
 ### including EAPI into your class
 
-Just include the module `Eapi::Common` into your class.
+Just include the module `Eapi::Item` into your class.
 
 ```ruby    
 class MyTestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something
 end
@@ -59,7 +60,7 @@ For now any unrecognised property in the hash will be ignored. This may change i
 
 ```ruby    
 class MyTestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something
 end
@@ -78,14 +79,14 @@ To show this feature and all the combinations for method names, we'll use the 2
 
 ```ruby
 class MyTestKlassOutside
-  include Eapi::Common
+  include Eapi::Item
 
   property :something
 end
 
 module Somewhere
   class TestKlassInModule
-    include Eapi::Common
+    include Eapi::Item
 
     property :something
   end
@@ -116,7 +117,7 @@ We define properties in our class with the instruction `property` as shown:
 
 ```ruby
 class MyTestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :one
   property :two
@@ -169,13 +170,15 @@ x.one # => :fluent
 res.equal? x # => true
 ```
 
-### Convert to hashes: `to_h` and `create_hash`
+### Convert to hashes: `render`, `to_h` and `create_hash`
 
-All Eapi classes respond to `to_h` and return a hash, as it is the main purpose of this gem. It will execute any validation (see property definition), and if everything is ok, it will convert it to a simple hash structure.
+All Eapi classes respond to `render` and return a hash (for `Item` classes) or an array (for `List` classes), as it is the main purpose of this gem. It will execute any validation (see property definition), and if everything is ok, it will convert it to a simple hash structure.
+
+`Item` classes will invoke `render` when receiving `to_h`, while `List` classes will do the same when receiving `to_a`
  
 #### Methods involved
 
-Inside, `to_h` will call `valid?`, raise an error of type `Eapi::Errors::InvalidElementError` if something is not right, and if everything is ok it will call `create_hash`.
+Inside, `render` will call `valid?`, raise an error of type `Eapi::Errors::InvalidElementError` if something is not right, and if everything is ok it will call `create_hash`.
 
 The `create_hash` method will create a hash with the properties as keys. Each value will be "converted".
 
@@ -203,13 +206,13 @@ class ComplexValue
 end
 
 class ExampleEapi
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, required: true
   property :other
 end
 
-# TESTING `to_h`
+# TESTING `render`
 
 list = Set.new [
                  OpenStruct.new(a: 1, 'b' => 2),
@@ -218,7 +221,9 @@ list = Set.new [
                ]
 
 eapi = ExampleEapi.new something: list, other: ComplexValue.new
-eapi.to_h # => 
+
+# same as eapi.to_h
+eapi.render # => 
 # {
 #   something: [
 #                {a: 1, b: 2},
@@ -249,7 +254,7 @@ example:
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, required: true
 end
@@ -268,7 +273,7 @@ example:
  
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, type: Hash
 end
@@ -283,7 +288,7 @@ Also, if a type is specified, then a `init_property_name` method is created that
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, type: Hash
 end
@@ -298,7 +303,7 @@ A symbol or a string can also be specified as class name in `type` option, and i
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, type: "Hash"
 end
@@ -319,7 +324,7 @@ example:
  
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, validate_with: ->(record, attr, value) do
     record.errors.add(attr, "must pass my custom validation") unless value == :valid_val
@@ -338,7 +343,7 @@ All other ActiveModel::Validations can be used:
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something
   validates :something, numericality: true
@@ -360,7 +365,7 @@ You can see (but not edit) the definition of a property calling the `definition_
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, type: Hash, unrecognised_option: 1
 end
@@ -384,7 +389,7 @@ A property marked as `multiple` will be initialised with an empty array. If no t
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, multiple: true
 end
@@ -398,7 +403,7 @@ If the property is `nil` when `add_property_name` is called, then it will call `
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, multiple: true
 end
@@ -431,7 +436,7 @@ class MyCustomList
 end
 
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :p1, multiple: true
   property :p2, type: Array
@@ -453,7 +458,7 @@ We can also specify `validate_element_with` option, and it will act the same as
 
 ```ruby
 class TestKlass
-  include Eapi::Common
+  include Eapi::Item
 
   property :something, multiple: true, element_type: Hash
   property :other, multiple: true, validate_element_with: ->(record, attr, value) do
@@ -480,6 +485,60 @@ eapi.other [:valid_val]
 eapi.valid? # => true
 ```
 
+### `List` classes
+
+An Eapi `List` is to an Array as an Eapi `Item` is to a Hash. 
+
+It will render itself into an array of elements. It can store a list of elements that will be validated and rendered.
+
+It works using an internal list of elements, to whom it delegates most of the behaviour. Its interface is compatible with an Array, including ActiveSupport methods. 
+
+#### accessor to internal element list: `_list`
+
+The internal list of elements of an Eapi `List` object can be accessed using the `_list` method, that is always an `Array`.
+ 
+#### fluent adder: `add`
+
+Similar to the `set_x` methods for properties, this method will add an element to the internal list and return `self`. 
+
+#### elements definition: `elements`
+
+Similar to the `property` macro to define a property and its requirements, `List` classes can set the definition to be used for its elements using the macro `elements`.
+
+The options for that definition is:
+
+* `required`: it will provoke the list validation to fail if there is at least 1 element in the list
+* `unique`: it will provoke the list validation to fail if there are duplicated elements in the list
+* `element_type` or `type`: it will provoke the list validation to fail if an element does not complies with the given type validation (see type validation on `Item`)
+* `validate_element_with` or `validate_with`: it will execute the given callable object to validate each element, similar to the `validate_element_with` option in the property definition.
+
+#### example
+
+```ruby
+class MyListKlass
+  include Eapi::List
+  
+  elements unique: true
+end
+
+l = MyListKlass.new
+
+# fluent adder
+l.add(1).add(2).add(3)
+
+# internal list accessor 
+l._list # => [1, 2, 3]
+
+# render method (same as #to_a)
+l.render # => [1, 2, 3]
+
+l.valid? # => true
+
+l.add(1) 
+
+l.valid? # => false
+```
+
 ### Pose as other types
 
 An Eapi class can poses as other types, for purposes of `type` checking in a property definition. We use the class method `is` for this.
@@ -492,7 +551,7 @@ example:
 
 ```ruby
 class SuperTestKlass
-  include Eapi::Common
+  include Eapi::Item
 end
  
 class TestKlass < SuperTestKlass

data/eapi.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-stack_explorer"
   spec.add_development_dependency "pry-doc"
 
+  spec.add_dependency 'fluent_accessors', '~> 1'
   spec.add_dependency 'activesupport', '~> 4'
   spec.add_dependency 'activemodel', '~> 4'
 end

data/lib/eapi.rb

@@ -1,15 +1,18 @@
+require 'fluent_accessors'
 require 'active_support/all'
 require 'active_model'
 
 require 'eapi/version'
 require 'eapi/errors'
 require 'eapi/children'
-require 'eapi/multiple'
-require 'eapi/definition_runner'
+require 'eapi/multiple_value'
+require 'eapi/definition_runners'
 require 'eapi/type_checker'
 require 'eapi/methods'
 require 'eapi/value_converter'
 require 'eapi/common'
+require 'eapi/item'
+require 'eapi/list'
 
 
 module Eapi
@@ -29,6 +32,8 @@ module Eapi
   def self.extended(mod)
     mod.class_eval <<-CODE
       Common = Eapi::Common
+      Item = Eapi::Item
+      List = Eapi::List
       Children = Eapi::Children
     CODE
     Eapi.add_method_missing mod

data/lib/eapi/common.rb

@@ -3,46 +3,29 @@ module Eapi
     def self.add_features(klass)
       Eapi::Children.append klass
       klass.send :include, ActiveModel::Validations
+      klass.send :include, Eapi::Common::Basic
       klass.send :include, Eapi::Methods::Properties::InstanceMethods
       klass.send :include, Eapi::Methods::Types::InstanceMethods
 
       klass.send :extend, ClassMethods
     end
 
-    def self.extended(mod)
-      def mod.included(klass)
-        Eapi::Common.add_features klass
+    module Basic
+      def initialize(** properties)
+        properties.each do |k, v|
+          normal_setter = Eapi::Methods::Names.setter k
+          #TODO: what to do with unrecognised properties
+          send normal_setter, v if respond_to? normal_setter
+        end
       end
-    end
-
-    def self.included(klass)
-      Eapi::Common.add_features klass
-    end
 
-    def initialize(** properties)
-      properties.each do |k, v|
-        normal_setter = Eapi::Methods::Names.setter k
-        #TODO: what to do with unrecognised properties
-        send normal_setter, v if respond_to? normal_setter
-      end
-    end
-
-    def to_h
-      raise Eapi::Errors::InvalidElementError, "errors: #{errors.full_messages}, self: #{self.inspect}" unless valid?
-
-      create_hash
-    end
-
-    def create_hash
-      {}.tap do |hash|
-        self.class.properties.each do |prop|
-          val        = Eapi::ValueConverter.convert_value(get(prop))
-          hash[prop] = val unless val.nil?
-        end
+      def validate!
+        raise Eapi::Errors::InvalidElementError, "errors: #{errors.full_messages}, self: #{self.inspect}" unless valid?
       end
     end
 
     module ClassMethods
+      include FluentAccessors
       include Eapi::Methods::Accessor
       include Eapi::Methods::Types::ClassMethods
       include Eapi::Methods::Properties::ClassMethods

data/lib/eapi/definition_runners.rb

@@ -0,0 +1,3 @@
+require 'eapi/definition_runners/runner'
+require 'eapi/definition_runners/property'
+require 'eapi/definition_runners/list'

data/lib/eapi/definition_runners/list.rb

@@ -0,0 +1,60 @@
+module Eapi
+  module DefinitionRunners
+
+
+    class List < Struct.new(:klass, :definition)
+      def run
+        run_validations
+      end
+
+      private
+      def run_validations
+        run_required
+        run_validate_element_type
+        run_validate_element_with
+        run_validate_uniqueness
+      end
+
+      def run_validate_uniqueness
+        if unique?
+          Runner.unique klass: klass, field: :_list
+        end
+      end
+
+      def run_validate_element_with
+        if validate_element_with
+          Runner.validate_element_with klass: klass, field: :_list, validate_element_with: validate_element_with
+        end
+      end
+
+      def run_validate_element_type
+        if element_type
+          Runner.validate_element_type(klass: klass, field: :_list, element_type: element_type)
+        end
+      end
+
+      def run_required
+        if required?
+          Runner.required(klass: klass, field: :_list)
+        end
+      end
+
+      def required?
+        definition.fetch(:required, false)
+      end
+
+      def unique?
+        definition.fetch(:unique, false)
+      end
+
+      def validate_element_with
+        definition.fetch(:validate_element_with, nil) || definition.fetch(:validate_with, nil)
+      end
+
+      def element_type
+        definition.fetch(:element_type, nil) || definition.fetch(:type, nil)
+      end
+    end
+
+  end
+end