cm-admin 1.5.45 → 1.5.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 316dde4d0d5c7b68e6c59d2efa5a26733b1139390467ff23ff71f3282b70d3d7
-  data.tar.gz: 32c8dbfde134f95955d8820b86bf877bbb0deb852469f9ca161fe0d9e6d868a1
+  metadata.gz: 378d66935a7066199a4eeadb51b8b7a585c8e4dd0babec1ecb19638657fa3f22
+  data.tar.gz: 847b3efed1840bdca5a69778f009a80be5fa4a66c0c19d88ed5a214f79f71c25
 SHA512:
-  metadata.gz: a4658b4917b398600ed8fde369eb201a275db905fa0f901824029232e65c09b34ad3567c375d9294313a042c80bb9b6c22c055dd1cfa9b7b29abaced0b0d4b89
-  data.tar.gz: b5ce7a6a45f6d9482a97210ae5ff7b6cdce23bbab811f28cd97fd63af32b226cdc7e8a797a1576bbe6e77eb77083081111f08fb5ba2ebd952158d37a68d63885
+  metadata.gz: 2826196f546388631dd501f71efd8c2ab2ba82e28c156ae7689c9b8334f53e51a7e50379cfbb9ca168ff2beb7c23da4b2a8b6e18a63745021a2b68f823cc7734
+  data.tar.gz: 657210656f5b832832fb26603768220fd4e09def454c969c41dff0025546ef1ac03d2efce531698205412327db965446e5a2b33eb1f8e683d20f4dd8a63deeaa

data/.yardopts

@@ -1 +1,5 @@
 lib/cm_admin/models/dsl_method.rb
+-
+docs/ShowHideContent.md
+docs/ListingSelectTwoItems.md
+docs/ListingSelectTwoAjax.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cm-admin (1.5.45)
+    cm-admin (1.5.46)
       caxlsx_rails
       cocoon (~> 1.2.15)
       csv-importer (~> 0.8.2)

data/docs/ListingSelectTwoAjax.md

@@ -0,0 +1,100 @@
+# Lisiting of Select Two using Ajax 🅰️
+
+## Method 1: Using Ajax URL for Form Field
+
+This method demonstrates how to create a form field with a single select input that uses an Ajax URL to fetch data.
+
+### Adding Ajax URL Parameter
+
+The below form field creates a single select input for optional languages. It uses an Ajax URL to fetch the language options dynamically.
+
+```ruby
+form_field :optional_language_id, input_type: :single_select, label: 'Optional Language', ajax_url: :fetch_optional_language
+```
+
+
+### Custom Action for Fetching Data
+
+This custom action retrieves data from the database and returns it as a JSON response. Example below, is specifically designed to fetch optional language data based on a search parameter.
+
+**Location**: Define this custom action in the index section of your configuration.
+
+
+```ruby
+custom_action name: 'fetch_optional_language', route_type: :collection, verb: 'get', path: '/fetch_optional_languages',
+display_type: :route do
+  @optional_language = ::Constant.search_constant_by_name(params[:search],"optional_language")
+  {
+    results: @optional_language.map { |language| { id: language.id, text: language.name.titleize } },
+    pagination: { more: false }
+  }
+end
+```
+
+This custom action is used to fetch optional languages based on a search parameter. It returns a JSON response with the language results and pagination information.
+
+## Method 2: Using HTML Attributes and JavaScript for Form Field
+
+This method shows how to create a form field with custom HTML attributes and use JavaScript to implement the select functionality.
+
+### Adding Custom HTML Attributes
+
+```ruby
+form_field :optional_language_id, input_type: :single_select, label: 'Optional Language', html_attrs: { 'data-behaviour': 'optional_language-select' }
+```
+
+This form field creates a single select input for optional languages with a custom data attribute for JavaScript targeting.
+
+
+
+### Custom Action for Fetching Data
+
+This custom action retrieves data from the database and returns it as a JSON response. Example below, is specifically designed to fetch optional language data based on a search parameter.
+
+**Location**: Define this custom action in the index section of your configuration.
+
+
+```ruby
+custom_action name: 'fetch_optional_language', route_type: :collection, verb: 'get', path: '/fetch_optional_languages',
+display_type: :route do
+  @optional_language = ::Constant.search_constant(params[:search], params[:class],"optional_language")
+  {
+    results: @optional_language.map { |language| { id: language.id, text: language.name.titleize } },
+    pagination: { more: false }
+  }
+end
+```
+
+### JavaScript Function for Select2 Implementation
+
+This JavaScript function initializes a Select2 dropdown for the optional language select field. It configures Ajax loading of options, result processing, and pagination. We can also pass additional parameters to the server using the `data` attribute.
+
+**Location**: Define this JavaScript function in your application's JavaScript file.
+
+```javascript
+function selectTwoAjaxCaller(){
+  const $event = $('select[data-behaviour="optional_language-select"]');
+    $event.select2({
+        theme: "bootstrap-5",
+        ajax: {
+            url: "fetch_optional_languages",
+            dataType: 'json',
+            delay: 250,
+            data: function (params) {
+                return {
+                    search: params.term,
+                    class: 12
+                };
+            },
+            processResults: function (data, params) {
+                return {
+                    results: data.results
+                };
+            },
+        },
+        minimumInputLength: 0,
+    });
+}
+```
+
+This JavaScript function initializes a Select2 dropdown for the optional language select field. It configures Ajax loading of options, result processing, and pagination.

data/docs/ListingSelectTwoItems.md

