golden-objects 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4854525e660454fcdcd717c48e05addb718eb6571e7ee2203068587968bc570d
-  data.tar.gz: b12b5850a5da5b637fe56005acf318a22085347dd9a22483dfc52bd24204978e
+  metadata.gz: 0d4ee2db8852f5eddb965ed6707deb5c5e2379c75d31fc60ef1137164673841d
+  data.tar.gz: 8e1db0713227091ab46b1c6ab73795861711ba8317c2cd35b9145533bfe308f9
 SHA512:
-  metadata.gz: ab570549fa989c52516de15a1c87a2439f3aba9928ef5563f9c9e02e82daa270c88f8c55cbd9936eaff22c23a6147a731d3bb3299f56b96fc17cbf50fb50324d
-  data.tar.gz: d149d32f6989842cb7407323d56a160651cb820f030f5b9ce5b649bfefa6ca7202ed5892e18e23745b3a9bb7c9fc9c6d6826e0088904ce0bf877bdc57bee693c
+  metadata.gz: f53b0282f9ec87265125ffaafb2078872d67ad90464abc24039fa345031b010fe2c6e363b8bd17b405113224d5df8001e0b19c77bce83a9d9626ad662f39b21e
+  data.tar.gz: 7f804752ea7aa38429115444da94cf227b2c3a273b05da8c7c70b5605084a3488cb51004e62ee6aa9d20cc2c2100f939a8a922b804b1405a11017fd682eb7714

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change Logs
 
-### v0.1.0
+# v0.3.3
+
+* fix typo of `total_pages`.
+* Add more methods for pagination.
+
+## v0.3.2
+
+* Add `Golden::QueryRecordPresenter` and `Golden::QueryFormPresenter` as basic presenters.
+
+## v0.3.1
+
+* The argement `presenter_class` of `Golden::QueryResultPresenter.collect` should be string instead of class.
+
+## 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.
+* Golden query context support pluck.
+
+## v0.1.0
 
 * Initial release.

data/README.md

@@ -8,32 +8,49 @@ Let's compose business logics as ruby components to improve efficiency of mainte
 
 Add this line to your application's Gemfile:
 
-```ruby
+``` ruby
 gem 'golden-objects'
 ```
 
 And then execute:
 
-    $ bundle install
+``` shell
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install golden-objects
+``` shell
+gem install golden-objects
+```
 
 ## Usage
 
-Create your class and inherite appropriate golden object directly or thought another class.
+Create your class and inherite appropriate golden object directly or though another class.
 
-```
+``` ruby
 class ApplicationPresenter < Golden::ApplicationPresenter
   include Rails.application.routes.url_helpers
 end
 
+class CartLineItemPresenter < ApplicationPresenter
+  class << self
+    def collect(records)
+      ::Golden::QueryResultPresenter.collect(records, name)
+    end
+  end
+
+  def initialize(line_item, accessors = {})
+    super(accessors)
+    @line_item = line_item
+  end
+end
+
 class CartPresenter < ApplicationPresenter
   attr_accessor :product_variants
 
   def line_items_presenter
-    @line_items_presenter ||= CartLineItemPresenter.all(product_variants: product_variants)
+    @line_items_presenter ||= CartLineItemPresenter.collect(product_variants)
   end
 end
 ```
@@ -45,14 +62,14 @@ And put into suggested pathes.
 
 Grouping classes by multi layers of folders are also suggested.
 
-```
+``` shell
 app/components/[major business logic]/[secondary business logic]/xxx_xxx.rb
 app/objects/[major data model logic]/[secondary data model logic]/xxx_xxx.rb
 ```
 
 For example:
 
-```
+``` shell
 app/components/identity/profile/update_form.rb
 app/components/frontend/popup_cart/main_presenter.rb
 app/objects/orders/line_item/create_operator.rb
@@ -61,15 +78,16 @@ app/objects/orders/create_operator.rb
 
 ## Modules
 
