app-service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecede2dd862dd858ea23141f7337e661433bdab75599e5a0e42fc724af12f9cd
+  data.tar.gz: 3f3206a7c651bb897887f23935688e645f0b44fe4a8001594ab20023d4419978
+SHA512:
+  metadata.gz: bf0ae3ebd9a94f33561582d16aa6c162fc95d95f0f3875b5dcb3c3826d52ce6eeb99db8f4b97670244b21f50bb5fed0554b43ec946003cc4e2c56eff429f529a
+  data.tar.gz: 9ddcbea0783c8b3f7fddf285294f9e7f2255ef72efa655c0897eb44da0c564c27d8bac641cada42ea87a9ad7b33dfee7a5d9996a32cfd9b7a81b4d733d3ea0d2

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor/
+*.pid
+*.log
+*.log.*
+/var/
+/log/
+*.swp
+/.rspec_status
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in app-service.gemspec
+gemspec
+

data/README.adoc

@@ -0,0 +1,137 @@
+= App::Service
+
+A library for service application daemonize.
+
+== Features
+
+* Easy switch from terminal application to background service.
+
+== Installation
+
+Add this line to your app's Gemfile:
+
+[source,ruby]
+----
+gem 'app-service'
+----
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install app-service
+    or
+    $ gem install -l app-service-x.x.x.gem
+
+== Usage
+
+=== Example
+
+[source,ruby]
+----
+require  "app/service"
+
+# execute service application with default settings.
+App::Service.setup( ARGV.shift )
+
+# execute service application with custom settings.
+App::Service.setup( ARGV.shift, **options )
+----
+
+[source,bash]
+----
+# run on terminal application.
+ruby sample.rb  run
+
+# start background service.
+ruby sample.rb  start
+
+# stop background service.
+ruby sample.rb  stop
+
+# restart background service.
+ruby sample.rb  restart
+
+# show status of background service.
+ruby sample.rb  status
+----
+
+== Reference
+
+=== Setup App::Service.
+
+[source,ruby]
+----
+App::Service.setup( mode = nil, **options )
+----
+
+* Result:
+  ** none.
+
+* Parameter:
+  ** mode:                      Run mode. [run start stop restart status]
+  ** argv:                      Commandline arguments. (default: ARGV)
+  ** app_dir:                   Application working directory. (default: "..")
+  ** tmp_dir:                   Temporary directory. (default: "tmp")
+  ** log_dir:                   Logging directory. (default: "log")
+  ** log_sync:                  Logging sync mode. (default: false)
+  ** shift_age:                 Log file count, or log change event. 
+                                [0.., "daily", "weekly", "monthly"] (default: 0)
+  ** shift_size:                Log rotation limit size. (default: 1048576)
+  ** log_level:                 Log level. (default: Logger::Severity::DEBUG)
+                                [0:DEBUG, 1:INFO, 2:WARN, 3:ERROR, 4:FATAL, 5:UNKNOWN] 
+  ** progname:                  (default: nil)
+  ** formatter:                 (default: Formatter.new)
+  ** datetime_format:           (default: '%Y-%m-%d %H:%M:%S') 
+  ** shift_period_suffix:       (default: '%Y%m%d')
+
+=== Shutdown App::Service.
+
+[source,ruby]
+----
+App::Service.shutdown( cond = 0 )
+----
+
+* Result:
+  ** なし.
+
+* Parameter:
+  ** cond:                      process exit condition. (default: 0)
+
+=== Get run mode.
+
+[source,ruby]
+----
+App::Service.mode
+----
+
+* Result:
+  ** String:                    Run mode. [run start stop restart status]
+
+* Parameter:
+  ** none.
+
+=== Get logger instance.
+
+[source,ruby]
+----
+App::Service.logger
+----
+
+* Result:
+  ** Logger instance.
+
+* Parameter:
+  ** none.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arimay/app-service.
+
+== License
+
+The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/README.ja.adoc

