tam_select 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cf23ba08878f41cb17355d5ce629542fc3bab8e61756960403223d2abde898c
-  data.tar.gz: 9257189f40b467cfdf80106c5c2c30ce3430f10395c8bb122b7c6ae09ee6a3c6
+  metadata.gz: b3a066f1e145b6a880f28494f78c00d51c1ca280fc984975c2eebf849704041c
+  data.tar.gz: 1537eeda1e3dda9a3a38077bbfe6076cc9d851e6b404345188b61b845fd3107a
 SHA512:
-  metadata.gz: 8c2ac3a785840329c378213fa5fdf9499756c44adc64788c6170ac5fc8f8a2de2c18eb7bd8949dbf6cd9792894ef7b5ca75e5b1135066d31052de62598e67510
-  data.tar.gz: 326c67bbe68fc22799b6a24993bd378ebb06650772d829ffdba775fe2f119997df09a66bb63c99b1661cc85e21b3e29a3f3662b2b71fa57789fb997fc126e368
+  metadata.gz: 454ff7b7e777da2409741dff572ead04fc84ae5e65be2984c44d9c0196924ecf6d695e7445d23cbb7ba683abea8bf7e821f79e06cac71da9e4c8c6a718f8c823
+  data.tar.gz: f5950761f9e589454f4dad82e2ed52dbe5ac88d5856a8ee133da81916bf5e5ec20c8e434e23aca8a868b8d9cce4612d5926929e1ef4643e9c4d597541c3b943e

data/README.md

@@ -35,6 +35,7 @@ app/javascript/tam_select/tam_select.js
 app/javascript/controllers/tam_select_controller.js
 app/inputs/tam_select_input.rb
 app/controllers/concerns/tam_select_paginatable.rb
+app/controllers/tam_select_remote_controller.rb
 app/helpers/tam_select_helper.rb
 ```
 
@@ -153,6 +154,47 @@ The generator installs `TamSelectPaginatable` as a Rails response helper. A comp
 
 Secure remote endpoints exactly like other Rails JSON endpoints. Scope records by the current user's permissions and never trust a submitted value merely because it appeared in the dropdown.
 
+### Generic remote controller
+
+The installer generates `TamSelectRemoteController`. Create a small subclass for each allowed remote source:
+
+```ruby
+# app/controllers/region_options_controller.rb
+class RegionOptionsController < TamSelectRemoteController
+  tam_select model: Region, label: :name, search_by: %i[name code]
+
+  private
+
+  # Override this method when records require authorization or tenant scoping.
+  def tam_select_scope(config)
+    current_account.regions.order(:name)
+  end
+end
+```
+
+Expose the JSON endpoint and pass it to the input:
+
+```ruby
+# config/routes.rb
+get "region_options", to: "region_options#index", defaults: { format: :json }
+```
+
+```erb
+<%= form.input :region_id,
+      as: :tam_select,
+      collection: [form.object.region].compact,
+      label_method: :name,
+      value_method: :id,
+      input_html: {
+        tam_options: {
+          remoteUrl: region_options_path,
+          minQueryLength: 1
+        }
+      } %>
+```
+
+Do not accept a model name from request parameters. Declaring each source in a controller subclass prevents clients from querying arbitrary application models.
+
 ## Core JavaScript
 
 ```js

data/lib/generators/tam_select/install_generator.rb

@@ -20,6 +20,10 @@ module TamSelect
         copy_file "lib/generators/tam_select/templates/tam_select_paginatable.rb", "app/controllers/concerns/tam_select_paginatable.rb"
       end
 
+      def copy_remote_controller
+        copy_file "lib/generators/tam_select/templates/tam_select_remote_controller.rb", "app/controllers/tam_select_remote_controller.rb"
+      end
+
       def copy_helper
         copy_file "lib/generators/tam_select/templates/tam_select_helper.rb", "app/helpers/tam_select_helper.rb"
       end

data/lib/generators/tam_select/templates/tam_select_remote_controller.rb

@@ -0,0 +1,44 @@
+class TamSelectRemoteController < ApplicationController
+  include TamSelectPaginatable
+
+  class_attribute :tam_select_config, instance_writer: false
+
+  def self.tam_select(model:, label:, value: :id, search_by: nil, per_page: 20)
+    self.tam_select_config = {
+      model: model,
+      label: label,
+      value: value,
+      search_by: Array(search_by || label),
+      per_page: per_page
+    }.freeze
+  end
+
+  def index
+    config = self.class.tam_select_config
+    raise "Configure #{self.class.name} with tam_select(...)" unless config
+
+    records = search(tam_select_scope(config), config)
+    render json: tam_select_payload(
+      records,
+      label: config[:label],
+      value: config[:value],
+      per_page: config[:per_page]
+    )
+  end
+
+  private
+
+  def tam_select_scope(config)
+    config[:model].all
+  end
+
+  def search(records, config)
+    query = params[:q].to_s.strip
+    return records if query.blank?
+
+    model = config[:model]
+    pattern = "%#{model.sanitize_sql_like(query)}%"
+    predicates = config[:search_by].map { |field| model.arel_table[field].matches(pattern) }
+    records.where(predicates.reduce(&:or))
+  end
+end

data/lib/tam_select/version.rb

@@ -1,3 +1,3 @@
 module TamSelect
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tam_select
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tamiru Hailu
@@ -62,6 +62,7 @@ files:
 - lib/generators/tam_select/templates/tam_select_helper.rb
 - lib/generators/tam_select/templates/tam_select_input.rb
 - lib/generators/tam_select/templates/tam_select_paginatable.rb
+- lib/generators/tam_select/templates/tam_select_remote_controller.rb
 - lib/tam_select.rb
 - lib/tam_select/engine.rb
 - lib/tam_select/version.rb