commons_yellowme 0.11.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72561778339f9301bc276ec516c4bf13d3e98323c93ba4a7bfce41d67dcca9d2
-  data.tar.gz: 9036b246544ec395c0cfb7829bdbea2b85deb1cbf14b465c8aacf3eaaf56c709
+  metadata.gz: d79985617cba32b33138c8436f656da439a49a01edb041982449e0ac4d59cffc
+  data.tar.gz: 97b8f3428026c1e89eedad0c4d80ad626805098ec2bf260d73f47916e1a9cb3c
 SHA512:
-  metadata.gz: 563e23f1dfecd7805b3e274327365fe77a789db503cb421e00773d4ada57fb990456cfc5dea53fb0a411d1622074e4ef5985e851f54bce516ae6237d5863c785
-  data.tar.gz: 87e562f16d6f70f1c870c6db5ade5f5ae3c48601704e7040f7c327f8ad7c3c42b56a345268a68fa2bc1c04965b5ab672512f9d46bd3dc83144eb31afc18c762d
+  metadata.gz: 05621d09bb7a699c797f8edb87362a046769ca960855ded4f6323d6d61ae8c1b3e49ab34489e494ac8371387fa4bc02c3e02c7550ca5bea2b9e9f73300da25ad
+  data.tar.gz: b008246db762536c3dadd45db51023eb9db7edfe30acf69225db58b15529290a49e727585964fe23f7feb59a163b8bf24c5cbdbef09ac157643d1a6b9fa3278e

data/.gitignore

