launchd 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fb752b754bb2198fdadd8ebbf74280e6f79aeaf
-  data.tar.gz: 1ec69bbdf2d510e349c1bfe4041cdebc8fcdd8fe
+  metadata.gz: dc9bd564abaac27b427b343ca88cfcb460137aba
+  data.tar.gz: 89db52cc37d76564f897123c3957d5a1b11780c8
 SHA512:
-  metadata.gz: e74098bed3e054e22185f09bf27528d1858186ca3042a05b4a3a69b4d0027ddc473a21e82f2ceae57bf31c27551653d9c8bdccc7ee592c13c43c0e3fcf74722d
-  data.tar.gz: a6fc55dcf1d6cbce2aa3726df13afb5b85bbd07364c0b8174c2f8dc07055e9e3107a8b4b2354eef26f93ac65019376634272532b53b64e473103ec7c79d43cc5
+  metadata.gz: cdd324002213f700174868512b6236063029a823efacb4257ce8e1358e92e5e32cbd4fefb3df3c94e76b9c9a353cb23ed749293286c64dfc70102c7d2cd2cade
+  data.tar.gz: a9dc1551d22ae89ad25bc86cf28633514a43e97e25baea7cfd2b51d652b006ca2842c1ea9bf23f0dd41d39291193efc314610f1ace2ea200375f3d8393578c46

data/README.md

@@ -23,16 +23,25 @@ Or install it yourself as:
 
 ## Usage
 
-Deploy (install & restart) a service:
+Initialize a service object:
 
 ```Ruby
-service = Launchd::Service.new 'com.example.chunkybacon', # Label of service
-  program_arguments: %w(/usr/sbin/chunkyd --bacon), # command line as array
-  keep_alive: true # Shall launchd keep it running?
-service.deploy
+service = Launchd::Service.new,
+  label:             'com.example.chunkybacon',     # Required
+  program_arguments: %w(/usr/sbin/chunkyd --bacon), # Required
+  keep_alive:        true                           # Optional
 ```
 
-**NOTE: All options are also required!**
+Only *label* and *program_arguments* are required. See
+[`man launchd.plist(5)`](https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man5/launchd.plist.5.html)
+for all possible properties.
+
+Then stop, overwrite and start the service with the given properties (i.e. for
+deployment):
+
+```Ruby
+service.restart
+```
 
 
 ## Development

data/lib/launchd/service.rb

@@ -1,20 +1,23 @@
 module Launchd
   class Service
-    attr_reader :label
+    attr_reader :options, :label
 
-    def initialize(label, opts = {})
-      @label = label
-      @opts = opts
+    # NOTE: Only *label* and *program_arguments* are required.
+    # See `man launchd.plist` for all possible properties.
+    #
+    def initialize(opts = {})
+      @options = opts
+      @label = opts.fetch(:label)
     end
 
-    # Deploy (install & restart) the service.
+    # restart (install & restart) the service.
     #
     # If running as root, it will get installed as system-wide daemon,
     # otherwise as agent.
     #
-    def deploy
+    def restart
       stop if running?
-      write_plist
+      save
       start
     end
 
@@ -33,10 +36,12 @@ module Launchd
       !!system("launchctl list #{label}")
     end
 
+    alias_method :to_hash, :options
+
     private
 
     # Save actual plist to disk.
-    def write_plist
+    def save
       File.open(plist_path, 'w') do |file|
         file.puts properties.to_plist
       end
@@ -58,13 +63,13 @@ module Launchd
       Process.euid.zero?
     end
 
-    # Returns hash of plist properties.
+    # Returns hash of properties with CamelCase-keys.
     def properties
-      {
-        'Label' => label,
-        'ProgramArguments' => @opts[:program_arguments],
-        'KeepAlive' => @opts[:keep_alive]
-      }
+      options.inject({}) do |memo, (k,v)|
+        camel_cased_key = k.to_s.split('_').map(&:capitalize).join
+        memo[camel_cased_key] = v
+        memo
+      end
     end
   end
 end

data/lib/launchd/version.rb

@@ -1,3 +1,3 @@
 module Launchd
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: launchd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Björn Albers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist