web-console 2.0.0.beta2 → 2.0.0.beta3

data/lib/web_console.rb

@@ -1,23 +1,22 @@
+require 'binding_of_caller'
+
 require 'active_support/lazy_load_hooks'
-require 'web_console/repl'
-require 'web_console/repl_session'
 require 'action_dispatch/exception_wrapper'
 require 'action_dispatch/debug_exceptions'
 
-module WebConsole
-  class << self
-    attr_accessor :binding_of_caller_available
+require 'web_console/exception_extension'
+require "web_console/view_helpers"
+require 'web_console/colors'
+require 'web_console/engine'
+require 'web_console/repl'
+require 'web_console/repl_session'
+require 'web_console/slave'
 
-    alias_method :binding_of_caller_available?, :binding_of_caller_available
+module WebConsole
+  # Shortcut the +WebConsole::Engine.config.web_console+.
+  def self.config
+    Engine.config.web_console
   end
-end
 
-begin
-  require 'binding_of_caller'
-  WebConsole.binding_of_caller_available = true
-rescue LoadError => e
-  WebConsole.binding_of_caller_available = false
+  ActiveSupport.run_load_hooks(:web_console, self)
 end
-
-require 'web_console/exception_extension'
-require 'web_console/railtie'

data/lib/web_console/colors.rb

@@ -0,0 +1,87 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module WebConsole
+  # = Colors
+  #
+  # Manages the creation and serialization of terminal color themes.
+  #
+  # Colors is a subclass of +Array+ and it stores a collection of CSS color
+  # values, to be used from the client-side terminal.
+  #
+  # You can specify 8 or 16 colors and additional +background+ and +foreground+
+  # colors. If not explicitly specified, +background+ and +foreground+ are
+  # considered to be the first and the last of the given colors.
+  class Colors < Array
+    class << self
+      # Registry of color themes mapped to a name.
+      #
+      # Don't manually alter the registry. Use WebConsole::Colors.register_theme
+      # for adding entries.
+      def themes
+        @@themes ||= {}.with_indifferent_access
+      end
+
+      # Register a color theme into the color themes registry.
+      #
+      # Registration maps a name and Colors instance.
+      #
+      # If a block is given, it would be yielded with a new Colors instance to
+      # populate the theme colors in.
+      #
+      # If a Colors instance is already instantiated it can be passed directly
+      # as the second (_colors_) argument. In this case, if a block is given,
+      # it won't be executed.
+      def register_theme(name, colors = nil)
+        themes[name] = colors || new.tap { |c| yield c }
+      end
+
+      # The default colors theme.
+      def default
+        self[:light]
+      end
+
+      # Shortcut for WebConsole::Colors.themes#[].
+      def [](name)
+        themes[name]
+      end
+    end
+
+    alias :add :<<
+
+    # Background color getter and setter.
+    #
+    # If called without arguments it acts like a getter. Otherwise it acts like
+    # a setter.
+    #
+    # The default background color will be the first entry in the colors theme.
+    def background(value = nil)
+      @background   = value unless value.nil?
+      @background ||= self.first
+    end
+
+    alias :background= :background
+
+    # Foreground color getter and setter.
+    #
+    # If called without arguments it acts like a getter. Otherwise it acts like
+    # a setter.
+    #
+    # The default foreground color will be the last entry in the colors theme.
+    def foreground(value = nil)
+      @foreground   = value unless value.nil?
+      @foreground ||= self.last
+    end
+
+    alias :foreground= :foreground
+
+    def to_json
+      (dup << background << foreground).to_a.to_json
+    end
+  end
+end
+
+require 'web_console/colors/light'
+require 'web_console/colors/monokai'
+require 'web_console/colors/solarized'
+require 'web_console/colors/tango'
+require 'web_console/colors/xterm'

data/lib/web_console/colors/light.rb

@@ -0,0 +1,24 @@
+module WebConsole
+  Colors.register_theme(:light) do |c|
+    c.add '#000000'
+    c.add '#cd0000'
+    c.add '#00cd00'
+    c.add '#cdcd00'
+    c.add '#0000ee'
+    c.add '#cd00cd'
+    c.add '#00cdcd'
+    c.add '#e5e5e5'
+
+    c.add '#7f7f7f'
+    c.add '#ff0000'
+    c.add '#00ff00'
+    c.add '#ffff00'
+    c.add '#5c5cff'
+    c.add '#ff00ff'
+    c.add '#00ffff'
+    c.add '#ffffff'
+
+    c.background '#ffffff'
+    c.foreground '#000000'
+  end
+end

data/lib/web_console/colors/monokai.rb

