jet_set 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c2b21527242c8574e604c1ece2b26ec71d59c7712b76cdfa9e88fdc6a47265b
-  data.tar.gz: bdcba0c32be1c7db5a0b63f206dd7c5e354c30a9af14eb1b0b204a55ea4ce349
+  metadata.gz: 41fe70bc858f2949d8cf010b6af40066a84bdfdf481f0fef13dfdb49fca1de46
+  data.tar.gz: 02c77cd6a4741a0be81caa52e3c3b63b75722cddffbd289497a194701d60c447
 SHA512:
-  metadata.gz: b6e155d9e2c20157beb3689764a42f8618159fb443b11c41d2ae81a5405fc3fadb55e31a562fcbf58fb0e06a78bf8611ea10eb36378c2b14e4c3e59c6e5b409b
-  data.tar.gz: 076a5aa11cb87fa6773faca5d3b92e218e5e939a6808d1825486c8cc1c8428cbeb1b480fe152f69a3e6f09b9f5431b4ebbec70873c567a44e91c6439f8150120
+  metadata.gz: 99ca355278cad5427c3b69228806f7405e4725a2d2acf1c5902fdf488a7e2acf5a29ee509e93ace75cdae86ba6a596fa79493d848b62acff90977cf00a04e864
+  data.tar.gz: 4008d0a706a8c416d7958c4276b3a494f5190a41df6fc4d4e69b669edf9d5e2f97d4dda73091a3692659a526da060aead126b4c44c747b368bbfa1162c857d2d

data/README.md

