ciesta 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e68ef3d47949c3fa6788ae15a08f5fa76078401cc2423bea094658486a1ec7b
-  data.tar.gz: f64ad04746e5acccddceb91442663e633cb3e46357311b35bf09499416ff80d4
+  metadata.gz: 686725e6d7930c99dafab26c796538ac28410261704491f9f676bb2204950481
+  data.tar.gz: 16b64dd435105dcc1a66c778e4cd321137b47d4859588a1b9c5f4d19ae7c4e42
 SHA512:
-  metadata.gz: 2b39a7a1f8a9b5b9624e7681e59f2398aa40be9b86dd4c1d5848776a62b4e9e399799aee207461c8daa9ef73458a06da2444c2c0e923a851eb55eb01676ce545
-  data.tar.gz: eaee3b3910b0fe808289e43ecc2707e07b91c50dd44d9072cd3c8e540882cc0594c16745aff680e9a55105667df65aec58dfada19f2ac051fa51aee9baf38894
+  metadata.gz: 12cce79f11ee00426ad3675c2bb1506a28b526ab0b565dae0719945661261c9d62fe6c01210f2d68697b595e174fc1c4e6f015d823adae3cf9a9ab83c63a73f9
+  data.tar.gz: 5b98c72dd163212fdea889553d501f486df12ddc7dfcd3ba73d6e09aae4e9d11afd0a61b0a1f5927fc0fd4fcbe4c937aef9ed5413b174d18923b9a07a25a9598

data/.rubocop.yml

@@ -1,14 +1,48 @@
-inherit_gem:
-  rubocop-config-umbrellio: lib/rubocop.rails.yml
-
 AllCops:
   TargetRubyVersion: 2.1
   Exclude:
     - db/schema.rb
-    - ciesta.gemspec
+    - config/**/*.rb
+
+# Metrics
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 6
 
 Metrics/LineLength:
+  Enabled: true
+  Max: 100
+  AllowHeredoc: true
   IgnoredPatterns: ['#.*']
 
-Rails/SaveBang:
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+# Style
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+# Lint
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
   Enabled: false

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    ciesta (0.2.1)
+    ciesta (0.2.3)
       dry-types (~> 0.12.1)
       dry-validation (~> 0.11.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     coveralls (0.8.21)
@@ -23,7 +24,7 @@ GEM
     dry-container (0.6.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.4)
+    dry-core (0.4.5)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.2.0)
     dry-logic (0.4.2)
@@ -48,9 +49,14 @@ GEM
     inflecto (0.0.2)
     json (2.1.0)
     method_source (0.9.0)