@@ -0,0 +1,71 @@
+# Population of items in drop-downs 🔽
+
+This document provides details on various methods used in our project. Each method is explained with its purpose and usage examples.
+
+## Method 1: Using Collection / Helper Method for Transport Type
+
+The example below demonstrates how to create a section with a single-select field using collection.
+
+```ruby
+cm_section 'Mode Of Transport' do
+  form_field :transport_type_id, input_type: :single_select, 
+  collection: :mode_of_transport
+end
+```
+
+💡Note: You need to set mode_transport array like this:
+
+```ruby
+mode_of_transport = [['Vehicle','vehicle'],['Bike', 'bike']]
+```
+
+Or you can use a helper method to fetch the data:
+
+```ruby
+cm_section 'Mode Of Transport' do
+  form_field :transport_type_id, input_type: :single_select, 
+  helper_method: :mode_of_transport_method
+end
+```
+
+💡Note: This should be defined in the helper module:
+
+```ruby
+def mode_of_transport_method
+  Constant.where(type:"transport_type").all.map { |item| [item.full_name, item.id] }
+end
+```
+
+## Method 2: Custom Action for Transport Type
+
+The example below demonstrates how to create a section with a single-select field using a custom action.
+
+This custom action is designed to fetch transport type data from the database and automatically populate the dropdown with the appropriate values when triggered.
+
+💡 Note: The retrieved data is used to populate the target_value field.
+
+**Location**: This custom action should be defined in the index section of your configuration.
+
+```ruby
+custom_action name: 'transport_type',  route_type: :collection, verb: 'get', path: '/transport_type', display_type: :route do
+transport_type = Constant.where(type: :transport_type).all.map { |item| [item.full_name, item.id] }
+  {
+    fields: [
+      {
+        target_type: :select,
+        target_value: {
+          table: 'student',
+          field_name: 'transport_type_id',
+          field_value: transport_type
+        }
+      }
+    ]
+  }
+end
+```
+
+💡Note: This needs to be added as a trigger variable for populating the fields:
+
+```ruby
+form_field :route_id, input_type: :single_select, target: { action_name: :fetch_transport_type }
+```

data/docs/ShowHideContent.md

@@ -0,0 +1,70 @@
+# Hide or Show Section and Fields 🦹
+
+This module provides methods for hiding form sections and fields with HTML attributes.
+
+## Method 1: Using HTML Attributes and JavaScript for Form Section
+
+### Adding Custom HTML Attributes
+
+Define the html_attrs attribute in a section / field to add custom HTML attributes.
+
+```ruby
+cm_section 'Private Van', html_attrs: { "data-behaviour": "private_van-section"} do
+  form_field :transport_vehicle_number, input_type: :string, label: 'Vehicle Number'
+  form_field :transport_vehicle_in_charge, input_type: :string, label: 'Vehicle In Charge'
+  form_field :transport_vehicle_in_charge_phone, input_type: :integer, label: 'Vehicle In Charge Phone'
+end
+```
+
+The below JavaScript code manages the visibility of the "Private Van" section based on a condition.
+
+**Location**: Define this JavaScript function in your application's JavaScript file.
+
+```javascript
+$(document).on("turbo:load", function() {
+  $(document).on('change', 'select[data-behaviour="transport_type-select"]', handleTransportTypeChange);
+});
+
+function handleTransportTypeChange(event) {
+  // Get the section element by its data attribute
+  var section = $('div[data-behaviour="private_van-section"]');
+  
+  // Get the selected value
+  var selectedValue = $(event.target).val();
+  
+  // Toggle the visibility based on the condition
+  if (selectedValue !== "private_van") {
+    section.addClass('hidden');
+  } else {
+    section.removeClass('hidden');
+  }
+}
+```
+
+## Method 2: Using `display_if` Attribute for Form Section
+
+### Adding `display_if` Attribute for Form Section
+
+Define the `display_if` attribute in a section to conditionally display the section based on a condition.
+
+```ruby
+cm_section 'Private Van', display_if:->(trip){trip.transport_type== "private_van" } do
+  form_field :transport_vehicle_number, input_type: :string, label: 'Vehicle Number'
+  form_field :transport_vehicle_in_charge, input_type: :string, label: 'Vehicle In Charge'
+  form_field :transport_vehicle_in_charge_phone, input_type: :integer, label: 'Vehicle In Charge Phone'
+end
+```
+
+### Adding `display_if` Attribute for Form Field
+
+Define the `display_if` attribute in a field to conditionally display the field based on a condition.
+
+```ruby
+form_field :transport_vehicle_number, input_type: :single_select,collection: :mode_of_transport, display_if:->(trip){
+  trip.transport_type=="private_van" }
+```
+
+You can also use the `display_if` attribute in any field to conditionally display the field based on a condition.
+
+
+💡Note: The `display_if` attribute is used to conditionally display the section based on the value of `trip.transport_type`. It doesn't updated in real time like the JavaScript method.

data/lib/cm_admin/models/filter.rb

@@ -92,7 +92,7 @@ module CmAdmin
               }
               sql = ''
               query_variables.each.with_index do |column, i|
-                sql.concat("#{column} ILIKE ?")
+                sql.concat("#{column}::TEXT ILIKE ?")
                 sql.concat(' OR ') unless query_variables.size.eql?(i + 1)
               end
 

data/lib/cm_admin/version.rb

@@ -1,3 +1,3 @@
 module CmAdmin
-  VERSION = '1.5.45'
+  VERSION = '1.5.46'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cm-admin
 version: !ruby/object:Gem::Version
-  version: 1.5.45
+  version: 1.5.46
 platform: ruby
 authors:
 - Michael
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -418,6 +418,9 @@ files:
 - config/webpack/production.js
 - config/webpack/test.js
 - config/webpacker.yml
+- docs/ListingSelectTwoAjax.md
+- docs/ListingSelectTwoItems.md
+- docs/ShowHideContent.md
 - lib/.DS_Store
 - lib/cm-admin.rb
 - lib/cm_admin.rb