@@ -0,0 +1,24 @@
+module WebConsole
+  Colors.register_theme(:monokai) do |c|
+    c.add '#1c1d19'
+    c.add '#d01b24'
+    c.add '#a7d32C'
+    c.add '#d8cf67'
+    c.add '#61b8d0'
+    c.add '#695abb'
+    c.add '#d53864'
+    c.add '#fefffe'
+
+    c.add '#1c1d19'
+    c.add '#d12a24'
+    c.add '#a7d32c'
+    c.add '#d8cf67'
+    c.add '#61b8d0'
+    c.add '#695abb'
+    c.add '#d53864'
+    c.add '#fefffe'
+
+    c.background '#1c1d19'
+    c.foreground '#fefffe'
+  end
+end

data/lib/web_console/colors/solarized.rb

@@ -0,0 +1,47 @@
+module WebConsole
+  Colors.register_theme(:solarized_dark) do |c|
+    c.add '#073642'
+    c.add '#dc322f'
+    c.add '#859900'
+    c.add '#b58900'
+    c.add '#268bd2'
+    c.add '#d33682'
+    c.add '#2aa198'
+    c.add '#eee8d5'
+
+    c.add '#002b36'
+    c.add '#cb4b16'
+    c.add '#586e75'
+    c.add '#657b83'
+    c.add '#839496'
+    c.add '#6c71c4'
+    c.add '#93a1a1'
+    c.add '#fdf6e3'
+
+    c.background '#002b36'
+    c.foreground '#657b83'
+  end
+
+  Colors.register_theme(:solarized_light) do |c|
+    c.add '#073642'
+    c.add '#dc322f'
+    c.add '#859900'
+    c.add '#b58900'
+    c.add '#268bd2'
+    c.add '#d33682'
+    c.add '#2aa198'
+    c.add '#eee8d5'
+
+    c.add '#002b36'
+    c.add '#cb4b16'
+    c.add '#586e75'
+    c.add '#657b83'
+    c.add '#839496'
+    c.add '#6c71c4'
+    c.add '#93a1a1'
+    c.add '#fdf6e3'
+
+    c.background '#fdf6e3'
+    c.foreground '#657b83'
+  end
+end

data/lib/web_console/colors/tango.rb

@@ -0,0 +1,24 @@
+module WebConsole
+  Colors.register_theme(:tango) do |c|
+    c.add '#2e3436'
+    c.add '#cc0000'
+    c.add '#4e9a06'
+    c.add '#c4a000'
+    c.add '#3465a4'
+    c.add '#75507b'
+    c.add '#06989a'
+    c.add '#d3d7cf'
+
+    c.add '#555753'
+    c.add '#ef2929'
+    c.add '#8ae234'
+    c.add '#fce94f'
+    c.add '#729fcf'
+    c.add '#ad7fa8'
+    c.add '#34e2e2'
+    c.add '#eeeeec'
+
+    c.background '#2e3436'
+    c.foreground '#eeeeec'
+  end
+end

data/lib/web_console/colors/xterm.rb

@@ -0,0 +1,24 @@
+module WebConsole
+  Colors.register_theme(:xterm) do |c|
+    c.add '#000000'
+    c.add '#cd0000'
+    c.add '#00cd00'
+    c.add '#cdcd00'
+    c.add '#0000ee'
+    c.add '#cd00cd'
+    c.add '#00cdcd'
+    c.add '#e5e5e5'
+
+    c.add '#7f7f7f'
+    c.add '#ff0000'
+    c.add '#00ff00'
+    c.add '#ffff00'
+    c.add '#5c5cff'
+    c.add '#ff00ff'
+    c.add '#00ffff'
+    c.add '#ffffff'
+
+    c.background '#000000'
+    c.foreground '#ffffff'
+  end
+end

data/lib/web_console/engine.rb

