nrser-notify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f8af4ec1d9676f261753ee852e09e94ae51e1ee
+  data.tar.gz: b1ca0c4d98d885846937897f007dc48d8a6633d9
+SHA512:
+  metadata.gz: cd1a2cdac6f40766d5bbdda8ceaedc2eee3d206d50c5f50091fb87f82ba580407251706420a62ba34163fcf413b6c876ecbf1f5de340f89934868ba6b1dd6fa9
+  data.tar.gz: a581d959136719b702babfaf0002d64613b910a5056b202003f9e6d74b0c23cd4a81e035d34afc082a5232039c07ea1e549151bc79f6a7a8f38ea9704bce62d2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 nrser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+nrser.rb-notify
+================================================================================
+
+TODO project description.

data/lib/nrser/log/plugins/notify.rb

@@ -0,0 +1,183 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Requirements
+# ========================================================================
+
+# Project / Package
+# ------------------------------------------------------------------------
+
+# Need {NRSER::Log::Plugin}
+require 'nrser/log/plugin'
+
+
+# Refinements
+# =======================================================================
+
+
+# Namespace
+# =======================================================================
+
+module  NRSER
+module  Log
+module  Plugins
+
+
+# Definitions
+# =======================================================================
+
+# 
+# 
+class Notify < NRSER::Log::Plugin
+  
+  @method_name = :notify
+  
+  
+  # Attributes
+  # ========================================================================
+  
+  # @return [#to_s]
+  #   The `:activate` option value.
+  attr_reader :activate
+  
+  
+  # @return [#to_s]
+  #   The `:open` option value.
+  attr_reader :open
+  
+  
+  # @return [#to_s]
+  #   The `:execute` option value.
+  attr_reader :execute
+  
+  
+  # @return [#to_s]
+  #   The `:sender` option value.
+  attr_reader :sender
+  
+  
+  # @return [#to_s]
+  #   The `:sound` option value.
+  attr_reader :sound
+  
+  
+  # Construction
+  # ========================================================================
+  
+  def initialize  logger,
+                  title: nil,
+                  subtitle: nil,
+                  group: nil,
+                  activate: nil,
+                  open: nil,
+                  execute: nil,
+                  sender: nil,
+                  sound: nil,
+                  icon: nil
+    super logger
+    @title = title
+    @subtitle = subtitle
+    @group = group
+    @activate = activate
+    @open = open
+    @execute = execute
+    @sender = sender
+    @sound = sound
+    @icon = icon
+  end
+  
+  
+  # Instance Methods
+  # ========================================================================
+  
+  def title level
+    @title || "#{ level.to_s.upcase } - #{ logger.name }"
+  end
+  
+  
+  def subtitle
+    @subtitle
+  end
+  
+  
+  def icon level
+    @icon || NRSER::Notify::ROOT / 'assets' / 'notify' / "#{ level }.png"
+  end
+  
+  
+  def group
+    return @group unless @group.nil?
+    
+    if SemanticLogger.application != 'Semantic Logger'
+      return SemanticLogger.application
+    end
+    
+    $0 # or Process.pid ?
+  end
+  
+  
+  # Get the options for {NRSER::Notify.notify} for a log call.
+  # 
+  # @note
+  #   Right now, {NRSER::Notify.notify} only supports [terminal-notifier][]
+  #   as a backend, and passes the options directly, so these are really the
+  #   options for {TerminalNotifier.notify}.
+  # 
+  # @return [Hash<Symbol, String>]
+  #   
+  def options level:, message:, payload:, exception:
+    {
+      title: title( level ),
+      subtitle: subtitle,
+      group: group,
+      activate: activate,
+      open: open,
+      execute: execute,
+      sender: sender,
+      sound: sound,
+      appIcon: icon( level ),
+    }.compact.transform_values &:to_s
+  end
+  
+  
+  # Handle a log call. Calls `super`, and if that indicates that the log was
+  # sent then dispatches the notification¹.
+  # 
+  # > ¹ Except for `trace` level log messages - we never notify of those.
+  # 
+  # @param (see NRSER::Log::Plugin#call)
+  # 
+  # @return [Boolean]
+  #   `true` if the log was sent (met level and not filtered).
+  # 
+  # def call level, message = nil, payload = nil, exception = nil, &block
+  def call level:, message:, payload:, exception:, metric:, &block
+    super.tap { |was_logged|
+      # TODO  Doesn't seem the return value *totally* represents if the log was
+      #       sent or not... there's some additional logic?
+      # 
+      # Also, we never notify for `trace` log messages regardless of log level.
+      # 
+      if level != :trace && was_logged
+        NRSER::Notify.notify \
+          message,
+          **options(
+            level: level,
+            message: message,
+            payload: payload,
+            exception: exception,
+          )
+      end
+    }
+  end # #call
+  
+end # class Notify
+
+
+# /Namespace
+# =======================================================================
+
+end # module Plugins
+end # module Log
+end # module NRSER

