api_presenter 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73dd421a335a6bd28bb1fa83bcf1142f3f72de40
-  data.tar.gz: 8e07b111ea8ab9d0f5dbb13420113ed9d7204825
+  metadata.gz: 2a3e0a34d5d50f902760195ffd58a409d3231a15
+  data.tar.gz: 8a4261472f7ba030c7ff72e2bed5d9c3171b98d6
 SHA512:
-  metadata.gz: f59b72c776aa0279c438cb20744d39074e9d18de3eadf9f84a7aa9e6849fe418a99e00ea8f7edd796fe3cc5c7227e34bae678e73fa1fd8917ece3abfc4373468
-  data.tar.gz: 36c674a4aa24f8f8af48c8ed2daba2c9e6c1dc1864b25edc23175ee4fa705508a71078775a7f2ea19784a649b82e8c458f489d4a3546a8d486b2956f85fea60a
+  metadata.gz: 3e3491e2c26ac8affb10ba11eaeef277be47b4b9666f205a6c9f5a07da5178b204ffcc28961e10df10811abb6a98ff5cc0e0968e0d213911f07f96d1094a94fa
+  data.tar.gz: e426cce2a716fc7cdcb4e5066cd9b9a51509a5c339886031c27159fe0a6698c07f08f107f939cd6c0a071637bd7f4ee942f61e2876d139757f42383e157ed367

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.4 (2016-11-07)
+
+Logical restructure. No API changes.
+
 ## 0.2.0 (2016-11-07)
 
 Fixes require statements. Note to self: don't publish a gem right before leaving for holidays.

data/lib/api_presenter.rb

@@ -1,205 +1,10 @@
 require 'pundit'
+module ApiPresenter; end
 
-module ApiPresenter
-  class Base
-
-    attr_reader :current_user, :params, :relation
-
-    # @example
-    #   @presenter = PostPresenter.call(
-    #     current_user: current_user,
-    #     relation:     relation,
-    #     params:       params
-    #   )
-    #
-    # @param (see #initialize)
-    #
-    # @return [ApiPresenter::Base]
-    #
-    def self.call(**kwargs)
-      new(kwargs).call
-    end
-
-    # @param current_user [User]                          Optional. current_user context.
-    # @param relation     [ActiveRecord::Relation, Array] Relation or array-wrapped record(s) to present
-    # @param params       [Hash]                          Controller params
-    # @option params      [Boolean]       :count          Optional. If true, return count only.
-    # @option params      [String, Array] :include        Optional. Associated resources to include.
-    # @option params      [Boolean]       :policies       Optional. If true, resolve polciies for relation.
-    #
-    def initialize(current_user: nil, relation:, params: {})
-      @current_user = current_user
-      @relation     = relation
-      @params       = params
-    end
-
-    # @return [ApiPresenter::Base]
-    #
-    def call
-      return self if count_only?
-      initialize_resolvers
-      call_resolvers
-      self
-    end
-
-    # Primary collection, empty if count requested
-    #
-    # @return [ActiveRecord::Relation, Array<ActiveRecord::Base>]
-    #
-    def collection
-      count_only? ? [] : relation
-    end
-
-    # Count of primary collection
-    #
-    # @note Delegate to Kaminari's `total_count` property, or regular count if not a paginated relation
-    #
-    # @return [Integer]
-    #
-    def total_count
-      relation.respond_to?(:total_count) ? relation.total_count : relation.count
-    end
-
-    # Policies for the primary collection
-    #
-    # @example
-    #   [
-    #     { post_id: 1, update: true, destroy: true },
-    #     { post_id: 2, update: false, destroy: false }
-    #   ]
-    #
-    # @return [<Array<Hash>]
-    #
-    def policies
-      @policies_resolver ? @policies_resolver.resolved_policies : {}
-    end
-
-    # Class names of included collections
-    #
-    # @example
-    #   [:categories, :sub_categories, :users]
-    #
-    # @return [Array<Symbol>]
-    #
-    def included_collection_names
-      @included_collection_names ||= ParseIncludeParams.call(params[:include])
-    end
-
-    # Map of included collection names and loaded record
-    #
-    # @example
-    #   {
-    #     categories:     [#<Category id:1>],
-    #     sub_categories: [#<SubCategory id:1>],
-    #     users:          [#<User id:1>, #<User id:2]
-    #   }
-    #
-    # @return [Hash]
-    #
-    def included_collections
-      @included_collections_resolver ? @included_collections_resolver.resolved_collections : {}
-    end
-
-    # Preload additional records with the relation
-    #
-    # @note Called by resolvers, but can also be called if additional data is required that does
-    #   not need to be loaded as an included collection, and for some reason cannot be chained
-    #   onto the original relation.
-    #
-    # @param associations [Symbol, Array<Symbol>]
-    #
-    def preload(associations)
-      @relation = @relation.preload(associations)
-    end
-
-    # Hash map that defines the sources for included collection names
-    #
-    # @example
-    #   def associations_map
-    #     {
-    #       categories:     { associations: { sub_category: :category } },
-    #       sub_categories: { associations: :sub_category },
-    #       users:          { associations: [:creator, :publisher] }
-    #     }
-    #   end
-    #
-    # @abstract
-    #
-    # @return [Hash]
-    #
-    def associations_map
-      {}
-    end
-
-    # Policy methods to resolve for the primary relation
-    #
-    # @example Single
-    #   def policy_methods
-    #     :update
-    #   end
-    #
-    # @example Multiple
-    #   def policy_methods
-    #     [:update, :destroy]
-    #   end
-    #
-    # @abstract
-    #
-    # @return [Symbol, Array<Symbol>]
-    #
-    def policy_methods
-      []
-    end
-
-    # Policy associations to preload to optimize policy resolution
-    #
-    # @example Single
-    #   def policy_associations
-    #     :user_profile
-    #   end
-    #
-    # @example Multiple
-    #   def policy_associations
-    #     [:user_profile, :company]
-    #   end
-    #
-    # @abstract
-    #
-    # @return [Symbol, Array<Symbol>]
-    #
-    def policy_associations
-      []
-    end
-
-    private
-
-    def count_only?
-      @count_only ||= !!params[:count]
-    end
-
-    def resolve_policies?
-      @resolve_policies ||= current_user && !!params[:policies]
-    end
-
-    def resolve_included_collctions?
-      included_collection_names.any?
-    end
-
-    def initialize_resolvers
-      @policies_resolver              = Resolvers::PoliciesResolver.new(self) if resolve_policies?
-      @included_collections_resolver  = Resolvers::IncludedCollectionsResolver.new(self) if resolve_included_collctions?
-    end
-
-    def call_resolvers
-      @policies_resolver.call if @policies_resolver
-      @included_collections_resolver.call if @included_collections_resolver
-    end
-  end
-end
-
-require 'api_presenter/parse_include_params'
-require 'api_presenter/version'
+require 'api_presenter/base'
 require 'api_presenter/concerns/presentable'
