notifiers 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ddbf316c3d227051cede7c16899601b69b8fe877
-  data.tar.gz: f28643946a68b7d4bf484086deccdb84c426a4e4
+SHA256:
+  metadata.gz: 283300dff237abf0a0ae9bdb960dd674ce1ddc632846087b1449438176a097d7
+  data.tar.gz: 899747ad18240c1f05c38ee57d315ccd365cdad7d7b42208c7772b1624b678c2
 SHA512:
-  metadata.gz: 05153d76e7ac7dfc4aa74d642fa4cffe12a690983dea8b08b1e83632b44431c1768805b96d704d24fc303b46e6973dcef4ad84efa26a87631866bee6e537730b
-  data.tar.gz: 3c7a7fbb267d26913bc70e4058af3f61e753493ba32e1bca2a5013aa177878d77421a6ecf7a4f33e3fbbc5e49ac506b5d26803b72188dc858daaa4e6c194818f
+  metadata.gz: bd88d8ec60ea149d0dc376f9aca984a097a9a4bf3bde1b5899cd872e7e98c6a47c09a9d02ca1244acb35d1969d5c46b6860801460ac1008689fea3321d74c3b5
+  data.tar.gz: f90c615293fd0ca70adf41a291a04ffe26a81cc5c37b81faf06d63091ea4927e15448807ea51db60cc2816df78d0674463bcec188999dfbb53da5217a43c5525

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.3', '3.4', 'jruby', 'truffleruby']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/History.markdown

@@ -1,3 +1,24 @@
+# 2.0.0
+
+Breaking changes:
+
+* Remove Growl support (project retired)
+* Remove Knotify support (KDE3 dcop deprecated)
+* Require Ruby >= 3.0
+
+New features:
+
+* Add TerminalNotifier for macOS (Notification Center via terminal-notifier)
+* Add Osascript for macOS (built-in AppleScript notifications)
+* Add Dunstify for Linux/BSD (dunst notification daemon)
+* Auto discover now works across all platforms and notifiers
+
+Other changes:
+
+* Replace Travis CI with GitHub Actions
+* Update RSpec to ~> 3.13
+* Add frozen_string_literal to all files
+
 # 1.2.1
 
 * Implementing auto discover, just for Growl now.

data/README.markdown

@@ -1,32 +1,85 @@
 # Notifiers
 
