notifaction 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9c48372819fc5caf672f85d8771cc8133c6db6f
-  data.tar.gz: 904d9e2f65ba36b8b7cc7630b6b1d9d2cbc9893d
+  metadata.gz: d0c8013e2cbee495ce3e2f6cd13af414292c32f1
+  data.tar.gz: cdf7f71f1a75ad3074352e236571ad6eb7a1ca10
 SHA512:
-  metadata.gz: f6cbf68833817f4f0d58bcf49e4f723ad3ed997425f8b587760ce3a84402dd4432fb3ebf6e93b2a066b5afe66e3d0d69e8b842298a6bff046e0184a927a9d937
-  data.tar.gz: 86eb64d5339ff7af1dddab00f9a2d962cfb498a9f4a6a7ae785551aa9f9e8174e962a1e36cfb4708a4a0a8f711930aba76ee655aeb9b91ff9c3aab97741181e9
+  metadata.gz: b0ba2be5cecd9be5798f0ae4d94d11f2399c7559fc62e5364cda360748794922900f6f59feba335805aa7c1f5c358aa4a003f59c22921b389aa2a2efbf1237c3
+  data.tar.gz: bf3ef1b2ecd318ecd4fd6e9eee50f590d4c27519288d48de150ca3e3f510737ba7388d3aa230e85899d1bce16e1fb25ab4a05e6c53442b918c441f20d8422021

data/lib/notifaction.rb

@@ -1,6 +1,7 @@
 require "time"
 require "rbconfig"
 
+require "notifaction/helpers"
 require "notifaction/type"
 require "notifaction/types/linux"
 require "notifaction/types/osx"

data/lib/notifaction/config.rb

@@ -4,8 +4,10 @@ module Notifaction
   class Cfg
     attr_reader :hooks, :conf
 
+    #
+    # @since 0.4.0
     def initialize
-      conf = YAML::load(File.open(Dir.home + '/.notifaction.yml'))
+      conf = YAML.load(File.open(Dir.home + "/.notifaction.yml"))
 
       @hooks = conf["hooks"] || []
       @conf = conf["config"] || {}

data/lib/notifaction/helpers.rb

@@ -0,0 +1,20 @@
+module Notifaction
+  module Helpers
+    # Alert the user that the method they've called is not supported
+    # @since 0.4.1
+    def deprecation_notice(version, config = {})
+      handler = Notifaction::Type::Terminal.new
+      handler.warning(
+        "Deprecated as of #{version}, current #{Notifaction::VERSION}",
+        config
+      )
+      handler.quit_soft
+    end
+
+    # Should method exit with Type::QUIT?  Mainly used in tests
+    # @since 0.4.1
+    def auto_quit_enabled?(config, user_conf)
+      config[:auto_quit] == false || user_conf.conf["auto_quit"] == false
+    end
+  end
+end

data/lib/notifaction/notify.rb

@@ -1,5 +1,8 @@
 class Notify
+  extend Notifaction::Helpers
+
   # Display a notification bubble
+  # @since 0.1.0
   def self.bubble(message, title)
     if Utils.os == :macosx
       handler = Notifaction::Type::OSX.new
@@ -8,9 +11,11 @@ class Notify
     end
 
     handler.bubble(message, title)
-    handler.quit
+    handler.quit_ok
   end
 
+  # Display a modal popup with a close button
+  # @since 0.1.0
   def self.modal(message, title)
     if Utils.os == :macosx
       handler = Notifaction::Type::OSX.new
@@ -19,92 +24,56 @@ class Notify
     end
 
     handler.modal(message, title)
-    handler.quit
+    handler.quit_ok
   end
 
   # Prints a pre-formatted error message to the console
+  # @since 0.1.0
   def self.error(message, config = {})
     handler = Notifaction::Type::Terminal.new
     handler.error(message, config)
-    handler.quit unless self.auto_quit_enabled(config, handler.user_conf)
+    handler.quit unless auto_quit_enabled?(config, handler.user_conf)
   end
 
   # Prints a pre-formatted warning message to the console
