dtachr 0.0.2 → 0.0.3

data/README.md

@@ -1,8 +1,22 @@
-= dtachr
+# dtachr
 
-Description goes here.
+`dtachr` wraps the [dtach](http://dtach.sourceforge.net) command line utlity
+to automate the creation of a socket file and send a notification to
+[terminal-notifier](https://github.com/alloy/terminal-notifier). This utility
+will only work with both `dtach` and `terminal-notifier` installed and in
+PATH.
 
-== Contributing to dtachr
+## Install Dependencies
+
+The recommended method of installation is [Homebrew](http://brew.sh). With
+Homebrew it is as simple as `brew install dtach terminal-notifier`. Both the
+`dtach` and `terminal-notifier` commands must be available in the PATH for
+dtachr to function.
+
+In the future I'd like to add support for various notifiers so this can be used
+somewhere besides OSX.
+
+## Contributing to dtachr
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -12,8 +26,7 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2013 Bryan Swift. See LICENSE.txt for
-further details.
+Copyright (c) 2013 Bryan Swift. See LICENSE.txt for further details.
 

data/Rakefile

@@ -87,16 +87,17 @@ end
 #
 #############################################################################
 
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
+desc "Create tag v#{version}"
+task :release do
   unless `git branch` =~ /^\* master$/
     puts "You must be on the master branch to release!"
     exit!
   end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
   sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
+end
+
+desc "Push #{gem_file} to Rubygems"
+task :publish do
   sh "gem push pkg/#{name}-#{version}.gem"
 end
 

data/dtachr.gemspec

@@ -13,14 +13,20 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'dtachr'
-  s.version           = '0.0.2'
-  s.date              = '2013-11-08'
+  s.version           = '0.0.3'
+  s.date              = '2013-11-14'
   s.rubyforge_project = 'dtachr'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
-  s.summary     = "Short description used in Gem listings."
-  s.description = "Long description. Maybe copied from the README."
+  s.summary     = "Wrapper for `dtach` utility."
+  s.description = <<DESC
+`dtachr` wraps the [dtach](http://dtach.sourceforge.net) command line utlity
+to automate the creation of a socket file and send a notification to
+[terminal-notifier](https://github.com/alloy/terminal-notifier). This utility
+will only work with both `dtach` and `terminal-notifier` installed and in
+PATH.
+DESC
 
   ## List the primary authors. If there are a bunch of authors, it's probably
   ## better to set the email to an email list or something. If you don't have
@@ -28,6 +34,7 @@ Gem::Specification.new do |s|
   s.authors  = ["Bryan Swift"]
   s.email    = 'bryan.j.swift@gmail.com'
   s.homepage = 'http://github.com/bryanjswift/dtachr'
+  s.license  = 'MIT'
 
   ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
   ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'

data/lib/dtachr.rb

@@ -5,25 +5,27 @@ require 'rubygems'
 require 'docopt'
 
 module Dtachr
-  
-  VERSION = '0.0.2'
+
+  VERSION = '0.0.3'
+  NAME = 'dtachr'
+
   DOC = <<-DOCOPT
     dtachr
 
     Usage:
-      #{__FILE__} [--socket=<sock>] <parts>...
-      #{__FILE__} -h | --help
-      #{__FILE__} -v | --version
+      #{Dtachr::NAME} [--socket=<sock>] <parts>...
+      #{Dtachr::NAME} -h | --help
+      #{Dtachr::NAME} -v | --version
 
     Options:
-      -h --help         Show this screen
-      -v --version      Show the version
-      -n --socket=<sock>   Temporary file to use as socket for dtach command
+      -h --help             Show this screen
+      -v --version          Show the version
+      -n --socket=<sock>    Temporary file to use as socket for dtach command
 
     DOCOPT
-  
+
   class Runner
-    
+
     def initialize(args)
       @opts = Docopt::docopt(Dtachr::DOC, {
         :argv => args,
@@ -34,14 +36,14 @@ module Dtachr
     rescue Docopt::Exit => e
       puts e.message
     end
-    
+
     def call
       return unless @opts
       execute("dtach -n #{@socket} #{@command} && terminal-notifier -message '`#{@command}` finished.'")
     end
-    
+
     private
-    
+
     def execute(command)
       `#{command}`
     end
@@ -49,7 +51,7 @@ module Dtachr
     def gen_socket
       "tmp"
     end
-    
+
   end
-  
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dtachr
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Bryan Swift
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-11-08 00:00:00 -05:00
+date: 2013-11-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,7 +74,13 @@ dependencies:
   name: rdoc
   version_requirements: *id003
   prerelease: false
-description: Long description. Maybe copied from the README.
+description: |
+  `dtachr` wraps the [dtach](http://dtach.sourceforge.net) command line utlity
+  to automate the creation of a socket file and send a notification to
+  [terminal-notifier](https://github.com/alloy/terminal-notifier). This utility
+  will only work with both `dtach` and `terminal-notifier` installed and in
+  PATH.
+
 email: bryan.j.swift@gmail.com
 executables: 
 - dtachr
@@ -94,8 +100,8 @@ files:
 - lib/dtachr.rb
 has_rdoc: true
 homepage: http://github.com/bryanjswift/dtachr
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -125,6 +131,6 @@ rubyforge_project: dtachr
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 2
-summary: Short description used in Gem listings.
+summary: Wrapper for `dtach` utility.
 test_files: []