golden-objects 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4854525e660454fcdcd717c48e05addb718eb6571e7ee2203068587968bc570d
-  data.tar.gz: b12b5850a5da5b637fe56005acf318a22085347dd9a22483dfc52bd24204978e
+  metadata.gz: d4de69f92ff7c1ce061a32efdd6a205ee59f19e099d11572d7f257e838d578ac
+  data.tar.gz: ea05875072e65491a83eee3c1c17c94ef83cfb0a8f722b8a815cccd4004250a3
 SHA512:
-  metadata.gz: ab570549fa989c52516de15a1c87a2439f3aba9928ef5563f9c9e02e82daa270c88f8c55cbd9936eaff22c23a6147a731d3bb3299f56b96fc17cbf50fb50324d
-  data.tar.gz: d149d32f6989842cb7407323d56a160651cb820f030f5b9ce5b649bfefa6ca7202ed5892e18e23745b3a9bb7c9fc9c6d6826e0088904ce0bf877bdc57bee693c
+  metadata.gz: 2729a0e5e57c3efa63e83d02772e386716dfc750abf68bba40c06d37ec546cdc1c2dbd4560657bac81afcc4c67dd0805f3fd7aa1a6ab5ed636548b2ee995edfb
+  data.tar.gz: 8564a13caf8cc5b3f04ee5213ffd10acd72f5d3cec1a2741bc3794a52cef9b7dc2e1ce7a74842fe978832c1b35f722f81f83aa1cc80169238ae1d3e35c9f1ac6

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Logs
 
+### v0.2.0
+
+* Add golden form builder and helper
+* Golden query context support pluck
+
 ### v0.1.0
 
 * Initial release.

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## 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.
 
 ```
 class ApplicationPresenter < Golden::ApplicationPresenter
@@ -61,15 +61,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 +91,17 @@ app/objects/orders/create_operator.rb
   * Golden::QueryFormOperator
   * Golden::QueryResultPresenter
 
+## Action View
+
+require extension for actionview in controller of rails.
+
+```
+require 'golden/action_view/extension'
+
+class ApplicationController < ActionController::Base
+  helper ::Golden::FormHelper
+```
+
 ## 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.

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

@@ -12,13 +12,18 @@ module Golden
     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 +52,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 +65,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 +75,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 +109,9 @@ module Golden
           def #{__method__}
             @sort_field ||= :id
             @sort_direction ||= :desc
-            @#{__method__} ||= Record.arel_table[@sort_field].send(@sort_direction)
+            @#{__method__} ||= [
+              Record.arel_table[@sort_field].send(@sort_direction)
+            ]
           end
         ```
       ERROR
@@ -97,6 +122,7 @@ module Golden
         Please define #{__method__} like
         ```
           def #{__method__}
+            @scopes = nil
             concat_xxx_scope
             @scopes
           end
@@ -105,10 +131,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,6 +50,7 @@ module Golden
 
     def query_accessors
       attrs = attributes.clone
+      attrs.delete(:mode)
       attrs.each { |accessor, value| attrs.delete(accessor) if value.blank? }
       attrs
     end

data/lib/golden/objects/version.rb

@@ -1,5 +1,5 @@
 module Golden
   module Objects
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   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.2.0
 platform: ruby
 authors:
 - Tse-Ching Ho
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-05-27 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
@@ -106,7 +109,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:
@@ -122,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Provide ruby classes and modules help you build business logics as ruby components.