sn_filterable 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d92b60cf8e65b1e9e7ff21155740d51f9a1a4b6b7bf7e81ba5a3d074c9fd8df
-  data.tar.gz: fba0177360cf72c903a695fb10adcf05daffbcca0be615c7ba5c6dd989f69267
+  metadata.gz: 4d4ca6d509892a2c953861a953127b8488669f6b8b5a4ffad77e18c70797961c
+  data.tar.gz: f395268a282728c7b7632a9638cc7ee325eca5de6e3c9ff46f346f897794cc85
 SHA512:
-  metadata.gz: ad2f3ec556867d5f643aa234de026dd4513ffb9866b78120ed863bbf136fff8e6ad08794ab670205063d46c271cff1b70b4dac637ce34b832c173aa48ca504ba
-  data.tar.gz: 8c10a4fb5ec63e12dd3ac35a6edbd49873a2fefb15e0836892f363b4121e80ce38f7ec71c2a65ee31a3ec6295d81741a56882d71a3c3769e092da6d1bbbbb372
+  metadata.gz: 4dd00f9138cc3b36004a984e9285d339b2eab51e939ba45a8f0049e9a051b3b4d6970eee191a0b7954d1511f5f215b00591efc378da22920f18018c8c6ce1748
+  data.tar.gz: 23901c70d787118584e856012389a20440dc274768479057102e35bbcafa16ce6e1d035de49dac2390290f7af8183974ed5fe9d201cf38eb66cec572fb162c70

data/README.md

@@ -20,7 +20,7 @@ There are a couple key requirements for your app to be compatible with this gem:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "sn_filterable", git: "https://github.com/ibm-skills-network/sn_filterable.git"
+gem "sn_filterable"
 ```
 
 And then execute:
@@ -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

@@ -70,7 +70,7 @@
     </div>
   <% end %>
 
-  <%= turbo_frame_tag @frame_id, "data-turbo-action": "advance" do %>
+  <%= turbo_frame_tag @frame_id, "data-turbo-action": @update_url_on_submit ? "advance" : nil do %>
     <%= content_tag :input, "", type: "hidden", name: "sort", value: @filtered.queries["sort"] if @filtered.queries["sort"].present? %>
     <%= content_tag :input, "", type: "hidden", name: "order", value: @filtered.queries["order"] if @filtered.queries["order"].present? %>
 

data/app/components/sn_filterable/main_component.rb

@@ -23,13 +23,15 @@ module SnFilterable
     # @param [String, nil] url Optional, the base URL of where the filters are displayed
     # @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.
-    def initialize(frame_id:, filtered:, filters:, url: nil, search_filter_name: nil, show_sidebar: true)
+    # @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)
       @frame_id = frame_id
       @filtered = filtered
       @filters = filters
       @url = url
       @search_filter_name = search_filter_name
       @show_sidebar = show_sidebar
+      @update_url_on_submit = update_url_on_submit
     end
 
     def search_field

data/lib/sn_filterable/engine.rb

@@ -1,5 +1,4 @@
 require "rails/engine"
-require "view_component/engine"
 
 module SnFilterable
   class Engine < Rails::Engine

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.0.1"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sn_filterable
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Chase McDougall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: heroicon
@@ -287,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Skills Network - Item filtering component