libnotify 0.8.0 → 0.8.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82a615e051a8e0dba67bdf342658f77916da91a5
+  data.tar.gz: 12fb683c69feb30e8566205c011a88ec18769f11
+SHA512:
+  metadata.gz: d5d6f9d9ce4d443b8a213f7836b5ef95f48d3f5c53ea41995b812d317a881a495418748d7697e2fc2ab46849c0a037a1269d74883a162d501758f54164e2e59d
+  data.tar.gz: 08c63a7b19b8cd9e000b7106f6c7d64326c837bc2719d65a85968409c98634ab87457ca27cbbfeb759c934648fde4fe6ca9aac56d7e413020752e2415c6ae975

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.simplecov

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - ree
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  #- rbx-19mode
+before_install:
+  - "sudo apt-get install libnotify4"

data/README.rdoc

@@ -1,5 +1,7 @@
 = Libnotify
 
+{<img src="https://travis-ci.org/splattael/libnotify.png?branch=master" alt="Build Status" />}[https://travis-ci.org/splattael/libnotify] {<img src="https://badge.fury.io/rb/libnotify.png" alt="Gem Version" />}[http://badge.fury.io/rb/libnotify] {<img src="https://codeclimate.com/github/splattael/libnotify.png" />}[https://codeclimate.com/github/splattael/libnotify]
+
 Ruby bindings for libnotify using FFI.
 
 Gem[https://rubygems.org/gems/libnotify] |
@@ -64,6 +66,16 @@ You'll need libnotify. On Debian just type:
   bundle install
   rake
 
+=== Code coverage
+
+  COVERAGE=1 rake
+
+== Caveats
+
+* +timeout+ and +append+ options might not work on Ubuntu.
+  See GH #21 for details.
+  https://github.com/splattael/libnotify/issues/21#issuecomment-19114127
+
 == Authors
 
 * Peter Suschlik (https://github.com/splattael)

data/Rakefile

@@ -11,7 +11,7 @@ desc 'Default: run unit tests.'
 task :default => :test
 
 Rake::TestTask.new(:test) do |test|
-  test.test_files = FileList.new('test/test_*.rb')
+  test.test_files = FileList.new('test/**/*_test.rb')
   test.libs << 'test'
   test.verbose = true
 end

data/lib/libnotify/api.rb

@@ -1,4 +1,5 @@
 require 'libnotify/ffi'
+require 'libnotify/icon_finder'
 
 module Libnotify
   # API for Libnotify
@@ -20,23 +21,6 @@ module Libnotify
       "/usr/share/icons/gnome/*/emotes"
     ]
 
-    # TODO refactor & test!
-    ICON_REGEX = /(\d+)x\d/
-    ICON_SORTER = proc do |a, b|
-      ma = a.scan ICON_REGEX
-      mb = b.scan ICON_REGEX
-
-      if ma.first && mb.first
-        mb.first.first.to_i <=> ma.first.first.to_i
-      elsif ma.first && !mb.first
-        1
-      elsif !ma.first && ma.first
-        -1
-      else
-        a <=> b
-      end
-    end
-
     # Creates a notification object.
     #
     # @see Libnotify.new
@@ -100,7 +84,6 @@ module Libnotify
     def timeout=(timeout)
       @timeout = case timeout
       when Float
-        timeout /= 10 if RUBY_VERSION == "1.8.6" # Strange workaround?
         (timeout * 1000).to_i
       when Fixnum
         if timeout >= 100 # assume miliseconds
@@ -117,16 +100,15 @@ module Libnotify
 
     # Sets icon path.
     #
-    # Path can be absolute, relative (will be resolved) or an symbol.
+    # Path can be absolute, relative (will be resolved) or a symbol.
     #
     # @todo document and refactor
     def icon_path=(path)
       case path
-      when /^\// # absolute
+      when %r{^/} # absolute
         @icon_path = path
       when String
-        list = self.class.icon_dirs.map { |d| Dir[File.join(d, path)] }.flatten.sort(&ICON_SORTER)
-        @icon_path = list.detect { |full_path| File.exist?(full_path) } || path
+        @icon_path = icon_for(path)
       when Symbol
         self.icon_path = "#{path}.png"
       else
@@ -142,5 +124,10 @@ module Libnotify
       new(options, &block).show!
     end
 
+    private
+
+    def icon_for(name)
+      IconFinder.new(self.class.icon_dirs).icon_path(name) || name
+    end
   end
 end

data/lib/libnotify/icon_finder.rb

@@ -0,0 +1,42 @@
+module Libnotify
+  class IconFinder
+    def initialize(dirs)
+      @dirs = dirs
+    end
+
+    def icon_path(name)
+      list = @dirs.map do |dir|
+        glob = File.join(dir, name)
+        Dir[glob].map { |fullpath| Icon.new(fullpath) }
+      end
+      if found = list.flatten.sort.first
+        found.to_s
+      end
+    end
+
+    private
+
+    class Icon
+      attr_reader :fullpath
+
+      def initialize(fullpath)
+        @fullpath = fullpath
+      end
+
+      ICON_REGEX = /(\d+)x\d+/
+      def resolution
+        @resolution ||= @fullpath[ICON_REGEX, 1].to_i
+      end
+
+      def to_s
+        fullpath
+      end
+
+      def <=>(other)
+        result = other.resolution <=> self.resolution
+        result = self.fullpath    <=> other.fullpath if result == 0
+        result
+      end
+    end
+  end
+end

data/lib/libnotify/tasks/rubies.rake

@@ -1,4 +1,4 @@
-SUPPORTED_RUBIES = %w[ree 1.9.2 1.9.3 jruby rbx]
+SUPPORTED_RUBIES = %w[ree 1.9.3 2.0.0 jruby rbx]
 GEMSPEC = Bundler::GemHelper.new(Dir.pwd).gemspec
 
 def with_ruby(ruby, command)
@@ -15,7 +15,7 @@ end
 namespace :rubies do
   desc "Run tests for following supported platforms #{SUPPORTED_RUBIES.join ", "}"
   task :test do
-    command = "(bundle check || bundle install) && bundle exec rake"
+    command = "rm -f Gemfile.lock && bundle install && bundle exec rake"
     SUPPORTED_RUBIES.each { |ruby| with_ruby(ruby, command) }
   end
 end

data/lib/libnotify/version.rb

@@ -1,3 +1,3 @@
 module Libnotify
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/libnotify.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'ffi', '>= 1.0.11'
 
-  s.add_development_dependency 'yard', '>= 0.8.2'
-  s.add_development_dependency 'minitest', '>= 3.1.0'
-  s.add_development_dependency 'minitest-libnotify', '>= 0.2.2'
+  s.add_development_dependency 'yard', '~> 0.8.6.1'
+  s.add_development_dependency 'minitest', '~> 4.7.4'
+  s.add_development_dependency 'minitest-libnotify', '~> 0.2.2'
+  s.add_development_dependency 'simplecov'
 end

data/test/helper.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'simplecov' if ENV['COVERAGE'] == '1'
+
 require 'minitest/autorun'
 require 'minitest/libnotify'
 
@@ -24,6 +26,10 @@ module LibnotifyAssertions
       assert_equal expected, got, message
     end
   end
+
+  def fixture_file(path)
+    File.expand_path(File.join(File.dirname(__FILE__), "fixtures", path))
+  end
 end
 
 class LibnotifyTestCase < MiniTest::Spec
@@ -32,6 +38,8 @@ class LibnotifyTestCase < MiniTest::Spec
   class << self
     alias :test :it
     alias :context :describe
+    alias :setup :before
+    alias :teardown :after
   end
 
   def libnotify(options={}, &block)

data/test/integration_test.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class IntegrationTest < LibnotifyTestCase
+  test "display notification" do
+    libnotify = Libnotify::API.new(:timeout => 0.5, :icon_path => :"emblem-favorite", :append => true)
+
+    [ :low, :normal, :critical ].each do |urgency|
+      libnotify.summary = "#{RUBY_VERSION} at #{RUBY_PLATFORM}"
+      libnotify.body    = [ urgency, defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : '?' ].join(" ")
+      libnotify.urgency = urgency
+      libnotify.show!
+    end
+  end
+end

data/test/libnotify/api_test.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+class LibnotifyAPITest < LibnotifyTestCase
+  test "instance default values" do
+    assert_equal " ",     libnotify.summary
+    assert_equal " ",     libnotify.body
+    assert_equal :normal, libnotify.urgency
+    assert_nil            libnotify.timeout
+    assert_nil            libnotify.icon_path
+    assert                libnotify.append
+    refute                libnotify.transient
+  end
+
+  test "instance with options and block" do
+    libnotify(:summary => "hello", :body => "body", :invalid_option => 23) do |n|
+      n.body      = "overwritten"
+      n.icon_path = "/path/to/icon"
+      n.append    = false
+      n.transient = true
+    end
+
+    assert_equal "hello",         libnotify.summary
+    assert_equal "overwritten",   libnotify.body
+    assert_equal "/path/to/icon", libnotify.icon_path
+    refute                        libnotify.append
+    assert                        libnotify.transient
+  end
+
+  test "timeout=" do
+    assert_timeout 2500,  2.5,    "with float"
+    assert_timeout 100,   100,    "with fixnum ms"
+    assert_timeout 101,   101,    "with fixnum ms"
+    assert_timeout 1000,  1,      "with fixnum seconds"
+    assert_timeout 99000, 99,     "with fixnum seconds"
+    assert_timeout nil,   nil,    "with nil"
+    assert_timeout nil,   false,  "with false"
+    assert_timeout 2,     :"2 s", "with to_s.to_i"
+  end
+
+  test "icon_path=" do
+    Libnotify::API.icon_dirs << File.expand_path("../../..", __FILE__)
+    assert_icon_path "/some/path/image.jpg",  "/some/path/image.jpg",   "with absolute path"
+    assert_icon_path "some-invalid-path.jpg", "some-invalid-path.jpg",  "with non-existant relative path"
+    assert_icon_path %r{^/.*/libnotify.png},  "libnotify.png",          "with relative path"
+    assert_icon_path %r{^/.*/libnotify.png},  :"libnotify",             "with symbol"
+  end
+
+  test "update" do
+    libnotify(:summary => "hello", :body => "world").show!
+    libnotify.update(:summary => "hell") do |n|
+      n.body = "yeah"
+    end
+    assert_equal "hell", libnotify.summary
+    assert_equal "yeah", libnotify.body
+    libnotify.close
+  end
+end

data/test/libnotify/icon_finder_test.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+require 'fileutils'
+
+class LibnotifyIconFinderTest < LibnotifyTestCase
+  test "find icon with highest resolution" do
+    dir = fixture_file("/icons/*")
+    assert_icon_path [ dir ], "/icons/128x128/happy.jpg", "happy.jpg"
+  end
+
+  test "search all provided dirs" do
+    dirs = [ fixture_file("/icons/*"), fixture_file("/emoticons/*") ]
+
+    assert_icon_path dirs, "/emoticons/128x128/happy.jpg", "happy.jpg"
+  end
+
+  test "does not find unknown icons" do
+    dir = fixture_file("/icons/*")
+    refute icon_finder([ dir ]).icon_path("unknown.jpg")
+  end
+
+  test "does not find known icon in unknown dirs" do
+    dir = fixture_file("/unknown/*")
+    refute icon_finder([ dir ]).icon_path("happy.jpg")
+  end
+
+  test "find icon alphabetically w/o resolution" do
+    dir = fixture_file("/images/*")
+    assert_icon_path [ dir ], "/images/another/happy.jpg", "happy.jpg"
+  end
+
+  private
+
+  def icon_finder(*dirs)
+    Libnotify::IconFinder.new(dirs)
+  end
+
+  def assert_icon_path(dirs, expected, name)
+    assert_equal fixture_file(expected), icon_finder(*dirs).icon_path(name)
+  end
+end

data/test/libnotify_test.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+class LibnotifyTest < LibnotifyTestCase
+  test "responds to new" do
+    assert_respond_to Libnotify, :new
+  end
+
+  test "responds to show" do
+    assert_respond_to Libnotify, :show
+  end
+
+  test "has version" do
+    assert defined?(Libnotify::VERSION), "version is defined"
+    assert Libnotify::VERSION
+  end
+end

metadata

@@ -1,80 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: libnotify
 version: !ruby/object:Gem::Version
-  version: 0.8.0
-  prerelease: 
+  version: 0.8.1
 platform: ruby
 authors:
 - Peter Suschlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.11
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 0.8.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 0.8.6.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.7.4
 - !ruby/object:Gem::Dependency
   name: minitest-libnotify
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - peter-libnotify@suschlik.de
@@ -83,7 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
+- .ruby-version
+- .simplecov
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -91,41 +98,46 @@ files:
 - lib/libnotify.rb
 - lib/libnotify/api.rb
 - lib/libnotify/ffi.rb
+- lib/libnotify/icon_finder.rb
 - lib/libnotify/tasks/rubies.rake
 - lib/libnotify/version.rb
 - libnotify.gemspec
 - libnotify.png
+- test/fixtures/.keep
+- test/fixtures/emoticons/128x128/happy.jpg
+- test/fixtures/icons/128x128/happy.jpg
+- test/fixtures/icons/16x16/happy.jpg
+- test/fixtures/icons/32x32/happy.jpg
+- test/fixtures/icons/other/happy.jpg
+- test/fixtures/images/another/happy.jpg
+- test/fixtures/images/other/happy.jpg
 - test/helper.rb
-- test/test_libnotify.rb
+- test/integration_test.rb
+- test/libnotify/api_test.rb
+- test/libnotify/icon_finder_test.rb
+- test/libnotify_test.rb
 homepage: http://rubygems.org/gems/libnotify
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3247068429593286265
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3247068429593286265
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings for libnotify using FFI
 test_files: []
 has_rdoc: 

data/.rvmrc

@@ -1 +0,0 @@
-rvm @libnotify --create

data/test/test_libnotify.rb

@@ -1,87 +0,0 @@
-require 'helper'
-
-class TestLibnotify < LibnotifyTestCase
-  context Libnotify do
-    test "responds to new" do
-      assert_respond_to Libnotify, :new
-    end
-
-    test "responds to show" do
-      assert_respond_to Libnotify, :show
-    end
-
-    test "has version" do
-      assert defined?(Libnotify::VERSION), "version is defined"
-      assert Libnotify::VERSION
-    end
-  end
-
-  context Libnotify::API do
-    test "instance default values" do
-      assert_equal " ",     libnotify.summary
-      assert_equal " ",     libnotify.body
-      assert_equal :normal, libnotify.urgency
-      assert_nil            libnotify.timeout
-      assert_nil            libnotify.icon_path
-      assert                libnotify.append
-      refute                libnotify.transient
-    end
-
-    test "instance with options and block" do
-      libnotify(:summary => "hello", :body => "body", :invalid_option => 23) do |n|
-        n.body      = "overwritten"
-        n.icon_path = "/path/to/icon"
-        n.append    = false
-        n.transient = true
-      end
-
-      assert_equal "hello",         libnotify.summary
-      assert_equal "overwritten",   libnotify.body
-      assert_equal "/path/to/icon", libnotify.icon_path
-      refute                        libnotify.append
-      assert                        libnotify.transient
-    end
-
-    test "timeout=" do
-      assert_timeout 2500,  2.5,    "with float"
-      assert_timeout 100,   100,    "with fixnum ms"
-      assert_timeout 101,   101,    "with fixnum ms"
-      assert_timeout 1000,  1,      "with fixnum seconds"
-      assert_timeout 99000, 99,     "with fixnum seconds"
-      assert_timeout nil,   nil,    "with nil"
-      assert_timeout nil,   false,  "with false"
-      assert_timeout 2,     :"2 s", "with to_s.to_i"
-    end
-
-    test "icon_path=" do
-      Libnotify::API.icon_dirs << File.expand_path("../..", __FILE__)
-      assert_icon_path "/some/path/image.jpg",  "/some/path/image.jpg",   "with absolute path"
-      assert_icon_path "some-invalid-path.jpg", "some-invalid-path.jpg",  "with non-existant relative path"
-      assert_icon_path %r{^/.*/libnotify.png},  "libnotify.png",          "with relative path"
-      assert_icon_path %r{^/.*/libnotify.png},  :"libnotify",             "with symbol"
-    end
-
-    test "update" do
-      libnotify(:summary => "hello", :body => "world").show!
-      libnotify.update(:summary => "hell") do |n|
-        n.body = "yeah"
-      end
-      assert_equal "hell", libnotify.summary
-      assert_equal "yeah", libnotify.body
-      libnotify.close
-    end
-  end
-
-  context "integration" do
-    test "works" do
-      libnotify = Libnotify::API.new(:timeout => 0.5, :icon_path => :"emblem-favorite", :append => true)
-
-      [ :low, :normal, :critical ].each do |urgency|
-        libnotify.summary = "#{RUBY_VERSION} at #{RUBY_PLATFORM}"
-        libnotify.body    = [ urgency, defined?(RUBY_DESCRIPTION) ? RUBY_DESCRIPTION : '?' ].join(" ")
-        libnotify.urgency = urgency
-        libnotify.show!
-      end
-    end
-  end
-end