sn_filterable 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b9cd4e29b1ae510d91132581e2bbd2f161ce990fc1e7ec6608d6f7bdb1b41c
-  data.tar.gz: 88eca5cf836c294bfb9853dc8bf321d63d7896115e6bdafc35faa8218c66f726
+  metadata.gz: 4336044ac4cbb8ec562c2b2dba9476223cd93044830290c7bca832e806710583
+  data.tar.gz: c664cc00c442d9638d4d648942b8a3a22fa4f56f4f8b0a624926d3458f2f52f4
 SHA512:
-  metadata.gz: d0ac7e1edc645cb96066facb446d424237abfb064c2143863a97cc88dbc758483f62be811403728fb0b14e3436a654877bbedcc9783c0b59e27a30b9c7b3c09b
-  data.tar.gz: 39991b7cfacb996f545bb0aae07a4f18a6c316ca65f884b78b2b5fe7f4082c8cab0bf6cabe208aafa870392f9be09d8a2c1b5c0dbefac70ede1d4986b97daed8
+  metadata.gz: 2f58e96ceb91c84632ccd441cdf7b5343a9a726fc016ce462ee65cb63edd53a4eda740f46589abf4a677fb20e1908020dae6eded35841105da6c097492c7b46d
+  data.tar.gz: 2b795ac02cfa49ec8ed72bdee4d8d3bb74d941e4555fbb93539a238801126e7f5c3d1a4240b2abf70bd1d473df1edda3bd84aa1615b89c12e502476c7f0afba2

data/README.md

@@ -53,6 +53,13 @@ en:
 <%= SnFilterable.load_js %>
 ```
 
+If your application does not allow for use of `.js.erb` files the JavaScript can be loaded by adding the following to your layout:
+```javascript
+<%= javascript_tag nonce: true do %>
+  <%= SnFilterable.load_js.html_safe %>
+<% end %>
+```
+
 3. Configure your app's Tailwind to scan the gem
 ```javascript
 // tailwind.config.js
@@ -190,8 +197,29 @@ Now the test suite can be run from the project root using
 bundle exec rspec
 ```
 
+### Using a Development Version
+
+Your changes can be tested manually by making one of the following additions to an App's Gemfile:
+
+For using a local version:
+```ruby
+gem "sn_filterable", path: "path/to/gem/sn_filterable"
+```
+
+For using a GitHub branch:
+```ruby
+gem "sn_filterable", git: "https://github.com/ibm-skills-network/sn_filterable.git", branch: "defaults_to_main"
+```
+
+
 ## Contributing
 
+Once you have made your updates to the codebase do the following to ensure a smooth merge:
+
+1. Update `lib/sn_filterable/version.rb` to follow [Semantic Versioning](https://semver.org)
+
+2. Run `bundle` to update the `Gemfile.lock` with your new version
+
 Bug reports and pull requests are welcome on [GitHub](https://github.com/ibm-skills-network/sn_filterable).
 
 ## License

data/app/components/sn_filterable/main_component.html.erb

@@ -7,6 +7,9 @@
                   "data-turbo-frame": @frame_id,
                   "class": "relative",
                   "@submit": "filtersLoading = true" do %>
+    <% @extra_params.each do |k, v| %>
+      <%= content_tag :input, "", class: "hidden", type: "hidden", value: v, name: k %>
+    <% end %>
     <div class="absolute w-full h-full pointer-events-none">
       <div class="absolute flex flex-col sm:grid sm:grid-cols-3 gap-4 w-full pointer-events-none">
         <div class="sm:hidden h-14"></div>

data/app/components/sn_filterable/main_component.rb

@@ -24,7 +24,8 @@ module SnFilterable
     # @param [String, nil] search_filter_name Optional, enable's and set's the search filter, specified by the filter's parameter name
     # @param [Boolean] show_sidebar If true, will show the sidebar with the filters.
     # @param [Boolean] update_url_on_submit If true, will update the URL in the user's browser on form submission.
-    def initialize(frame_id:, filtered:, filters:, url: nil, search_filter_name: nil, show_sidebar: true, update_url_on_submit: true)
+    # @param [Hash] extra_params Optional, allows for custom form values to be supplied. Useful if you need to retain non-filterable query params
+    def initialize(frame_id:, filtered:, filters:, url: nil, search_filter_name: nil, show_sidebar: true, update_url_on_submit: true, extra_params: {})
       @frame_id = frame_id
       @filtered = filtered
       @filters = filters
@@ -32,6 +33,7 @@ module SnFilterable
       @search_filter_name = search_filter_name
       @show_sidebar = show_sidebar
       @update_url_on_submit = update_url_on_submit
+      @extra_params = extra_params
     end
 
     def search_field

data/lib/sn_filterable/filterable.rb

@@ -33,9 +33,8 @@ module SnFilterable
         filter_params = filter_params(params)
         sort_params = sort_params(params)
         other_params = other_params(params, items)
-
-        items = perform_filter(items, filter_params)
         items, sort_name, reverse_order = perform_sort(items, sort_params, default_sort)
+        items = perform_filter(items, filter_params)
         items = items.page(other_params[:page]).per(other_params[:per]) if pagination_enabled
 
         Filtered.new(self, items, generate_url_queries(filter_params, sort_params, other_params), sort_name, reverse_order)

data/lib/sn_filterable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SnFilterable
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sn_filterable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Chase McDougall
+- IBM Skills Network
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: heroicon
@@ -237,7 +237,7 @@ dependencies:
 description: This gem adds a ViewComponent powered filtering component for searching
   and filtering your PostgreSQL data.
 email:
-- chasemcdougall@hotmail.com
+- Skills.Network@ibm.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -280,14 +280,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Skills Network - Item filtering component