@@ -0,0 +1,137 @@
+= App::Service
+
+サービスアプリケーションをデーモン化するライブラリ。
+
+== 特徴
+
+* 端末アプリからバックグラウンドサービスへ容易に切り替える。
+
+== 導入
+
+アプリの Gemfile にこの行を追加
+
+[source,ruby]
+----
+gem 'app-service'
+----
+
+それから実行
+
+    $ bundle install
+
+または次のように手動で導入
+
+    $ gem install app-service
+    or
+    $ gem install -l app-service-x.x.x.gem
+
+== 使い方
+
+=== 例
+
+[source,ruby]
+----
+require  "app/service"
+
+# デフォルト設定でサービスアプリを実行する.
+App::Service.setup( ARGV.shift )
+
+# カスタム設定でサービスアプリを実行する.
+App::Service.setup( ARGV.shift, **options )
+----
+
+[source,bash]
+----
+# 端末アプリを実行する.
+ruby sample.rb  run
+
+# バックグラウンドサービスを開始する.
+ruby sample.rb  start
+
+# バックグラウンドサービスを停止する.
+ruby sample.rb  stop
+
+# バックグラウンドサービスを再起動する.
+ruby sample.rb  restart
+
+# バックグラウンドサービスの状態を表示する.
+ruby sample.rb  status
+----
+
+== リファレンス
+
+=== App::Service を準備する.
+
+[source,ruby]
+----
+App::Service.setup( mode = nil, **options )
+----
+
+* Result:
+  ** なし.
+
+* Parameter:
+  ** mode:                      動作モード [run start stop restart status]
+  ** argv:                      コマンドライン引数. (default: ARGV)
+  ** app_dir:                   アプリ作業ディレクトリ. (default: "..")
+  ** tmp_dir:                   一時使用ディレクトリ. (default: "tmp")
+  ** log_dir:                   ログ保管ディクトリ. (default: "log")
+  ** log_sync:                  ログ同期モード. (default: false)
+  ** shift_age:                 ログファイルを保持する数か、ログファイルを切り替える頻度. 
+                                [0.., "daily", "weekly", "monthly"] (default: 0)
+  ** shift_size:                ログファイルを切り替えるサイズ. (default: 1048576)
+  ** log_level:                 ログレベル. (default: Logger::Severity::DEBUG)
+                                [0:DEBUG, 1:INFO, 2:WARN, 3:ERROR, 4:FATAL, 5:UNKNOWN]
+  ** progname:                  (default: nil)
+  ** formatter:                 (default: Formatter.new)
+  ** datetime_format:           (default: '%Y-%m-%d %H:%M:%S')
+  ** shift_period_suffix:       (default: '%Y%m%d')
+
+=== App::Service を終了する.
+
+[source,ruby]
+----
+App::Service.shutdown( cond = 0 )
+----
+
+* Result:
+  ** none.
+
+* Parameter:
+  ** cond:                      プロセス終了コード. (default: 0)
+
+=== 動作モードを取得する.
+
+[source,ruby]
+----
+App::Service.mode
+----
+
+* Result:
+  ** String:                    動作モード [run start stop restart status]
+
+* Parameter:
+  ** なし.
+
+=== ロガーを取得する.
+
+[source,ruby]
+----
+App::Service.logger
+----
+
+* Result:
+  ** Loggerインスタンス.
+
+* Parameter:
+  ** なし.
+
+== 貢献
+
+不具合報告とプルリクエストは GitHub https://github.com/arimay/app-service まで. 
+
+== ライセンス
+
+この Gem は、 http://opensource.org/licenses/MIT[MITライセンス] の条件に基づいてオープンソースとして入手できる.
+
+Copyright (c) ARIMA Yasuhiro <arima.yasuhiro@gmail.com>

data/Rakefile

@@ -0,0 +1,96 @@
+require "bundler/gem_helper"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+class Bundler::GemHelper
+
+  def git_archive( dir = "../zip" )
+    FileUtils.mkdir_p  dir
+    dest_path  =  File.join(dir, "#{name}-#{version}.zip")
+    cmnd  =  "git archive --format zip --prefix=#{name}/ HEAD > #{dest_path}"
+
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't archive gem,"  unless  code == 0
+
+    Bundler.ui.confirm "#{name} #{version} archived to #{dest_path}."
+  end
+
+  def git_push
+    ver  =  version.to_s
+
+    cmnd  =  "git push origin  #{ver} "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git push origin."  unless  code == 0
+
+    cmnd  =  "git push "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git push."         unless  code == 0
+
+    Bundler.ui.confirm "Git Push #{ver}."
+  end
+
+  def update_version( new_version )
+    version_filename  =  %x[ find . -type f -name "version.rb" | grep -v vendor | head -1 ].chomp
+    version_pathname  =  File.expand_path( version_filename )
+    lines  =  File.open( version_pathname ).read
+    lines  =  lines.gsub( /VERSION\s*=\s*\"\d+\.\d+\.\d+\"/, "VERSION = \"#{new_version}\"" )
+    File.open( version_pathname, "w" ) do |file|
+      file.write( lines )
+    end
+
+    cmnd  =  "git add  #{version_pathname} "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git add,"  unless  code == 0
+
+    cmnd  =  "git commit -m  '#{new_version}' "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git commit."  unless  code == 0
+
+    cmnd  =  "git tag        #{new_version} "
+    _, code = sh_with_status( cmnd )
+    raise "Couldn't git tag."          unless  code == 0
+
+    Bundler.ui.confirm "Update Tags to #{new_version}."
+  end
+
+end
+
+Bundler::GemHelper.new(Dir.pwd).instance_eval do
+
+  desc "Archive #{name}-#{version}.zip from repository"
+  task 'zip' do
+    git_archive
+  end
+
+  desc "Git Push"
+  task 'push' do
+    git_push
+  end
+
+  desc "Update Version Tiny"
+  task 'tiny' do
+    major, minor, tiny  =  version.to_s.split('.')
+    new_version  =  [major, minor, tiny.to_i + 1].join('.')
+    update_version( new_version )
+  end
+
+  desc "Update Version Minor"
+  task 'minor' do
+    major, minor, _tiny  =  version.to_s.split('.')
+    new_version  =  [major, minor.to_i + 1, 0].join('.')
+    update_version( new_version )
+  end
+
+  desc "Update Version Major"
+  task 'major' do
+    major, _minor, _tiny  =  version.to_s.split('.')
+    new_version  =  [major.to_i + 1, 0, 0].join('.')
+    update_version( new_version )
+  end
+
+end
+

