lmkwyd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb5fa8d94865eb470f6231ed7ecca314b19d3ad9
+  data.tar.gz: 650ef50d9d53bea871d9c2538a585254692a9838
+SHA512:
+  metadata.gz: 61e6390105bfaf2b4d1aa39dc3016f92b69abbf02eacd63da2cb4db193a98bb977fb07e203799b6cfb5f5d46818a569ecce8b6cf50fccfc45533d2d209161a90
+  data.tar.gz: 1d78598cea3f179fe5eee5aea456a177c37f051836aff7ca8cb17ea7db2aa08e91fcb8af550d40f0576293a90df5956dea603a62180a364a2f4bbda01d3803a2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+
+rspec:
+  script:
+    - bundle exec rspec

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.12.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tatsuya Suzuki
+
+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,68 @@
+# lmkwyd
+
+Mac terminal command to notify when a specified commands is done by displaying a banner of Notification Center
+
+### General Usage:
+
+```shell
+lmkwyd sleep 3
+# => displays notification with title "Command Completed", subtitle "sleep 3" and body saying "Time to execute: 00:00:03"
+```
+
+![](https://gitlab.com/szkmp/lmkwyd/uploads/65793e28551695b4fd16348db0bd41ea/Screen_Shot_2016-05-08_at_4.40.41_PM.png)
+
+
+lmkwyd doesn't change exit code of commands a user specified. When
+consecutive commands are specified lmkwyd exits with exit code of their
+final result.
+
+### Usage (variation):
+
+```shell
+lmkwyd 'sleep 1 && echo Hey!'
+# => Sleeps 1 sec and displays notification saying "Hey!"
+
+lmkwyd 'ls /inexistent && echo Hey!'
+# => Displays notification and prints stdout 'ls: /inexistent: No such file or directory'
+# => echo Hey! is not executed, as same result as `lmkwyd ls /inexistent && echo Hey!` (without single quot)
+
+lmkwyd 'echo Hey! && sleep 10'
+# => Displays notification 10 seconds after both spcified commands are completed
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lmkwyd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lmkwyd
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at `https://gitlab.com/szkmp/lmkwyd`.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lmkwyd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lmkwyd

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "lmkwyd"
+
+p Lmkwyd.exec

data/lib/lmkwyd.rb

@@ -0,0 +1,11 @@
+require 'lmkwyd/version'
+require 'lmkwyd/commander'
+
+module Lmkwyd
+  def self.exec
+    commander = Commander.new(ARGV.join(' '))
+    exit commander.exec.tap {
+      Lmkwyd::Notifier.new(commander).notify
+    }
+  end
+end

data/lib/lmkwyd/commander.rb

@@ -0,0 +1,59 @@
+require 'open3'
+require 'lmkwyd/notifier'
+
+# Executes user specified command line
+#
+# @example General usage
+#   lmkwyd sleep 3
+#   # => displays notification with title "Command Completed", subtitle "sleep 3" and body saying "Time to execute: 00:00:03"
+#   # => ![](https://gitlab.com/szkmp/lmkwyd/uploads/65793e28551695b4fd16348db0bd41ea/Screen_Shot_2016-05-08_at_4.40.41_PM.png)
+class Lmkwyd::Commander
+  EXIT_CODE_OK = 0
+
+  attr_reader :command, :duration
+
+  def initialize(command_string)
+    @command = command_string
+  end
+
+  # Executes user specified command line
+  #
+  # @return [integer] Exit code of user specified command line
+  # @note This returns exit code 1 (General Error) if one of multiple commands in the command line fails
+  # @example Execute multiple commands
+  #   lmkwyd 'sleep 1 && echo Hey!'
+  #   # => Sleeps 1 sec and displays notification saying "Hey!"
+  #
+  #   lmkwyd 'ls /inexistent && echo Hey!'
+  #   # => Displays notification and prints stdout 'ls: /inexistent: No such file or directory'
+  #   # => echo Hey! is not executed, as same result as `lmkwyd ls /inexistent && echo Hey!` (without single quot)
+  #
+  #   lmkwyd 'echo Hey! && sleep 10'
+  #   # => Displays notification 10 seconds after both spcified commands are completed
+  def exec
+    exit_code = EXIT_CODE_OK
+
+    # TODO Check system ruby version
+    @duration = measure_time_consumption {
+        exit_code = run_command
+      }
+
+    exit_code
+  end
+
+  private
+
+  def run_command
+    Open3.popen3(command) {|stdin, stdout, stderr, wait_thr|
+      stdout.each {|line| print line }
+      stderr.each {|line| print line }
+      wait_thr.value.exitstatus
+    }
+  end
+
+  def measure_time_consumption
+    start = Time.now
+    yield
+    Time.now - start
+  end
+end

data/lib/lmkwyd/notifier.rb

@@ -0,0 +1,30 @@
+class Lmkwyd::Notifier
+  attr_reader :commander
+
+  def initialize(commander)
+    @commander = commander
+  end
+
+  def notify
+    `#{command}`
+  end
+
+  def command
+    %Q|osascript -e \
+       'display notification "#{body}" \
+        with title "Command completed" \
+        subtitle "#{commander.command}" \
+        sound name "Hero"'|
+  end
+
+  private
+
+  def body
+    # TODO make this Linux compatible
+    "Time to execute: #{humanize_length_of_time(commander.duration)}"
+  end
+
+  def humanize_length_of_time(seconds)
+    Time.at(seconds).utc.strftime("%H:%M:%S")
+  end
+end

data/lib/lmkwyd/version.rb

@@ -0,0 +1,3 @@
+module Lmkwyd
+  VERSION = "0.1.0"
+end

data/lmkwyd.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lmkwyd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lmkwyd"
+  spec.version       = Lmkwyd::VERSION
+  spec.authors       = ["Tatsuya Suzuki"]
+  spec.email         = ["sin.wave808@gmail.com"]
+
+  spec.summary       = %q{Mac terminal command to notify when a specified command is done by displaying a banner of Notification Center}
+  spec.description   = %q{Mac terminal command to notify when a specified command is done by displaying a banner of Notification Center}
+  spec.homepage      = "https://gitlab.com/szkmp/lmkwyd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: lmkwyd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tatsuya Suzuki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Mac terminal command to notify when a specified command is done by displaying
+  a banner of Notification Center
+email:
+- sin.wave808@gmail.com
+executables:
+- lmkwyd
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/lmkwyd
+- lib/lmkwyd.rb
+- lib/lmkwyd/commander.rb
+- lib/lmkwyd/notifier.rb
+- lib/lmkwyd/version.rb
+- lmkwyd.gemspec
+homepage: https://gitlab.com/szkmp/lmkwyd
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Mac terminal command to notify when a specified command is done by displaying
+  a banner of Notification Center
+test_files: []