web-console-rails3 0.3.0 → 0.4.1

data/lib/web_console.rb

@@ -1,6 +1,6 @@
-require 'rails/version'
 require 'active_support/lazy_load_hooks'
 require 'web_console/engine'
+require 'web_console/colors'
 require 'web_console/slave'
 
 module WebConsole
@@ -11,11 +11,3 @@ module WebConsole
 
   ActiveSupport.run_load_hooks(:web_console, self)
 end
-
-if Rails::VERSION::MAJOR == 3
-  # ActiveModel::Model is not defined in Rails 3. Use a backported version.
-  require 'web_console/backport/active_model'
-
-  # Explicitly require strong_parameters to make sure the users won't have to.
-  require 'strong_parameters'
-end

data/lib/web_console/colors.rb

@@ -0,0 +1,86 @@
+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/xterm'
+require 'web_console/colors/tango'
+require 'web_console/colors/solarized'

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/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

@@ -2,6 +2,10 @@ require 'ipaddr'
 require 'active_support/core_ext/numeric/time'
 require 'rails/engine'
 
+# Those are required for Rails 3 compatibility.
+require 'strong_parameters'
+require 'active_model/model'
+
 module WebConsole
   class Engine < ::Rails::Engine
     isolate_namespace WebConsole
@@ -11,7 +15,13 @@ module WebConsole
       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.add_default_route' do |app|
@@ -25,17 +35,18 @@ module WebConsole
     end
 
     initializer 'web_console.process_whitelisted_ips' do
-      # 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.
-      config.web_console.whitelisted_ips = Array(config.web_console.whitelisted_ips)
-      config.web_console.whitelisted_ips.map! do |ip|
-        ip.is_a?(IPAddr) ? ip : 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 (config.web_console.whitelisted_ips).include?(ip)
-        ip.is_a?(IPAddr) ? super : any? { |net| net.include?(ip.to_s) }
+      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 do |ip|
+          ip.is_a?(IPAddr) ? ip : 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)
+          ip.is_a?(IPAddr) ? super : any? { |net| net.include?(ip.to_s) }
+        end
       end
     end
 
@@ -43,7 +54,18 @@ module WebConsole
       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.
-        c.command = ('rails console').to_s if c.command.blank?
+        c.command = 'rails console' if c.command.blank?
+      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

data/lib/web_console/engine.rb.orig

@@ -0,0 +1,75 @@
+require 'ipaddr'
+require 'active_support/core_ext/numeric/time'
+require 'rails/engine'
+
+<<<<<<< HEAD
+# Those are required for Rails 3 compatibility.
+require 'strong_parameters'
+require 'active_model/model'
+=======
+>>>>>>> 0bca90aa29cdad3a02e366681e005a574449caa8
+
+module WebConsole
+  class Engine < ::Rails::Engine
+    isolate_namespace WebConsole
+
+    config.web_console = ActiveSupport::OrderedOptions.new.tap do |c|
+      c.automount          = true
+      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.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 do |ip|
+          ip.is_a?(IPAddr) ? ip : 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)
+          ip.is_a?(IPAddr) ? super : any? { |net| net.include?(ip.to_s) }
+        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.
+        c.command = ('rails console').to_s if c.command.blank?
+      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/slave.rb

@@ -14,7 +14,9 @@ module WebConsole
     attr_reader :pid
 
     def initialize(command = WebConsole.config.command, options = {})
-      @output, @input, @pid = PTY.spawn(command.to_s)
+      using_term(options[:term] || WebConsole.config.term) do
+        @output, @input, @pid = PTY.spawn(command.to_s)
+      end
       configure(options)
     end
 
@@ -102,6 +104,22 @@ module WebConsole
 
     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)

data/lib/web_console/version.rb

@@ -1,3 +1,3 @@
 module WebConsole
-  VERSION = '0.3.0'
+  VERSION = '0.4.1'
 end

data/test/dummy/config/application.rb

@@ -49,6 +49,19 @@ module Dummy
       # For long-polling 45 seconds timeout seems reasonable.
       config.web_console.timeout = 45.seconds
     end
+
+    config.web_console.style.colors =
+      if ENV['SOLARIZED_LIGHT']
+        'solarized_light'
+      elsif ENV['SOLARIZED_DARK']
+        'solarized_dark'
+      elsif ENV['TANGO']
+        'tango'
+      elsif ENV['XTERM']
+        'xterm'
+      else
+        'light'
+      end
   end
 end