data/lib/nrser/notify/setup.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'nrser/notify'
+require 'nrser/log/plugins/notify'
+NRSER::Log::Logger.plugin NRSER::Log::Plugins::Notify

data/lib/nrser/notify/version.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+require 'pathname'
+
+
+# Namespace
+# =======================================================================
+
+module NRSER
+
+
+# Definitions
+# =======================================================================
+
+module Notify
+  
+  # Absolute, expanded path to the gem's root directory.
+  # 
+  # Here in `//lib/nrser/version` so that it can be used via
+  # 
+  #     require 'nrser/version'
+  # 
+  # without loading the entire module.
+  # 
+  # @return [Pathname]
+  # 
+  ROOT = (
+    Pathname.new( __FILE__ ).dirname / '..' / '..' / '..'
+  ).expand_path
+  
+  
+  # String version of the gem.
+  # 
+  # @return [String]
+  # 
+  VERSION = (ROOT / 'VERSION').read
+  
+end
+
+
+# /Namespace
+# =======================================================================
+
+end # module NRSER

data/lib/nrser/notify.rb

@@ -0,0 +1,95 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Need {NRSER::Log}, etc.
+require 'nrser'
+
+# Need {NRSER::LazyAttr} decorator.
+require 'nrser/meta/lazy_attr'
+
+require 'terminal-notifier'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+require_relative './notify/version'
+
+
+# Namespace
+# =======================================================================
+
+module NRSER
+
+
+# Definitions
+# =======================================================================
+
+module Notify
+  
+  +NRSER::LazyAttr
+  # Is the `terminal-notifier` gem available?
+  # 
+  # [terminal-notifier][] is not an NRSER dependency since it does not make
+  # sense for many systems and situations. It must be installed separately.
+  # 
+  # [terminal-notifier]: https://rubygems.org/gems/terminal-notifier
+  # 
+  # Tests by trying to `require` it.
+  # 
+  # @return [Boolean]
+  # 
+  def self.terminal_notifier?
+    begin
+      require 'terminal-notifier'
+    rescue LoadError => error
+      false
+    else
+      TerminalNotifier.available?
+    end
+  end # .terminal_notifier?
+  
+  
+  +NRSER::LazyAttr
+  # Can we send notification to the user?
+  # 
+  # Right now, only {.terminal_notifier?} is tested, but we can add more
+  # options in the future.
+  # 
+  # @return [Boolean]
+  # 
+  def self.available?
+    terminal_notifier?
+  end # .available?
+  
+  
+  # Send a notification to the use *if* notifications are {.available?}.
+  # 
+  def self.notify message, **options, &block
+    return false unless available?
+    notify! message, **options, &block
+  end
+  
+  
+  # Force sending of a notification regardless of {.available?}.
+  # 
+  def self.notify! message, **options, &block
+    require 'terminal-notifier'
+    TerminalNotifier.notify message, **options, &block
+  end
+  
+end
+
+
+# /Namespace
+# =======================================================================
+
+end # module NRSER

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: nrser-notify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nrser
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard-commonmarker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: nrser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 
+email:
+- neil@neilsouza.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- assets/notify/debug.png
+- assets/notify/error.png
+- assets/notify/info.png
+- assets/notify/warn.png
+- lib/nrser/log/plugins/notify.rb
+- lib/nrser/notify.rb
+- lib/nrser/notify/setup.rb
+- lib/nrser/notify/version.rb
+homepage: https://github.com/nrser/nrser.rb-notify
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+specification_version: 4
+summary: User notification support (OSX-only for now)
+test_files: []