-3 kinds of modules are provied.
+4 kinds of modules are provided.
 
 * attribute accessors
 * active model concerns
 * active record concerns
+* action view extensions
 
 ## Objects
 
-3 groups of objects are provied.
+3 groups of objects are provided.
 
 * Application objects
   * Golden::ApplicationCalculator
@@ -90,6 +108,18 @@ app/objects/orders/create_operator.rb
   * Golden::QueryFormOperator
   * Golden::QueryResultPresenter
 
+## Action View
+
+require extension for actionview in controller of rails.
+
+``` ruby
+require 'golden/action_view/extension'
+
+class ApplicationController < ActionController::Base
+  helper ::Golden::FormHelper
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -98,4 +128,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/goldenio/golden-objects.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/goldenio/golden-objects>.

data/golden-objects.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   # spec.metadata['allowed_push_host'] = 'https://github.com'
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/goldenio/golden-objects.git'
-  spec.metadata['changelog_uri'] = 'https://github.com/goldenio/golden-objects/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/goldenio/golden-objects/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/golden/action_view/extension.rb

@@ -0,0 +1,2 @@
+require 'golden/action_view/form_builder'
+require 'golden/action_view/form_helper'

data/lib/golden/action_view/form_builder.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Golden
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    def label(method, text = nil, options = {}, &block)
+      text ||= I18n.t("helpers.label.#{object.model_name.i18n_key}.#{method}")
+      super(method, text, options, &block)
+    end
+  end
+end

data/lib/golden/action_view/form_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Golden
+  module FormHelper
+    def golden_form_with(**options, &block)
+      model = options[:model]
+      default_options = { builder: ::Golden::FormBuilder }
+      default_options.merge!({ scope: :query, url: model.query_url }) if model.respond_to? :query_url
+      form_with(**default_options.merge(options), &block)
+    end
+  end
+end

data/lib/golden/objects/application/application_presenter.rb

@@ -4,6 +4,7 @@ require 'golden/attribute_accessors'
 
 module Golden
   class ApplicationPresenter
+    extend ActiveModel::Naming
     extend ActiveModel::Translation
     include ActiveModel::AttributeAssignment
 

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

@@ -9,16 +9,23 @@ module Golden
       end
     end
 
+    include ::ActiveRecord::Sanitization::ClassMethods
+
     attr_accessor :page, :per
     attr_accessor :sort_field, :sort_direction
 
+    boolean_accessor :plucking
+    attr_reader :pluck_fields
+
     def initialize(accessors = {})
       assign_attributes(accessors || {})
       @page ||= 1
       @per ||= 100
     end
 
-    def perform(mode = :paginated)
+    def perform(mode = :paginated, pluck: nil)
+      @plucking = pluck.present?
+      @pluck_fields = pluck
       send("find_#{mode}")
     end
 
@@ -47,7 +54,8 @@ module Golden
     def find_all
       return [] if invalid?
 
-      relations.where(query_scopes).order(sort).all
+      finder = relations.where(query_scopes).order(sort).all
+      find_or_pluck(finder)
     end
 
     def find_count
@@ -59,7 +67,8 @@ module Golden
     def find_paginated
       return paginated_blank_result if invalid?
 
-      relations.where(query_scopes).order(sort).page(page).per(per)
+      finder = relations.where(query_scopes).order(sort).page(page).per(per)
+      find_or_pluck(finder)
     end
 
     def paginated_blank_result
@@ -68,6 +77,22 @@ module Golden
       raise NotImplementedError
     end
 
+    def find_or_pluck(finder)
+      return finder unless plucking?
+
+      finder.pluck(safe_table_fields(pluck_fields) || Arel.star)
+    end
+
+    def safe_table_fields(table_and_fields)
+      table_fields = table_and_fields.flat_map do |table, fields|
+        table_name = send(table)&.name
+        next if table_name.blank?
+
+        fields.map { |field| [table_name, field.to_s].join('.') }
+      end.compact
+      Arel.sql(table_fields.join(', '))
+    end
+
     def relations
       raise NotImplementedError, <<~ERROR
         Please define #{__method__} like
@@ -86,7 +111,17 @@ 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
         ```
       ERROR