+require 'api_presenter/parsers/parse_include_params'
 require 'api_presenter/resolvers/base'
-require 'api_presenter/resolvers/policies_resolver'
 require 'api_presenter/resolvers/included_collections_resolver'
+require 'api_presenter/resolvers/policies_resolver'
+require 'api_presenter/version'

data/lib/api_presenter/base.rb

@@ -0,0 +1,196 @@
+module ApiPresenter
+  class Base
+
+    attr_reader :current_user, :params, :relation
+
+    # @example
+    #   @presenter = PostPresenter.call(
+    #     current_user: current_user,
+    #     relation:     relation,
+    #     params:       params
+    #   )
+    #
+    # @param (see #initialize)
+    #
+    # @return [ApiPresenter::Base]
+    #
+    def self.call(**kwargs)
+      new(kwargs).call
+    end
+
+    # @param current_user [User]                          Optional. current_user context.
+    # @param relation     [ActiveRecord::Relation, Array] Relation or array-wrapped record(s) to present
+    # @param params       [Hash]                          Controller params
+    # @option params      [Boolean]       :count          Optional. If true, return count only.
+    # @option params      [String, Array] :include        Optional. Associated resources to include.
+    # @option params      [Boolean]       :policies       Optional. If true, resolve polciies for relation.
+    #
+    def initialize(current_user: nil, relation:, params: {})
+      @current_user = current_user
+      @relation     = relation
+      @params       = params
+    end
+
+    # @return [ApiPresenter::Base]
+    #
+    def call
+      return self if count_only?
+      initialize_resolvers
+      call_resolvers
+      self
+    end
+
+    # Primary collection, empty if count requested
+    #
+    # @return [ActiveRecord::Relation, Array<ActiveRecord::Base>]
+    #
+    def collection
+      count_only? ? [] : relation
+    end
+
+    # Count of primary collection
+    #
+    # @note Delegate to Kaminari's `total_count` property, or regular count if not a paginated relation
+    #
+    # @return [Integer]
+    #
+    def total_count
+      relation.respond_to?(:total_count) ? relation.total_count : relation.count
+    end
+
+    # Policies for the primary collection
+    #
+    # @example
+    #   [
+    #     { post_id: 1, update: true, destroy: true },
+    #     { post_id: 2, update: false, destroy: false }
+    #   ]
+    #
+    # @return [<Array<Hash>]
+    #
+    def policies
+      @policies_resolver ? @policies_resolver.resolved_policies : {}
+    end
+
+    # Class names of included collections
+    #
+    # @example
+    #   [:categories, :sub_categories, :users]
+    #
+    # @return [Array<Symbol>]
+    #
+    def included_collection_names
+      @included_collection_names ||= Parsers::ParseIncludeParams.call(params[:include])
+    end
+
+    # Map of included collection names and loaded record
+    #
+    # @example
+    #   {
+    #     categories:     [#<Category id:1>],
+    #     sub_categories: [#<SubCategory id:1>],
+    #     users:          [#<User id:1>, #<User id:2]
+    #   }
+    #
+    # @return [Hash]
+    #
+    def included_collections
+      @included_collections_resolver ? @included_collections_resolver.resolved_collections : {}
+    end
+
+    # Preload additional records with the relation
+    #
+    # @note Called by resolvers, but can also be called if additional data is required that does
+    #   not need to be loaded as an included collection, and for some reason cannot be chained
+    #   onto the original relation.
+    #
+    # @param associations [Symbol, Array<Symbol>]
+    #
+    def preload(associations)
+      @relation = @relation.preload(associations)
+    end
+
+    # Hash map that defines the sources for included collection names
+    #
+    # @example
+    #   def associations_map
+    #     {
+    #       categories:     { associations: { sub_category: :category } },
+    #       sub_categories: { associations: :sub_category },
+    #       users:          { associations: [:creator, :publisher] }
+    #     }
+    #   end
+    #
+    # @abstract
+    #
+    # @return [Hash]
+    #
+    def associations_map
+      {}
+    end
+
+    # Policy methods to resolve for the primary relation
+    #
+    # @example Single
+    #   def policy_methods
+    #     :update
+    #   end
+    #
+    # @example Multiple
+    #   def policy_methods
+    #     [:update, :destroy]
+    #   end
+    #
+    # @abstract
+    #
+    # @return [Symbol, Array<Symbol>]
+    #
+    def policy_methods
+      []
+    end
+
+    # Policy associations to preload to optimize policy resolution
+    #
+    # @example Single
+    #   def policy_associations
+    #     :user_profile
+    #   end
+    #
+    # @example Multiple
+    #   def policy_associations
+    #     [:user_profile, :company]
+    #   end
+    #
+    # @abstract
+    #
+    # @return [Symbol, Array<Symbol>]
+    #
+    def policy_associations
+      []
+    end
+
+    private
+
+    def count_only?
+      @count_only ||= !!params[:count]
+    end
+
+    def resolve_policies?
+      @resolve_policies ||= current_user && !!params[:policies]
+    end
+
+    def resolve_included_collctions?
+      included_collection_names.any?
+    end
+
+    def initialize_resolvers
+      @policies_resolver              = Resolvers::PoliciesResolver.new(self) if resolve_policies?
+      @included_collections_resolver  = Resolvers::IncludedCollectionsResolver.new(self) if resolve_included_collctions?
+    end
+
+    def call_resolvers
+      @policies_resolver.call if @policies_resolver
+      @included_collections_resolver.call if @included_collections_resolver
+    end
+  end
+end

