rails_omnibar 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07132bcc31a15ed0d5ba925a00bf25ac2656babd01c15e8df03ac41b46897512
-  data.tar.gz: f18ef9526a35db7790b4c79ae597df3bbcf4ab93273e245ba753650b427453ca
+  metadata.gz: eb8dc9106768dd42363729701b4590ff5a8f8276d675e5b408e9475d06f1e756
+  data.tar.gz: fb4070d55e1ee60265dd7fba81506556b03d974edb6c95a2a9a6d22e4fcca40e
 SHA512:
-  metadata.gz: 25e3eb51a271cb5c229a6850c138f783a828b6b08434625ebca9aa75ea16c7368073eaf52260270ea1599c74734a7662cc0f0c8be700295c4aa062b26018efc8
-  data.tar.gz: a4e5a52e52eadaedc34018b95f79aaf084c6310d0bb1a33fd68188736e7a7028bbaa6c3ed090788d7e256b8df5f15989c562791f6fe389192a8220f0596fe6ca
+  metadata.gz: 6b3ca6606749745f045e671efa9119aebcc695dec2c55072bb2042877b402f734d44e6ac89fc30e5a96321a8e6d15188f7ce327d7eb821bba94839e5e48467a9
+  data.tar.gz: 365ab2b1d105d7639828ba5bb1cc65c1a339f2ce5450a9740fd00559d7c793fc1d3ee5156924e211fa4e1a34748309e6f602423ea444a51f66ff2ac5c08af3a6

data/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.8.0] - 2024-07-06
+
+### Added
+
+- added support for turbo frames, thanks to @xijo
+- added loading animation for long-running commands
+
+## [1.7.0] - 2024-07-02
+
+### Added
+
+- conditional rendering of items (`add_item(if: ->{ ... })`)
+- conditional execution of commands (`add_command(if: ->{ ... })`)
+- inheritance of items, commands, and configuration (`Bar2 = Class.new(Bar1)`)
+
 ## [1.6.0] - 2024-01-25
 
 ### Added

data/Gemfile

@@ -12,7 +12,7 @@ group :development, :test do
   gem 'puma', '~> 6.0'
   gem 'rake', '~> 13.0'
   gem 'rspec-rails', '~> 5.0'
-  gem 'sqlite3', '>= 1.3.6'
+  gem 'sqlite3', '~> 1.4'
   gem 'sprockets-rails', '~> 3.4' # for activeadmin
   gem 'webdrivers', '~> 5.0'
 end

data/README.md

@@ -89,14 +89,14 @@ end
 Render it somewhere. E.g. `app/views/layouts/application.html.erb`:
 
 ```erb
-<%= Omnibar.render %>
+<%= Omnibar.render(self) %>
 ```
 
 If you have a fully decoupled frontend, use `Omnibar.html_url` instead, fetch the omnibar HTML from there, and inject it.
 
 ### Authorization
 
-You can limit access to commands (e.g. search commands). This will not limit access to plain items.
+You can limit access to commands (e.g. search commands) and items.
 
 #### Option 1: globally limit engine access
 
@@ -119,19 +119,35 @@ MyOmnibar.auth = ->(controller, omnibar:) do
 end
 ```
 
+#### Option 3: Item-level conditionality
+
+Items and commands can have an `if` proc that is executed in the controller context. If it returns false, the item is not shown and the command is not executed.
+
+```ruby
+MyOmnibar.add_item(
+  title: 'Admin link',
+  url:   admin_url,
+  if:    ->{ current_user.admin? }
+)
+```
+
+For this to work, the controller context must be given to the omnibar when rendering (e.g. by passing `self` in a view):
+
+```erb
+<%= Omnibar.render(self) %>
+```
+
 ### Using multiple different omnibars
 
 ```ruby
-BaseOmnibar = Class.new(RailsOmnibar)
-BaseOmnibar.configure do |c|
+BaseOmnibar = Class.new(RailsOmnibar).configure do |c|
   c.add_item(
     title: 'Log in',
     url:    Rails.application.routes.url_helpers.log_in_url
   )
 end
 
-UserOmnibar = Class.new(RailsOmnibar)
-UserOmnibar.configure do |c|
+UserOmnibar = Class.new(RailsOmnibar).configure do |c|
   c.auth = ->{ user_signed_in? }
   c.add_item(
     title: 'Log out',
@@ -143,7 +159,15 @@ end
 Then, in some layout:
 
 ```erb
-<%= (user_signed_in? ? UserOmnibar : BaseOmnibar).render %>
+<%= (user_signed_in? ? UserOmnibar : BaseOmnibar).render(self) %>
+```
+
+Omnibars can also inherit commands, configuration, and items from existing omnibars:
+
+```ruby
+SuperuserOmnibar = Class.new(UserOmnibar).configure do |c|
+  # add more items that only superusers should get
+end
 ```
 
 ### Other options and usage patterns
@@ -172,7 +196,7 @@ end
 ```ruby
 module AddOmnibar
   def build_page(...)
-    within(super) { text_node(MyOmnibar.render) }
+    within(super) { text_node(MyOmnibar.render(self)) }
   end
 end
 ActiveAdmin::Views::Pages::Base.prepend(AddOmnibar)
@@ -180,7 +204,7 @@ ActiveAdmin::Views::Pages::Base.prepend(AddOmnibar)
 
 ##### To render in RailsAdmin
 
-Add `MyOmnibar.render` to `app/views/layouts/rails_admin/application.*`.
+Add `MyOmnibar.render(self)` to `app/views/layouts/rails_admin/application.*`.
 
 #### Adding all index routes as searchable items
 

data/app/controllers/rails_omnibar/html_controller.rb

@@ -1,5 +1,5 @@
 class RailsOmnibar::HtmlController < RailsOmnibar::BaseController
   def show
-    render html: omnibar.render
+    render html: omnibar.render(self)
   end
 end

data/bin/console

@@ -2,6 +2,7 @@
 
 require 'bundler/setup'
 require 'rails_omnibar'
+require_relative '../spec/dummy/config/environment'
 
 require 'irb'
 IRB.start(__FILE__)