@@ -0,0 +1,95 @@
+require 'ipaddr'
+require 'active_support/core_ext/numeric/time'
+require 'rails/engine'
+
+require 'active_model'
+require 'sprockets/rails'
+
+module WebConsole
+  class Engine < ::Rails::Engine
+    isolate_namespace WebConsole
+
+    config.web_console = ActiveSupport::OrderedOptions.new.tap do |c|
+      c.automount          = false
+      c.command            = nil
+      c.default_mount_path = '/console'
+      c.timeout            = 0.seconds
+      c.term               = 'xterm-color'
+      c.whitelisted_ips    = '127.0.0.1'
+
+      c.style = ActiveSupport::OrderedOptions.new.tap do |s|
+        s.colors = 'light'
+        s.font   = 'large DejaVu Sans Mono, Liberation Mono, monospace'
+      end
+    end
+
+    initializer "web_console.initialize_view_helpers" do
+      ActiveSupport.on_load :action_view do
+        include WebConsole::ViewHelpers
+      end
+
+      ActiveSupport.on_load :action_controller do
+        prepend_view_path File.dirname(__FILE__) + '/../action_dispatch/templates'
+      end
+    end
+
+    initializer 'web_console.add_default_route' do |app|
+      # While we don't need the route in the test environment, we define it
+      # there as well, so we can easily test it.
+      if config.web_console.automount && (Rails.env.development? || Rails.env.test?)
+        app.routes.append do
+          mount WebConsole::Engine => app.config.web_console.default_mount_path
+        end
+      end
+    end
+
+    initializer 'web_console.process_whitelisted_ips' do
+      config.web_console.tap do |c|
+        # Ensure that it is an array of IPAddr instances and it is defaulted to
+        # 127.0.0.1 if not precent. Only unique entries are left in the end.
+        c.whitelisted_ips = Array(c.whitelisted_ips).map { |ip|
+          if ip.is_a?(IPAddr)
+            ip
+          else
+            IPAddr.new(ip.presence || '127.0.0.1')
+          end
+        }.uniq
+
+        # IPAddr instances can cover whole networks, so simplify the #include?
+        # check for the most common case.
+        def (c.whitelisted_ips).include?(ip)
+          if ip.is_a?(IPAddr)
+            super
+          else
+            any? { |net| net.include?(ip.to_s) }
+          end
+        end
+      end
+    end
+
+    initializer 'web_console.process_command' do
+      config.web_console.tap do |c|
+        # +Rails.root+ is not available while we set the default values of the
+        # other options. Default it during initialization.
+
+        # Not all people created their Rails 4 applications with the Rails 4
+        # generator, so bin/rails may not be available.
+        if c.command.blank?
+          local_rails = Rails.root.join('bin/rails')
+          c.command = "#{local_rails.executable? ? local_rails : 'rails'} console"
+        end
+      end
+    end
+
+    initializer 'web_console.process_colors' do
+      config.web_console.style.tap do |c|
+        case colors = c.colors
+        when Symbol, String
+          c.colors = Colors[colors] || Colors.default
+        else
+          c.colors = Colors.new(colors)
+        end
+      end
+    end
+  end
+end

data/lib/web_console/exception_extension.rb

@@ -1,19 +1,18 @@
+# Thanks to @charliesome who wrote this bit for better_errors.
 class Exception
   original_set_backtrace = instance_method(:set_backtrace)
 
-  if WebConsole.binding_of_caller_available?
-    define_method :set_backtrace do |*args|
-      unless Thread.current[:__web_console_exception_lock]
-        Thread.current[:__web_console_exception_lock] = true
-        begin
-          @__web_console_bindings_stack = binding.callers.drop(1)
-        ensure
-          Thread.current[:__web_console_exception_lock] = false
-        end
+  define_method :set_backtrace do |*args|
+    unless Thread.current[:__web_console_exception_lock]
+      Thread.current[:__web_console_exception_lock] = true
+      begin
+        @__web_console_bindings_stack = binding.callers.drop(1)
+      ensure
+        Thread.current[:__web_console_exception_lock] = false
       end
-
-      original_set_backtrace.bind(self).call(*args)
     end
+
+    original_set_backtrace.bind(self).call(*args)
   end
 
   def __web_console_bindings_stack

data/lib/web_console/repl_session.rb

@@ -17,10 +17,10 @@ module WebConsole
     class << self
       # Finds a session by its id.
       def find(id)
-        INMEMORY_STORAGE[id.to_i] or raise NotFound.new('Session unavailable')
+        INMEMORY_STORAGE[id.to_i] or raise NotFound, 'Session unavailable'
       end
 
-      # Creates an already persisted consolse session.
+      # Creates an already persisted console session.
       #
       # Use this method if you need to persist a session, without providing it
       # any input.
@@ -37,7 +37,7 @@ module WebConsole
 
     def binding=(binding)
       @binding = binding
-      @repl = WebConsole::REPL.new binding
+      @repl = WebConsole::REPL.new(binding)
     end
 
     # Saves the model into the in-memory storage.
@@ -55,6 +55,7 @@ module WebConsole
     end
 
     protected
+
       # Returns a hash of the attributes and their values.
       def attributes
         return Hash[ATTRIBUTES.zip([nil])]
@@ -69,6 +70,7 @@ module WebConsole
       end
 
     private
+
       def ensure_consequential_id!
         self.id = begin
           @@counter ||= 0

data/lib/web_console/slave.rb

