golden-objects 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4de69f92ff7c1ce061a32efdd6a205ee59f19e099d11572d7f257e838d578ac
-  data.tar.gz: ea05875072e65491a83eee3c1c17c94ef83cfb0a8f722b8a815cccd4004250a3
+  metadata.gz: fb87d44d24edcf4229613926623a663f47715af02ec287a84d87618480e0bf61
+  data.tar.gz: fb652ede3b1a0535be872ebc595c663ceb12b8f205e24a23d114d4c93b2352ea
 SHA512:
-  metadata.gz: 2729a0e5e57c3efa63e83d02772e386716dfc750abf68bba40c06d37ec546cdc1c2dbd4560657bac81afcc4c67dd0805f3fd7aa1a6ab5ed636548b2ee995edfb
-  data.tar.gz: 8564a13caf8cc5b3f04ee5213ffd10acd72f5d3cec1a2741bc3794a52cef9b7dc2e1ce7a74842fe978832c1b35f722f81f83aa1cc80169238ae1d3e35c9f1ac6
+  metadata.gz: 3ec0d2f10fb89604eecc12e34dc5a26ccde337af47eda00ee2b74f9c7dbb43b5ceb1a62209a5d99a34e0dff5516343ca38d268840af240147f3ccf2cd765e9c8
+  data.tar.gz: 00b23f3b130d76eb08bb63b3c1037838e4de74e9b882d7e6003bed652fa83439663c5efb073dccf8aa05ebcd886dea6201b0db361e8d42efe5e56e2e1739fd2e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Logs
 
+### v0.3.0
+
+* `Golden::QueryResultPresenter`:
+  * BREAKING: Change `initialize` definition.
+  * Add `records`, `presenter_class` accessors.
+  * Add `collect`, `paginated_array` class methods.
+  * Let `presenters` can be customized.
+  * Add missing `total_page` method.
+* `Golden::QueryFormOperator`:
+  * Add `mode` accessor and pass to form.
+  * Let `query_result`, `record_presenter_class` can be customized.
+* `Golden::QueryContext`:
+  * Include `ActiveRecord::Sanitization::ClassMethods`.
+  * Change prefered `sort` implementation.
+
 ### v0.2.0
 
 * Add golden form builder and helper

data/lib/golden/objects/query/query_context.rb

@@ -9,6 +9,8 @@ module Golden
       end
     end
 
+    include ::ActiveRecord::Sanitization::ClassMethods
+
     attr_accessor :page, :per
     attr_accessor :sort_field, :sort_direction
 
@@ -109,8 +111,16 @@ module Golden
           def #{__method__}
             @sort_field ||= :id
             @sort_direction ||= :desc
-            @#{__method__} ||= [
-              Record.arel_table[@sort_field].send(@sort_direction)
+            @#{__method__} = send("sort_by_\#{@sort_field}")
+          rescue NoMethodError
+            @#{__method__} = sort_by_id
+          end
+        ```
+        And define sort_by_xxx like
+        ```
+          def sort_by_id
+            [
+              Record.arel_table[sort_field].send(sort_direction)
             ]
           end
         ```

data/lib/golden/objects/query/query_form.rb

@@ -56,7 +56,16 @@ module Golden
     end
 
     def query!
-      raise NotImplementedError
+      raise NotImplementedError, <<~ERROR
+        Please define #{__method__} like
+        ```
+          def #{__method__}
+            context = ::Orders::QueryContext.new query_accessors
+            @result = context.perform(mode)
+            errors.merge! context.errors
+          end
+        ```
+      ERROR
     end
   end
 end

data/lib/golden/objects/query/query_form_operator.rb

@@ -4,7 +4,7 @@ module Golden
   class QueryFormOperator < Golden::ApplicationOperator
     class << self
       # rubocop:disable Naming/PredicateName
-      def has_query_form(form: nil, form_presenter: nil, result_presenter: nil)
+      def has_query_form(form: nil, form_presenter: nil, result_presenter: nil, record_presenter: nil)
         define_method :form_class do
           return form.to_s.constantize if form.present?
 
@@ -22,6 +22,12 @@ module Golden
 
           "#{self.class.parent.name}::QueryResultPresenter".constantize
         end
+
+        define_method :record_presenter_class do
+          return record_presenter.to_s.constantize if record_presenter.present?
+
+          "#{self.class.parent.name}::RecordPresenter".constantize
+        end
       end
       # rubocop:enable Naming/PredicateName
     end
@@ -30,6 +36,7 @@ module Golden
 
     define_model_callbacks :build_form
 
+    attr_accessor :mode
     attr_reader :params, :form
 
     def initialize(params, accessors = {})
@@ -49,7 +56,7 @@ module Golden
     end
 
     def result_presenter
-      @result_presenter ||= result_presenter_class.collect form.result
+      @result_presenter ||= result_presenter_class.collect query_result, record_presenter_class
     end
 
     private
@@ -58,6 +65,16 @@ module Golden
       params
     end
 
+    def query_accessors
+      {
+        mode: mode
+      }
+    end
+
+    def query_result
+      form.result
+    end
+
     def build_form
       form_accessors = send(:query_accessors) if private_methods.include? :query_accessors
       form_class.new query_params, form_accessors

data/lib/golden/objects/query/query_result_presenter.rb

@@ -2,23 +2,43 @@
 
 module Golden
   class QueryResultPresenter < Golden::ApplicationPresenter
-    include Enumerable
+    class << self
+      def collect(result, presenter_class)
+        new(
+          records: paginated_array(result),
+          presenter_class: presenter_class
+        )
+      end
 
-    attr_reader :records, :presenters
+      def paginated_array(result)
+        return result unless result.is_a?(Array)
+        return result unless ::Object.const_defined? 'Kaminari'
+        return Kaminari.paginate_array([], total_count: 0).page(1) if result.empty?
 
-    def initialize(records, presenter_class)
-      @records = records
-      @presenters = records.map { |record| presenter_class.constantize.new record }
+        Kaminari.paginate_array(result).page(1).per(result.size)
+      end
     end
 
+    include Enumerable
+
+    attr_accessor :records, :presenter_class
+
     def each(&block)
       presenters.each(&block)
     end
 
+    def presenters
+      @presenters ||= records.map { |record| presenter_class.constantize.new record }
+    end
+
     def total_count
       records.total_count
     end
 
+    def total_page
+      records.total_page
+    end
+
     def current_page
       records.current_page
     end

data/lib/golden/objects/version.rb

@@ -1,5 +1,5 @@
 module Golden
   module Objects
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: golden-objects
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tse-Ching Ho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Provide ruby classes and modules help you build business logics as ruby components.