@@ -0,0 +1,62 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.vscode
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store
+
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/db/*.sqlite3-*
+spec/dummy/log/*.log
+spec/dummy/storage/
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--require rails_helper
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in commons.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.

data/Gemfile.lock

@@ -0,0 +1,218 @@
+PATH
+  remote: .
+  specs:
+    commons_yellowme (0.13.0)
+      active_model_serializers (~> 0.10.10)
+      dry-validation
+      json (~> 2.0)
+      jwt
+      phonelib (~> 0.6.29)
+      rails (~> 5.2)
+      strip_attributes
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      actionview (= 5.2.4.1)
+      activejob (= 5.2.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4.1)
+      actionview (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.1)
+      activesupport (= 5.2.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    active_model_serializers (0.10.10)
+      actionpack (>= 4.1, < 6.1)
+      activemodel (>= 4.1, < 6.1)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activejob (5.2.4.1)
+      activesupport (= 5.2.4.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4.1)
+      activesupport (= 5.2.4.1)
+    activerecord (5.2.4.1)
+      activemodel (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      arel (>= 9.0)
+    activestorage (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      activerecord (= 5.2.4.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.4)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.1.5)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-schema (1.4.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.2)
+    dry-types (1.3.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.4.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.4, >= 1.4.3)
+    erubi (1.9.0)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    factory_bot_rails (5.1.1)
+      factory_bot (~> 5.1.0)
+      railties (>= 4.2.0)
+    faker (2.8.1)
+      i18n (>= 1.6, < 1.8)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.7.1)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    jsonapi-renderer (0.2.2)
+    jwt (2.2.1)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.4)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    phonelib (0.6.41)
+    rack (2.1.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.1)
+      actioncable (= 5.2.4.1)
+      actionmailer (= 5.2.4.1)
+      actionpack (= 5.2.4.1)
+      actionview (= 5.2.4.1)
+      activejob (= 5.2.4.1)
+      activemodel (= 5.2.4.1)
+      activerecord (= 5.2.4.1)
+      activestorage (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.1)
+      actionpack (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.1)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    strip_attributes (1.9.0)
+      activemodel (>= 3.0, < 7.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  commons_yellowme!
+  factory_bot_rails (~> 5.1.1)
+  faker
+  rspec-rails
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/commons.gemspec

@@ -0,0 +1,36 @@
+$:.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "commons/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name        = "commons_yellowme"
+  spec.version     = Commons::VERSION
+  spec.date        = '2019-12-10'
+  spec.summary     = "Commons is Yellowme's Rails APIs utilities gem"
+  spec.description = "Commons is Yellowme's Rails APIs utilities gem"
+  spec.authors     = ["Yellowme"]
+  spec.email       = 'hola@yellowme.mx'
+  spec.homepage    = 'https://github.com/yellowme/commons-rails'
+  spec.license      = 'MIT'
+
+  spec.files       = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+
+  spec.add_dependency "rails", "~> 6.0"
+  spec.add_dependency 'json', '~> 2.0'
+  spec.add_dependency "active_model_serializers", "~> 0.10.10"
+  spec.add_dependency "strip_attributes"
+  spec.add_dependency "jwt"
+  spec.add_dependency "dry-validation"
+  spec.add_dependency "phonelib", "~> 0.6.29"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "factory_bot_rails", "~> 5.1.1"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "simplecov"
+end

data/lib/commons.rb

@@ -24,7 +24,7 @@ require 'commons/services/concerns/callable'
 
 # models
 require 'commons/concerns/attributes/sex'
-require 'commons/concerns/extensions/deleted'
+require 'commons/concerns/extensions/soft_deleted'
 require 'commons/concerns/guard/capitalizable'
 require 'commons/concerns/validations/undestroyable'
 

data/lib/commons/concerns/extensions/soft_deleted.rb

@@ -0,0 +1,34 @@
+module Commons
+  module Concerns
+    module Extensions
+      module SoftDeleted
+        extend ActiveSupport::Concern
+
+        included do
+          before_validation :check_not_deleted, on: [:update]
+
+          def deleted?
+            raise ActiveModel::MissingAttributeError unless has_required_fields?
+            self.deleted_at.present?
+          end
+
+          def self.default_scope
+            raise ActiveModel::MissingAttributeError unless has_attribute?(:deleted_at)
+            where(deleted_at: nil)
+          end
+        end
+
+        private
+
+        def check_not_deleted
+          raise ActiveModel::MissingAttributeError unless has_required_fields?
+          raise ActiveRecord::RecordInvalid if self.deleted_at_in_database.present?
+        end
+
+        def has_required_fields?
+          self.has_attribute?(:deleted_at)
+        end
+      end
+    end
+  end
+end

data/lib/commons/formatter/regex_constants.rb

@@ -4,6 +4,8 @@ module Commons
       PROPER_NOUN = /\A\p{L}[\p{L}'\.\-]*( [\p{L}'\.\-]+)*\z/u
       CURP = /\A([A-Z][AEIOUX][A-Z]{2}\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\d|3[01])[HM](?:AS|B[CS]|C[CLMSH]|D[FG]|G[TR]|HG|JC|M[CNS]|N[ETL]|OC|PL|Q[TR]|S[PLR]|T[CSL]|VZ|YN|ZS)[B-DF-HJ-NP-TV-Z]{3}[A-Z\d])(\d)\z/
       RFC = /\A([A-ZÑ\x26]{3,4}(\d{2})(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[0-1])([A-Z0-9]){2}([A0-9]))?\z/i
+      ELECTOR_KEY = /\A(?:[A-Z][B-DF-HJ-NP-TV-Z]){3}\d{2}(?:0[1-9]|1[0-2])(?:0[1-9]|[12]\d|3[01])(?:0[1-9]|[12]\d|3[0-2]|99)[A-Z]\d{3}\z/
+      MONEY = /\A[+-]?\d+(\.\d{1,6})?\z/
     end
   end
 end

data/lib/commons/repositories/base_repository.rb

@@ -4,54 +4,47 @@ module Commons
       include Singleton
 
       #
-      # Método que devuelve todos los objetos
+      # Método que devuelve todos los objetos activos
       #
-      # @return [Object,nil]
+      # @return [Arrat<Object>, nil]
       #
-      def all
-        @db_client.all
-      end
+      delegate :all, to: :@db_client
 
       #
       # Método que devuelve todos los objetos que no han sido eliminados
       #
       # @return [Object,nil]
       #
-      def kept
-        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
-
-        @db_client.where(deleted_at: nil)
-      end
+      delegate :where, to: :@db_client
+      alias_method :query, :where
 
       #
       # Método que devuelve todos los objetos que han sido eliminados
       #
-      # @return [Object,nil]
+      # @return [Object, nil]
       #
       def deleted
-        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+        raise ActiveModel::MissingAttributeError unless @db_client.include? Commons::Concerns::Extensions::SoftDeleted
 
-        @db_client.where.not(deleted_at: nil)
+        @db_client.unscoped.where.not(deleted_at: nil)
       end
 
       #
       # Método que devuelve el objeto según su ID
       #
-      # @return [Object,nil]
+      # @return [Object, nil]
       #
-      def find(id)
-        @db_client.find(id)
-      end
+      delegate :find, to: :@db_client
 
       #
       # Método que devuelve el objeto según su ID
       #
       # @return [Object,nil]
       #
-      def find_kept(id)
-        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+      def find_deleted(id)
+        raise ActiveModel::MissingAttributeError unless @db_client.include? Commons::Concerns::Extensions::SoftDeleted
 
-        @db_client.find_by!(id: id, deleted_at: nil)
+        @db_client.unscoped.where(id: id).where.not(deleted_at: nil).first
       end
 
       #
@@ -59,22 +52,17 @@ module Commons
       #
       # @return [Object,nil]
       #
-      def find_by(params)
-        @db_client.find_by(params)
-      end
+      delegate :find_by, to: :@db_client
 
       #
       # Método que devuelve el objeto según parámetros
       #
       # @return [Object,nil]
       #
-      def find_kept_by(params)
-        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+      def find_deleted_by(params)
+        raise ActiveModel::MissingAttributeError unless @db_client.include? Commons::Concerns::Extensions::SoftDeleted
 
-        @db_client.find_by(
-          deleted_at: nil,
-          **params
-        )
+        @db_client.unscoped.where.not(deleted_at: nil).where(**params).first
       end
 
       #
@@ -84,9 +72,7 @@ module Commons
       #
       # @raise [ActiveRecord::RecordNotFound]
       #
-      def find_by!(params)
-        @db_client.find_by!(params)
-      end
+      delegate :find_by!, to: :@db_client
 
       #
       # Método que devuelve el objeto según parámetros
@@ -95,13 +81,10 @@ module Commons
       #
       # @raise [ActiveRecord::RecordNotFound]
       #
-      def find_kept_by!(params)
-        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
+      def find_deleted_by!(params)
+        raise ActiveModel::MissingAttributeError unless @db_client.include? Commons::Concerns::Extensions::SoftDeleted
 
-        @db_client.find_by!(
-          deleted_at: nil,
-          **params
-        )
+        @db_client.unscoped.where.not(deleted_at: nil).where(**params).first!
       end
 
       #
@@ -115,9 +98,10 @@ module Commons
       # @raise [ActiveRecord::RecordNotSaved]
       #
       def create!(object)
-        raise ArgumentError unless object.is_a? @db_client
+        raise ArgumentError unless object.is_a?(@db_client)
+        raise ActiveRecord::RecordInvalid.new(object) unless object.valid?
 
-        object.save!
+        save_object(object)
       end
 
       #
@@ -143,10 +127,7 @@ module Commons
       #
       # @raises [ActiveRecord::RecordInvalid]
       #
-      def find_or_create_by!(params, &block)
-        object = @db_client.find_by(params) || @db_client.create!(params, &block)
-        object
-      end
+      delegate :find_or_create_by!, to: :@db_client
 
       #
       # Método que realiza una busqueda de la primer entrada,
@@ -174,7 +155,13 @@ module Commons
       # @raise [ActiveRecord::RecordNotSaved]
       #
       def update!(object)
-        create!(object)
+        if !object.is_a?(@db_client) || object.id.blank?
+          raise ArgumentError
+        end
+
+        raise ActiveRecord::RecordInvalid.new(object) unless object.valid?
+
+        save_object(object)
       end
 
       #
@@ -203,25 +190,43 @@ module Commons
       # @raises [ActiveRecord::RecordInvalid]
       # @raises [ActiveModel::MissingAttributeError]
       #
-      def soft_delete!(id)
-        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include? "deleted_at"
-
-        object = @db_client.find_by!(id: id, deleted_at: nil)
-        object.update!(deleted_at: Time.current)
-
-        object
+      def destroy!(object)
+        if @db_client.include? Commons::Concerns::Extensions::SoftDeleted
+          soft_delete!(object)
+        else
+          hard_delete!(object)
+        end
       end
 
-      private
+      protected
 
       def initialize
-        @db_client ||= class_object
+        @db_client = class_object
       end
 
       def class_object
         model_name = self.class.to_s.gsub("Repository", "")
         Object.const_get model_name
       end
+
+      private
+
+      def save_object(object)
+        object.save
+      end
+
+      def soft_delete!(object)
+        raise ActiveModel::MissingAttributeError unless @db_client.column_names.include?("deleted_at")
+        object.update!(deleted_at: Time.current)
+
+        object
+      end
+
+      def hard_delete!(object)
+        object.destroy!
+
+        object
+      end
     end
   end
 end