archfiend 0.1.0

data/lib/archfiend/generators/options.rb

@@ -0,0 +1,51 @@
+require 'ostruct'
+require 'optparse'
+
+module Archfiend
+  module Generators
+    class Options
+      extend Forwardable
+      SETTINGS_FILE = '.archfiend'.freeze
+
+      def_delegators :@options, :extensions
+
+      def initialize(args)
+        default_args = parse_archfiend_file || []
+        @options = parse_options(default_args + args)
+      end
+
+      private
+
+      def parse_options(args)
+        options = OpenStruct.new
+        options.extensions = Set.new
+
+        opt_parser = OptionParser.new do |opts|
+          opts.on '-e', '--extension EXTENSION_NAME', 'Include the specified Archfiend extension' do |extension_name|
+            options.extensions << extension_name
+          end
+        end
+
+        opt_parser.parse!(args)
+        options
+      end
+
+      # Look if there is a default settings file in pwd or all the way up and read it
+      #
+      # @return [Array<String>, nil] A list of options from the options file or nil when no file
+      def parse_archfiend_file
+        settings_file = Utils.find_file(SETTINGS_FILE)
+
+        return unless settings_file
+
+        unless File.readable?(settings_file)
+          puts "Skipping #{settings_file}, not readable"
+          return
+        end
+
+        puts "Reading #{settings_file} for default options"
+        File.read(settings_file).split
+      end
+    end
+  end
+end

data/lib/archfiend/generators/utils.rb

@@ -0,0 +1,37 @@
+module Archfiend
+  module Generators
+    module Utils
+      class << self
+        # Methods borrowed from Bundler
+        # source: bundler/lib/bundler/shared_helpers.rb
+        def find_file(*names)
+          search_up(*names) do |filename|
+            return filename if File.file?(filename)
+          end
+        end
+
+        def find_directory(*names)
+          search_up(*names) do |dirname|
+            return dirname if File.directory?(dirname)
+          end
+        end
+
+        private
+
+        def search_up(*names)
+          previous = nil
+          current  = File.expand_path(Pathname.pwd).untaint
+
+          until !File.directory?(current) || current == previous
+            names.each do |name|
+              filename = File.join(current, name)
+              yield filename
+            end
+            previous = current
+            current = File.expand_path('..', current)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/archfiend/logging.rb

@@ -0,0 +1,38 @@
+require 'logger'
+require 'oj'
+
+module Archfiend
+  class Logging
+    class << self
+      # @param environment [String|Symbol] Current running environment, ex. :development
+      # @param log_directory [String,Pathname] Directory in which the logfile is supposed to live
+      # @param quiet [Boolean] Whether the STDOUT development output should be suppressed
+      # @return [MultiLogger] A multiplexer for up to two loggers
+      def create(environment, log_directory, quiet = false)
+        environment = environment.to_sym
+        loggers = [file_logger(environment, log_directory)]
+        loggers << stdio_logger if environment == :development && !quiet
+
+        MultiLogger.new(*loggers)
+      end
+
+      private
+
+      def file_logger(environment, log_directory)
+        log_name = File.join(log_directory, "#{environment}.log")
+        file_logger = Logger.new(log_name, 'daily')
+        file_logger.formatter = JSONFormatter.new
+        file_logger
+      end
+
+      def stdio_logger
+        stdout_io = IO.try_convert(STDOUT)
+        stdout_io.sync = true
+        stdout_logger = Logger.new(stdout_io)
+
+        stdout_logger.formatter = DefaultFormatter.new
+        stdout_logger
+      end
+    end
+  end
+end

data/lib/archfiend/logging/base_formatter.rb

