zeus 0.1.0 → 0.2.0.beta1

data/README.md

@@ -4,17 +4,19 @@
 
 Zeus preloads your app so that your normal development tasks such as `console`, `server`, `generate`, and tests are faster.
 
+[Mediocre screencast](http://burke.libbey.me/zeus.mov). Better one coming soon.
+
 ## Why?
 
 Because waiting 25 seconds sucks, but waiting 0.4 seconds doesn't.
 
 ## When?
 
-Not yet. Zeus is nowhere near production-ready yet. Use only if you really like broken things.
+Soon? You can use Zeus now, but don't expect it to be perfect. I'm working hard on it.
 
 ## Ugly bits
 
-* Probably crashes a lot
+* Not battle-tested yet
 * Creates a bunch of sockets
 * Uses an obscene number of file descriptors
 
@@ -43,13 +45,15 @@ Run some commands:
 
 ## TODO (roughly prioritized)
 
-* Kill process when files are detected to have changed
-* Handle client/server without requiring a unix socket for each acceptor (1 shared socket)
+* Fix all the bugs I added when I switched to singlesocket...
 * Make the code less terrible
 * Figure out how to run full test suites without multiple env loads
 * Support other frameworks?
-* Use fsevents instead of kqueue to reduce the obscene number of file descriptors.
-* Support epoll on linux
+* Use fsevent instead of kqueue to reduce the obscene number of file descriptors.
+* Support inotify on linux
+* Handle connections for not-yet-started sockets
+* Don't replace a socket with changed deps until the new one is ready
+* (maybe) Start the preloader as a daemon transparently when any command is run, then wait for it to finish
 
 ## Contributing
 
@@ -58,3 +62,17 @@ Run some commands:
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Thanks...
+
+* To [Jesse Storimer](http://github.com/jstorimer) for spin, part of the inspiration for this project
+* To [Samuel Kadolph](http://github.com/samuelkadolph) for doing most of the cross-process pseudoterminal legwork.
+* To [Shopify](http://github.com/Shopify) for letting me spend (some of) my days working on this.
+
+## Doesn't work for you?
+
+Try these libraries instead:
+
+* [spin](https://github.com/jstorimer/spin)
+* [spork](https://github.com/sporkrb/spork)
+* [guard](https://github.com/guard/guard)

data/bin/zeus

@@ -1,12 +1,42 @@
 #!/usr/bin/env ruby
 
-zeus = File.expand_path("../../lib/", __FILE__)
-$:.unshift(zeus) unless $:.include?(zeus)
+require 'zeus'
+  require 'zeus/cli'
+  Zeus::CLI.start
 
-if ARGV[0] == "start"
+begin
+rescue Zeus::ZeusError => e
+  Zeus.ui.error e.message
+  Zeus.ui.debug e.backtrace.join("\n")
+  exit e.status_code
+rescue Interrupt => e
+  Zeus.ui.error e.message
+  Zeus.ui.debug e.backtrace.join("\n")
+  exit 1
+rescue SystemExit => e
+  exit e.status
+rescue Exception => e
+  Zeus.ui.error("A fatal error has occurred. Please see the github issues at:\n" \
+    "http://github.com/burke/zeus/issues")
+end
+exit 0
+
+
+case ARGV[0]
+when "start"
   require 'zeus/server'
-  require './.zeus.rb'
+  begin
+    require './.zeus.rb'
+  rescue LoadError
+    puts "\x1b[31mYour project is missing a config file (.zeus.rb), or you are not in the project root."
+    puts "You can run `zeus init` to generate a config file.\x1b[0m"
+    exit 1
+  end
   Zeus::Server.run
+when "init"
+  require 'zeus/init'
+  ARGV.shift # get "init" off the list
+  Zeus::Init.run(ARGV)
 else
   require 'zeus/client'
   Zeus::Client.run

data/lib/tiny_thor.rb

@@ -0,0 +1,96 @@
+class TinyThor
+
+  class Task < Struct.new(:method_name, :desc, :long_desc, :method_options)
+    def arity(obj)
+      obj.method(method_name).arity
+    end
+  end
+
+  def self.desc(name, a)
+    @desc = a
+  end
+  def self.long_desc(a)
+    @long_desc = a
+  end
+  def self.method_option(*a)
+    @method_options ||= []
+    @method_options << a
+  end
+
+  def self.method_added(m)
+    desc, long_desc, method_options = @desc, @long_desc, (@method_options||[])
+    @desc, @long_desc, @method_options = nil, nil, nil
+
+    @tasks ||= {}
+    @tasks[m.to_s] = Task.new(m, desc, long_desc, method_options)
+  end
+
+  def self.map(a)
+    a.each do |aliases, target|
+      aliases = [aliases] unless aliases.kind_of?(Array)
+      aliases.each do |name|
+        @tasks[name.to_s] = @tasks[target.to_s]
+      end
+    end
+  end
+
+  def self.task_for_name(name)
+    @tasks[name.to_s]
+  end
+
+  def task_for_name(name)
+    self.class.task_for_name(name)
+  end
+
+  def help(taskname = nil)
+    if taskname && task = task_for_name(taskname)
+      arity = task.arity(self)
+      puts <<-BANNER
+Usage:
+  zeus #{taskname} #{arity == -1 ? "[ARGS]" : ""}
+
+Description:
+  #{task.long_desc || task.desc}
+BANNER
+    else
+      # this is super non-generic. problem for future-burke.
+      project_tasks = self.class.instance_variable_get("@tasks").
+        reject{|k,_|['init', 'start', 'help'].include?(k)}.values.uniq
+
+      tasks = project_tasks.map { |task|
+        "  zeus %-14s # %s" % [task.method_name, task.desc]
+      }
+
+      puts <<-BANNER
+Global Commands:
+  zeus help           # show this help menu
+  zeus help [COMMAND] # show help for a specific command
+  zeus init           # #{task_for_name(:init).desc}
+  zeus start          # #{task_for_name(:start).desc}
+
+Project-local Commands:
+#{tasks.join("\n")}
+BANNER
+    end
+  end
+
+  def self.start
+    taskname = ARGV.shift
+    arguments = ARGV
+
+    taskname == "" and taskname = "help"
+
+    unless task = @tasks[taskname.to_s]
+      Zeus.ui.error "Could not find task \"#{taskname}\""
+      exit 1
+    end
+
+    instance = new
+    if instance.method(task.method_name).arity == 0 && arguments.any?
+      Zeus.ui.error "\"#{task.method_name}\" was called incorrectly. Call as \"zeus #{task.method_name}\"."
+      exit 1
+    end
+    instance.send(task.method_name, *arguments)
+  end
+
+end

data/lib/zeus.rb

@@ -1,5 +1,20 @@
 require "zeus/version"
+require 'zeus/server'
+require "zeus/ui"
 
 module Zeus
-  # Your code goes here...
+  class ZeusError < StandardError
+    def self.status_code(code)
+      define_method(:status_code) { code }
+    end
+  end
+
+  def self.ui
+    @ui ||= UI.new
+  end
+
+  def self.ui=(ui)
+    @ui = ui
+  end
+
 end

data/lib/zeus/cli.rb

@@ -0,0 +1,72 @@
+require 'zeus'
+require 'tiny_thor'
+
+module Zeus
+  class CLI < TinyThor
+
+    def initialize(*)
+      super
+      Zeus.ui = Zeus::UI.new
+      Zeus.ui.debug! #if options['verbose']
+    end
+
+    desc "init", "Generates a zeus config file in the current working directory"
+    long_desc <<-D
+      Init tries to determine what kind of project is in the current working directory,
+      and generates a relevant config file. Currently the only supported template is
+      rails.
+    D
+    # method_option "rails", type: :string, banner: "Use the rails template instead of auto-detecting based on project contents"
+    def init
+      if File.exist?(".zeus.rb")
+        Zeus.ui.error ".zeus.rb already exists at #{Dir.pwd}/.zeus.rb"
+        exit 1
+      end
+
+      Zeus.ui.info "Writing new .zeus.rb to #{Dir.pwd}/.zeus.rb"
+      FileUtils.cp(File.expand_path("../templates/rails.rb", __FILE__), '.zeus.rb')
+    end
+
+    desc "start", "Start a zeus server for the project in the current working directory"
+    long_desc <<-D
+      starts a server that boots your application using the config file in
+      .zeus.rb. The server will take several seconds to start, after which you may
+      use the zeus runner commands (see `zeus help` for a list of available commands).
+    D
+    def start
+      require 'zeus/server'
+      begin
+        require './.zeus.rb'
+      rescue LoadError
+        Zeus.ui.error("Your project is missing a config file (.zeus.rb), or you are not\n"\
+          "in the project root. You can run `zeus init` to generate a config file.")
+        exit 1
+      end
+      Zeus::Server.new.run
+    end
+
+    def help(*)
+      super
+    end
+
+    desc "version", "Print zeus's version information and exit"
+    def version
+      Zeus.ui.info "Zeus version #{Zeus::VERSION}"
+    end
+    map %w(-v --version) => :version
+
+    begin
+      require './.zeus.rb'
+      Zeus::Server.acceptors.each do |acc|
+        desc acc.name, (acc.description || "#{acc.name} task defined in .zeus.rb")
+        define_method(acc.name) { |*args|
+          require 'zeus/client'
+          Zeus::Client.run(acc.name, args)
+        }
+        map acc.aliases => acc.name
+      end
+    rescue LoadError
+    end
+
+  end
+end

data/lib/zeus/client.rb

@@ -20,32 +20,19 @@ module Zeus
       end
     end
 
-    def self.run
+    def self.run(command, args)
       maybe_raw do
         PTY.open do |master, slave|
           $stdout.tty? and master.winsize = $stdout.winsize
           winch, winch_ = IO.pipe
           trap("WINCH") { winch_ << "\0" }
 
-          case ARGV.shift
-          when 'testrb', 't'
-            socket = UNIXSocket.new(".zeus.test_testrb.sock")
-          when 'console', 'c'
-            socket = UNIXSocket.new(".zeus.dev_console.sock")
-          when 'server', 's'
-            socket = UNIXSocket.new(".zeus.dev_server.sock")
-          when 'rake'
-            socket = UNIXSocket.new(".zeus.dev_rake.sock")
-          when 'runner', 'r'
-            socket = UNIXSocket.new(".zeus.dev_runner.sock")
-          when 'generate', 'g'
-            socket = UNIXSocket.new(".zeus.dev_generate.sock")
-          end
+          socket = UNIXSocket.new(".zeus.sock")
+          socket << {command: command, arguments: args}.to_json << "\n"
           socket.send_io(slave)
-          socket << ARGV.to_json << "\n"
           slave.close
 
-          pid = socket.gets.strip.to_i
+          pid = socket.readline.chomp.to_i
 
           begin
             buffer = ""
@@ -76,3 +63,5 @@ module Zeus
     end
   end
 end
+
+__FILE__ == $0 and Zeus::Client.run

data/lib/zeus/dsl.rb

@@ -0,0 +1,88 @@
+require 'zeus/server/stage'
+require 'zeus/server/acceptor'
+
+module Zeus
+  module DSL
+
+    class Evaluator
+      def stage(name, &b)
+        stage = DSL::Stage.new(name)
+        stage.instance_eval(&b)
+      end
+    end
+
+    class Acceptor
+
+      attr_reader :name, :aliases, :description, :action
+      def initialize(name, aliases, description, &b)
+        @name = name
+        @description = description
+        @aliases = aliases
+        @action = b
+      end
+
+      # ^ configuration
+      # V later use
+
+      def acceptors
+        self
+      end
+
+      def to_domain_object(server)
+        Zeus::Server::Acceptor.new(server).tap do |stage|
+          stage.name = @name
+          stage.aliases = @aliases
+          stage.action = @action
+          stage.description = @description
+        end
+      end
+
+    end
+
+    class Stage
+
+      attr_reader :pid, :stages, :actions
+      def initialize(name)
+        @name = name
+        @stages, @actions = [], []
+      end
+
+      def action(&b)
+        @actions << b
+        self
+      end
+
+      def desc(desc)
+        @desc = desc
+      end
+
+      def stage(name, &b)
+        @stages << DSL::Stage.new(name).tap { |s| s.instance_eval(&b) }
+        self
+      end
+
+      def command(name, *aliases, &b)
+        @stages << DSL::Acceptor.new(name, aliases, @desc, &b)
+        @desc = nil
+        self
+      end
+
+      # ^ configuration
+      # V later use
+
+      def acceptors
+        stages.map(&:acceptors).flatten
+      end
+
+      def to_domain_object(server)
+        Zeus::Server::Stage.new(server).tap do |stage|
+          stage.name = @name
+          stage.stages = @stages.map { |stage| stage.to_domain_object(server) }
+          stage.actions = @actions
+        end
+      end
+
+    end
+
+  end
+end

data/lib/zeus/init.rb

@@ -0,0 +1,17 @@
+module Zeus
+  module Init
+
+    def self.run
+      if looks_like_rails?
+        copy_rails_template!
+      else
+        puts 
+      end
+    end
+
+    def self.looks_like_rails?
+      File.exist?('Gemfile') && File.read('Gemfile').include?('rails')
+    end
+
+  end
+end