pinkman 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99be758a6c0fd2b3b91ded4b49b176b0084daa153008390ce2d7a0301b763339
-  data.tar.gz: 7652fe78dbacada668465d7aa3abc24789439f87b8f9d32b8e861dc9467f3dd9
+  metadata.gz: 3763200ced79aa36f7e47198b0195abdcdfd0318f3b553b3875bfcecdb1883a3
+  data.tar.gz: a6d43c350ee70c96812144476c408b3b46612b3b16a0b9ed4b4d2f14919b7263
 SHA512:
-  metadata.gz: b200b9dc96f6cdc0ff71a583d16e21dd65d953100f465fef9e2c0716009ffdc67f5226962e4fd52b5be931988bc9834a26f68e6793e8d949a7818a115ee529fb
-  data.tar.gz: dcaca3c9a82cec48a1304ed40d0be1efb1ed480b0ecfeef432c611bfe764c83797a387fea888c10b121699c7a1f5789a2ee428b1f40d0cbff45ea748cc57e83a
+  metadata.gz: 900495e9e1845b8c5f55d70d5236bed4f1f602e548c59833bdd0fc62f1a30520d73810f93e1a08255f180cab5a34155d38dd3df59a446cdaaeb34744e83afde1
+  data.tar.gz: ecb1773b0a1b504c4872786460def8868949209eb91ecdc2f28005c7d73c3a7c67c43806d21127c62e9ed28c72cb7cd473f78ca11d4f3429996316f2c59c2f7d

data/lib/pinkman/model/base.rb

@@ -0,0 +1,80 @@
+require 'active_record'
+
+module Pinkman
+  module Model
+    class Base < ::ActiveRecord::Base
+      
+      self.abstract_class = true
+      
+      # Serializer
+      def self.serializer= value
+        @serializer = value
+      end
+
+      def self.serializer
+        @serializer || (begin eval(self.to_s + 'Serializer') rescue nil end)
+      end
+      
+      # Get: Pinkman way of fetching records
+      def self.get query
+        if (begin Integer(query) rescue false end)
+          [find(query)]
+        elsif query.is_a? Hash
+          where(query)
+        elsif query.is_a? Array
+          where(id: query)
+        elsif query.is_a? String
+          search(query)
+        else
+          []
+        end
+      end
+      
+      def self.optimize(scope, options = {})
+        if  (options.keys - [:includes, :select]).any?
+          raise ArgumentError, "#{self}.optimize called with invalid options. Options hash accepts :includes and :select only."
+        end
+        options_includes = options[:includes] || []
+        options_select = options[:select] || []
+        
+        scope_obj = serializer.scope(scope)
+        including_array = scope_obj.including + options_includes
+        selecting_array = scope_obj.selecting + options_select
+        
+        includes(including_array).select(selecting_array)
+      end
+      def self.optim(*args)
+        optimize(*args)
+      end
+      
+      def serialize_for scope_name, params_hash = {}
+        options = {scope: scope_name}.merge(params: params_hash)
+        self.class.serializer.new(self,options)
+      end
+
+      def json scope_name=:public, params_hash={}
+        serialize_for(scope_name, params_hash).to_json
+      end
+      
+      def json_for *args, &block
+        ActiveSupport::Deprecation.warn('"json_for" deprecated. Use "json" instead.')
+        json(*args, &block)
+      end
+      
+      def has_json_key? key, scope=:public, options={}
+        json_version(scope, options).has_key?(key.to_s) and json_version(scope, options)[key.to_s].present?
+      end
+      
+      def json_version *args
+        JSON.parse(json(*args))
+      end
+      alias json_hash json_version
+      
+      def json_key key, scope=:public, options={}
+        json_version(scope, options)[key.to_s]
+      end
+      
+      
+    end
+  end
+end

data/lib/pinkman/serializer/base.rb

@@ -17,11 +17,14 @@ module Pinkman
       end
 
       self.root = false
-
+      def self.table_name
+        model.table_name
+      end
+      
       def self.scope name=:public, &block
         @scopes ||= {}
         if block_given?
