ciesta 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c546a423a524c000586945f454df552aad095cc9cf83c9f5a5a1f632c270a44
-  data.tar.gz: 2a8699af62652d17dc4f0705136855e827a1273488c873022c3057621058abfe
+  metadata.gz: 5edecb23ff1a41bdee5b20058e2a3f89688cb84c4c75d5bca1dd588388cfccbf
+  data.tar.gz: 2e31ce2197aee8f2289026a1589c838c31eeb589d0f223ccb55a4801b19eaea1
 SHA512:
-  metadata.gz: 45f65ccdfbc46528f966fe48ccb799c1232bf67e00db3572569788b3560cd8b59c7d0154578c76bd71d234e38498025e13187af6d0a89ba8a7a236e794f72ef7
-  data.tar.gz: f8274e3f6e55fb7774634ea3ac47ed84514f3bcc50093220559192e4e52458bf7398e245824d0519577010ad393f2f10fa23eb4e40d18e770eb08003eae8141b
+  metadata.gz: cf6686bed0df0f9cc26e5c0f7447e636603e6ceb0802fe7f36e40906850b702bab4514265e5e5f642ae712ee375d8336788af1fd4413b9379d822ee275001f4d
+  data.tar.gz: e33e92164712e7720c6842b52d7064bfe232608b78ed44bb50e29674e64261260ab9aa0d5ef009593db38096430b0c2a2cd8e0b77dd5dd958699fbc4bf964258

data/.rubocop.yml

@@ -34,5 +34,8 @@ Style/ModuleFunction:
 Lint/AmbiguousOperator:
   Enabled: false
 
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
 Lint/AmbiguousBlockAssociation:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ciesta (0.3.2)
+    ciesta (0.4.0)
       dry-types (~> 0.13)
       dry-validation (~> 0.12)
 
@@ -102,6 +102,7 @@ DEPENDENCIES
   rake (~> 10.5)
   rspec (~> 3.8)
   rubocop (~> 0.59)
+  simplecov (~> 0.16)
 
 BUNDLED WITH
    1.16.3

data/README.md

