facet 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf32ae4d71605965f10204b1f506ac6b793b61a1a67ae691ff9a3abd6271d42f
-  data.tar.gz: 2fec26e6bf7facc28d0159fc5403bdd8ccc50ca79e10e27911681cb308578580
+  metadata.gz: 981aad54986ddaa928792065efcb8b95e4eb5271138ec2d864f9cd88275501d2
+  data.tar.gz: e05973e52d09014e166755cc7fc9b700bb2dcca51191022fabaa4934ce3d1d7e
 SHA512:
-  metadata.gz: 1428de7b6d1a06c0388eb62a5f6ead9e0bbfdb0fdf9d50a96ad41e06bf1ed1b90142449cdf321d749bfc190384acd337051b9e98b4fc076fbc286d8da7c0bd30
-  data.tar.gz: c14758818065d284b516706a347ccefb29da1b690d0764f2cb2ce578afcd537d70f4fe7b5d55168253aae49728da89f717f9ef8b7a28b67dc6bf5053f9d007cb
+  metadata.gz: a668f00be7c584694c176c3548ae921513d860129a5ee4409ca71353382c3b12bfbaa704deda2a36bf5db37d260bbdca4dc5979ce30a294011867df1bd9ab8fa
+  data.tar.gz: c9a0b9bddceca2562b93988a25609f4215e9fa4a2534cf7af7f07026916d23c4f7d923a0e6670c01e2e1e9df0a34b319bdf64e2760fe0313f86e56c7b58b8f8b

data/lib/facet/base.rb

@@ -1,9 +1,23 @@
 # frozen_string_literal: true
 
+require_relative "concerns/record"
+require_relative "concerns/paginate"
+require_relative "concerns/filter"
+require_relative "concerns/sort"
 require_relative "concerns/core"
+require_relative "concerns/collection"
+require_relative "concerns/cache"
 
 module Facet
   class Base
+    include ShortCircuIt
+
+    include Facet::Record
+    include Facet::Paginate
+    include Facet::Filter
+    include Facet::Sort
     include Facet::Core
+    include Facet::Collection
+    include Facet::Cache
   end
 end

data/lib/facet/concerns/cache.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Facets are intended to work with Rails view (russian doll) caching which requires responding to `#cache_key`
+module Facet
+  module Cache
+    extend ActiveSupport::Concern
+
+    included do
+      memoize :cache_key
+    end
+
+    def cache_key
+      [ collection, current_page, filter_by, sort_by ]
+    end
+  end
+end

data/lib/facet/concerns/collection.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Facets output the paginated filtered and sorted collection of data they represent
+module Facet
+  module Collection
+    extend ActiveSupport::Concern
+
+    included do
+      memoize :collection
+      memoize :filtered_collection
+      memoize :sorted_filtered_collection
+
+      # Supports transparent rendering with Rails of a facet in place of a collection
+      delegate :to_model, :to_partial_path, to: :collection
+    end
+
+    def collection
+      record_class.public_send(record_scope)
+    end
+
+    def output
+      return sorted_filtered_collection unless current_page.present? && current_page >= 0
+
+      sorted_filtered_collection.paginate(page: current_page)
+    end
+
+    # Template rendering checks for this method to exist and calls it to get the actual data to render
+    alias_method :to_ary, :output
+    alias_method :to_a, :to_ary
+
+    private
+
+    def sorted_filtered_collection
+      return filtered_collection unless sorted?
+
+      filtered_collection.public_send(sort_by)
+    end
+
+    def filtered_collection
+      return collection unless filtered?
+
+      collection.public_send(filter_by)
+    end
+  end
+end

data/lib/facet/concerns/core.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Facets are the filter/sort/pagination parameters that represent a subset of an ActiveRecord collection.
 module Facet
   module Core
     extend ActiveSupport::Concern
@@ -8,10 +9,38 @@ module Facet
       attr_reader :current_page, :filter_by, :sort_by
     end
 
