service 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    service (1.0.0)
+      version (~> 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    github-markup (0.7.4)
+    guard (1.5.4)
+      listen (>= 0.4.2)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-yard (2.0.1)
+      guard (>= 1.1.0)
+      yard (>= 0.7.0)
+    listen (0.6.0)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.3)
+    rb-fsevent (0.9.2)
+    redcarpet (2.2.2)
+    slop (3.3.3)
+    thor (0.16.0)
+    version (1.0.0)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-markup (~> 0.7)
+  guard-yard (~> 2.0)
+  rake (~> 10.0)
+  rb-fsevent (~> 0.9)
+  redcarpet (~> 2.2.2)
+  service!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ryan Scott Lewis <ryan@rynet.us>.
+
+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,166 @@
+# Service
+
+__serv·ice__ _noun_ _/ˈsɜr vɪs/_ __:__ The action of helping or doing work for someone.
+
+Service encapsulates an object which executes a bit of code in a loop that can be started or 
+stopped and query whether it is running or not.
+
+## Install
+
+### Bundler: `gem 'service'`
+
+### RubyGems: `gem install service`
+
+## Usage
+
+### Defining
+
+You can define an Object as a Service by subclassing `Service` or by including/extending 
+`Service::Base`.
+
+```ruby
+class ServiceA < Service
+end
+
+class ServiceB
+  include Service::Base
+end
+
+class ServiceC
+  extend Service::Base
+end
+```
+
+A `Service` object stores it's state in the `@_service_state` instance variable as to be as 
+unobtrusive as possible when integrating with your custom objects.
+
+The next thing to do is define a `execute` instance method on your object:
+
+```ruby
+class MyService < Service
+  def execute
+    # ...
+  end
+end
+```
+
+### Running
+
+Use the `start`/`run` instance method to call the `execute` instance method in a loop.
+
+```ruby
+class MyService < Service
+  def execute
+    puts "Hello"
+  end
+end
+
+MyService.new.run
+# => Hello
+# => Hello
+# => ...
+```
+
+Use `start!`/`run!` to call the `run` in a new Thread.
+
+```ruby
+class MyService < Service
+  def execute
+    puts "Hello"
+  end
+end
+
+thread = MyService.new.run!
+thread.join
+# => Hello
+# => Hello
+# => ...
+```
+
+### Stopping
+
+Use the `stop` instance method break the run loop.  
+This will also kill the Thread it is running in, if running in a Thread.
+
+```ruby
+class MyService < Service
+  def execute
+    sleep 3
+    stop
+  end
+end
+
+print "Running MyService in a new Thread... "
+thread = MyService.new.run!
+thread.join
+puts "Done!"
+```
+
+### Querying State
+
+Use the `started?`/`running?` or `stopped?` instance methods to determine the current state of 
+the Service instance.
+
+```ruby
+class MyService < Service
+  def execute
+    sleep 10
+  end
+end
+
+service = MyService.new
+p service.running? # => false
+service.run!
+sleep 1
+p service.running? # => true
+```
+
+## Example
+
+```ruby
+require 'service'
+
+class PingService < Service
+  def execute
+    sleep rand(5)
+    print 'ping'
+    stop
+  end
+end
+
+class PongService
+  include Service::Base
+  
+  def execute
+    sleep rand(5)
+    print 'pong'
+    stop
+  end
+end
+
+class ExcitementService
+  extend Service::Base
+  
+  def execute
+    sleep rand(5)
+    print '!'
+    stop
+  end
+end
+
+threads = []
+threads << PingService.new.run!
+threads << PongService.new.run!
+threads << ExcitementService.new.run!
+
+threads.each(&:join)
+```
+
+## Copyright
+
+Copyright © 2012 Ryan Scott Lewis <ryan@rynet.us>.
+
+The MIT License (MIT) - See LICENSE for further details.
+
+[message_queue]: http://en.wikipedia.org/wiki/Message_queue
+[queue]: http://rubydoc.info/stdlib/thread/Queue

data/Rakefile

@@ -0,0 +1,57 @@
+require 'pathname'
+
+def require_task(path)
+  begin
+    require path
+    
+    yield
+  rescue LoadError
+    puts '', "Could not load '#{path}'.", 'Try to `rake gem:spec` and `bundle install` and try again.', ''
+  end
+end
+
+spec = Gem::Specification.new do |s|
+  
+  # Variables
+  s.name = 'service'
+  s.author = 'Ryan Scott Lewis'
+  s.email = 'ryan@rynet.us'
+  s.summary = 'A basic implementation of a Service, which has a run loop can be start and stopped or run an a new Thread.'
+  s.description = 'Service encapsulates an object which executes a bit of code in a loop that can be started or stopped and query whether it is running or not.'
+  
+  # Dependencies
+  s.add_dependency 'version', '~> 1.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'guard-yard', '~> 2.0'
+  s.add_development_dependency 'rb-fsevent', '~> 0.9'
+  s.add_development_dependency 'redcarpet', '~> 2.2.2'
+  s.add_development_dependency 'github-markup', '~> 0.7'
+  
+  # Pragmatically set variables
+  s.homepage = "http://github.com/RyanScottLewis/#{s.name}"
+  s.version = Pathname.glob('VERSION*').first.read
+  s.require_paths = ['lib']
+  s.files        = `git ls-files`.lines.to_a.collect { |s| s.strip }
+  s.executables  = `git ls-files -- bin/*`.lines.to_a.collect { |s| File.basename(s.strip) }
+  
+end
+
+desc 'Generate the gemspec defined in this Rakefile'
+task :gemspec do
+  Pathname.new("#{spec.name}.gemspec").open('w') { |f| f.write(spec.to_ruby) }
+end
+
+require_task 'rake/version_task' do
+  Rake::VersionTask.new do |t|
+    t.with_git_tag = true
+    t.with_gemspec = spec
+  end
+end
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(spec) do |t|
+  t.need_zip = false
+  t.need_tar = false
+end
+
+task :default => :gemspec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/service.rb