data/app-service.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/app/service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "app-service"
+  spec.version       = App::Service::VERSION
+  spec.authors       = ["ARIMA Yasuhiro"]
+  spec.email         = ["arima.yasuhiro@gmail.com"]
+
+  spec.summary       = %q{ Service application daemonize. }
+  spec.description   = %q{ App::Service is a library for service application daemonize. }
+  spec.homepage      = "https://github.com/arimay/app-service"
+  spec.license       = "MIT"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "app/service"
+
+# 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(__FILE__)

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/lib/app/service.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require_relative "service/version"
+require "fileutils"
+require "logger"
+
+module App
+  class Service
+    class Error < StandardError; end
+
+    PROGRAM_DIR  =  File.expand_path( File.dirname( $PROGRAM_NAME ) )
+
+    class << self
+      def setup( mode = nil, argv: ARGV, app_dir: nil, tmp_dir: nil, log_dir: nil, **options )
+        setup_vars( mode, argv, app_dir, tmp_dir, log_dir, options[:progname] )
+
+        case  @@mode
+        when  "run"
+          if alive?
+            puts  "already in alive."
+            ::Kernel.exit
+          end
+          setup_logger( **options )
+
+        when  "start"
+          if alive?
+           #puts  "already in alive."
+            ::Kernel.exit
+          end
+          Process.daemon( true, true )
+          setup_service
+          setup_logger( log_path: @@log_path, **options )
+
+        when  "restart"
+          while  alive?
+            request_to_stop
+            ::Kernel.sleep( 1 )
+          end
+          Process.daemon( true, true )
+          setup_service
+          setup_logger( log_path: @@log_path, **options )
+
+        when  "stop"
+          while  alive?
+            request_to_stop
+            ::Kernel.sleep( 1 )
+          end
+          # puts  "successed to stop."
+          ::Kernel.exit
+
+        when  "status"
+          if alive?
+            puts  "in alive."
+          else
+            puts  "not in alive."
+          end
+          ::Kernel.exit
+
+        end
+      end
+
+      def shutdown( cond = 0 )
+        delete_pid_path
+        ::Kernel.exit( cond )
+      end
+
+      def logger
+        @@logger
+      end
+
+      def mode
+        @@mode
+      end
+
+    private
+
+      def setup_vars( mode, argv, app_dir, tmp_dir, log_dir, progname )
+        if mode.nil?
+          @@mode  =  argv.dup.shift.to_s.downcase
+        else
+          @@mode  =  mode.to_s.downcase
+        end
+
+        @@progname  =  progname || File.basename( $PROGRAM_NAME, '.rb' )
+        unless  %w[ run start stop restart status ].include?( @@mode )
+          STDERR.puts <<~USAGE
+          usage: #{@@progname}  [run|start|stop|restart|status]
+          USAGE
+          ::Kernel.exit( 1 )
+        end
+
+        if ( !app_dir.nil? && app_dir[0] == "/" )
+          @@app_dir  =  app_dir
+        else
+          @@app_dir  =  File.expand_path( File.join( PROGRAM_DIR, ( app_dir || ".." ) ) )
+        end
+        Dir.chdir( @@app_dir )
+
+        if ( !tmp_dir.nil? && tmp_dir[0] == "/" )
+          @@tmp_dir  =  tmp_dir
+        else
+          @@tmp_dir  =  File.expand_path( File.join( @@app_dir, ( tmp_dir || "tmp" ) ) )
+        end
+        unless  Dir.exist?( @@tmp_dir )
+          FileUtils.makedirs( @@tmp_dir )
+        end
+
+        @@pid_path  =  File.expand_path( File.join( @@tmp_dir, @@progname + ".pid" ) )
+
+        if ( !log_dir.nil? && log_dir[0] == "/" )
+          @@log_dir  =  log_dir
+        else
+          @@log_dir  =  File.expand_path( File.join( @@app_dir, ( log_dir || "log" ) ) )
+        end
+
+        unless  Dir.exist?( @@log_dir )
+          FileUtils.makedirs( @@log_dir )
+        end
+
+        @@log_path  =  File.expand_path( File.join( @@log_dir, @@progname + ".log" ) )
+      end
+
+      def setup_service
+        File.open( @@pid_path, "w" ) do |f|
+          f.puts( Process.pid )
+        end
+        $0  =  "[#{ @@progname }]"
+      end
+
+      def delete_pid_path
+        if  File.exist?( @@pid_path )
+          File.delete( @@pid_path )
+        end
+      end
+
+      def setup_logger( log_path: nil, shift_age: nil, shift_size: nil, log_sync: nil, **options )
+        sync  =  ( log_sync.nil? ? true : log_sync )
+        if  log_path
+          if shift_age && shift_size
+            @@logger  =  ::Logger.new( log_path, shift_age, shift_size.to_i, **options )
+          elsif shift_age && shift_size.nil?
+            @@logger  =  ::Logger.new( log_path, shift_age, **options )
+          else
+            @@logger  =  ::Logger.new( log_path, **options )
+          end
+
+          dev  =  @@logger.instance_variable_get(:@logdev).dev
+          $stdout.reopen  dev
+          $stdout.sync  =  sync
+          $stderr.reopen  dev
+          $stderr.sync  =  sync
+        else
+          @@logger  =  ::Logger.new( STDOUT, **options )
+          STDOUT.sync  =  sync
+        end
+      end
+
+      # send INT signal to background process.
+      def request_to_stop
+        pid  =  File.open( @@pid_path ).read.to_i    rescue  raise( ArgumentError, "could not load '#{ @@pid_path }'." )
+        Process.kill( :INT, pid )                    rescue  raise( ArgumentError, "could not send signal." )
+      rescue => e
+        puts  e.message
+      end
+
+      def alive?
+        result  =  true
+        begin
+          pid  =  File.open( @@pid_path ).read.to_i
+          Process.kill( 0, pid )
+        rescue => e
+          result  =  false
+        end
+        result
+      end
+    end
+
+  end
+end
+

