notifiers 1.2.1 → 2.0.0

data/spec/notifiers/notify_send_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Notifiers
@@ -8,98 +10,154 @@ module Notifiers
       @notify_send = notify_send
     end
 
+    describe '.installed?' do
+      context 'when is linux or freebsd platform' do
+        before do
+          expect(NotifySend).to receive(:platform?).with(/(freebsd|linux)/).and_return(true)
+        end
+
+        context 'with notify-send installed' do
+          before do
+            expect(NotifySend).to receive(:command?).with('notify-send').and_return(true)
+          end
+
+          it 'returns true' do
+            expect(NotifySend).to be_installed
+          end
+        end
+
+        context 'without notify-send installed' do
+          before do
+            expect(NotifySend).to receive(:command?).with('notify-send').and_return(false)
+          end
+
+          it 'returns false' do
+            expect(NotifySend).to_not be_installed
+          end
+        end
+      end
+
+      context 'when is not linux or freebsd platform' do
+        before do
+          expect(NotifySend).to receive(:platform?).with(/(freebsd|linux)/).and_return(false)
+        end
+
+        it 'returns false' do
+          expect(NotifySend).to_not be_installed
+        end
+      end
+    end
+
     describe '#image' do
-      it "should set the image" do
+      it 'sets the image' do
         @notify_send.image('my_image.png')
         expect(@notify_send.instance_variable_get(:@icon)).to eql 'my_image.png'
       end
 
-      it "should set the icon option" do
+      it 'sets the icon option' do
         @notify_send.image('homer_simpson.png')
         expect(@notify_send.instance_variable_get(:@icon)).to eql 'homer_simpson.png'
       end
     end
 
     describe '#message' do
-      it "should set the message" do
+      it 'sets the message' do
         @notify_send.message('Oh Donuts!')
         expect(@notify_send.instance_variable_get(:@message)).to eql 'Oh Donuts!'
       end
 
-      it "should set the message option" do
+      it 'sets the message option' do
         @notify_send.message('Duff Beer')
         expect(@notify_send.instance_variable_get(:@message)).to eql 'Duff Beer'
       end
     end
 
     describe '#title' do
-      it "should set the title" do
+      it 'sets the title' do
         @notify_send.title('W00T!!')
         expect(@notify_send.instance_variable_get(:@title)).to eql 'W00T!!'
       end
 
-      it "should set a title as intance variable" do
+      it 'sets a title as instance variable' do
         @notify_send.title('Joker Owned Batman!')
         expect(@notify_send.instance_variable_get(:@title)).to eql 'Joker Owned Batman!'
       end
     end
 
     describe '#urgency' do
-      it "should set the urgency instance variable to low" do
+      it 'sets the urgency instance variable to low' do
         @notify_send.urgency(:low)
         expect(@notify_send.instance_variable_get(:@urgency)).to eql 'low'
       end
 
-      it "should set he urgency instance variable to normal" do
+      it 'sets the urgency instance variable to normal' do
         @notify_send.urgency(:normal)
         expect(@notify_send.instance_variable_get(:@urgency)).to eql 'normal'
       end
 
-      it "should set the urgency to critical" do
+      it 'sets the urgency to critical' do
         @notify_send.urgency(:critical)
         expect(@notify_send.instance_variable_get(:@urgency)).to eql 'critical'
       end
     end
 
     describe '#expire_time' do
-      it "should set the expire time" do
+      it 'sets the expire time' do
         @notify_send.expire_time(1000)
         expect(@notify_send.instance_variable_get(:@expire_time)).to eql 1000
       end
 
-      it "should set the expire time in miliseconds" do
+      it 'sets the expire time in milliseconds' do
         @notify_send.expire_time(2000)
         expect(@notify_send.instance_variable_get(:@expire_time)).to eql 2000
       end
     end
 
     describe '#hint' do
-      it "should set the hint" do
+      it 'sets the hint' do
         @notify_send.hint([:string, :me, :yeah])
         expect(@notify_send.instance_variable_get(:@hint)).to eql 'string:me:yeah'
       end
 
-      it "should set the hint in int" do
+      it 'sets the hint in int' do
         @notify_send.hint([:int, :me, 1])
         expect(@notify_send.instance_variable_get(:@hint)).to eql 'int:me:1'
       end
     end
 
+    describe '#category' do
+      it 'sets the category' do
+        @notify_send.category('email')
+        expect(@notify_send.instance_variable_get(:@category)).to eql 'email'
+      end
+    end
+
     describe '#to_s' do