@@ -0,0 +1,81 @@
+require 'version'
+
+# Service encapsulates an object which executes a bit of code in a loop 
+# that can be started or stopped and query whether it is running or not.
+# 
+# Objects can subclass Service.
+class Service
+  is_versioned
+  
+  # The Base module for Services.
+  # Objects can include or extend Service::Base.
+  module Base
+    
+    # The instance methods to be mixed into modules which include/extend Service::Base.
+    module InstanceMethods
+      
+      # Query if the service is currently stopped.
+      # 
+      # @returns [true, false]
+      def stopped?
+        @_service_state == :stopped
+      end
+      
+      # Query if the service is currently started.
+      # 
+      # @returns [true, false]
+      def started?
+        @_service_state == :started
+      end
+      alias_method :running?, :started?
+      
+      # The code that will be executed within the run loop.
+      # @abstract Subclass and override {#run} to implement a custom Service.
+      def execute
+        raise NotImplementedError
+      end
+      
+      # Stop the run loop.
+      def stop
+        @_service_state = :stopped
+      end
+      
+      # Start the run loop.
+      def start
+        @_service_state = :started
+        loop do
+          break if stopped?
+          execute
+        end
+      end
+      alias_method :run, :start
+      
+      # Start the run loop in a new Thread.
+      # 
+      # @return [Thread]
+      def start!
+        Thread.new { start }
+      end
+      alias_method :run!, :start!
+      
+    end
+    
+    class << self
+      
+      # Include Service::Base::InstanceMethods when Service::Base is included.
+      def included(base)
+        base.send(:include, InstanceMethods)
+      end
+      
+      # Include Service::Base::InstanceMethods when Service::Base is extended.
+      def extended(base)
+        base.send(:include, InstanceMethods)
+      end
+      
+    end
+    
+  end
+  
+  include Base
+  
+end

data/service.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "service"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Scott Lewis"]
+  s.date = "2012-12-13"
+  s.description = "Service encapsulates an object which executes a bit of code in a loop that can be started or stopped and query whether it is running or not."
+  s.email = "ryan@rynet.us"
+  s.files = ["Gemfile", "Gemfile.lock", "LICENSE", "README.md", "Rakefile", "VERSION", "lib/service.rb", "service.gemspec"]
+  s.homepage = "http://github.com/RyanScottLewis/service"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A basic implementation of a Service, which has a run loop can be start and stopped or run an a new Thread."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<version>, ["~> 1.0"])
+      s.add_development_dependency(%q<rake>, ["~> 10.0"])
+      s.add_development_dependency(%q<guard-yard>, ["~> 2.0"])
+      s.add_development_dependency(%q<rb-fsevent>, ["~> 0.9"])
+      s.add_development_dependency(%q<redcarpet>, ["~> 2.2.2"])
+      s.add_development_dependency(%q<github-markup>, ["~> 0.7"])
+    else
+      s.add_dependency(%q<version>, ["~> 1.0"])
+      s.add_dependency(%q<rake>, ["~> 10.0"])
+      s.add_dependency(%q<guard-yard>, ["~> 2.0"])
+      s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
+      s.add_dependency(%q<redcarpet>, ["~> 2.2.2"])
+      s.add_dependency(%q<github-markup>, ["~> 0.7"])
+    end
+  else
+    s.add_dependency(%q<version>, ["~> 1.0"])
+    s.add_dependency(%q<rake>, ["~> 10.0"])
+    s.add_dependency(%q<guard-yard>, ["~> 2.0"])
+    s.add_dependency(%q<rb-fsevent>, ["~> 0.9"])
+    s.add_dependency(%q<redcarpet>, ["~> 2.2.2"])
+    s.add_dependency(%q<github-markup>, ["~> 0.7"])
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Scott Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Service encapsulates an object which executes a bit of code in a loop
+  that can be started or stopped and query whether it is running or not.
+email: ryan@rynet.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/service.rb
+- service.gemspec
+homepage: http://github.com/RyanScottLewis/service
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 619595835784170795
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A basic implementation of a Service, which has a run loop can be start and
+  stopped or run an a new Thread.
+test_files: []