view_delegates 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86b85a56ceaba2da6e3064fafbab4ca1f26f47908b631130eb3b648d39cf61c
-  data.tar.gz: 6f87036ea78a719456b6831d7a1bb43fad387f90917120a52a66fc1f07671ee2
+  metadata.gz: 1648039de8d610f3ccc9e8cd6fee86695778a3ae3e90875b277c3b1bfb6ba67c
+  data.tar.gz: 1971fdebc9a6be05ffcadbe5f6616b4083e3577c2b168d6ef016cc5b9996390c
 SHA512:
-  metadata.gz: 5953364fa322a3ba872cae75ac18303f692795f4d963fa35804b96a928decba145acbd4860105baeffebb4fd8db75626cb5f6d46d92d84e4049336ddd061b136
-  data.tar.gz: 79b37df27e0f53d51b54bb85071e0d9654653e97e9f001b200cd882e8e7325bb7ea063a84a4ae23db79ad6b8031f2954195b62b635432ccaf0af7ca455a4df5a
+  metadata.gz: 969bc93127d9115c0087d7648c1fd207464787fd0efcf9c01fb255b918c8423c015ef032f3130f7af0168f8f96fb37db4aed528c07e676a14de3df06320b2346
+  data.tar.gz: f9b6de9f6789b71556f2f0947424033a35a621a5d87ded4603defbb4b24bee007e775dbe1c55daf0737baea1381e166d3d88ec04d87204ac9e67d684c8e5275f

data/README.md

@@ -1,4 +1,6 @@
 <a href="https://codeclimate.com/github/coreSegmentFault/view_delegates/maintainability"><img src="https://api.codeclimate.com/v1/badges/a74e2a9f9198b29683a2/maintainability" /></a>
+[![Gem Version](https://badge.fury.io/rb/view_delegates.svg)](https://badge.fury.io/rb/view_delegates)
+- Work in progress
 # ViewDelegates
 ViewDelegates makes easy to write reusable view components with decoupled functionality from
 the active record models
@@ -16,6 +18,13 @@ just add your logic.
      view_local :test_method
      property :my_property
      model :dummy, properties: [:a]
+     polymorph do
+	   if my_property == 1
+		BasicDelegate
+	   else
+		 PolymorphicDelegate
+	   end
+     end
      cache true
      def test_method
        'test_method'
@@ -28,6 +37,8 @@ just add your logic.
 - model also creates an accessor but permits to reject other properties not wanted to have in your view. pass to to the properties array any properties you will need in your view
 and the rest will be discarted
 - cache is an optional parameter, pass a size: parameter to change the default size of the cache pool. Default: 50  
+- polymorph gives polymorphism to our delegates, just return a class based on conditions of the properties of your base delegate to transform your view delegate
+ this is really useful in case of STI based models.
 
 ## Render views
 Create an instance from the delegate you want to render

data/app/controllers/view_delegate_controller.rb

@@ -1,4 +1,6 @@
+# View delegate minimal controller for rendering
 class ViewDelegateController < ActionController::Base
+  # Unnecesary modules to remove
   MODULES = [
     ActionController::ConditionalGet,
     ActionController::EtagWithTemplateDigest,

data/lib/view_delegates/engine.rb

@@ -1,4 +1,5 @@
 module ViewDelegates
+  # View delegates plugin
   class Engine < ::Rails::Engine
   end
 end

data/lib/view_delegates/poros/cache.rb

@@ -1,22 +1,30 @@
 module ViewDelegates
+  # View cache class
   class Cache
+    # Internal struct to save all the values
     CacheEntry = Struct.new(:key, :value)
+    # Accessor for the current entries
+    # Entries is an array, the most recent elements are at the end of the array
     attr_accessor :entries
+    # Initializer
+    # @param [Integer] max_size
     def initialize(max_size: 10)
       @entries = []
       @max_size = max_size
     end
-
+    # Add a new entry
+    # @param [Symbol] key
+    # @param [String] value
     def add(key:, value:)
       @entries << CacheEntry.new(key, value)
-      if @entries.length > @max_size
-        @entries.delete_at 0
-      end
+      # If the array is full, remove the first element, since its the oldest
+      @entries.delete_at 0 if @entries.length > @max_size
     end
-
+    # Get an entry
+    # @param [Symbol] key
     def get(key)
       result = nil
-      index = @entries.index { |e| e.key == key }
+      index = @entries.index { |e| e.key == key } rescue byebug
       if index
         result = @entries[index].value
         update_element index
@@ -25,14 +33,15 @@ module ViewDelegates
     end
 
     private
-
+    # Put the element at index one step to the right
+    # @param [Integer] index
     def update_element(index)
       before = index - 1
       start = []
       start = @entries[0..before] unless before.negative?
       @entries = start, @entries[index..(index + 1)].reverse,
                  @entries[(index + 2)..-1]
-      @entries = @entries.flatten.uniq
+      @entries = @entries.flatten.uniq.reject &:nil?
     end
   end
 end

data/lib/view_delegates/poros/view_delegate.rb

@@ -13,6 +13,7 @@ module ViewDelegates
     def delegate_cache
       @@delegate_cache
     end
+
     # Initialize method
     # @param [Hash] view_data hash containing all delegate properties
     def initialize(view_data = {})
@@ -26,8 +27,8 @@ module ViewDelegates
 
     # Renders as a string the view passed as params
     # @param [Symbol] view
-    def render(view, local_params: {})
-      locals = {}.merge(local_params)
+    def render(view, local_params: {}, &block)
+      locals = {}
       @@view_locals.each do |method|
         locals[method] = send(method)
       end
@@ -38,92 +39,112 @@ module ViewDelegates
       @@properties.each do |property|
         locals[property] = instance_variable_get "@#{property}"
       end
-      locals = locals.merge(ar_models)
-      ViewDelegateController.render(self.class.view_path + '/' + view.to_s,
-                                    locals: locals)
+      locals = locals.merge(ar_models).merge(local_params)
+      result = ViewDelegateController.render(self.class.view_path + '/' + view.to_s,
+                                             locals: locals)
+
+      if block
+        block.call(result)
+      else
+        result
+      end
     end
-    class << self
 
-        def new *args
-          if defined? @@polymorph_function
-            command = (super(*args))
-            klazz = command.instance_eval(&@@polymorph_function)
-            if klazz == self
-              super(*args)
-            else
-             klazz.new(*args)
-            end
+    class << self
+      # Override the new, we may need polymorphism
+      # @param [Hash] args
+      def new *args
+        if defined? @@polymorph_function
+          command = super(*args)
+          klazz = command.instance_eval(&@@polymorph_function)
+          if klazz == self
+            super(*args)
           else
-            super
+            klazz.new(*args)
           end
+        else
+          super
         end
-        def cache(option, size: 50)
-          if option
-            render_method = instance_method :render
-            @@delegate_cache = ViewDelegates::Cache.new(max_size: size)
-            define_method(:render) do |view, local_params: {}|
-              value_key = "#{hash}#{view.to_s}"
-              cache = @@delegate_cache.get value_key
-              if cache.nil?
-                rendered = render_method.bind(self).call(view, local_params)
-                @@delegate_cache.add key: value_key, value: rendered
-                rendered
-              else
-                cache
-              end
+      end
+
+      # Activates cache on the view delegate
+      # option must be true/false
+      # size is an optional parameter, controls the max size of the cache array
+      # @param [Boolean] option
+      # @param [Integer] size
+      def cache(option, size: 50)
+        if option
+          render_method = instance_method :render
+          @@delegate_cache = ViewDelegates::Cache.new(max_size: size)
+          define_method(:render) do |view, local_params: {}, &block|
+            value_key = "#{hash}#{local_params.hash}#{view.to_s}"
+            result = @@delegate_cache.get value_key
+            if result.nil?
+              result = render_method.bind(self).call(view, local_params: local_params)
+              @@delegate_cache.add key: value_key, value: result
+            end
+            if block
+              block.call(result)
+            else
+              result
             end
           end
         end
-        # Gets the path for the delegate views
-        def view_path
-          @view_path ||= to_s.sub(/Delegate/, ''.freeze).underscore
-        end
+      end
 
-        # Marks a method as a view local
-        # @param [Symbol] method
-        def view_local(*methods)
-          methods.each do |method|
-            @@view_locals << method
-          end
-        end
+      # Gets the path for the delegate views
+      def view_path
+        @view_path ||= to_s.sub(/Delegate/, ''.freeze).underscore
+      end
 
-        # View properties
-        # @param [Symbol] method
-        def property(*methods)
-          methods.each do |method|
-            @@properties << method
-            attr_accessor method
-          end
+      # Marks a method as a view local
+      # @param [Symbol] method
+      def view_local(*methods)
+        methods.each do |method|
+          @@view_locals << method
         end
+      end
 
-        def polymorph &block
-           @@polymorph_function = block
-        end
-        # The models this delegate will use
-        # @param [method] method The variable name this model will use
-        # @param [Array] properties The model properties to extract
-        # from the active record model
-        def model(method, properties: [])
+      # View properties
+      # @param [Symbol] method
+      def property(*methods)
+        methods.each do |method|
+          @@properties << method
           attr_accessor method
-          # Add the method name to the array of delegate models
-          @@ar_models << method
-          # Define a setter for the model
-          define_method "#{method}=" do |val|
-            # Create a struct with the model properties
-            model_delegate = if properties.any?
-                               Struct.new(*properties)
-                             else
-                               Struct.new(*val.attributes.keys)
-                             end
-            initialize_hash = {}
-            model_delegate.members.each do |k|
-              initialize_hash[k] = val.send k
-            end
-            model_delegate = model_delegate.new(*initialize_hash.values_at(*model_delegate.members))
-            # set the struct to instance model
-            instance_variable_set(:"@#{method}", model_delegate)
+        end
+      end
+      # Polymorphism method
+      # The block must return the class we must use
+      # @param [Proc] block
+      def polymorph &block
+        @@polymorph_function = block
+      end
+
+      # The models this delegate will use
+      # @param [method] method The variable name this model will use
+      # @param [Array] properties The model properties to extract
+      # from the active record model
+      def model(method, properties: [])
+        attr_accessor method
+        # Add the method name to the array of delegate models
+        @@ar_models << method
+        # Define a setter for the model
+        define_method "#{method}=" do |val|
+          # Create a struct with the model properties
+          model_delegate = if properties.any?
+                             Struct.new(*properties)
+                           else
+                             Struct.new(*val.attributes.keys)
+                           end
+          initialize_hash = {}
+          model_delegate.members.each do |k|
+            initialize_hash[k] = val.send k
           end
+          model_delegate = model_delegate.new(*initialize_hash.values_at(*model_delegate.members))
+          # set the struct to instance model
+          instance_variable_set(:"@#{method}", model_delegate)
         end
       end
+    end
   end
 end

data/lib/view_delegates/version.rb

@@ -1,3 +1,4 @@
 module ViewDelegates
-  VERSION = '0.2.1'.freeze
+  # Gem version
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_delegates
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Miguel Aurelio Lamas Murias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,10 +104,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/view_delegate.js
-- app/assets/stylesheets/view_delegate.css
 - app/controllers/view_delegate_controller.rb
-- app/helpers/view_delegate_helper.rb
 - lib/view_delegates.rb
 - lib/view_delegates/engine.rb
 - lib/view_delegates/poros/cache.rb

data/app/assets/javascripts/view_delegate.js

@@ -1,2 +0,0 @@
-// Place all the behaviors and hooks related to the matching controller here.
-// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/view_delegate.css

@@ -1,4 +0,0 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/

data/app/helpers/view_delegate_helper.rb

@@ -1,2 +0,0 @@
-module ViewDelegateHelper
-end