-          @scopes[name.to_sym] = Pinkman::Serializer::Scope.new(serializer: self)
+          @scopes[name.to_sym] = Pinkman::Serializer::Scope.new(serializer: self, name: name.to_s)
           yield(@scopes[name.to_sym]) 
         else
           if @scopes[name.to_sym]
@@ -33,6 +36,10 @@ module Pinkman
           end
         end
       end
+      
+      def self.has_scope?(name)
+        scopes.has_key?(name.to_sym)
+      end
 
       def self.scopes
         @scopes
@@ -77,6 +84,12 @@ module Pinkman
         errors.each {|k,v| e[k] = [v].flatten}
         e
       end
+      
+      # assocs
+      
+      def self.reflections
+        model.reflections
+      end
 
       def attributes *args
         hash = super(*args)

data/lib/pinkman/serializer/scope.rb

@@ -1,12 +1,16 @@
 module Pinkman
   module Serializer
     class Scope
+      
+      attr_accessor :name, :read, :write, :access, :serializer
 
       def initialize hash
-       self.serializer = hash[:serializer] if hash.is_a?(Hash) and hash[:serializer]
-      end
-
-      attr_accessor :read, :write, :access, :serializer
+       if hash.is_a?(Hash)
+         self.serializer = hash[:serializer]
+         self.name = hash[:name]
+       end
+       self
+     end
       
       def read_ghost
         @read_ghost || []
@@ -19,9 +23,47 @@ module Pinkman
       def read_attributes *args
         self.read = args
         self.read = [] unless args.first
+        query_optimizer
         read
       end
       
+      def associations
+        read.select{ |attribute| attribute_is_association?(attribute) }
+      end
+      
+      def fields
+        read.select{ |attribute| attribute_is_in_db?(attribute) }
+      end
+      
+      def query_optimizer 
+        select_optimizer
+        include_optimizer
+      end
+      
+      def select_optimizer
+        unless :all.in?(read.map(&:to_sym))
+          fields.each do |attribute|
+            selecting << "#{serializer.table_name}.#{attribute}"
+          end
+        end
+        selecting
+      end
+      
+      def include_optimizer
+        associations.each do |attribute|
+          including << attribute_inclusion_clause(attribute)
+        end
+        including
+      end
+      
+      def selecting
+        @selecting ||= []
+      end
+      
+      def including
+        @including ||= []
+      end
+      
       def read_ghost_attributes *args
         self.read_ghost = args
         self.read_ghost = [] unless args.first
@@ -45,7 +87,7 @@ module Pinkman
       end
 
       def can_write? attribute
-        (write.include?(:all) or write.include?(attribute.to_sym)) and (serializer.model.column_names.include?(attribute.to_s) or (serializer.model.instance_methods.include?("#{attribute.to_s}=".to_sym) and write.include?(attribute.to_sym)))
+        (write.include?(:all) or write.include?(attribute.to_sym)) and (serializer.column_names.include?(attribute.to_s) or (serializer.instance_methods.include?("#{attribute.to_s}=".to_sym) and write.include?(attribute.to_sym)))
       end
 
       def can_access? action
@@ -63,6 +105,69 @@ module Pinkman
       def can_access
         access
       end
+      
+      # private
+      
+      def reflections
+        serializer.reflections
+      end
+      
+      def attribute_is_in_db?(attribute)
+        attribute.to_s.in?(serializer.model.column_names)
+      end
+      
+      def attribute_is_association?(attribute)
+        attribute.to_s.in?(reflections.keys.map(&:to_s))
+      end
+      
+      def attribute_inclusion_clause attribute
+        if attribute_has_nested_associated?(attribute)
+          a = []
+          assoc_scope = attribute_assoc_scope(attribute)
+          assoc_scope.associations.each do |assoc_attribute|
+            a << assoc_scope.attribute_inclusion_clause(assoc_attribute)
+          end
+          { attribute.to_sym => a }
+        else
+          attribute.to_sym
+        end
+      end
+      
+      
+      
+      def get_associated_model(reflection)
+        reflection.klass
+      end
+      
+      def get_associated_serializer(attribute)
+        begin
+          get_associated_model(reflections[attribute.to_s]).serializer if attribute_is_association?(attribute.to_s)
+        rescue
+          raise ArgumentError, "#{serializer}.#{name}: association named - #{attribute} - found but I can't find its serializer."
+        end
+      end
+      
+      def attribute_assoc_scope(attribute)
+        assoc_serializer = get_associated_serializer(attribute)
+        if assoc_serializer
+          assoc_serializer.scope(name.to_sym) 
+        else
+          raise ArgumentError, "#{serializer}.#{name}: association named - #{attribute} - found but I can't find its serializer."
+        end
+      end
+    
+      # given that a attribute is a association,
+      # and the associated serializer has same scope defined,
+      # checks if a nested association is present
+      def attribute_has_nested_associated?(attribute)
+        attribute = attribute.to_s
+        if attribute_is_association?(attribute)
+          assoc_scope = attribute_assoc_scope(attribute)
+          assoc_scope && assoc_scope.associations.any? && assoc_scope.serializer.model != serializer.model
+        end
+      end
+      
     end