@@ -0,0 +1,35 @@
+module Archfiend
+  class Logging
+    class BaseFormatter
+      STACK_ENTRIES_TO_SKIP = 9 # How many stack frames to exclude from the backtrace
+      SEVERITY_STACK_ENTRIES_COUNT = { # How many stack frames to include
+        'FATAL' => 10,
+        'ERROR' => 10,
+        'WARN' => 5,
+        'INFO' => 2,
+        'DEBUG' => 2,
+        'UNKNOWN' => 2
+      }.freeze
+
+      private
+
+      def description_and_backtrace(severity, msg)
+        description = nil
+        backtrace = nil
+
+        if msg.is_a?(Hash)
+          description = msg[:message]
+          backtrace = msg[:backtrace]&.slice(0, SEVERITY_STACK_ENTRIES_COUNT[severity])
+        else
+          description = msg
+        end
+        backtrace ||= caller.slice(STACK_ENTRIES_TO_SKIP - 1, SEVERITY_STACK_ENTRIES_COUNT[severity])
+        [description, backtrace]
+      end
+
+      def tid
+        Thread.current[:tid] ||= (Thread.current.object_id ^ ::Process.pid).to_s(36)
+      end
+    end
+  end
+end

data/lib/archfiend/logging/default_formatter.rb

@@ -0,0 +1,12 @@
+module Archfiend
+  class Logging
+    # Simple formatter that includes both PID and a unique thread id
+    class DefaultFormatter < BaseFormatter
+      def call(severity, datetime, _progname, msg)
+        description, _backtrace = description_and_backtrace(severity, msg)
+
+        "#{datetime.utc.iso8601(3)} #{::Process.pid} TID-#{tid} #{severity}: #{description}\n"
+      end
+    end
+  end
+end

data/lib/archfiend/logging/json_formatter.rb

@@ -0,0 +1,21 @@
+module Archfiend
+  class Logging
+    # A JSON log formatter class, returns each entry as a JSON line
+    class JSONFormatter < BaseFormatter
+      def call(severity, datetime, progname, msg)
+        description, backtrace = description_and_backtrace(severity, msg)
+        log_hash = {
+          '@timestamp': datetime.utc.iso8601(3),
+          loglevel: severity&.downcase,
+          pid: ::Process.pid,
+          tid: tid,
+          type: :archfiend,
+          message: description,
+          backtrace: backtrace,
+          app: progname
+        }
+        Oj.dump(log_hash, mode: :compat) + "\n"
+      end
+    end
+  end
+end

data/lib/archfiend/logging/multi_logger.rb

@@ -0,0 +1,31 @@
+module Archfiend
+  class Logging
+    # A basic class that forwards all log calls to loggers it was initialized with.
+    class MultiLogger < BasicObject
+      attr_reader :loggers
+
+      # @param loggers [Array<Logger>] A list of loggers to forward messages to
+      def initialize(*loggers)
+        @loggers = loggers.flatten
+        @responding_loggers = {}
+      end
+
+      private
+
+      # @return [Object] The return value is forwarded from the first logger that responds to the method_name
+      def method_missing(method_name, *args)
+        return super unless responding_loggers(method_name).any?
+
+        responding_loggers(method_name).map { |l| l.public_send(method_name, *args) }.first
+      end
+
+      def respond_to_missing?(symbol, include_private = false)
+        responding_loggers(method_name).any? || super
+      end
+
+      def responding_loggers(method_name)
+        @responding_loggers[method_name.to_sym] ||= @loggers.select { |l| l.respond_to?(method_name) }
+      end
+    end
+  end
+end

data/lib/archfiend/shared_loop/runnable.rb

@@ -0,0 +1,26 @@
+module Archfiend
+  module SharedLoop
+    module Runnable
+      def run
+        loop do
+          begin
+            wrap_iterate
+          rescue => e
+            log_exception(e)
+            sleep self.class.const_get('EXCEPTION_DELAY')
+          end
+        end
+      end
+
+      def log_exception(exception)
+        logger.error(message: exception.to_s, backtrace: exception.backtrace)
+      end
+
+      private
+
+      def wrap_iterate
+        iterate
+      end
+    end
+  end
+end

data/lib/archfiend/subprocess_loop.rb

@@ -0,0 +1,46 @@
+module Archfiend
+  class SubprocessLoop
+    extend Forwardable
+    include SharedLoop::Runnable
+
+    EXCEPTION_DELAY = 1 # Seconds to sleep for after rescuing recoverable exception
+
+    def_delegator :app, :logger
+
+    attr_accessor :app
+
+    class << self
+      attr_reader :subclasses, :subprocess_pids
+
+      def inherited(child_class)
+        @subclasses ||= []
+        @subclasses.push(child_class)
+        @subprocess_pids ||= [] # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+
+      def start_all(app)
+        (subclasses || []).each do |subclass|
+          process_id = fork do
+            instance = subclass.new
+            instance.app = app
+            app.logger.info "Starting subprocess #{subclass}"
+            instance.run
+          end
+          @subprocess_pids << process_id
+          Process.detach(process_id)
+        end
+      end
+
+      def kill_all
+        return if !@subprocess_pids || @subprocess_pids.empty?
+        @subprocess_pids.each do |spid|
+          begin
+            Process.kill('TERM', spid)
+          rescue Errno::ESRCH, Errno::EPERM # rubocop:disable Lint/HandleExceptions
+            # The list might contain some stale pids, if any of subprocesses terminated early
+          end
+        end
+      end
+    end
+  end
+end

data/lib/archfiend/thread_loop.rb

@@ -0,0 +1,35 @@
+module Archfiend
+  class ThreadLoop
+    extend Forwardable
+    include SharedLoop::Runnable
+
+    EXCEPTION_DELAY = 1 # Seconds to sleep for after rescuing recoverable exception
+
+    def_delegator :app, :logger
+
+    attr_accessor :app
+
+    class << self
+      attr_reader :subclasses
+
+      # Collects all subclasses in the class instance variable
+      def inherited(child_class)
+        @subclasses ||= []
+        @subclasses.push(child_class)
+      end
+
+      def start_all(app)
+        (subclasses || []).map do |thread_loop_class|
+          th = Thread.new do
+            instance = thread_loop_class.new
+            instance.app = app
+            app.logger.info "Starting thread #{thread_loop_class}"
+            instance.run
+          end
+          th[:name] = thread_loop_class.name
+          th
+        end
+      end
+    end
+  end
+end

data/lib/archfiend/version.rb

@@ -0,0 +1,3 @@
+module Archfiend
+  VERSION = '0.1.0'.freeze
+end

data/scripts/travis/install

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# This script handles the Travis build execution in the 'install' phase.
+# It runs Bundler.
+
+require 'pathname'
+require 'fileutils'
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+system('bundle check --gemfile=Gemfile') || system!('bundle install --jobs=3 --retry=3 --gemfile=Gemfile')