-    def initialize(current_page: 0, filter_by: nil, sort_by: nil)
-      @current_page = current_page
-      @filter_by = filter_by
-      @sort_by = sort_by
+    def initialize(current_page: nil, filter_by: nil, sort_by: nil, all: false, paginate: true)
+      @current_page = page_for(current_page, paginate)
+      @filter_by = filter_for(filter_by, all)
+      @sort_by = sort_for(sort_by)
+    end
+
+    def paginated?
+      current_page.present?
+    end
+
+    def filtered?
+      filter_by.present?
+    end
+
+    def sorted?
+      sort_by.present?
+    end
+
+    private
+
+    def page_for(current_page, paginate)
+      return current_page.presence || default_page if paginate && pagination?
+
+      raise ArgumentError, "pagination is disabled for this facet." if current_page.present?
+    end
+
+    def filter_for(filter_by, all)
+      filter_by.presence || ((default_filter? && !all) ? default_filter : nil)
+    end
+
+    def sort_for(sort_by)
+      sort_by.presence || (default_sort? ? default_sort : nil)
     end
   end
 end

data/lib/facet/concerns/filter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Filters allow you to pare down a collection of records into a meaningful subset.
+module Facet
+  module Filter
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :default_filter, :default_filter?, to: :class
+    end
+
+    class_methods do
+      attr_reader :default_filter
+
+      def inherited(base)
+        base.__send__(:filter_default, default_filter) if default_filter?
+        super
+      end
+
+      def default_filter?
+        default_filter.present?
+      end
+
+      private
+
+      def filter_default(value)
+        @default_filter = value
+      end
+    end
+  end
+end

data/lib/facet/concerns/paginate.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Pagination allows you to segment records into a renderable subset.
+module Facet
+  module Paginate
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :default_page, :default_page?, :pagination?, to: :class
+    end
+
+    class_methods do
+      def default_page
+        default_page? ? @default_page : 1
+      end
+
+      def inherited(base)
+        base.__send__(:page_default, @default_page) if default_page?
+        super
+      end
+
+      def default_page?
+        @default_page.present?
+      end
+
+      def pagination?
+        return true unless defined?(@default_page)
+
+        @default_page >= 1
+      end
+
+      private
+
+      def disable_pagination!
+        page_default(-1)
+      end
+
+      def page_default(value)
+        @default_page = value
+      end
+    end
+  end
+end

data/lib/facet/concerns/record.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Records are the collection source, with an optional scope that is always applied before filters.
+module Facet
+  module Record
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :record_class, :record_scope, to: :class
+    end
+
+    class_methods do
+      def record_class
+        name.chomp("Facet").constantize
+      end
+
+      def record_scope
+        scoped? ? @record_scope : :all
+      end
+
+      def scoped?
+        @record_scope.present?
+      end
+
+      def inherited(base)
+        base.__send__(:scope, @record_scope) if scoped?
+        super
+      end
+
+      private
+
+      def scope(value)
+        @record_scope = value
+      end
+    end
+  end
+end

data/lib/facet/concerns/sort.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Sorting allow you to control the display order of a collection or subset of records.
+module Facet
+  module Sort
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :default_sort, :default_sort?, to: :class
+    end
+
+    class_methods do
+      attr_reader :default_sort
+
+      def inherited(base)
+        base.__send__(:sort_default, default_sort) if default_sort?
+        super
+      end
+
+      def default_sort?
+        default_sort.present?
+      end
+
+      private
+
+      def sort_default(value)
+        @default_sort = value
+      end
+    end
+  end
+end

data/lib/facet/version.rb

@@ -2,5 +2,5 @@
 
 module Facet
   # This constant is managed by spicerack
-  VERSION = "0.16.1"
+  VERSION = "0.16.2"
 end

data/lib/facet.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_support/core_ext/string"
 
 require "tablesalt/dsl_accessor"
 
+require "short_circu_it"
+
 require "facet/version"
 
 require "facet/base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: facet
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.16.2
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.16.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: short_circu_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.2
 description: Create cacheable collections of filtered, sorted, and paginated ActiveRecord
   objects
 email:
@@ -50,7 +64,13 @@ files:
 - README.md
 - lib/facet.rb
 - lib/facet/base.rb
+- lib/facet/concerns/cache.rb
+- lib/facet/concerns/collection.rb
 - lib/facet/concerns/core.rb
+- lib/facet/concerns/filter.rb
+- lib/facet/concerns/paginate.rb
+- lib/facet/concerns/record.rb
+- lib/facet/concerns/sort.rb
 - lib/facet/version.rb
 homepage: https://github.com/Freshly/spicerack/tree/master/facet
 licenses:
@@ -74,7 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A filterable, sortable, pageable, and Rails cacheable ActiveRecord::Relation