-      it "should transform in a command" do
+      it 'transforms in a command' do
         command = @notify_send.title('Inception').message('3 levels').image('my_image.png').to_s
         expect(command).to eql "notify-send --icon=my_image.png 'Inception' '3 levels'"
       end
 
-      it "should transform in a command to execute" do
+      it 'transforms in a command with hint and expire_time' do
         command = @notify_send.title('Joker').message('Haha ha!').expire_time(1000).hint([:string, :me, :woot]).to_s
-        expect(command).to eql "notify-send --hint=string:me:woot --expire-time=1000 'Joker' 'Haha ha!'"
+        expect(command).to eql "notify-send --expire-time=1000 --hint=string:me:woot 'Joker' 'Haha ha!'"
       end
 
-      it "should transform in a command to execute" do
+      it 'transforms in a command with urgency' do
         command = @notify_send.title('Batman').urgency(:critical).to_s
         expect(command).to eql "notify-send --urgency=critical 'Batman'"
       end
+
+      it 'transforms in a command with category' do
+        command = @notify_send.title('Mail').message('New email').category('email').to_s
+        expect(command).to eql "notify-send --category=email 'Mail' 'New email'"
+      end
+    end
+
+    describe '#install_instructions' do
+      it 'returns installation instructions' do
+        expect(@notify_send.install_instructions).to eq 'notify-send is not installed. Install libnotify for your distribution.'
+      end
     end
   end
 end

data/spec/notifiers/osascript_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Notifiers
+  describe Osascript do
+    it_should_behave_like 'a notifier'
+
+    before do
+      @osascript = osascript
+    end
+
+    describe '.installed?' do
+      context 'when is darwin platform' do
+        before do
+          expect(Osascript).to receive(:platform?).with(/darwin/).and_return(true)
+        end
+
+        context 'with osascript installed' do
+          before do
+            expect(Osascript).to receive(:command?).with('osascript').and_return(true)
+          end
+
+          it 'returns true' do
+            expect(Osascript).to be_installed
+          end
+        end
+
+        context 'without osascript installed' do
+          before do
+            expect(Osascript).to receive(:command?).with('osascript').and_return(false)
+          end
+
+          it 'returns false' do
+            expect(Osascript).to_not be_installed
+          end
+        end
+      end
+
+      context 'when is not darwin platform' do
+        before do
+          expect(Osascript).to receive(:platform?).with(/darwin/).and_return(false)
+        end
+
+        it 'returns false' do
+          expect(Osascript).to_not be_installed
+        end
+      end
+    end
+
+    describe '#message' do
+      it 'sets the message' do
+        @osascript.message('Hello World!')
+        expect(@osascript.instance_variable_get(:@message)).to eql 'Hello World!'
+      end
+    end
+
+    describe '#title' do
+      it 'sets the title' do
+        @osascript.title('My App')
+        expect(@osascript.instance_variable_get(:@title)).to eql 'My App'
+      end
+    end
+
+    describe '#subtitle' do
+      it 'sets the subtitle' do
+        @osascript.subtitle('Additional info')
+        expect(@osascript.instance_variable_get(:@subtitle)).to eql 'Additional info'
+      end
+    end
+
+    describe '#sound' do
+      it 'sets the sound' do
+        @osascript.sound('default')
+        expect(@osascript.instance_variable_get(:@sound)).to eql 'default'
+      end
+
+      it 'sets a custom sound' do
+        @osascript.sound('Glass')
+        expect(@osascript.instance_variable_get(:@sound)).to eql 'Glass'
+      end
+    end
+
+    describe '#to_s' do
+      it 'constructs the command with message only' do
+        command = @osascript.message('Hello World!').to_s
+        expect(command).to eql "osascript -e 'display notification \"Hello World!\"'"
+      end
+
+      it 'constructs the command with title and message' do
+        command = @osascript.title('Test').message('Hello World!').to_s
+        expect(command).to eql "osascript -e 'display notification \"Hello World!\" with title \"Test\"'"
+      end
+
+      it 'constructs the command with subtitle' do
+        command = @osascript.title('Test').subtitle('Info').message('Hello').to_s
+        expect(command).to eql "osascript -e 'display notification \"Hello\" with title \"Test\" subtitle \"Info\"'"
+      end
+
+      it 'constructs the command with sound' do
+        command = @osascript.message('Alert').sound('Glass').to_s
+        expect(command).to eql "osascript -e 'display notification \"Alert\" sound name \"Glass\"'"
+      end
+
+      it 'constructs the full command' do
+        command = @osascript.title('App').subtitle('Status').message('Done').sound('default').to_s
+        expect(command).to eql "osascript -e 'display notification \"Done\" with title \"App\" subtitle \"Status\" sound name \"default\"'"
+      end
+    end
+
+    describe '#install_instructions' do
+      it 'returns empty string since osascript is built-in' do
+        expect(@osascript.install_instructions).to eq ''
+      end
+    end
+  end
+end