@@ -0,0 +1,139 @@
+require 'pty'
+require 'io/console'
+
+module WebConsole
+  # = Slave\ Process\ Wrapper
+  #
+  # Creates and communicates with slave processes.
+  #
+  # The communication happens through an input with attached psuedo-terminal.
+  # All of the communication is done in asynchronous way, meaning that when you
+  # send input to the process, you have get the output by polling for it.
+  class Slave
+    # Different OS' and platforms raises different errors when trying to read
+    # on output end of a closed process.
+    READING_ON_CLOSED_END_ERRORS = [ Errno::EIO, EOFError ]
+
+    # Raised when trying to read from a closed (exited) process.
+    Closed = Class.new(IOError)
+
+    # The slave process id.
+    attr_reader :pid
+
+    def initialize(command = WebConsole.config.command, options = {})
+      using_term(options[:term] || WebConsole.config.term) do
+        @output, @input, @pid = PTY.spawn(command.to_s)
+      end
+      configure(options)
+    end
+
+    # Configure the psuedo terminal properties.
+    #
+    # Options:
+    #   :width  The width of the terminal in number of columns.
+    #   :height The height of the terminal in number of rows.
+    #
+    # If any of the width or height is missing (or zero), the terminal size
+    # won't be set.
+    def configure(options = {})
+      dimentions = options.values_at(:height, :width).collect(&:to_i)
+      @input.winsize = dimentions unless dimentions.any?(&:zero?)
+    end
+
+    # Sends input to the slave process STDIN.
+    #
+    # Returns immediately.
+    def send_input(input)
+      raise ArgumentError if input.nil? or input.try(:empty?)
+      input.each_char { |char| @input.putc(char) }
+    end
+
+    # Returns whether the slave process has any pending output in +wait+
+    # seconds.
+    #
+    # By default, the +timeout+ follows +config.web_console.timeout+. Usually,
+    # it is zero, making the response immediate.
+    def pending_output?(timeout = WebConsole.config.timeout)
+      # JRuby's select won't automatically coerce ActiveSupport::Duration.
+      !!IO.select([@output], [], [], timeout.to_i)
+    end
+
+    # Gets the pending output of the process.
+    #
+    # The pending output is read in an non blocking way by chunks, in the size
+    # of +chunk_len+. By default, +chunk_len+ is 49152 bytes.
+    #
+    # Returns +nil+, if there is no pending output at the moment. Otherwise,
+    # returns the output that hasn't been read since the last invocation.
+    #
+    # Raises Errno:EIO on closed output stream. This can happen if the
+    # underlying process exits.
+    def pending_output(chunk_len = 49152)
+      # Returns nil if there is no pending output.
+      return unless pending_output?
+
+      pending = String.new
+      while chunk = @output.read_nonblock(chunk_len)
+        pending << chunk
+      end
+      pending.force_encoding('UTF-8')
+    rescue IO::WaitReadable
+      pending.force_encoding('UTF-8')
+    rescue
+      raise Closed if READING_ON_CLOSED_END_ERRORS.any? { |exc| $!.is_a?(exc) }
+    end
+
+    # Dispose the underlying process, sending +SIGTERM+.
+    #
+    # After the process is disposed, it is detached from the parent to prevent
+    # zombies.
+    #
+    # If the process is already disposed an Errno::ESRCH will be raised and
+    # handled internally. If you want to handle Errno::ESRCH yourself, pass
+    # +{raise: true}+ as options.
+    #
+    # Returns a thread, which can be used to wait for the process termination.
+    def dispose(options = {})
+      dispose_with(:SIGTERM, options)
+    end
+
+    # Dispose the underlying process, sending +SIGKILL+.
+    #
+    # After the process is disposed, it is detached from the parent to prevent
+    # zombies.
+    #
+    # If the process is already disposed an Errno::ESRCH will be raised and
+    # handled internally. If you want to handle Errno::ESRCH yourself, pass
+    # +{raise: true}+ as options.
+    #
+    # Returns a thread, which can be used to wait for the process termination.
+    def dispose!(options = {})
+      dispose_with(:SIGKILL, options)
+    end
+
+    private
+
+      LOCK = Mutex.new
+
+      def using_term(term)
+        if term.nil?
+          yield
+        else
+          LOCK.synchronize do
+            begin
+              (previous_term, ENV['TERM'] = ENV['TERM'], term) and yield
+            ensure
+              ENV['TERM'] = previous_term
+            end
+          end
+        end
+      end
+
+      def dispose_with(signal, options = {})
+        Process.kill(signal, @pid)
+        Process.detach(@pid)
+      rescue Errno::ESRCH
+        raise if options[:raise]
+      end
+  end
+end