data/lib/app/service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module App
+  class Service
+    VERSION = "0.1.0"
+  end
+end

data/sample/sample1.rb

@@ -0,0 +1,11 @@
+require "app/service"
+
+p :echo_console
+App::Service.setup( ARGV.shift )
+
+p :echo_redirect
+sleep  1
+
+App::Service.shutdown
+p :not_reach
+

data/sample/sample2.rb

@@ -0,0 +1,25 @@
+require "app/service"
+
+options = {
+# app_dir:              "..",
+# tmp_dir:              "tmp",
+# log_dir:              "log",
+# log_sync:             true,   # Boolean
+
+# shift_age:            0,      # 0, Positive, "daily", "weekly", "monthly"
+# shift_size:           1048576,# Positive
+# level:                Logger::Severity::DEBUG,
+                                # 0:DEBUG, 1:INFO, 2:WARN, 3:ERROR, 4:FATAL, 5:UNKNOWN
+# progname:             nil,
+# formatter:            Formatter.new,
+# datetime_format:      '%Y-%m-%d %H:%M:%S', 
+# shift_period_suffix:  '%Y%m%d',
+}
+
+App::Service.setup( ARGV.shift, **options )
+
+logger  =  App::Service.logger
+logger.info  App::Service.mode
+sleep  1
+logger.info  "quit"
+

data/sample/sample3.rb

@@ -0,0 +1,14 @@
+require "app/service"
+
+App::Service.setup( ARGV.shift )
+
+[:TERM, :INT].each do |signal|
+  ::Signal.trap( signal ) do
+    p signal
+    App::Service.shutdown
+  end
+end
+
+p App::Service.mode
+sleep
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: app-service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ARIMA Yasuhiro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-18 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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'
+description: " App::Service is a library for service application daemonize. "
+email:
+- arima.yasuhiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.adoc
+- README.ja.adoc
+- Rakefile
+- app-service.gemspec
+- bin/console
+- bin/setup
+- lib/app/service.rb
+- lib/app/service/version.rb
+- sample/sample1.rb
+- sample/sample2.rb
+- sample/sample3.rb
+homepage: https://github.com/arimay/app-service
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Service application daemonize.
+test_files: []