data/spec/notifiers/terminal_notifier_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Notifiers
+  describe TerminalNotifier do
+    it_should_behave_like 'a notifier'
+
+    before do
+      @terminal_notifier = terminal_notifier
+    end
+
+    describe '.installed?' do
+      context 'when is darwin platform' do
+        before do
+          expect(TerminalNotifier).to receive(:platform?).with(/darwin/).and_return(true)
+        end
+
+        context 'with terminal-notifier installed' do
+          before do
+            expect(TerminalNotifier).to receive(:command?).with('terminal-notifier').and_return(true)
+          end
+
+          it 'returns true' do
+            expect(TerminalNotifier).to be_installed
+          end
+        end
+
+        context 'without terminal-notifier installed' do
+          before do
+            expect(TerminalNotifier).to receive(:command?).with('terminal-notifier').and_return(false)
+          end
+
+          it 'returns false' do
+            expect(TerminalNotifier).to_not be_installed
+          end
+        end
+      end
+
+      context 'when is not darwin platform' do
+        before do
+          expect(TerminalNotifier).to receive(:platform?).with(/darwin/).and_return(false)
+        end
+
+        it 'returns false' do
+          expect(TerminalNotifier).to_not be_installed
+        end
+      end
+    end
+
+    describe '#image' do
+      it 'sets the icon' do
+        @terminal_notifier.image('my_image.png')
+        expect(@terminal_notifier.instance_variable_get(:@icon)).to eql 'my_image.png'
+      end
+    end
+
+    describe '#message' do
+      it 'sets the message' do
+        @terminal_notifier.message('Hello World!')
+        expect(@terminal_notifier.instance_variable_get(:@message)).to eql 'Hello World!'
+      end
+    end
+
+    describe '#title' do
+      it 'sets the title' do
+        @terminal_notifier.title('My App')
+        expect(@terminal_notifier.instance_variable_get(:@title)).to eql 'My App'
+      end
+    end
+
+    describe '#sound' do
+      it 'sets the sound' do
+        @terminal_notifier.sound('default')
+        expect(@terminal_notifier.instance_variable_get(:@sound)).to eql 'default'
+      end
+
+      it 'sets a custom sound' do
+        @terminal_notifier.sound('Ping')
+        expect(@terminal_notifier.instance_variable_get(:@sound)).to eql 'Ping'
+      end
+    end
+
+    describe '#group' do
+      it 'sets the group' do
+        @terminal_notifier.group('my-group')
+        expect(@terminal_notifier.instance_variable_get(:@group)).to eql 'my-group'
+      end
+    end
+
+    describe '#open' do
+      it 'sets the url to open' do
+        @terminal_notifier.open('https://example.com')
+        expect(@terminal_notifier.instance_variable_get(:@open)).to eql 'https://example.com'
+      end
+    end
+
+    describe '#execute' do
+      it 'sets the command to execute' do
+        @terminal_notifier.execute('open .')
+        expect(@terminal_notifier.instance_variable_get(:@execute)).to eql 'open .'
+      end
+    end
+
+    describe '#to_s' do
+      it 'constructs the command with title and message' do
+        command = @terminal_notifier.title('Test').message('Hello World!').to_s
+        expect(command).to eql "terminal-notifier -title 'Test' -message 'Hello World!'"
+      end
+
+      it 'constructs the command with image and sound' do
+        command = @terminal_notifier.message('Alert').image('icon.png').sound('default').to_s
+        expect(command).to eql "terminal-notifier -message 'Alert' -contentImage 'icon.png' -sound 'default'"
+      end
+
+      it 'constructs the command with group and open' do
+        command = @terminal_notifier.message('Click me').group('notifications').open('https://example.com').to_s
+        expect(command).to eql "terminal-notifier -message 'Click me' -group 'notifications' -open 'https://example.com'"
+      end
+
+      it 'constructs the command with execute' do
+        command = @terminal_notifier.message('Run').execute('open .').to_s
+        expect(command).to eql "terminal-notifier -message 'Run' -execute 'open .'"
+      end
+    end
+
+    describe '#install_instructions' do
+      it 'returns installation instructions' do
+        expect(@terminal_notifier.install_instructions).to eq 'terminal-notifier is not installed. Install with: brew install terminal-notifier'
+      end
+    end
+  end
+end