+    parallel (1.12.1)
+    parser (2.5.0.4)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -65,6 +71,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -74,6 +88,7 @@ GEM
       tins (~> 1.0)
     thor (0.19.4)
     tins (1.16.3)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -85,6 +100,7 @@ DEPENDENCIES
   pry (~> 0.11)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.52)
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -15,10 +15,10 @@ You should keep it in mind that here uses [dry-validation](https://github.com/dr
   - [Basic case](#basic-case)
   - [Syncing](#syncing)
   - [Validation](#validation)
-  - [Advanced declaring fields](#advanced-declaring-fields)
+  - [Advanced field declaration](#advanced-field-declaration)
     - [Types](#types)
     - [Default value](#default-value)
-  - [Mass updating values](#mass-updating-values)
+  - [Values mass update](#values-mass-update)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -42,14 +42,15 @@ Or install it yourself as:
 ## Usage
 
 ### Basic case
-Just imageine that we have a user object with `name` and `age` attributes:
+For example will be used user object with `name` and `age` attributes:
 
 ```ruby
 User = Struct.new(:name, :age)
 
 user = User.new(nil, nil)
 ```
-And we need to save new values and update and we will use simple form object:
+
+For setting and syncing new values let's create a form object:
 
 ```ruby
 class Form < Ciesta::Form
@@ -77,10 +78,10 @@ form.sync! do |user|
   user.make_happy!
 end
 ```
-Both methods `sync` and `sync!` are provides this DSL.
+Both `sync` and `sync!` provide this DSL.
 
 ### Validation
-There we want to validate incoming values. We should use `validate` method:
+For validating incoming values you can use `validate` method:
 
 ```ruby
 class Form < Ciesta::Form
@@ -96,7 +97,7 @@ end
 form = Form.new(user)
 ```
 
-Trying to sync with invalid form will raise `Ciesta::FormNotValid` error.
+An attempt to sync with invalid form will raise `Ciesta::FormNotValid` error.
 
 ```ruby
 form.age = 15
@@ -110,10 +111,10 @@ form.sync!  # => true
 user.age    # => 42
 ```
 
-### Advanced declaring fields
+### Advanced field declaration
 
 #### Types
-You can define a type of the field using `Ciesta::Types` namespace.
+You can define the type of a field using `Ciesta::Types` namespace.
 
 ```ruby
 field :age, type: Ciesta::Types::Coercible::Int
@@ -124,7 +125,7 @@ form.age # => 42
 Default type is `Ciesta::Types::Any`.
 
 #### Default value
-If your attribute wasn't set yet but value already is in use, you can set `default` option to avoid some kind of exceptions.
+If your attribute wasn’t set yet, but value is already in use, one can set a `default` option to avoid exceptions.
 
 ```ruby
 field :age, default: 42
@@ -132,7 +133,7 @@ field :age, default: 42
 form.age # => 42
 ```
 
-Default value can also be a `Proc`, wich will executed in object context.
+Default value can also be a `Proc`, wich will be called in the object context.
 
 ```ruby
 class User
@@ -148,8 +149,8 @@ field :age, default: -> { default_age }
 form.age # => 42
 ```
 
-## Mass updating values
-There are exists two methods for mass update form fields: `assign` and `assign!`.
+## Values mass update
+There are two methods for form fields mass update: `assign` and `assign!`.
 
 ```ruby
 form.assign!(name: "Neo", age: 30)
@@ -159,7 +160,7 @@ user.name # => "Neo"
 user.age  # => 30
 ```
 
-`assign!` method will raise `Ciesta::FieldNotDefined` error if one of passed attribute is not exists in the form.
+`assign!` method will raise `Ciesta::FieldNotDefined` error if one of the passed attributes is not declared in the form.
 
 ## Contributing
 

data/ciesta.gemspec

@@ -1,7 +1,7 @@
 
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ciesta/version"
 
@@ -18,9 +18,7 @@ Gem::Specification.new do |spec|
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
+  unless spec.respond_to?(:metadata)
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
@@ -30,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.0"
+  spec.required_ruby_version = ">= 2.1"
 
   spec.add_dependency "dry-types", "~> 0.12.1"
   spec.add_dependency "dry-validation", "~> 0.11.1"
@@ -40,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.52"
 end

data/lib/ciesta/delegator.rb

@@ -13,7 +13,7 @@ module Ciesta::Delegator
         "  if !#{to}.nil?",
         "    #{to}.#{name}(*args, &block)",
         "  end",
-        "end",
+        "end"
       ].join(";")
 
       module_eval(method_def)

data/lib/ciesta/errors.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Ciesta
-  # Error class for error about violating constraints
+  # Error for violating constraints
   ViolatesConstraints = Class.new(ArgumentError)
 
   # Error for invalid object
@@ -9,4 +9,7 @@ module Ciesta
 
   # Error for missing field definition
   FieldNotDefined = Class.new(NoMethodError)
+
+  # Error for nil object
+  ModelNotPresent = Class.new(StandardError)
 end

data/lib/ciesta/field_list.rb

@@ -56,7 +56,11 @@ class Ciesta::FieldList
   # @return [Boolean]
   def assign(attributes)
     attributes = attributes.keep_if { |key| keys.include?(key) }
-    assign!(attributes) rescue false
+    begin
+      assign!(attributes)
+    rescue StandardError
+      false
+    end
   end
 
   # Getting all field names
@@ -72,7 +76,7 @@ class Ciesta::FieldList
   # @api private
   # @return [Hash<Symbol, any>]
   def attributes
-    list.values.each_with_object({}) { |field, mem| mem[field.name] = field.value }
+    list.values.map { |field| [field.name, field.value] }.to_h
   end
 
   # Iterate over all fields

data/lib/ciesta/form.rb

@@ -12,11 +12,6 @@ class Ciesta::Form
   # @see Ciesta::FieldList
   delegate :assign, :assign!, :attributes, to: :fields
 
-  # @!method sync!
-  # @!method sync
-  # @see Ciesta::Syncer
-  delegate :sync, to: :syncer
-
   # @!method errors
   # @see Ciesta::Validator
   delegate :errors, to: :validator
@@ -65,14 +60,13 @@ class Ciesta::Form
   # Constructor
   #
   # @param [Object] object Object wich will be updated though this form
-  def initialize(object)
+  def initialize(object = nil)
     @object = object
 
-    obj_values = fields.keys.each_with_object({}) do |key, mem|
-      mem[key] = object.public_send(key)
-    end
+    return if object.nil?
 
-    assign(obj_values)
+    values = fields.keys.map { |key| [key, object.public_send(key)] }.to_h
+    assign(values)
   end
 
   # Checks if form is valid
@@ -87,15 +81,31 @@ class Ciesta::Form
 
   # 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::ModelNotPresent, "Model not present" if object.nil?
     raise Ciesta::FormNotValid, "Form is not valid" unless valid?
     syncer.sync(&block)
   end
 
+  # Sync form attributes to object
+  #
+  # @see Ciesta::Syncer
+  #
+  # @param [Block] block Block wich will be yielded after synfing
+  #
+  # @return [Boolean]
+  def sync(&block)
+    return if object.nil?
+    syncer.sync(&block)
+  end
+
   private
 
   # Sync class for form

data/lib/ciesta/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ciesta
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Alexey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
 description: Gem for creating and using form object
 email:
 - alex.coder1@gmail.com
@@ -151,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="