kvetch 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a413670a96d7d94f2e2c9a7bebbc6b078b7f309c
+  data.tar.gz: a35e524fbfe01ed6456f959890b10bf5ea0f30c3
+SHA512:
+  metadata.gz: 6a4b8915c60ad558afb8cb7c1bd63e0f85a519de1573868768ca03e3b4c1a070d0843a0561dd8481d13d44cd2d1e0a71859b33e33e56ddf7aeb5ee53c5eb3a38
+  data.tar.gz: d398da8d19819d9180ca7c2666cbdee9c517a3fd6b892b4c5567e8e88dc1f07a1762de419cbf531248d5a5360899c07ae35ac455d9b0ae184a1c3d402940e02d

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/terminal-notifier"]
+	path = vendor/terminal-notifier
+	url = https://github.com/JacksonGariety/terminal-notifier.git

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jackson Gariety
+
+MIT License
+
+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,45 @@
+# Kvetch
+[![Gem Version](https://badge.fury.io/rb/kvetch.png)](http://badge.fury.io/rb/kvetch)
+
+A Ruby logger that uses native Mac/Linux notifications.
+
+![kvetch](https://raw.github.com/JacksonGariety/kvetch/master/kvetch.jpg)
+
+*Gets in yo face when you write ruby.*
+
+## Installation
+
+Add this line to your application's Gemfile under the `:development` tree:
+
+    gem 'kvetch'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Some examples of how to use kvetch:
+
+1. `Kvetch.yell("yo homie there's a problem") #=> String`
+2. `Kvetch.yell("yo homie there's a problem", { :sound => "Frog" }) #=> String`
+3. `Kvetch.silence!; Kvetch.yell("yo homie there's a problem") #=> false`
+4. `Kvetch.silence!; Kvetch.unsilence!; Kvetch.yell("stop that") #=> String`
+
+`Kvetch.yell`'s second parameter is a hash of symbols/values based on the [terminal-notifier](https://github.com/alloy/terminal-notifier) documentation.
+
+## Contributing
+
+#### Cloning
+
+This repo depends upon my fork of @alloy's `terminal-notifier` gem. To clone with submodules:
+
+    $ git clone --recursive https://github.com/JacksonGariety/terminal-notifier.git
+
+#### GitHub for dummies
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kvetch.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kvetch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kvetch"
+  spec.version       = Kvetch::VERSION
+  spec.authors       = ["Jackson Gariety", "Colby Aley"]
+  spec.email         = ["personal@jacksongariety.com", "colby@aley.me"]
+  spec.description   = "A Ruby logger that uses native Mac/Linux notifications."
+  spec.summary       = "Gets in yo face when you write ruby."
+  spec.homepage      = "http://github.com/JacksonGariety/kvetch"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/kvetch.rb

@@ -0,0 +1,37 @@
+require 'kvetch/version'
+require 'kvetch/os'
+require 'shellwords'
+
+module Kvetch
+  # Main usage: Kvetch.yell(MESSAGE)
+  def self.yell(message, options = {})
+    return false if @silenced
+
+    if message.is_a? String
+      if OS.mac? && `sw_vers -productVersion` >= '10.8'
+        bin = File.expand_path('../../vendor/terminal-notifier/kvetch.app/Contents/MacOS/terminal-notifier', __FILE__)
+        
+        options[:sound].capitalize! if options[:sound]
+        options = options.merge(:message => message).map do |argument, value|
+          value = value.to_s; ["-#{argument}", "#{Shellwords.escape(value[0,1])}#{value[1..-1]}"]
+        end
+
+        command = [bin, *options.flatten]
+        command = Shellwords.join(command) if RUBY_VERSION < '1.9'
+
+        IO.popen(command) # send message and options to terminal-notifier/kvetch.app
+      elsif OS.linux? || OS.unix?
+        `notify-send \"#{message}\"`
+      else # OS doesn't have notification support
+        return "Kvetch works on Linux, Unix, or Mac OS X >= 10.8."
+      end
+    else # message is not a string
+      return "You should give that kvetch a string. Kvetches love strings."
+    end
+  end
+
+  # Silence methods
+  def self.silence!() @silenced = true end
+  def self.unsilence!() @silenced = false end
+  def self.silent?() @silenced end
+end

data/lib/kvetch/os.rb

@@ -0,0 +1,34 @@
+require 'rbconfig'
+
+# An alternative would be using `RUBY_PLATFORM`.
+# That would not require `rbconfig` but would
+# fail on JRuby (returning `java` independently of
+# the running OS).
+
+# Finds out the current Operating System.
+module OS
+  def self.windows?
+    windows = /cygwin|mswin|mingw|bccwin|wince|emx/i
+
+    (RbConfig::CONFIG['host_os'] =~ windows) != nil
+  end
+
+  def self.mac?
+    mac = /darwin|mac os/i
+
+    (RbConfig::CONFIG['host_os'] =~ mac) != nil
+  end
+
+  def self.unix?
+    unix = /solaris|bsd/i
+
+    (RbConfig::CONFIG['host_os'] =~ unix) != nil
+  end
+
+  def self.linux?
+    linux = /linux/i
+
+    (RbConfig::CONFIG['host_os'] =~ linux) != nil
+  end
+end
+

data/lib/kvetch/version.rb

@@ -0,0 +1,3 @@
+module Kvetch
+  VERSION = "1.0.3"
+end

data/spec/kvetch_spec.rb

@@ -0,0 +1,27 @@
+require "kvetch"
+
+describe Kvetch do
+  describe ".yell" do
+    it "should send a message" do
+      Kvetch.yell("a problem you finna resolve").should_not be_false
+    end
+
+    it "should not send a message" do
+      Kvetch.silence!
+      Kvetch.yell("a problem you were finna resolve but got stupid n' gave up").should_not be_true
+    end
+
+    it "should not send a message after toggling silence" do
+      Kvetch.unsilence!
+      Kvetch.yell("a problem you finna resolve").should_not be_false
+    end
+  end
+
+  describe ".silent?" do
+    it "should let you know if Kvetch is silent" do
+      Kvetch.silent?.should be_false
+      Kvetch.silence!
+      Kvetch.silent?.should be_true
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: kvetch
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Jackson Gariety
+- Colby Aley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A Ruby logger that uses native Mac/Linux notifications.
+email:
+- personal@jacksongariety.com
+- colby@aley.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitmodules
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kvetch.gemspec
+- kvetch.jpg
+- lib/kvetch.rb
+- lib/kvetch/os.rb
+- lib/kvetch/version.rb
+- spec/kvetch_spec.rb
+homepage: http://github.com/JacksonGariety/kvetch
+licenses:
+- Apache
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Gets in yo face when you write ruby.
+test_files:
+- spec/kvetch_spec.rb