@@ -10,18 +10,17 @@ Supported Ruby 2.2.0+
 
 You should keep it in mind that here uses [dry-validation](https://github.com/dry-rb/dry-validation) and [dry-types](https://github.com/dry-rb/dry-types) for validation and typification respectively.
 
-- [Installation](#installation)
-- [Usage](#usage)
-  - [Basic case](#basic-case)
-  - [Syncing](#syncing)
-  - [Validation](#validation)
-  - [Advanced field declaration](#advanced-field-declaration)
-    - [Types](#types)
-    - [Default value](#default-value)
-    - [Virtual field](#virtual-field)
+- [Ciesta](#ciesta)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Basic case](#basic-case)
+    - [Validation](#validation)
+    - [Advanced field declaration](#advanced-field-declaration)
+      - [Types](#types)
+      - [Default value](#default-value)
   - [Values mass update](#values-mass-update)
-- [Contributing](#contributing)
-- [License](#license)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ## Installation
 
@@ -43,12 +42,10 @@ Or install it yourself as:
 ## Usage
 
 ### Basic case
-For example will be used user object with `name` and `age` attributes:
+For example will be used a hash with `name` and `age` attributes:
 
 ```ruby
-User = Struct.new(:name, :age)
-
-user = User.new(nil, nil)
+user = Hash[name: nil, age: nil]
 ```
 
 For setting and syncing new values let's create a form object:
@@ -71,22 +68,8 @@ form = Form.new(user)
 ```ruby
 form.name = "John"
 form.age = "33"
-form.sync!
-
-user.name # => "John"
-user.age  # => 33
 ```
 
-### Syncing
-You can pass a block to sync method to do some stuff with object after syncing.
-
-```ruby
-form.sync! do |user|
-  user.make_happy!
-end
-```
-Both `sync` and `sync!` provide this DSL.
-
 ### Validation
 For validating incoming values you can use `validate` method:
 
@@ -111,13 +94,10 @@ An attempt to sync with invalid form will raise `Ciesta::FormNotValid` error.
 ```ruby
 form.age = 15
 form.valid? # => false
-form.sync!  # => raises Ciesta::FormNotValid
 form.errors # => { age: ["must be greater than 18"] }
 ...
 form.age = 42
-form.sync!  # => true
-
-user.age    # => 42
+form.valid?  # => true
 ```
 
 ### Advanced field declaration
@@ -159,25 +139,11 @@ field :age, default: -> { default_age }
 form.age # => 42
 ```
 
-### Virtual field
-You can declare field as "virtual". It means that when you call `sync!` it will not raise an error "model attribute is not defined".
-
-```ruby
-User = Struct.new(:name)
-...
-field :age, virtual: true
-...
-form.age = "42"
-form.age # => 42
-form.sync! # => true
-```
-
 ## Values mass update
 There are two methods for form fields mass update: `assign` and `assign!`.
 
 ```ruby
 form.assign!(name: "Neo", age: 30)
-form.sync!
 ...
 user.name # => "Neo"
 user.age  # => 30
@@ -185,6 +151,7 @@ user.age  # => 30
 
 `assign!` method will raise `Ciesta::FieldNotDefined` error if one of the passed attributes is not declared in the form.
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/nulldef/ciesta](https://github.com/nulldef/ciesta).

data/ciesta.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.5"
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "rubocop", "~> 0.59"
+  spec.add_development_dependency "simplecov", "~> 0.16"
 end

data/lib/ciesta.rb

@@ -5,7 +5,6 @@ require "dry-types"
 require "dry-validation"
 require "ciesta/version"
 require "ciesta/field_list"
-require "ciesta/syncer"
 require "ciesta/types"
 require "ciesta/validator"
 require "ciesta/errors"

data/lib/ciesta/class_methods.rb

@@ -2,14 +2,6 @@ module Ciesta
   module ClassMethods
     extend self
 
-    def form_from(**hash)
-      form = new
-      hash.each do |(k, v)|
-        form.public_send("#{k}=", v) if form.respond_to?("#{k}=")
-      end
-      form
-    end
-
     # Declare new form field
     #
     # @param [Symbol] name Field name
@@ -17,14 +9,14 @@ module Ciesta
     # @option (see Ciesta::Field)
     def field(name, **options)
       name = name.to_sym
-      fields << Ciesta::Field.new(name, options)
+      definitions[name] = options
       proxy.instance_eval do
-        define_method(name) { self.class.fields[name] }
-        define_method("#{name}=") { |value| self.class.fields[name] = value }
+        define_method(name) { fields[name] }
+        define_method("#{name}=") { |value| fields[name] = value }
       end
     end
 
-    # Declare rules for valudation
+    # Declare rules for validation
     #
     # @param [Block] block Block with validation rules
     # @see http://dry-rb.org/gems/dry-validation
@@ -32,12 +24,12 @@ module Ciesta
       validator.use(&block)
     end
 
-    # Returns field list
+    # Returns fields definitions
     #
     # @api private
     # @return [Ciesta::FieldList]
-    def fields
-      @fields ||= Ciesta::FieldList.new
+    def definitions
+      @definitions ||= {}
     end
 
     # Returns form validator

data/lib/ciesta/errors.rb

@@ -4,15 +4,6 @@ module Ciesta
   # Error for violating constraints
   ViolatesConstraints = Class.new(ArgumentError)
 
-  # Error for invalid object
-  FormNotValid = Class.new(StandardError)
-
   # Error for missing field definition
   FieldNotDefined = Class.new(NoMethodError)
-
-  # Error for missing method of model
-  AttributeNotDefined = Class.new(NoMethodError)
-
-  # Error for nil object
-  ModelNotPresent = Class.new(StandardError)
 end

data/lib/ciesta/field.rb

@@ -16,11 +16,10 @@ class Ciesta::Field
   # @param [Hash] options Field's options
   # @option [Ciesta::Types::Definition] :type Type of value stored in this field
   # @option [Proc, Lambda, any] :default Default value for this field
-  def initialize(name, options)
+  def initialize(name, **options)
     @name = name.to_sym
     @type = options.delete(:type) || DEFAULT_TYPE
     @default = options.delete(:default)
-    @virtual = options.delete(:virtual) || false
   end
 
   # Sets a new value for field
@@ -32,7 +31,7 @@ class Ciesta::Field
     @value = type[val]
     @was_set = true
   rescue Dry::Types::ConstraintError
-    raise Ciesta::ViolatesConstraints, "#{val} is not a #{type.name}"
+    raise Ciesta::ViolatesConstraints, "#{val} is not a valid #{name} (#{type.name})"
   end
 
   # Returns current value
@@ -52,15 +51,6 @@ class Ciesta::Field
     @binding = obj
   end
 
-  # Returns true if field is virtual
-  #
-  # @api private
-  #
-  # @return [Boolean]
-  def virtual?
-    @virtual
-  end
-
   # Clear field
   def clear!
     @value = nil

data/lib/ciesta/field_list.rb

@@ -4,6 +4,18 @@
 #
 # @attr_reader [Hash<Symbol, Ciesta::Field>] list Field list
 class Ciesta::FieldList
+  # Define a new field list
+  #
+  # @api private
+  # @param [Hash] definitions Hash of fields definitions
+  #
+  # @return Ciesta::FieldList
+  def self.define(definitions)
+    definitions.each_with_object(new) do |(name, options), list|
+      list << Ciesta::Field.new(name, options)
+    end
+  end
+
   # Constructor
   def initialize
     @list = {}
@@ -44,7 +56,6 @@ class Ciesta::FieldList
   # @return [Boolean]
   def assign!(attributes)
     attributes.each { |name, value| self[name] = value }
-    true
   rescue NoMethodError => e
     raise Ciesta::FieldNotDefined, "Field #{e.name} is not specified"
   end
@@ -58,8 +69,8 @@ class Ciesta::FieldList
     attributes = attributes.keep_if { |key| keys.include?(key) }
     begin
       assign!(attributes)
-    rescue StandardError
-      false
+    rescue Ciesta::FieldNotDefined # rubocop:disable Lint/HandleExceptions
+      # do nothing
     end
   end
 
@@ -79,14 +90,6 @@ class Ciesta::FieldList
     list.values.map { |field| [field.name, field.value] }.to_h
   end
 
-  # Iterate over all fields
-  #
-  # @api private
-  # @param [Block] block Block to iterate
-  def each
-    list.each_value { |field| yield(field) }
-  end
-
   # Clear all fields
   #
   # @api private

data/lib/ciesta/instance_methods.rb

@@ -12,27 +12,14 @@ module Ciesta
     # @see Ciesta::Validator
     def_delegators :validator, :errors
 
-    # @!method sync
-    # @!method sync!
-    # @see Ciesta::Syncer
-    def_delegators :syncer, :sync
-
-    attr_accessor :object
+    attr_reader :fields
 
     # Constructor
     #
-    # @param [Object] object Object wich will be updated though this form
-    def initialize(object = nil)
-      @object = object
-      clear!
-
-      return if object.nil?
-
-      values = fields.keys.each_with_object({}) do |key, mem|
-        mem[key] = object.public_send(key) if object.respond_to?(key)
-      end
-
-      assign(values)
+    # @param [Hash] values Hash with values
+    def initialize(values = {})
+      @fields = Ciesta::FieldList.define(self.class.definitions)
+      assign(values || {})
     end
 
     # Checks if form is valid
@@ -40,36 +27,13 @@ module Ciesta
     # @param [Hash] params Attrubutes to assign before validation
     #
     # @return [Boolean]
-    def valid?(params = nil)
-      assign(params) if params
+    def valid?(values = {})
+      assign(values) unless values.empty?
       validator.valid?(attributes)
     end
 
-    # Sync form attributes to object
-    #
-    # @see Ciesta::Syncer
-    #
-    # @param [Block] block Block wich will be yielded after synfing
-    #
-    # @raise Ciesta::ModelNotPresent
-    # @raise Ciesta::FormNotValid
-    # @return [Boolean]
-    def sync!(&block)
-      raise Ciesta::FormNotValid, "Form is not valid" unless valid?
-
-      syncer.sync!(&block)
-    end
-
     private
 
-    # Sync class for form
-    #
-    # @api private
-    # @return [Ciesta::Syncer]
-    def syncer
-      @syncer ||= Ciesta::Syncer.new(object, fields)
-    end
-
     # Returns form validator
     #
     # @api private
@@ -77,13 +41,5 @@ module Ciesta
     def validator
       self.class.validator
     end
-
-    # Returns field list
-    #
-    # @api private
-    # @see Ciesta::Form.fields
-    def fields
-      self.class.fields
-    end
   end
 end

data/lib/ciesta/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ciesta
-  VERSION = "0.3.2".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ciesta
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 description: Gem for creating and using form object
 email:
 - nulldefiner@gmail.com
@@ -151,7 +165,6 @@ files:
 - lib/ciesta/field.rb
 - lib/ciesta/field_list.rb
 - lib/ciesta/instance_methods.rb
-- lib/ciesta/syncer.rb
 - lib/ciesta/types.rb
 - lib/ciesta/validator.rb
 - lib/ciesta/version.rb

data/lib/ciesta/syncer.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-# Class for syncing fields and object
-#
-# @attr_reader [Object] object Form objecy
-# @attr_reader [Ciesta::FieldList] fields Field list
-class Ciesta::Syncer
-  # Constructor
-  #
-  # @api private
-  # @param [Object] object Form object
-  # @param [Ciesta::FieldList] fields Field list
-  def initialize(object, fields)
-    @object = object
-    @fields = fields
-  end
-
-  # Sync attributes with object
-  #
-  # @param [Block] block Block which will be yielded after syncing
-  #
-  # @return [Booelan]
-  def sync
-    return if object.nil?
-
-    fields.each do |field|
-      begin
-        save_to_object(field)
-      rescue StandardError
-        nil
-      end
-    end
-
-    yield(object) if block_given?
-
-    true
-  end
-
-  # Sync attributes with object
-  #
-  # @param [Block] block Block which will be yielded after syncing
-  #
-  # @raise Ciesta::ModelNotPresent
-  # @raise Ciesta::AttributeNotDefined
-  # @return [Booelan]
-  def sync!
-    raise Ciesta::ModelNotPresent, "Cannot sync without model" if object.nil?
-
-    fields.each { |field| save_to_object(field) }
-
-    yield(object) if block_given?
-
-    true
-  end
-
-  private
-
-  attr_reader :object, :fields
-
-  def save_to_object(field)
-    object.send("#{field.name}=", field.value) unless field.virtual?
-  rescue NoMethodError
-    raise Ciesta::AttributeNotDefined, "Attribute #{field.name} is not defined on model"
-  end
-end