@@ -97,6 +132,7 @@ module Golden
         Please define #{__method__} like
         ```
           def #{__method__}
+            @scopes = nil
             concat_xxx_scope
             @scopes
           end
@@ -105,10 +141,14 @@ module Golden
         ```
           def concat_xxx_scope
             scope = Record.arel_table[:xxx_number].eq(@xxx_number)
-            @scopes = @scopes ? @scopes.and(scope) : scope
+            scopes_and(scope)
           end
         ```
       ERROR
     end
+
+    def scopes_and(scope)
+      @scopes = @scopes ? @scopes.and(scope) : scope
+    end
   end
 end

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

@@ -17,6 +17,7 @@ module Golden
 
     attr_reader :result
     attr_accessor :per, :page, :sort
+    attr_accessor :mode
 
     def initialize(params, accessors = {})
       @query_params = find_query_from(params)
@@ -25,6 +26,7 @@ module Golden
       @per ||= params.dig(:per)
       @page ||= params.dig(:page)
       @sort ||= params.dig(:sort)
+      @mode ||= :paginated
     end
 
     def save
@@ -48,12 +50,22 @@ module Golden
 
     def query_accessors
       attrs = attributes.clone
+      attrs.delete(:mode)
       attrs.each { |accessor, value| attrs.delete(accessor) if value.blank? }
       attrs
     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}::QueryRecordPresenter".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.name
     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_form_presenter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Golden
+  class QueryFormPresenter < Golden::SingleFormPresenter
+    delegate :result, to: :form
+
+    def query_url
+      raise NotImplementedError
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Golden
+  class QueryRecordPresenter < Golden::ApplicationPresenter
+    class << self
+      def collect(records)
+        ::Golden::QueryResultPresenter.collect(records, name)
+      end
+    end
+
+    def initialize(record, accessors = {})
+      super(accessors)
+      @record = record
+    end
+  end
+end

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.to_s
+        )
+      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_pages
+      records.total_pages
+    end
+
     def current_page
       records.current_page
     end
@@ -26,5 +46,25 @@ module Golden
     def per_page
       records.limit_value
     end
+
+    def next_page
+      records.next_page
+    end
+
+    def prev_page
+      records.prev_page
+    end
+
+    def first_page?
+      records.first_page?
+    end
+
+    def last_page?
+      records.last_page?
+    end
+
+    def out_of_range?
+      records.out_of_range?
+    end
   end
 end

data/lib/golden/objects/version.rb

@@ -1,5 +1,5 @@
 module Golden
   module Objects
-    VERSION = '0.1.0'
+    VERSION = '0.3.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: golden-objects
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Tse-Ching Ho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,6 +69,9 @@ files:
 - bin/console
 - bin/setup
 - golden-objects.gemspec
+- lib/golden/action_view/extension.rb
+- lib/golden/action_view/form_builder.rb
+- lib/golden/action_view/form_helper.rb
 - lib/golden/active_model_concerns.rb
 - lib/golden/active_model_concerns/datepicker_concern.rb
 - lib/golden/active_model_concerns/has_persisted_record_concern.rb
@@ -98,6 +101,8 @@ files:
 - lib/golden/objects/query/query_context.rb
 - lib/golden/objects/query/query_form.rb
 - lib/golden/objects/query/query_form_operator.rb
+- lib/golden/objects/query/query_form_presenter.rb
+- lib/golden/objects/query/query_record_presenter.rb
 - lib/golden/objects/query/query_result_presenter.rb
 - lib/golden/objects/version.rb
 homepage: https://github.com/goldenio/golden-objects
@@ -106,7 +111,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/goldenio/golden-objects
   source_code_uri: https://github.com/goldenio/golden-objects.git
-  changelog_uri: https://github.com/goldenio/golden-objects/CHANGELOG.md
+  changelog_uri: https://github.com/goldenio/golden-objects/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: