power-compass 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c873e63a81792879a36683624858b32b9a02279786b36c37a6c64fc3ccfa1b0f
-  data.tar.gz: 2a43d082daaf8d7e0a758f9a71637458955a3c3b8a7aac74242f3d32d8be5ebc
+  metadata.gz: 92964d0bc95b3089f4e105800d24841f977eff9926bb711426139c5a41ef478b
+  data.tar.gz: b3035664afbd00d81063828910c177da1b0203110953401c493fc8660294561b
 SHA512:
-  metadata.gz: 461e8ad448d14598e7ad037be842a560c771796107265a23608e265f59fcb50bb7b4558949d6a6f941fcf0f1db829c3f6e4a6a4cf4c5e1c7ce2583f10ecb5e26
-  data.tar.gz: 87912b60c754bc176734a71ed37b107d1928fe20f5f37f686a3e0ad5c56e5d41fb539ca47d88bda5ba32f01099f0708f762ebe2cf2b4c2fc562e2c07f751c9bd
+  metadata.gz: 323ab2d69ef15f35515468721e9d96a9b86da4e0bb60e07f668b23d32088b5c6ef2f220ca1e6d02d8765fc67679fc93dd18b2e375078b815bc924d6c88c02678
+  data.tar.gz: 3cd5ecb57888a3323586d57f213095b4c256ba54fb6069ebd5197bb7313513b5b26d839d09a35fd477efad86a4a853cd97b2574f8637cb5011500e4c7327e7bc

data/app/controllers/compass/notification_controller.rb

@@ -15,7 +15,7 @@ module Compass
   private
 
     def providers
-      @providers ||= Compass::Notification::Provider.global_notifications(current_context)
+      @providers ||= Compass::Notification.build(current_context)
     end
   end
 end

data/lib/compass/json_formatter.rb

@@ -0,0 +1,100 @@
+module Compass
+  # Formats an object into a JSON hash.
+  # @private
+  module JsonFormatter
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_json_formatter, default: nil
+    end
+
+    class_methods do
+      # Formats an object into a JSON hash.
+      #
+      # @example
+      #
+      #   class Service
+      #     include Compass::JsonFormatter
+      #
+      #     format :name, :email
+      #   end
+      #
+      #   class ServiceProvider < Service
+      #     format do
+      #       name &:name
+      #       email &:email
+      #     end
+      #   end
+      #
+      #   User < Struct.new(:name, :email)
+      #   ServiceProvider.new.format(User.new("John Doe", "john.doe@example.com")) => { name: "John Doe", email: "john.doe@example.com" }
+      #
+      #   A service provider can also default some format attribute by defining the method:
+      #
+      #   class ServiceProvider < Service
+      #     format do
+      #       name &:name
+      #     end
+      #
+      #     def email = "john.doe@example.com"
+      #   end
+      #
+      #   ServiceProvider.new.format(User.new("John Doe")) => { name: "John Doe", email: "john.doe@example.com" }
+      #
+      # @param attrs [Array] the attributes to format
+      # @param attr_options [Hash] the options for the attributes
+      # @private
+      def format(*attrs, **attr_options)
+        self._json_formatter = Formatter.new(attrs + attr_options.keys, attr_options)
+        define_singleton_method(:format) do |obj = nil, &block|
+          raise ArgumentError, "Format must be defined for provider #{self.class}" if obj
+
+          self._json_formatter&.instance_eval(&block)
+
+          define_method(:format) do |object|
+            self._json_formatter&.to_h(self, object)
+          end
+        end
+      end
+    end
+
+    # Formats an object into a JSON hash.
+    # @private
+    class Formatter
+      # Initializes a new Formatter.
+      #
+      # @param attrs [Array] the attributes to format
+      # @param attr_options [Hash] the options for the attributes
+      def initialize(attrs, attr_options)
+        @attrs = attrs.index_with { nil }
+        @attr_options = attr_options
+        attrs.each do |attr|
+          define_singleton_method(attr) do |&block|
+            @attrs[attr] = block
+          end
+        end
+      end
+
+      # Formats an object into a ruby hash.
+      # @param service [Object] the service requesting the formatting of obj
+      # @param obj [Object] the object to format
+      # @return [Hash] the formatted hash
+      def to_h(service, obj)
+        Hash[@attrs.map do |method, formatter|
+          value = formatter ? formatter.call(obj) : service.try(method)
+          validate!(method, value)
+
+          [ method, value ]
+        end].compact
+      end
+
+    private
+
+      def validate!(method, value)
+        if value.blank? && @attr_options[method].eql?(:required)
+          raise ArgumentError, "#{self.class}#format must include :#{method}. Got: #{value.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/compass/notification/provider.rb

@@ -1,31 +1,10 @@
 module Compass
   module Notification
-    class UnknownProvider < StandardError
-      attr_reader :provider_name, :available_providers
-
-      def initialize(provider_name, available_providers)
-        @provider_name = provider_name
-        @available_providers = available_providers
-        super("Notification provider '#{provider_name}' not found")
-      end
-    end
-
     class Provider
-      class << self
-        def global_notifications(context = {})
-          Compass.config.notification.providers.map do |provider|
-            begin
-              provider_class = provider.try(:constantize) || provider
-              provider_class.new(**context)
-            rescue => e
-              Compass.logger&.error("[ Compass::Notification::Provider ] #{provider}: #{e.class}: #{e.message}")
-              nil
-            end
-          end
-        end
-      end
+      include Compass::JsonFormatter
+
+      format :icon, :color, id: :required, title: :required, body: :required, url: :required, date: :required
 
-      # Instance methods
       def initialize(**context)
         @context = context
         context.each { |key, value| define_singleton_method(key) { value } }
@@ -35,43 +14,30 @@ module Compass
         notifications.pluck(:id).hash
       end
 
-      def fetch_notifications
-        retrieve_notifications
+      def notifications
+        @notifications ||= Array(fetch).map { |notification| format(notification) }
       rescue => e
         log_error(e)
         []
       end
 
-      def retrieve_notifications
-        raise NotImplementedError, "#{self.class} must implement #retrieve_notifications"
-      end
-
-      def format_notification(notification)
-        raise NotImplementedError, "#{self.class} must implement #format_notification and return a hash with :id, :title, :body, and :url keys"
-      end
+      def fetch = must_implement(:fetch)
 
-      def label
-        raise NotImplementedError, "#{self.class} must implement #label"
-      end
+      def label = must_implement(:label)
 
-      def updated_at
-        raise NotImplementedError, "#{self.class} must implement #updated_at"
-      end
+      def updated_at = must_implement(:updated_at)
 
       def as_json(options = {})
         {
           label: label,
           notifications: notifications
-        }
+        }.compact.as_json(options)
       end
 
     private
 
-      def notifications
-        @notifications ||= Array(fetch_notifications).map do |notification|
-          formatted = format_notification(notification)
-          formatted[:id] ? formatted : raise(ArgumentError, "#{self.class}#format_notification must include :id. Got: #{formatted.inspect}")
-        end.compact
+      def must_implement(method)
+        raise NotImplementedError, "#{self.class} must implement ##{method}"
       end
 
       def log_error(error)

data/lib/compass/notification.rb

@@ -1,5 +1,19 @@
 module Compass
   module Notification
     autoload :Provider, "compass/notification/provider"
+
+    # Returns all notification providers for the given context.
+    #
+    # @param context [Hash] the context to pass to the notification providers
+    # @return [Array<Compass::Notification::Provider>] the notification providers
+    def self.build(context)
+      Compass.config.notification.providers.filter_map do |provider|
+        provider_class = provider.try(:constantize) || provider
+        provider_class.new(**context)
+      rescue => e
+        Compass.logger&.error("[ Compass::Notification::Provider ] #{provider}: #{e.class}: #{e.message}")
+        nil
+      end
+    end
   end
 end

data/lib/compass/version.rb

@@ -1,3 +1,3 @@
 module Compass
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/compass.rb

@@ -14,6 +14,7 @@ module Compass
   autoload :Notification, "compass/notification"
   autoload :Breadcrumb, "compass/breadcrumb"
   autoload :LazyAttribute, "compass/lazy_attribute"
+  autoload :JsonFormatter, "compass/json_formatter"
 
   include Compass::Configuration
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-compass
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Carlos Palhares
@@ -108,6 +108,7 @@ files:
 - lib/compass/configuration/notification.rb
 - lib/compass/configuration/search.rb
 - lib/compass/engine.rb
+- lib/compass/json_formatter.rb
 - lib/compass/lazy_attribute.rb
 - lib/compass/menu.rb
 - lib/compass/menu/item.rb