+  # @since 0.1.0
   def self.warning(message, config = {})
     handler = Notifaction::Type::Terminal.new
     handler.warning(message, config)
   end
 
   # Prints a pre-formatted informational message to the console
+  # @since 0.1.0
   def self.info(message, config = {})
     handler = Notifaction::Type::Terminal.new
     handler.info(message, config)
   end
 
   # Prints a pre-formatted secondary informational message to the console
-  def self.sinfo(message, config = {})
-    handler = Notifaction::Type::Terminal.new
-    handler.note(message, config)
-  end
-
+  # @since 0.2.0
   def self.note(message, config = {})
     handler = Notifaction::Type::Terminal.new
     handler.note(message, config)
   end
 
   # Prints a pre-formatted success message to the console
+  # @since 0.1.0
   def self.success(message, config = {})
     handler = Notifaction::Type::Terminal.new
     handler.success(message, config)
   end
 
   # Prints a pre-formatted unstyled message to the console
+  # @since 0.1.0
   def self.spit(message, config = {})
     handler = Notifaction::Type::Terminal.new
     handler.spit(message, config)
   end
 
-  # Send status updates to WorkingOn
-  def self.workingon(message, print_info_message = false)
-    self.deprecation_notice("0.3.0")
-  end
-
   # pretty-print a spacer
+  # @since 0.1.0
   def self.spacer(config = {})
     handler = Notifaction::Type::Terminal.new
     handler.spacer(config)
   end
-
-  def self.configure
-    self.deprecation_notice("0.3.0")
-
-    yield self if block_given?
-  end
-
-  def self.print_output
-    true
-  end
-
-  def self.print_timestamps
-    true
-  end
-
-  # register new plugins
-  def self.plugins=(plugin_config_arr)
-    self.deprecation_notice("0.3.0")
-  end
-
-  private_class_method
-
-  #
-  # @since 0.2.8
-  def deprecation_notice(version)
-    puts "Deprecated as of #{version}, current #{Notifaction::VERSION}"
-  end
-
-  #
-  # @since 0.3.0
-  def self.auto_quit_enabled(config, user_conf)
-    config[:auto_quit] == false || user_conf.conf["auto_quit"] == false
-  end
 end

data/lib/notifaction/style.rb

@@ -1,25 +1,32 @@
 module Notifaction