+  
   end
 end

data/lib/pinkman/version.rb

@@ -1,3 +1,3 @@
 module Pinkman
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/pinkman.rb

@@ -2,6 +2,7 @@ require 'rails'
 require 'pathname'
 require 'active_model_serializers'
 require 'pinkman/serializer'
+require 'pinkman/model/base'
 require 'pinkman/views_helpers'
 require 'pinkman/form_helper'
 require 'pinkman/version'
@@ -37,34 +38,6 @@ module Pinkman
         Slim::Engine.set_options(attr_list_delims: {'(' => ')', '[' => ']'})
       end
       
-      # Extending ActiveRecord
-      ActiveRecord::Base.singleton_class.class_eval do 
-        
-        # Serializer
-        def serializer= value
-          @serializer = value
-        end
-
-        def serializer
-          @serializer || (begin eval(self.to_s + 'Serializer') rescue nil end)
-        end
-        
-        # Get: Pinkman way of fetching records
-        def get query
-          if (begin Integer(query) rescue false end)
-            [find(query)]
-          elsif query.is_a? Hash
-            where(query)
-          elsif query.is_a? Array
-            where(id: query)
-          elsif query.is_a? String
-            search(query)
-          else
-            []
-          end
-        end
-        
-      end
 
       # Active Record Relation: json
       ActiveRecord::Relation.class_eval do 
@@ -101,36 +74,6 @@ module Pinkman
         end
       end
 
-      # Instance method: json
-      ActiveRecord::Base.class_eval do
-        def serialize_for scope_name, params_hash = {}
-          options = {scope: scope_name}.merge(params: params_hash)
-          self.class.serializer.new(self,options)
-        end
-
-        def json scope_name=:public, params_hash={}
-          serialize_for(scope_name, params_hash).to_json
-        end
-        
-        def json_for *args, &block
-          ActiveSupport::Deprecation.warn('"json_for" deprecated. Use "json" instead.')
-          json(*args, &block)
-        end
-        
-        def has_json_key? key, scope=:public, options={}
-          json_version(scope, options).has_key?(key.to_s) and json_version(scope, options)[key.to_s].present?
-        end
-        
-        def json_version *args
-          JSON.parse(json(*args))
-        end
-        alias json_hash json_version
-        
-        def json_key key, scope=:public, options={}
-          json_version(scope, options)[key.to_s]
-        end
-        
-      end
     end
     
   end

data/pinkman.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'coffee-script'
   spec.add_development_dependency 'sprockets', '~> 3.0'
   spec.add_development_dependency 'uglifier'
@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rails'
 
   spec.add_dependency 'rails'
+  spec.add_dependency 'activerecord'
   spec.add_dependency 'jquery-rails'
   spec.add_dependency 'active_model_serializers', '~> 0.9.0'
   

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pinkman
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Agilso Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coffee-script
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -273,6 +287,7 @@ files:
 - lib/pinkman/broadcaster.rb
 - lib/pinkman/form_helper.rb
 - lib/pinkman/form_helper/form_helpers.rb
+- lib/pinkman/model/base.rb
 - lib/pinkman/serializer.rb
 - lib/pinkman/serializer/base.rb
 - lib/pinkman/serializer/scope.rb