runify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2159c4ba2f63ddc75363f6c267768f71a2d396bb
+  data.tar.gz: 2159f9f1a0351e07b372d9afbe7d4099dbe283e7
+SHA512:
+  metadata.gz: 118aca90ae253b5dad52c1a6502432e24f7bd701157c891db3df249a8f3147c204e0ba4ecd4885140987d36bcc396b8bee6e6f2df23cdf1b0bf82d47032013d4
+  data.tar.gz: ff276990c11ba2bf5ca3e535c5fe6ae791c06ef50ce5a6ab430cd354f2eaf3b31ecedee44eca047059459c3c8e20e5a928838caf312352c0b01764e4dc98be55

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Paul Duncan
+
+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,101 @@
+# Runify
+
+Easily turn any object into a service
+
+## Presentation
+
+This library provides a very simple interface for any 'runnable' object (responds to _run_) to be used as a service.
+When included into a class, the *Runify* module adds _startup_, _shutdown_ and _restart_ methods, which take care of wrapping execution of the _run_ method into a thread.
+
+## Installation
+
+### Gemfile
+```ruby
+gem 'runify'
+```
+
+### Terminal
+```bash
+gem install -V runify
+```
+
+## Usage
+
+For any object that features a _run_ method, simply include the *Runify* module into the class.
+Instances of this class will respond to the following new methods:
+
+#### *startup*
+
+Calling this method will spawn a new thread around the _run_ method, effectively starting the service in the 'background'.
+
+#### *shutdown*
+
+Calling _shutdown_ will request the service to terminate by setting *@stop* to *true* and wait for the thread to complete (join).
+Once this method returns, the service has completely terminated.
+
+#### *restart*
+
+The _restart_ method is nothing more than a shortcut to shutdown and startup:
+```ruby
+def restart
+	shutdown
+	startup
+end
+```
+
+#### The *@stop* variable
+
+Any class that includes the runify module should check the *@stop* instance variable in its _run_ method.
+Runify will set @stop to _true_ to indicate execution should end and the _run_ method should return when a shutdown is requested.
+
+A typical _run_ method will usually be implemented as such:
+
+```ruby
+def run
+	update until @stop		# Run until shutdown is requested
+end
+```
+
+## Examples
+
+### Runifying a simple service class
+
+```ruby
+require 'runify'
+
+# Foo Service
+class FooService
+
+	# Runify
+	include Runify
+
+	def run
+		update until @stop		# Run until shutdown is requested
+	end
+
+	def update
+		# Business Logic goes here...
+	end
+end
+
+# Start Foo Service in the background
+fs = FooService.new
+fs.startup
+puts 'Foo Service has started'
+
+# Do something while service is running...
+
+# Restart Foo Service
+fs.restart
+puts 'Foo Service has restarted'
+
+# Do something while service is running...
+
+# Shutdown Foo Service
+fs.shutdown
+puts 'Foo Service has terminated'
+```
+
+## 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,9 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.pattern = 'test/**/test*.rb'
+end
+
+task :default => :test

data/lib/runify.rb

@@ -0,0 +1,33 @@
+# Runify
+# by Eresse <eresse@eresse.net>
+
+# External Includes
+require 'thread'
+
+# Runify Module
+# Root Module for Runify
+module Runify
+
+	# Startup
+	# Spawns a new Thread around the _run_ method
+	def startup
+		return if @thread
+		@stop = nil
+		@thread = Thread.new { run }
+	end
+
+	# Shutdown
+	# Requests the _run_ method to complete and blocks until it returns
+	def shutdown
+		@stop = true
+		@thread.join if @thread
+		@thread = nil
+	end
+
+	# Restart
+	# Calls _shutdown_, immediately followed by _startup_
+	def restart
+		shutdown
+		startup
+	end
+end

data/lib/runify/version.rb

@@ -0,0 +1,9 @@
+# Runify
+# by Eresse <eresse@eresse.net>
+
+# Runify Module
+module Runify
+
+	# Version
+	VERSION = '0.1.0'
+end

data/runify.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runify/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'runify'
+	spec.version = Runify::VERSION
+	spec.authors = ['Eresse']
+	spec.email = ['eresse@eresse.net']
+
+	spec.summary = 'Easily turn any object into a service'
+	spec.description = 'Provides a very simple interface for any \'runnable\' object (responds to _run_) to be used as a service'
+	spec.homepage = 'http://redmine.eresse.net/projects/runify'
+	spec.license = 'MIT'
+
+	spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler'
+	spec.add_development_dependency 'rake'
+	spec.add_runtime_dependency 'minitest'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: runify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eresse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a very simple interface for any 'runnable' object (responds
+  to _run_) to be used as a service
+email:
+- eresse@eresse.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/runify.rb
+- lib/runify/version.rb
+- runify.gemspec
+homepage: http://redmine.eresse.net/projects/runify
+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.10
+signing_key: 
+specification_version: 4
+summary: Easily turn any object into a service
+test_files: []