data/scripts/travis/script

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+# This script handles the Travis build execution in the 'script' phase.
+# It runs RuboCop and RSpec.
+
+require 'pathname'
+require 'fileutils'
+
+archfiend_root = Pathname.new File.expand_path(File.join('..', '..'), __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+system!('BUNDLE_GEMFILE=Gemfile bundle exec rubocop')
+system!('BUNDLE_GEMFILE=Gemfile bundle exec rspec')
+
+system!('mkdir testing')
+
+FileUtils.chdir(archfiend_root.join('testing')) do
+  system!('bundle exec archfiend new foo_bar')
+end
+
+database_yml = '
+test:
+  adapter: postgresql
+  database: foo_bar_test
+'
+
+File.open(archfiend_root.join('testing', 'foo_bar', 'config', 'database.yml'), 'w') do |f|
+  f.puts(database_yml)
+end
+
+FileUtils.chdir(File.join('testing', 'foo_bar')) do
+  system!('BUNDLE_GEMFILE=Gemfile bundle exec rake db:create')
+  system!('BUNDLE_GEMFILE=Gemfile bundle exec rake db:migrate')
+  system!('BUNDLE_GEMFILE=Gemfile bundle exec rspec')
+  system!('BUNDLE_GEMFILE=Gemfile bundle exec rubocop')
+
+  system!('BUNDLE_GEMFILE=Gemfile bin/start -d')
+  sleep(1)
+  system!('ps -o pid= -p `cat foo_bar.pid`')
+end

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: archfiend
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maciek Dubiński
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: config
+  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: oj
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: A tool to simplify creation and development of Ruby daemons.
+email:
+- maciek@dubinski.net
+executables:
+- archfiend
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGES.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- ROADMAP.md
+- Rakefile
+- archfiend.gemspec
+- bin/console
+- bin/setup
+- exe/archfiend
+- lib/archfiend.rb
+- lib/archfiend/application.rb
+- lib/archfiend/cli.rb
+- lib/archfiend/generators/daemon.rb
+- lib/archfiend/generators/daemon/templates/.rspec
+- lib/archfiend/generators/daemon/templates/.rubocop.yml
+- lib/archfiend/generators/daemon/templates/Gemfile.tt
+- lib/archfiend/generators/daemon/templates/README.md.tt
+- lib/archfiend/generators/daemon/templates/Rakefile.tt
+- lib/archfiend/generators/daemon/templates/app/clockwork/clockwork.rb.tt
+- lib/archfiend/generators/daemon/templates/app/models/application_record.rb
+- lib/archfiend/generators/daemon/templates/app/subprocess_loops/foo_subprocess_loop.rb
+- lib/archfiend/generators/daemon/templates/app/thread_loops/bar_thread_loop.rb
+- lib/archfiend/generators/daemon/templates/bin/console
+- lib/archfiend/generators/daemon/templates/bin/start.tt
+- lib/archfiend/generators/daemon/templates/config/application.rb.tt
+- lib/archfiend/generators/daemon/templates/config/boot.rb.tt
+- lib/archfiend/generators/daemon/templates/config/daemon.rb.tt
+- lib/archfiend/generators/daemon/templates/config/database.yml.example.tt
+- lib/archfiend/generators/daemon/templates/config/environment.rb.tt
+- lib/archfiend/generators/daemon/templates/config/settings.yml.tt
+- lib/archfiend/generators/daemon/templates/config/settings/development.yml.tt
+- lib/archfiend/generators/daemon/templates/config/settings/production.yml.tt
+- lib/archfiend/generators/daemon/templates/config/settings/staging.yml.tt
+- lib/archfiend/generators/daemon/templates/config/settings/test.yml.tt
+- lib/archfiend/generators/daemon/templates/db/migrate/.gitkeep
+- lib/archfiend/generators/daemon/templates/lib/tasks/.gitkeep
+- lib/archfiend/generators/daemon/templates/log/.gitkeep
+- lib/archfiend/generators/daemon/templates/spec/factories/.gitkeep
+- lib/archfiend/generators/daemon/templates/spec/models/.gitkeep
+- lib/archfiend/generators/daemon/templates/spec/spec_helper.rb
+- lib/archfiend/generators/daemon/templates/spec/subprocess_loops/foo_subprocess_loop_spec.rb
+- lib/archfiend/generators/daemon/templates/spec/support/factory_bot.rb
+- lib/archfiend/generators/daemon/templates/spec/support/timecop.rb
+- lib/archfiend/generators/daemon/templates/spec/thread_loops/bar_thread_loop_spec.rb
+- lib/archfiend/generators/daemon/templates/tmp/.gitkeep
+- lib/archfiend/generators/extensions.rb
+- lib/archfiend/generators/options.rb
+- lib/archfiend/generators/utils.rb
+- lib/archfiend/logging.rb
+- lib/archfiend/logging/base_formatter.rb
+- lib/archfiend/logging/default_formatter.rb
+- lib/archfiend/logging/json_formatter.rb
+- lib/archfiend/logging/multi_logger.rb
+- lib/archfiend/shared_loop/runnable.rb
+- lib/archfiend/subprocess_loop.rb
+- lib/archfiend/thread_loop.rb
+- lib/archfiend/version.rb
+- scripts/travis/install
+- scripts/travis/script
+homepage: https://github.com/toptal/archfiend
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A tool to simplify creation and development of Ruby daemons
+test_files: []