-Use notifications systems like growl, lib-notify in a simple and elegant way. :)
+Cross-platform desktop notifications for macOS and Linux.
+
+[![CI](https://github.com/tomas-stefano/notifiers/actions/workflows/ci.yml/badge.svg)](https://github.com/tomas-stefano/notifiers/actions/workflows/ci.yml)
 
 ## Install
 
-     gem install notifiers
+```
+gem install notifiers
+```
+
+## Requirements
+
+- Ruby >= 3.0
 
 ## Usage
 
-     require 'notifiers'
-     include Notifiers
+```ruby
+require 'notifiers'
+include Notifiers
+```
+
+### Auto Discover
+
+Automatically detect and use an available notifier for your platform:
+
+```ruby
+auto_discover.title('Hello').message('World!').notify!
+```
+
+### macOS
+
+#### terminal-notifier
+
+Requires [terminal-notifier](https://github.com/julienXX/terminal-notifier): `brew install terminal-notifier`
+
+```ruby
+terminal_notifier.title('Hello').message('World!').sound('default').notify!
+terminal_notifier.message('Click me').open('https://example.com').notify!
+```
+
+#### osascript (built-in)
+
+Uses AppleScript, no installation required:
+
+```ruby
+osascript.title('Hello').message('World!').sound('Glass').notify!
+osascript.title('Alert').subtitle('Status').message('Done!').notify!
+```
+
+### Linux / BSD
+
+#### notify-send
 
-### Growl
+Requires libnotify: `apt install libnotify-bin` or equivalent
 
-     growl.message('Hi Growl!').image('my_image.png').priority(2).name('my_app').notify!
+```ruby
+notify_send.title('Hello').message('World!').urgency(:critical).notify!
+notify_send.title('Alert').message('Check this').expire_time(5000).notify!
+```
 
-### Lib_Notify
+`lib_notify` is an alias for `notify_send`.
 
-     notify_send.image('my_image.png').message('Hi Growl').notify!
+#### dunstify
 
-<b>Obs.: #notify_send is an alias to #lib_notify .</b>
+Requires [dunst](https://dunst-project.org/): `apt install dunst` or equivalent
 
-### Knotify
+```ruby
+dunstify.title('Hello').message('World!').urgency(:low).notify!
+dunstify.title('Update').message('Progress').timeout(3000).notify!
+```
 
-     knotify.title('Hello World').message('Hi!').notify!
+## Supported Notifiers
 
-# Why I created this gem?
+| Notifier | Platform | Command | Installation |
+|----------|----------|---------|--------------|
+| `terminal_notifier` | macOS | `terminal-notifier` | `brew install terminal-notifier` |
+| `osascript` | macOS | `osascript` | Built-in |
+| `notify_send` | Linux/BSD | `notify-send` | `apt install libnotify-bin` |
+| `dunstify` | Linux/BSD | `dunstify` | `apt install dunst` |
 
-## Only one explanation:
+## License
 
-### Because is fun! =)
+MIT

data/TODO.markdown

@@ -1,2 +1,5 @@
+# TODO
 
-* Auto Discover the OS and notify as expected.
+* Add support for Windows notifications (powershell/toast)
+* Add notification icons/images support for all notifiers
+* Add callback/action support where available

data/lib/notifiers/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Notifiers
   class Base
     def self.inherited(subclass)
@@ -14,16 +16,20 @@ module Notifiers
       false
     end
 
-    def self.darwin?
-      platform?(/darwin/)
-    end
-
     def self.platform?(name)
       RbConfig::CONFIG['host_os'] =~ name or RUBY_PLATFORM =~ name
     end
 
     def self.command?(command)
-      `which #{command}` and $?.to_i.zero?
+      `which #{command}` and success_process_status?
+    end
+
+    def self.process?(process_name)
+      `ps -A #{process_name}` and success_process_status?
+    end
+
+    def self.success_process_status?
+      $?.to_i.zero?
     end
 
     def notify

data/lib/notifiers/dunstify.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Notifiers
+  class Dunstify < Notifiers::Base
+    COMMAND = 'dunstify'
+
+    def self.installed?
+      platform?(/(freebsd|linux)/) and command?(COMMAND)
+    end
+
+    def urgency(level)
+      @urgency = level.to_s
+      self
+    end
+
+    def timeout(milliseconds)
+      @timeout = milliseconds
+      self
+    end
+
+    def action(action_string)
+      @action = action_string
+      self
+    end
+
+    def replace(id)
+      @replace = id
+      self
+    end
+
+    def to_s
+      command = COMMAND.dup
+      command << " -u '#{@urgency}'" if @urgency
+      command << " -t '#{@timeout}'" if @timeout
+      command << " -i '#{@icon}'" if @icon
+      command << " -r '#{@replace}'" if @replace
+      command << " -A '#{@action}'" if @action
+      command << " '#{@title}'" if @title
+      command << " '#{@message}'" if @message
+      command
+    end
+
+    def install_instructions
+      'dunstify is not installed. Install dunst notification daemon for your distribution.'
+    end
+  end
+end

data/lib/notifiers/notifier_not_found.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Notifiers
   class NotifierNotFound < StandardError
   end

data/lib/notifiers/notify_send.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
 module Notifiers
   class NotifySend < Notifiers::Base
     COMMAND = 'notify-send'
 
+    def self.installed?
+      platform?(/(freebsd|linux)/) and command?(COMMAND)
+    end
+
     def urgency(level)
       @urgency = level.to_s
       self
@@ -13,22 +19,29 @@ module Notifiers
     end
 
     def hint(values)
-      @hint = values.collect.each { |element| element.to_s}.join(':')
+      @hint = values.collect.each { |element| element.to_s }.join(':')
+      self
+    end
+
+    def category(name)
+      @category = name
       self
     end
 
     def to_s
-      command = COMMAND.clone
-      [:hint, :priority, :icon, :urgency].each do |option|
-        variable = instance_variable_get("@#{option}")
-        command << " --#{option}=#{variable}" if variable
-      end
+      command = COMMAND.dup
+      command << " --urgency=#{@urgency}" if @urgency
       command << " --expire-time=#{@expire_time}" if @expire_time
-      [:title, :message].each do |option|
-        variable = instance_variable_get("@#{option}")
-        command << " '#{variable}'" if variable
-      end
+      command << " --icon=#{@icon}" if @icon
+      command << " --category=#{@category}" if @category
+      command << " --hint=#{@hint}" if @hint
+      command << " '#{@title}'" if @title
+      command << " '#{@message}'" if @message
       command
     end
+
+    def install_instructions
+      'notify-send is not installed. Install libnotify for your distribution.'
+    end
   end
 end

data/lib/notifiers/osascript.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Notifiers
+  # macOS native notifications using osascript (AppleScript).
+  #
+  # Note: The 'display notification' AppleScript command does not support
+  # custom images. The notification will display the application icon of the
+  # calling process (e.g., Terminal.app or Ruby). If you need custom image
+  # support on macOS, consider using terminal-notifier instead.
+  class Osascript < Notifiers::Base
+    def self.installed?
+      platform?(/darwin/) and command?('osascript')
+    end
+
+    # Override to warn that images are not supported by osascript.
+    def image(icon)
+      warn '[Notifiers::Osascript] Warning: Custom images are not supported ' \
+           'by osascript display notification. The image will be ignored. ' \
+           'Consider using terminal-notifier for image support.'
+      super
+    end
+
+    def subtitle(text)
+      @subtitle = text
+      self
+    end
+
+    def sound(name)
+      @sound = name
+      self
+    end
+
+    def to_s
+      script = 'display notification'.dup
+      script << " \"#{@message}\"" if @message
+      script << " with title \"#{@title}\"" if @title
+      script << " subtitle \"#{@subtitle}\"" if @subtitle
+      script << " sound name \"#{@sound}\"" if @sound
+
+      "osascript -e '#{script}'"
+    end
+
+    def install_instructions
+      ''
+    end
+  end
+end

data/lib/notifiers/terminal_notifier.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Notifiers
+  class TerminalNotifier < Notifiers::Base
+    COMMAND = 'terminal-notifier'
+
+    def self.installed?
+      platform?(/darwin/) and command?(COMMAND)
+    end
+
+    def sound(name)
+      @sound = name
+      self
+    end
+
+    def group(id)
+      @group = id
+      self
+    end
+
+    def open(url)
+      @open = url
+      self
+    end
+
+    def execute(command)
+      @execute = command
+      self
+    end
+
+    def to_s
+      command = COMMAND.dup
+      command << " -title '#{@title}'" if @title
+      command << " -message '#{@message}'" if @message
+      command << " -contentImage '#{@icon}'" if @icon
+      command << " -sound '#{@sound}'" if @sound
+      command << " -group '#{@group}'" if @group
+      command << " -open '#{@open}'" if @open
+      command << " -execute '#{@execute}'" if @execute
+      command
+    end
+
+    def install_instructions
+      'terminal-notifier is not installed. Install with: brew install terminal-notifier'
+    end
+  end
+end

data/lib/notifiers.rb

@@ -1,23 +1,29 @@
-[:base, :growl, :knotify, :notify_send, :notifier_not_found].each do |notifier|
+# frozen_string_literal: true
+
+%i[base terminal_notifier osascript notify_send dunstify notifier_not_found].each do |notifier|
   require "notifiers/#{notifier}"
 end
 
 module Notifiers
-  def growl
-    Growl.new
+  def terminal_notifier
+    TerminalNotifier.new
   end
 
-  def knotify
-    Knotify.new
+  def osascript
+    Osascript.new
   end
 
   def notify_send
     NotifySend.new
   end
-  alias :lib_notify :notify_send
+  alias lib_notify notify_send
+
+  def dunstify
+    Dunstify.new
+  end
 
   def auto_discover
-    notifier = Notifiers::Base.subclasses.find { |notifier| notifier.installed? } or raise NotifierNotFound
+    notifier = Notifiers::Base.subclasses.find(&:installed?) or raise NotifierNotFound
 
     notifier.new
   end

data/notifiers.gemspec

@@ -1,20 +1,21 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
   s.name        = "notifiers"
-  s.version     = '1.2.2'
+  s.version     = '2.0.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Tomás D'Stefano"]
   s.email       = ["tomasdestefi@gmail.com"]
-  s.homepage    = "http://rubygems.org/gems/notifiers"
-  s.summary     = "Use notifications in a simple and elegant way."
-  s.description = "Use Growl and Lib-Notify in a simple and clean way."
+  s.homepage    = "https://rubygems.org/gems/notifiers"
+  s.summary     = "Cross-platform desktop notifications for macOS and Linux."
+  s.description = "Send desktop notifications on macOS (terminal-notifier, osascript) and Linux (notify-send, dunstify) in a simple and clean way."
+  s.license     = "MIT"
 
-  s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project         = "notifiers"
+  s.required_ruby_version     = ">= 3.0"
+  s.required_rubygems_version = ">= 3.0"
 
-  s.add_development_dependency('rspec', "~> 2.14")
-  s.add_development_dependency('bundler', ">= 1.0.0")
+  s.add_development_dependency('rspec', "~> 3.13")
+  s.add_development_dependency('bundler', ">= 2.0")
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/spec/notifiers/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Notifiers
@@ -7,7 +9,7 @@ module Notifiers
     end
 
     describe '.subclasses' do
-      it { expect(Base.subclasses).to include(Growl, Knotify, NotifySend) }
+      it { expect(Base.subclasses).to include(TerminalNotifier, Osascript, NotifySend, Dunstify) }
     end
 
     describe '.installed?' do
@@ -16,22 +18,6 @@ module Notifiers
       end
     end
 
-    describe '.darwin?' do
-      context 'when the ruby platform is darwin' do
-        it 'returns true' do
-          expect(Base).to receive(:platform?).with(/darwin/).and_return(true)
-          expect(Base.darwin?).to be true
-        end
-      end
-
-      context 'when the ruby platform is not darwin' do
-        it 'returns false' do
-          expect(Base).to receive(:platform?).with(/darwin/).and_return(false)
-          expect(Base.darwin?).to be false
-        end
-      end
-    end
-
     describe '#notify' do
       before do
         expect(base).to receive(:to_s).and_return('example')

data/spec/notifiers/dunstify_spec.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Notifiers
+  describe Dunstify do
+    it_should_behave_like 'a notifier'
+
+    before do
+      @dunstify = dunstify
+    end
+
+    describe '.installed?' do
+      context 'when is linux or freebsd platform' do
+        before do
+          expect(Dunstify).to receive(:platform?).with(/(freebsd|linux)/).and_return(true)
+        end
+
+        context 'with dunstify installed' do
+          before do
+            expect(Dunstify).to receive(:command?).with('dunstify').and_return(true)
+          end
+
+          it 'returns true' do
+            expect(Dunstify).to be_installed
+          end
+        end
+
+        context 'without dunstify installed' do
+          before do
+            expect(Dunstify).to receive(:command?).with('dunstify').and_return(false)
+          end
+
+          it 'returns false' do
+            expect(Dunstify).to_not be_installed
+          end
+        end
+      end
+
+      context 'when is not linux or freebsd platform' do
+        before do
+          expect(Dunstify).to receive(:platform?).with(/(freebsd|linux)/).and_return(false)
+        end
+
+        it 'returns false' do
+          expect(Dunstify).to_not be_installed
+        end
+      end
+    end
+
+    describe '#image' do
+      it 'sets the icon' do
+        @dunstify.image('my_image.png')
+        expect(@dunstify.instance_variable_get(:@icon)).to eql 'my_image.png'
+      end
+    end
+
+    describe '#message' do
+      it 'sets the message' do
+        @dunstify.message('Hello World!')
+        expect(@dunstify.instance_variable_get(:@message)).to eql 'Hello World!'
+      end
+    end
+
+    describe '#title' do
+      it 'sets the title' do
+        @dunstify.title('My App')
+        expect(@dunstify.instance_variable_get(:@title)).to eql 'My App'
+      end
+    end
+
+    describe '#urgency' do
+      it 'sets the urgency to low' do
+        @dunstify.urgency(:low)
+        expect(@dunstify.instance_variable_get(:@urgency)).to eql 'low'
+      end
+
+      it 'sets the urgency to normal' do
+        @dunstify.urgency(:normal)
+        expect(@dunstify.instance_variable_get(:@urgency)).to eql 'normal'
+      end
+
+      it 'sets the urgency to critical' do
+        @dunstify.urgency(:critical)
+        expect(@dunstify.instance_variable_get(:@urgency)).to eql 'critical'
+      end
+    end
+
+    describe '#timeout' do
+      it 'sets the timeout' do
+        @dunstify.timeout(5000)
+        expect(@dunstify.instance_variable_get(:@timeout)).to eql 5000
+      end
+    end
+
+    describe '#action' do
+      it 'sets the action' do
+        @dunstify.action('open,Open File')
+        expect(@dunstify.instance_variable_get(:@action)).to eql 'open,Open File'
+      end
+    end
+
+    describe '#replace' do
+      it 'sets the replace id' do
+        @dunstify.replace(123)
+        expect(@dunstify.instance_variable_get(:@replace)).to eql 123
+      end
+    end
+
+    describe '#to_s' do
+      it 'constructs the command with title and message' do
+        command = @dunstify.title('Test').message('Hello World!').to_s
+        expect(command).to eql "dunstify 'Test' 'Hello World!'"
+      end
+
+      it 'constructs the command with urgency and timeout' do
+        command = @dunstify.title('Alert').message('Important').urgency(:critical).timeout(10000).to_s
+        expect(command).to eql "dunstify -u 'critical' -t '10000' 'Alert' 'Important'"
+      end
+
+      it 'constructs the command with icon' do
+        command = @dunstify.title('App').message('Done').image('icon.png').to_s
+        expect(command).to eql "dunstify -i 'icon.png' 'App' 'Done'"
+      end
+
+      it 'constructs the command with replace' do
+        command = @dunstify.title('Update').message('Progress').replace(42).to_s
+        expect(command).to eql "dunstify -r '42' 'Update' 'Progress'"
+      end
+
+      it 'constructs the command with action' do
+        command = @dunstify.title('File').message('Click to open').action('open,Open').to_s
+        expect(command).to eql "dunstify -A 'open,Open' 'File' 'Click to open'"
+      end
+    end
+
+    describe '#install_instructions' do
+      it 'returns installation instructions' do
+        expect(@dunstify.install_instructions).to eq 'dunstify is not installed. Install dunst notification daemon for your distribution.'
+      end
+    end
+  end
+end