-  module Style
-    @map = {
-      colour: {
-        red: 31,
-        green: 32,
-        yellow: 33,
-        blue: 34,
-        magenta: 35,
-        cyan: 36,
-        white: 37,
-        null: 0
-      },
-      style: {
-        reset: 0,
-        bold: 1,
-        underline: 4,
-        normal: ""
+  class Style
+    # Create the map hash
+    # @since 0.4.1
+    def initialize
+      @map = {
+        colour: {
+          red: 31,
+          green: 32,
+          yellow: 33,
+          blue: 34,
+          magenta: 35,
+          cyan: 36,
+          white: 37,
+          null: 0
+        },
+        style: {
+          reset: 0,
+          bold: 1,
+          underline: 4,
+          normal: ""
+        }
       }
-    }
+    end
 
-    def self.format(message, colour = nil, style = nil)
+    # Return an ASCII-formatted string for display in common command line
+    # terminals
+    # @since 0.0.1
+    def format(message, colour = nil, style = nil)
       c = @map[:colour][colour.to_sym] unless colour.nil?
 
       if style.nil?

data/lib/notifaction/type.rb

@@ -1,3 +1,4 @@
+require "notifaction/style"
 require "net/http"
 require "uri"
 
@@ -6,22 +7,44 @@ module Notifaction
     class Base
       attr_reader :user_conf
 
+      # Exit code to indicate everything is ok!
+      OK = 0
+      # Exit code to indicate a force quit (exit) call, meaning the program
+      # quit with an error
+      QUIT = 1
+      # Exit code to indicate that the program exited with a non-zero exit code,
+      # but not one that resulted in a force quit
+      QUIT_SOFT = 2
+
       #
       # @since 0.3.0.1
       def initialize
         @user_conf = Notifaction::Cfg.new
+        @style = Notifaction::Style.new
       end
 
       #
       # @since 0.2.8
-      def deprecation_notice(version)
-        puts "Deprecated as of #{version}, current #{Notifaction::VERSION}"
+      def quit
+        exit(QUIT)
       end
 
       #
-      # @since 0.2.8
-      def quit
-        exit
+      # @since 0.4.1
+      def quit_soft
+        QUIT_SOFT
+      end
+
+      #
+      # @since 0.4.1
+      def ok
+        OK
+      end
+
+      #
+      # @since 0.4.1
+      def quit_ok
+        exit(OK)
       end
 
       #

data/lib/notifaction/types/linux.rb

@@ -1,6 +1,8 @@
 module Notifaction
   module Type
     class Linux < Type::Base
+      #
+      # @since 0.1.0
       def bubble(message, title)
         @response = `notify-send "#{title}" "#{message}"`
         $?.exitstatus == 0
@@ -8,6 +10,8 @@ module Notifaction
         fire_hooks({ method: __method__, message: message, title: title })
       end
 
+      #
+      # @since 0.1.0
       def modal(message, title)
         nil
       end

data/lib/notifaction/types/osx.rb

@@ -1,18 +1,30 @@
 module Notifaction
   module Type
     class OSX < Type::Base
+      #
+      # @since 0.1.0
       def bubble(message, title)
         @response = `osascript -e 'display notification "#{message}" with title "#{title}"'`
         $?.exitstatus == 0
 
-        fire_hooks(method: __method__, message: message, title: title)
+        if fire_hooks(method: __method__, message: message, title: title)
+          quit_ok
+        else
+          quit_soft
+        end
       end
 
+      #
+      # @since 0.1.0
       def modal(message, title, icon = :caution)
         @response = `osascript -e 'tell app "System Events" to display dialog "#{message}" buttons {"OK"} default button 1 with title "#{title}" with icon #{icon}'`
         $?.exitstatus == 0
 
-        fire_hooks(method: __method__, message: message, title: title)
+        if fire_hooks(method: __method__, message: message, title: title)
+          quit_ok
+        else
+          quit_soft
+        end
       end
     end
   end

data/lib/notifaction/types/terminal.rb

@@ -1,5 +1,3 @@
-require "notifaction/style"
-
 module Notifaction
   module Type
     class Terminal < Type::Base
@@ -74,21 +72,29 @@ module Notifaction
           message = "#{config[:symbol]} #{message}" if show_symbol(config)
         end
 
-        puts Style.format(message, colour, style) unless show_message(config)
-
-        fire_hooks(method: __method__, message: message, config: config)
+        puts @style.format(message, colour, style) unless show_message(config)
 
-        true
+        if fire_hooks(method: __method__, message: message, config: config)
+          ok
+        else
+          soft_quit
+        end
       end
 
+      #
+      # @since 0.4.0
       def show_symbol(config)
         config[:symbol] || config[:fancy] || @user_conf.conf["fancy"] == true
       end
 
+      #
+      # @since 0.4.0
       def show_time(config)
         config[:show_time] || @user_conf.conf["show_time"]
       end
 
+      #
+      # @since 0.4.0
       def show_message(config)
         config[:print] == false || @user_conf.conf["print"] == false
       end

data/lib/notifaction/utils.rb

@@ -1,5 +1,8 @@
 module Notifaction
   class Utils
+    # Returns a formatted time string
+    # Used, mainly, for printing timestamps next to terminal output
+    # @since 0.0.1
     def self.formatted_time(time = nil)
       if time.nil?
         time = Time.now
@@ -8,6 +11,8 @@ module Notifaction
       time.strftime("%e/%-m/%Y @ %I:%M:%S%P")
     end
 
+    # Determine the current OS
+    # @since 0.0.1
     def self.os
       host_os = RbConfig::CONFIG['host_os']
 

data/lib/notifaction/version.rb

@@ -1,3 +1,3 @@
 module Notifaction
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifaction
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Яyan Priebe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - bin/setup
 - lib/notifaction.rb
 - lib/notifaction/config.rb
+- lib/notifaction/helpers.rb
 - lib/notifaction/notify.rb
 - lib/notifaction/style.rb
 - lib/notifaction/type.rb