islo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b73d49fca1c9bbc70e94c8127f312cfa7710d435
+  data.tar.gz: 61ab656bc1d910a4d59036e0dd13add441a2da3b
+SHA512:
+  metadata.gz: 016bb45985d99b0814010a4719aa124701d4675c4c2ef74098150a32ae13ff4c628eb677cdb9908a1b5577d9c86c38116a77a02b73079e05fb8f81cb99f07fcf
+  data.tar.gz: d60f682ee982622d098294b0052efec9554f398b12ab136ab4237c7f2d8617eff6d907da1d023eb48a23e4229e445434761a5ec3801f003920c8de3fb9ecf61b

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Loic Nageleisen
+
+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,74 @@
+# Islo - Self-contained apps
+
+Make apps completely self-contained by abstracting service process settings and execution.
+
+## Quick, show me how to use my favorite daemon!
+
+First, install Islo:
+
+```
+$ gem install islo
+```
+
+Then, a nice example might be worth a thousand words, so here goes:
+
+### MySQL or MariaDB
+
+```
+$ islo mysql_install_db  # creates database in db/mysql
+$ islo mysqld            # starts server without daemonizing[^1]
+$ islo mysql             # connects to running server via unix socket in tmp/sockets
+```
+
+### Redis
+
+```
+$ islo redis-init        # creates directory in db/redis
+$ islo redis-server      # starts server without daemonizing[^1]
+$ islo redis-cli         # connects to server via unix socket in tmp/sockets
+```
+
+### PostgreSQL
+
+```
+$ islo initdb            # creates directory in db/postgres
+$ islo postgres          # starts server without daemonizing[^1]
+$ islo psql              # connects to server via unix socket in tmp/sockets
+```
+
+[^1]: Best used in a [Procfile](https://github.com/ddollar/foreman)
+
+## What's more to know?
+
+- Additional arguments are passed to the command.
+
+  Run `islo --help` for details.
+
+- Servers will listen only on unix sockets, TCP will be disabled.
+
+  This saves headaches when you have to handle multiple projects, and thus
+  conflicting ports. Also, it's too easy to forget not to listen for the world.
+
+## My service is installed in a non-standard location/I want to use different versions in different projects
+
+Configuration is a pending item, which will make locations selectable.
+
+## I don't like how it assumes a Rails project layout
+
+Configuration is a pending item, which will help set relevant paths.
+
+## I've got a super service you don't seem to know about
+
+Some configuration may help you soon. Also, contributions are welcome.
+
+## I can't be bothered/always forget to type *islo* before my commands every single time!
+
+Look soon enough under `support` for a few optional helpers for your favorite shell.
+
+## I want to contribute. How?
+
+Great! Write specs, have them all pass, respect rubocop, rebase on master and make your PR.
+
+## License
+
+MIT, see [LICENSE](LICENSE).

data/bin/islo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'islo/cli'
+
+Islo::CLI.start

data/islo.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'islo/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'islo'
+  s.version     = Islo::VERSION
+  s.authors     = ['Loic Nageleisen']
+  s.email       = ['loic.nageleisen@gmail.com']
+  s.homepage    = 'http://github.com/lloeki/islo'
+  s.summary     = %q(Self-contained apps)
+  s.description = <<-EOT
+    Makes app completely self-contained by abstracting
+    service process settings and execution
+  EOT
+  s.license     = 'MIT'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rainbow', '~> 2.0'
+  s.add_dependency 'slop'
+
+  s.add_development_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'pry'
+end

data/lib/islo.rb

@@ -0,0 +1,21 @@
+# Islo - application isolator
+module Islo
+  class << self
+    def commands
+      @commands ||= {}
+    end
+
+    def register(command)
+      commands[command.name.to_sym] = command
+    end
+
+    def command(args, options = {})
+      name = File.basename(args[0]).to_sym
+      (commands[name] || Command).new(args, options)
+    end
+  end
+end
+
+[:mysql, :postgres, :redis].each do |c|
+  require "islo/commands/#{c}"
+end

data/lib/islo/cli.rb

@@ -0,0 +1,91 @@
+require 'slop'
+require 'islo'
+require 'rainbow/ext/string'
+
+module Islo
+  # Handle and run the command line interface
+  class CLI
+    NAME = File.basename($PROGRAM_NAME)
+
+    # See sysexits(3)
+    RC = { ok:           0,
+           error:        1,
+           usage:       64,
+           data:        65,
+           noinput:     66,
+           nouser:      67,
+           nohost:      68,
+           unavailable: 69,
+           software:    70,
+           oserr:       71,
+           osfile:      72,
+           cantcreat:   73,
+           ioerr:       74,
+           tempfail:    75,
+           protocol:    76,
+           noperm:      77,
+           config:      78 }
+
+    # Shortcut for Islo::CLI.new.start
+    def self.start
+      new.start
+    end
+
+    attr_reader :args
+
+    def opts
+      @opts.to_hash
+    end
+
+    def initialize(args = ARGV)
+      @args, @opts = parse(args)
+    rescue Slop::InvalidOptionError => e
+      die(:usage, e.message)
+    rescue Slop::MissingArgumentError => e
+      die(:usage, e.message)
+    end
+
+    # Start execution based on options
+    def start
+      Islo.command(args, title: opts[:title]).exec
+    rescue Islo::Command::Error => e
+      die(:oserr, e.message)
+    end
+
+    private
+
+    # Stop with a popping message and exit with a return code
+    def die(rc, message)
+      $stderr.puts('Error: '.color(:red) << message)
+      exit(rc.is_a?(Symbol) ? RC[rc] : rc)
+    end
+
+    # Stop with a nice message
+    def bye(message)
+      $stdout.puts message
+      exit
+    end
+
+    def version_string
+      "#{NAME} v#{Islo::VERSION}"
+    end
+
+    # Parse arguments and set options
+    # rubocop:disable MethodLength
+    def parse(args)
+      args = args.dup
+
+      opts = Slop.parse!(args, strict: true, help: true) do
+        banner "Usage: #{NAME} [options] [--] command arguments"
+
+        on 't', 'title=', 'String displayed in process list', argument: true
+        on 'd', 'directory=', 'Change working directory', argument: true
+        on 'v', 'version', 'Print the version', -> { bye(version_string) }
+      end
+
+      fail Slop::MissingArgumentError, 'missing an argument' if args.empty?
+
+      [args, opts]
+    end
+  end
+end

data/lib/islo/command.rb

@@ -0,0 +1,36 @@
+module Islo
+  # Generic command execution
+  class Command
+    class Error < StandardError; end
+
+    attr_reader :title, :wd
+    attr_reader :command, :args
+
+    def initialize(args, title: nil, wd: nil)
+      @command = args.shift
+      @args = args
+      @title = title unless title.nil? || title.empty?
+      @wd = Pathname.new(wd || Dir.pwd)
+    end
+
+    def title?
+      !title.nil?
+    end
+
+    def exec
+      Dir.chdir(wd.to_s)
+      Kernel.exec(*args_for_exec)
+    rescue SystemCallError => e
+      raise Command::Error, e.message
+    end
+
+    private
+
+    def args_for_exec
+      command = (title? ? [@command, title] : @command)
+      args = self.args
+
+      [command] + args
+    end
+  end
+end

data/lib/islo/commands/mysql.rb

@@ -0,0 +1,70 @@
+require 'islo/command'
+
+module Islo
+  # MySQL support
+  module Mysql
+    # MySQL client
+    class Client < Command
+      def self.name
+        :mysql
+      end
+
+      def args
+        %W(
+          --socket=#{wd}/tmp/sockets/mysql.sock
+          -uroot
+        ) + super
+      end
+
+      Islo.register(self)
+    end
+
+    # MySQL server
+    class Server < Command
+      def self.name
+        :mysqld
+      end
+
+      def args
+        %W(
+          --no-defaults
+          --datadir=#{wd}/db/mysql
+          --pid-file=#{wd}/tmp/pids/mysqld.pid
+          --socket=#{wd}/tmp/sockets/mysql.sock
+          --skip-networking
+        ) + super
+      end
+
+      Islo.register(self)
+    end
+
+    # MySQL initializer
+    class Init < Command
+      def self.name
+        :mysql_install_db
+      end
+
+      def args
+        %W(
+          --no-defaults
+          --basedir=#{Mysql.basedir}
+          --datadir=#{wd}/db/mysql
+          --pid-file=#{wd}/tmp/pids/mysqld.pid
+        ) + super
+      end
+
+      Islo.register(self)
+    end
+
+    def self.basedir
+      path = %x(which mysql)
+
+      fail Command::Error, 'could not find mysql' if path.empty?
+
+      path = File.dirname(path)
+      path = File.dirname(path)
+
+      path
+    end
+  end
+end

data/lib/islo/commands/postgres.rb

@@ -0,0 +1,50 @@
+require 'islo/command'
+
+module Islo
+  # PostgreSQL support
+  module Postgres
+    # PostgreSQL client
+    class Client < Command
+      def self.name
+        :psql
+      end
+
+      def args
+        %W(--host=#{wd}/tmp/sockets) + super
+      end
+
+      Islo.register(self)
+    end
+
+    # PostgreSQL server
+    class Server < Command
+      def self.name
+        :postgres
+      end
+
+      def args
+        %W(
+          -D #{wd}/db/postgres
+          -k #{wd}/tmp/sockets
+        ) + ['-h', ''] + super
+      end
+
+      Islo.register(self)
+    end
+
+    # PostgreSQL initializer
+    class Init < Command
+      def self.name
+        :initdb
+      end
+
+      def args
+        %W(
+          -D #{wd}/db/postgres
+        ) + super
+      end
+
+      Islo.register(self)
+    end
+  end
+end

data/lib/islo/commands/redis.rb

@@ -0,0 +1,108 @@
+require 'islo/command'
+
+module Islo
+  # Redis support
+  module Redis
+    # Redis client
+    class Client < Command
+      def self.name
+        :'redis-cli'
+      end
+
+      def args
+        %w(-s redis.sock)
+      end
+
+      # Change working directory (makes for a nicer prompt)
+      def wd
+        super + 'tmp/sockets'
+      end
+
+      Islo.register(self)
+    end
+
+    # Redis server
+    class Server < Command
+      def self.name
+        :'redis-server'
+      end
+
+      def args
+        %W(#{wd}/db/redis/redis.conf)
+      end
+
+      Islo.register(self)
+    end
+
+    # Redis initializer
+    #
+    # Creates a minimal configuration because redis-server doesn't accept
+    # arguments allowing for paths to be set.
+    class Init < Command
+      def self.name
+        :'redis-init'
+      end
+
+      def exec
+        FileUtils.mkdir_p(wd + 'db/redis')
+
+        File.open(wd + 'db/redis/redis.conf', 'w') do |f|
+          f << template.gsub('${WORKING_DIR}', wd.to_s)
+        end
+      rescue SystemCallError => e
+        raise Command::Error, e.message
+      end
+
+      private
+
+      # rubocop:disable MethodLength,LineLength
+      def template
+        <<-EOT.gsub(/^ +/, '')
+          daemonize no
+          pidfile ${WORKING_DIR}/pids/redis.pid
+          port 0
+          bind 127.0.0.1
+          unixsocket ${WORKING_DIR}/tmp/sockets/redis.sock
+          unixsocketperm 700
+          timeout 0
+          tcp-keepalive 0
+          loglevel notice
+          databases 1
+          save 900 1
+          save 300 10
+          save 60 10000
+          stop-writes-on-bgsave-error yes
+          rdbcompression yes
+          rdbchecksum yes
+          dbfilename dump.rdb
+          dir ${WORKING_DIR}/db/redis
+          slave-serve-stale-data yes
+          slave-read-only yes
+          repl-disable-tcp-nodelay no
+          slave-priority 100
+          appendonly yes
+          appendfsync everysec
+          no-appendfsync-on-rewrite no
+          auto-aof-rewrite-percentage 100
+          auto-aof-rewrite-min-size 64mb
+          lua-time-limit 5000
+          slowlog-log-slower-than 10000
+          slowlog-max-len 128
+          hash-max-ziplist-entries 512
+          hash-max-ziplist-value 64
+          list-max-ziplist-entries 512
+          list-max-ziplist-value 64
+          set-max-intset-entries 512
+          zset-max-ziplist-entries 128
+          zset-max-ziplist-value 64
+          activerehashing yes
+          client-output-buffer-limit normal 0 0 0
+          client-output-buffer-limit slave 256mb 64mb 60
+          client-output-buffer-limit pubsub 32mb 8mb 60
+        EOT
+      end
+
+      Islo.register(self)
+    end
+  end
+end

data/lib/islo/version.rb

@@ -0,0 +1,3 @@
+module Islo
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: islo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Loic Nageleisen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: |2
+      Makes app completely self-contained by abstracting
+      service process settings and execution
+email:
+- loic.nageleisen@gmail.com
+executables:
+- islo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/islo
+- islo.gemspec
+- lib/islo.rb
+- lib/islo/cli.rb
+- lib/islo/command.rb
+- lib/islo/commands/mysql.rb
+- lib/islo/commands/postgres.rb
+- lib/islo/commands/redis.rb
+- lib/islo/version.rb
+homepage: http://github.com/lloeki/islo
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Self-contained apps
+test_files: []