@@ -28,7 +28,7 @@ Open DB connection, see [Sequel docs](https://sequel.jeremyevans.net/rdoc/files/
  @connection = Sequel.connect('sqlite:/') # you can connect to any DB supported by Sequel
 ```
 
-Create a mapping of your model, a details described [here]:
+Create a mapping of your model, details described [here]:
 ```ruby
 class Mapping
   def self.load_mapping
@@ -137,8 +137,41 @@ json = JSON.generate(data: result)
 In other words, following [CQS](https://en.wikipedia.org/wiki/Command%E2%80%93query_separation) approach you can 
 load your model for a command but not for a query.
 
+### Validation
+Simple validation is optional feature provided by JetSet out of the box. To add this to your domain object you just need
+to include module `JetSet::Validations` and use `validate` statements:
+
+```ruby
+require 'jet_set/validations'
+
+class User
+  include JetSet::Validations
+  validate :name, 'cannot be empty', -> (value) {!value.nil? && !value.empty?}
+  validate :email, type: :string, presence: true
+  validate :email, 'should be valid email address', -> (value) {value.match(...)}
+
+  def initialize(attrs = {})
+    @name = attrs[:name]
+  end
+end
+```
+JetSet uses such validations automatically on saving objects in the database. Also you can invoke validation manually,
+i.e. in unit tests, using `validate!` method:
+
+```ruby
+user = User.new(name: nil)
+user.validate! # raises JetSet::ValidationError
+```
+
+`JetSet::ValidationError` contains details regarding invalid items like:
+
+```ruby
+error.invalid_items # => {name: 'cannot be empty'}
+```
+
+
+
 You can find more interesting examples in [JetSet integration tests](https://github.com/cylon-v/jet_set/tree/master/spec/integration).        
-Also for the details please visit our [wiki].
 
 ## Development
 

data/jet_set.gemspec

@@ -30,11 +30,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'sequel', '~> 5.4.0'
-  spec.add_dependency 'hypo', '~> 0.10.0'
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_dependency 'sequel', '>= 5.4.0'
+  spec.add_dependency 'hypo', '>= 1.0.0'
+  spec.add_development_dependency 'bundler', '>= 2.1'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'sqlite3', '>= 1.3'
+  spec.add_development_dependency 'simplecov', '>= 0.16'
 end

data/lib/jet_set/entity_builder.rb

@@ -1,5 +1,6 @@
 require 'jet_set/mixin/identity'
 require 'jet_set/mixin/entity'
+require 'jet_set/validations'
 
 module JetSet
   # A converter of a pure Ruby object to JetSet trackable object.
@@ -22,6 +23,7 @@ module JetSet
 
       object.extend(Identity)
       object.extend(Entity)
+      object.extend(Validations)
     end
   end
 end

data/lib/jet_set/mapper.rb

@@ -15,7 +15,8 @@ module JetSet
       @container = container
 
       @mapping.entity_mappings.values.each do |entity_mapping|
-        container.register(entity_mapping.type)
+        entity_name = "jet_set__#{entity_mapping.type.name.underscore}".to_sym
+        container.register(entity_mapping.type, entity_name)
       end
     end
 
@@ -29,6 +30,7 @@ module JetSet
     #       "SELECT u.name AS customer__name from users u"
     def map(type, row_hash, session, prefix = type.name.underscore)
       entity_name = type.name.underscore.to_sym
+      resolve_name = "jet_set__#{type.name.underscore}".to_sym
       entity_mapping = @mapping.get(entity_name)
       row = Row.new(row_hash, entity_mapping.fields, prefix)
 
@@ -43,7 +45,7 @@ module JetSet
         end
       end
 
-      object = @container.resolve(entity_name, row.attributes_hash.merge(reference_hash))
+      object = @container.resolve(resolve_name, row.attributes_hash.merge(reference_hash))
       entity = @entity_builder.create(object)
       entity.load_attributes!(row.attributes)
 

data/lib/jet_set/mixin/entity.rb

@@ -77,6 +77,8 @@ module JetSet
     # Parameters:
     #   +sequel+:: Sequel sequel
     def flush(sequel)
+      validate! if respond_to? :validate!
+
       table_name = self.class.name.underscore.pluralize.to_sym
       table = sequel[table_name]
       entity_name = self.class.name.underscore.to_sym
@@ -113,12 +115,14 @@ module JetSet
             values << value.instance_variable_get('@id')
           end
         end
+
         new_id = table.insert(fields, values)
         @__attributes['@id'] = Attribute.new('@id', new_id)
         @id = new_id
       elsif dirty?
         attributes = {}
         dirty_attributes.each {|attribute| attributes[attribute.name.sub('@', '')] = instance_variable_get(attribute.name)}
+
         if attributes.keys.length > 0
           table.where(id: @id).update(attributes)
         end

data/lib/jet_set/session.rb

@@ -103,9 +103,15 @@ module JetSet
       dirty_objects = @objects.select {|object| object.dirty?}
       ordered_objects = @dependency_graph.order(dirty_objects)
 
-      if ordered_objects.length > 0
-        @sequel.transaction do
-          ordered_objects.each{|obj| obj.flush(@sequel)}
+      begin
+        if ordered_objects.length > 0
+          @sequel.transaction do
+            ordered_objects.each{|obj| obj.flush(@sequel)}
+          end
+        end
+      ensure
+        @mutex.synchronize do
+          @objects = []
         end
       end
     end

data/lib/jet_set/validation_definition_error.rb

@@ -0,0 +1,4 @@
+module JetSet
+  class ValidationDefinitionError < StandardError
+  end
+end

data/lib/jet_set/validation_error.rb

@@ -0,0 +1,10 @@
+module JetSet
+  class ValidationError < StandardError
+    attr_reader :invalid_items
+
+    def initialize(message, invalid_items = {})
+      super(message)
+      @invalid_items = invalid_items
+    end
+  end
+end

data/lib/jet_set/validations.rb

@@ -0,0 +1,89 @@
+require 'jet_set/validation_error'
+
+module JetSet
+  # Optional validation decorator. Adds validation logic to pure Ruby objects.
+  module Validations
+    # The method runs all validations declared in the model
+    def validate!
+      validations = self.class.class_variable_defined?(:@@validations) ? self.class.class_variable_get(:@@validations) : {}
+      attributes = validations.keys
+      invalid_items = []
+
+      attributes.each do |attribute|
+        attribute_validations = validations[attribute] || []
+
+        error = nil
+        attribute_validations.each do |validation|
+          value = instance_variable_get("@#{attribute}")
+          if validation[:func].call(value) == false
+            error = validation[:message]
+            break
+          end
+        end
+        invalid_items << {"#{attribute}": error} if error
+      end
+
+      raise ValidationError.new("#{self.class.name} is invalid", invalid_items) if invalid_items.length > 0
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Adds a validation to an attribute of the entity
+      # Parameters:
+      #   +attribute_name+:: +Symbol+ attribute name
+      #   +options+ || +message+:: validation options {type, presence, message, custom} or just a message
+      #   +func+:: boolean proc with a check for validity
+      def validate(attribute_name, options, func = nil)
+        validations = self.class_variable_defined?(:@@validations) ? self.class_variable_get(:@@validations) : {}
+        validations[attribute_name] ||= []
+
+        if options.is_a?(Hash)
+          if options.has_key?(:type)
+            validations[attribute_name] << validate_type(options[:type])
+          end
+
+          if options[:presence] == true
+            validations[attribute_name] << validate_presence
+          end
+
+          message = options[:message]
+        elsif options.is_a?(String)
+          message = options
+        else
+          raise ValidationDefinitionError, "Validation definition of attribute #{attribute_name} is incorrect."
+        end
+
+        func ||= options[:custom]
+
+        unless func.nil?
+          validations[attribute_name] << {func: func, message: message}
+        end
+
+        self.class_variable_set(:@@validations, validations)
+      end
+
+      private
+
+      def validate_presence
+        {message: 'cannot be blank', func: -> (value) {!value.nil? && value != ''}}
+      end
+
+      def validate_type(type)
+        unless [:numeric, :string, :boolean].include?(type)
+          raise ValidationDefinitionError, "the type should be :numeric, :string or :boolean"
+        end
+
+        checks = {
+          numeric: -> (value) {value.is_a?(Numeric)},
+          string: -> (value) {value.is_a?(String)},
+          boolean: -> (value) {!!value == value}
+        }
+
+        {message: "should be #{type}", func: -> (value) {value.nil? || checks[type].call(value)}}
+      end
+    end
+  end
+end

data/lib/jet_set/version.rb

@@ -1,3 +1,3 @@
 module JetSet
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/jet_set.rb

@@ -3,6 +3,9 @@ require 'sequel'
 require 'sequel/extensions/inflector'
 require 'jet_set/environment'
 require 'jet_set/mapping'
+require 'jet_set/validations'
+require 'jet_set/validation_error'
+require 'jet_set/validation_definition_error'
 require 'jet_set/version'
 
 module JetSet

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: jet_set
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vladimir Kalinkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-03 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: hypo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: ''
@@ -143,6 +143,9 @@ files:
 - lib/jet_set/reference.rb
 - lib/jet_set/row.rb
 - lib/jet_set/session.rb
+- lib/jet_set/validation_definition_error.rb
+- lib/jet_set/validation_error.rb
+- lib/jet_set/validations.rb
 - lib/jet_set/version.rb
 homepage: https://github.com/cylon-v/jet_set
 licenses:
@@ -164,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: JetSet is a microscopic ORM for DDD projects.