data/lib/api_presenter/parsers/parse_include_params.rb

@@ -0,0 +1,27 @@
+module ApiPresenter
+  module Parsers
+
+    # Parses values into array of acceptable association map keys:
+    # * Removes blanks and dups
+    # * Underscores camel-cased keys
+    # * Converts to symbol
+    #
+    # @param values [String, Array<String>, Array<Symbol>] Comma-delimited string or array
+    #
+    # @return [Array<Symbol>]
+    #
+    class ParseIncludeParams
+      def self.call(values)
+        return [] if values.blank?
+
+        array = values.is_a?(Array) ? values.dup : values.split(',')
+        array.select!(&:present?)
+        array.map! { |value| value.try(:underscore) || value }
+        array.uniq!
+        array.map!(&:to_sym)
+
+        array
+      end
+    end
+  end
+end

data/lib/api_presenter/version.rb

@@ -1,3 +1,3 @@
 module ApiPresenter
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_presenter
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Yuval Kordov
@@ -129,8 +129,9 @@ files:
 - bin/console
 - bin/setup
 - lib/api_presenter.rb
+- lib/api_presenter/base.rb
 - lib/api_presenter/concerns/presentable.rb
-- lib/api_presenter/parse_include_params.rb
+- lib/api_presenter/parsers/parse_include_params.rb
 - lib/api_presenter/resolvers/base.rb
 - lib/api_presenter/resolvers/included_collections_resolver.rb
 - lib/api_presenter/resolvers/policies_resolver.rb

data/lib/api_presenter/parse_include_params.rb

@@ -1,25 +0,0 @@
-module ApiPresenter
-
-  # Parses values into array of acceptable association map keys:
-  # * Removes blanks and dups
-  # * Underscores camel-cased keys
-  # * Converts to symbol
-  #
-  # @param values [String, Array<String>, Array<Symbol>] Comma-delimited string or array
-  #
-  # @return [Array<Symbol>]
-  #
-  class ParseIncludeParams
-    def self.call(values)
-      return [] if values.blank?
-
-      array = values.is_a?(Array) ? values.dup : values.split(',')
-      array.select!(&:present?)
-      array.map! { |value| value.try(:underscore) || value }
-      array.uniq!
-      array.map!(&:to_sym)
-
-      array
-    end
-  end
-end