data/spec/notifiers_spec.rb

@@ -1,19 +1,23 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Notifiers do
-  it { expect(growl).to be_instance_of(Notifiers::Growl) }
+  it { expect(terminal_notifier).to be_instance_of(Notifiers::TerminalNotifier) }
 
-  it { expect(knotify).to be_instance_of(Notifiers::Knotify) }
+  it { expect(osascript).to be_instance_of(Notifiers::Osascript) }
 
   it { expect(notify_send).to be_instance_of(Notifiers::NotifySend) }
 
   it { expect(lib_notify).to be_instance_of(Notifiers::NotifySend) }
 
+  it { expect(dunstify).to be_instance_of(Notifiers::Dunstify) }
+
   describe '#auto_discover' do
     context 'when have a notifier library installed' do
       it 'returns the notifier' do
-        expect(Notifiers::Growl).to receive(:installed?).and_return(true)
-        expect(auto_discover).to be_instance_of(Notifiers::Growl)
+        expect(Notifiers::TerminalNotifier).to receive(:installed?).and_return(true)
+        expect(auto_discover).to be_instance_of(Notifiers::TerminalNotifier)
       end
     end
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'notifiers'
 

metadata

@@ -1,54 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: notifiers
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Tomás D'Stefano
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2026-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
-description: Use Growl and Lib-Notify in a simple and clean way.
+        version: '2.0'
+description: Send desktop notifications on macOS (terminal-notifier, osascript) and
+  Linux (notify-send, dunstify) in a simple and clean way.
 email:
 - tomasdestefi@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .infinity_test
-- .rspec
-- .travis.yml
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".infinity_test"
+- ".rspec"
 - Gemfile
 - History.markdown
 - README.markdown
@@ -56,38 +56,38 @@ files:
 - TODO.markdown
 - lib/notifiers.rb
 - lib/notifiers/base.rb
-- lib/notifiers/growl.rb
-- lib/notifiers/knotify.rb
+- lib/notifiers/dunstify.rb
 - lib/notifiers/notifier_not_found.rb
 - lib/notifiers/notify_send.rb
+- lib/notifiers/osascript.rb
+- lib/notifiers/terminal_notifier.rb
 - notifiers.gemspec
 - spec/notifiers/base_spec.rb
-- spec/notifiers/growl_spec.rb
-- spec/notifiers/knotify_spec.rb
+- spec/notifiers/dunstify_spec.rb
 - spec/notifiers/notify_send_spec.rb
+- spec/notifiers/osascript_spec.rb
+- spec/notifiers/terminal_notifier_spec.rb
 - spec/notifiers_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/notifiers
-licenses: []
+homepage: https://rubygems.org/gems/notifiers
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '3.0'
 requirements: []
-rubyforge_project: notifiers
-rubygems_version: 2.0.5
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Use notifications in a simple and elegant way.
+summary: Cross-platform desktop notifications for macOS and Linux.
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - jruby
-  - 2.0
-before_install:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
-script:
-  - bundle exec rspec

data/lib/notifiers/growl.rb

@@ -1,47 +0,0 @@
-module Notifiers
-  class Growl < Notifiers::Base
-    def self.installed?
-      darwin? and command?('growlnotify')
-    end
-
-    def image(icon)
-      @image = icon
-      self
-    end
-
-    def priority(number)
-      @priority = number
-      self
-    end
-
-    def host(hostname)
-      @host = hostname
-      self
-    end
-
-    def password(secret)
-      @password = secret
-      self
-    end
-
-    def auth(authentication)
-      @auth = authentication
-      self
-    end
-
-    def to_s
-      command = 'growlnotify'
-      command << " --title '#{@title}'" if @title
-      command << " --message '#{@message}'"
-      [:image, :priority, :host, :password, :auth].each do |option|
-        variable = instance_variable_get("@#{option}")
-        command << " --#{option} #{variable}" if variable
-      end
-      command
-    end
-
-    def install_instructions
-      'The Growl is not installed. You can find more details here: http://growl.info/downloads'
-    end
-  end
-end

data/lib/notifiers/knotify.rb

@@ -1,14 +0,0 @@
-module Notifiers
-  class Knotify < Notifiers::Base
-    COMMAND = "dcop knotify default notify eventname"
-
-    def to_s
-      command = "#{COMMAND}"
-      command << " '#{@title}'" if @title
-      command << " '#{@message}'" if @message
-      command << " '' ''"
-      command << " 12 1"
-      command
-    end
-  end
-end