redis-ui 0.3.1 → 0.4.0

data/README.rdoc

@@ -1,22 +1,57 @@
 == RedisUI
 
+[WARNING] 
+RedisUI is not very smart (yet?) about memory management. It loads ALL of your keys and values into memory at the same time, and then messes around with them. I haven't tried it, but you may run into issues with very large production databases. At this point this is more intended for debugging/development work.
+[/WARNING]
+
 * web accessible panel to view/manage redisdb
 * requires ruby 1.8.7+ or ruby 1.9+
 
     $ gem install redis-ui
     $ redis-ui [redis://<ip:port>] [--namespace <redis-namespace>]
 
+
+* redis-ui runs with Vegas (see gem vegas) so also comes with all the command-line options that affords:
+
+    Vegas options:
+     -K, --kill               kill the running process and exit
+     -S, --status             display the current running PID and URL then quit
+     -s, --server SERVER      serve using SERVER (thin/mongrel/webrick)
+     -o, --host HOST          listen on HOST (default: 0.0.0.0)
+     -p, --port PORT          use PORT (default: 5678)
+     -x, --no-proxy           ignore env proxy settings (e.g. http_proxy)
+     -e, --env ENVIRONMENT    use ENVIRONMENT for defaults (default: development)
+     -F, --foreground         don't daemonize, run in the foreground
+     -L, --no-launch          don't launch the browser
+     -d, --debug              raise the log level to :debug (default: :info)
+         --app-dir APP_DIR    set the app dir where files are stored (default: ~/.vegas/redis_ui)/)
+     -P, --pid-file PID_FILE  set the path to the pid file (default: app_dir/redis_ui.pid)
+         --log-file LOG_FILE  set the path to the log file (default: app_dir/redis_ui.log)
+         --url-file URL_FILE  set the path to the URL file (default: app_dir/redis_ui.url)
+    
+    'redis-ui' options:
+     -N NAMESPACE,            set the Redis namespace
+         --namespace
+    
+    Common options:
+     -h, --help               Show this message
+         --version            Show version
+
+
+
 == Features
 
 * specify which redis server to connect to (or default to localhost at port 5678 or 5679)
+* Click on the namespace tree to filter the keys shown to that namespace (since v0.4.0)
 * specify a namespace (see redis-namespace gem) to show only keys in that namespace
 * view all keys in a paged, sortable, as-you-type-filterable table
 
-== urls
+== Todo
 
-* /keys (json)
-* /keys/:id (html or json)
-* /server (json)
+* auto-refresh?
+* incr/decr buttons for number-strings?
+* in-place edit for strings?
+* free-form console for typing to redis directly?
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/redis-ui.rb

@@ -3,6 +3,7 @@ require 'redis'
 require 'redis/namespace'
 require 'deep_merge'
 require 'pp'
+require 'cgi'
 
 begin
   require 'yajl'
@@ -14,9 +15,11 @@ require 'sinatra/base'
 require 'sinatra/respond_to'
 require 'erb'
 
+require 'redis-ui/helpers'
+
 module RedisUI
   extend self
-  
+
   # hostname:port
   # redis://hostname:port
   def redis=(server)    
@@ -46,6 +49,10 @@ module RedisUI
     self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
     self.redis
   end
+
+  def namespace
+    @namespace
+  end
    
   
   class Server < Sinatra::Base
@@ -64,86 +71,20 @@ module RedisUI
     helpers do 
       include Rack::Utils
       alias_method :h, :escape_html
-
-      def redis
-        RedisUI.redis
-      end
-      
-      def get_key(key)
-        data = case redis.type(key)
-               when "string"
-                 redis[key]
-               when "list"
-                 redis.lrange(key, 0, -1)
-               when "set"
-                 redis.smembers(key)
-               when 'zset'
-                 redis.zrange(key, 0, -1)
-               when 'hash'
-                 redis.hgetall(key)
-               else
-                 '???'
-               end
-
-        {:key => key, :type => redis.type(key), :data => data}
-      end
-
-      def show(val)
-        case val
-        when String
-          val
-        when Array
-          if val.empty?
-            '[]'
-          else
-            str = "<ul><li> · "
-            str << val.map{|v|show(v)}.join('</li><li> · ')
-            str << '</li></ul>'
-          end
-        when Hash
-          str = "<ul><li> · "
-          arr = []
-          val.map do |k, v|
-            arr << "#{k} => #{show(v)}"
-          end
-          str << arr.join("</li><li> · ")
-          str << '</li></ul>'
-        else
-          val.to_s
-        end
-      end
-
-      def render_tree(val)
-          str = "<ul>"
-          val.each do |k, v|
-            str << "<li><a href='#'>#{k}</a>#{render_tree(v)}</li>"
-          end
-          str << '</ul>'
-      end
-
-      def build_namespace_tree
-        @namespace_tree = {}
-        namespaces = redis.keys.map{|k| k.split(':')[0..-2]}.uniq.sort_by(&:size)
-        namespaces.each do |array|
-          hash = array.reverse.inject({}) do |branch, string|
-            newtrunk = {}
-            newtrunk[string] = branch
-            newtrunk
-          end
-          @namespace_tree.deep_merge!(hash)
-        end
-      end
-      # {
-      #   'top' => {
-      #     'second' => {}
-      #   }
-      # }
-      
+      include RedisUIHelpers
     end
     
     get "/" do
-      @keys = RedisUI.redis.keys.map{ |key| get_key(key) }
-      build_namespace_tree
+      keys = RedisUI.redis.keys
+      build_namespace_tree(keys)
+      @keys = keys.map{ |key| get_key(key) }
+      erb :index
+    end
+
+    get "/namespace/:ns" do
+      ns = Redis::Namespace.new(params[:ns], :redis => redis)
+      @keys = ns.keys.map{|k| get_key(k, ns)}
+      build_namespace_tree(redis.keys)
       erb :index
     end
     
@@ -163,6 +104,15 @@ module RedisUI
       end
     end
 
+    post "/del/:key" do
+      result = redis.del(params[:key])
+      if result == 1
+        true
+      else
+        500
+      end
+    end
+
     get "/server" do
       {
         :info => RedisUI.redis.info,

data/lib/redis-ui/helpers.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+module RedisUIHelpers
+  def redis
+    RedisUI.redis
+  end
+
+  def partial(template,locals=nil)
+    locals = (locals.is_a?(Hash)) ? locals : {template.to_sym => locals}
+    template = ('_' + template.to_s).to_sym
+    erb template, {layout: false}, locals
+  end
+  
+  def get_key(key, redis=self.redis)
+    data = case redis.type(key)
+           when "string"
+             redis[key]
+           when "list"
+             redis.lrange(key, 0, -1)
+           when "set"
+             redis.smembers(key)
+           when 'zset'
+             redis.zrange(key, 0, -1)
+           when 'hash'
+             redis.hgetall(key)
+           else
+             '???'
+           end
+
+    {:key => key, :type => redis.type(key), :data => data}
+  end
+
+  def show(val)
+    case val
+    when String
+      val
+    when Array
+      if val.empty?
+        '[]'
+      else
+        str = "<ul><li> · "
+        str << val.map{|v|show(v)}.join('</li><li> · ')
+        str << '</li></ul>'
+      end
+    when Hash
+      str = "<ul><li> · "
+      arr = []
+      val.map do |k, v|
+        arr << "#{k} => #{show(v)}"
+      end
+      str << arr.join("</li><li> · ")
+      str << '</li></ul>'
+    else
+      val.to_s
+    end
+  end
+
+  def render_tree(val)
+    str = "<ul>"
+    val.each do |k, v|
+      str << "<li><a href='#'>#{k}</a>#{render_tree(v)}</li>"
+    end
+    str << '</ul>'
+  end
+
+  def build_namespace_tree(keys)
+    @namespace_tree = {}
+    namespaces = keys.map{|k| k.split(':')[0..-2]}.uniq.sort_by(&:size)
+    namespaces.each do |array|
+      hash = array.reverse.inject({}) do |branch, string|
+        newtrunk = {}
+        newtrunk[string] = branch
+        newtrunk
+      end
+      @namespace_tree.deep_merge!(hash)
+    end
+  end
+  # {
+  #   'top' => {
+  #     'second' => {}
+  #   }
+  # }
+
+end

data/lib/redis-ui/version.rb

@@ -1,5 +1,5 @@
 module Redis
   module Ui
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

data/lib/static/js/lib/jquery.cookie.js

@@ -0,0 +1,47 @@
+/*!
+ * jQuery Cookie Plugin
+ * https://github.com/carhartl/jquery-cookie
+ *
+ * Copyright 2011, Klaus Hartl
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://www.opensource.org/licenses/mit-license.php
+ * http://www.opensource.org/licenses/GPL-2.0
+ */
+(function($) {
+    $.cookie = function(key, value, options) {
+
+        // key and at least value given, set cookie...
+        if (arguments.length > 1 && (!/Object/.test(Object.prototype.toString.call(value)) || value === null || value === undefined)) {
+            options = $.extend({}, options);
+
+            if (value === null || value === undefined) {
+                options.expires = -1;
+            }
+
+            if (typeof options.expires === 'number') {
+                var days = options.expires, t = options.expires = new Date();
+                t.setDate(t.getDate() + days);
+            }
+
+            value = String(value);
+
+            return (document.cookie = [
+                encodeURIComponent(key), '=', options.raw ? value : encodeURIComponent(value),
+                options.expires ? '; expires=' + options.expires.toUTCString() : '', // use expires attribute, max-age is not supported by IE
+                options.path    ? '; path=' + options.path : '',
+                options.domain  ? '; domain=' + options.domain : '',
+                options.secure  ? '; secure' : ''
+            ].join(''));
+        }
+
+        // key and possibly options given, get cookie...
+        options = value || {};
+        var decode = options.raw ? function(s) { return s; } : decodeURIComponent;
+
+        var pairs = document.cookie.split('; ');
+        for (var i = 0, pair; pair = pairs[i] && pairs[i].split('='); i++) {
+            if (decode(pair[0]) === key) return decode(pair[1] || ''); // IE saves cookies with empty string as "c; ", e.g. without "=" as opposed to EOMB, thus pair[1] may be undefined
+        }
+        return null;
+    };
+})(jQuery);

data/lib/static/js/redis-ui.js

@@ -0,0 +1,100 @@
+var RedisUI = {};
+RedisUI.prefs = {
+  "warn-on-del": true,
+  "num-entries" : "25"
+}
+
+$(function() {
+  
+
+  RedisUI.keytable = $('table.keys').dataTable({
+    "bStateSave": true
+  });
+  
+  $('#namespace_tree').bind("loaded.jstree", function (event, data) {
+    $(this).jstree("open_all");
+  }).jstree({
+    "core" : {
+      "animation": 20
+    },
+    "plugins" : [ "themes", "html_data" ]
+  });
+
+
+  // update prefs from cookie if available,
+  // else set the cookie
+  for(var key in RedisUI.prefs) {
+    if (val = $.cookie(key)) {
+      RedisUI.prefs[key] = val
+    } else {
+      $.cookie(key, RedisUI.prefs[key])
+    }
+  }
+  
+  // Todo: give them a type so we can loop through instead of this?
+  // (if there are ever more than just checkboxes, anyway...)
+  $('#warn-on-del').prop("checked", RedisUI.prefs['warn-on-del'] == "true");
+  $('[name=DataTables_Table_0_length]').val(RedisUI.prefs['num-entries'])
+
+
+  // update pref cookie when changing options
+  $('input.pref-cb').click(function(e) {
+    $.cookie('warn-on-del', $(this).prop('checked'));
+  })
+  
+  $('[name=DataTables_Table_0_length]').change(function(e) {
+    $.cookie('num-entries', $(this).val());
+  })
+
+
+
+
+
+
+  // ajax delete
+  $('a.del').live('click', function(e) {
+    e.preventDefault();
+
+    var nodes = RedisUI.keytable.fnGetNodes();
+    var row = $(this).closest('tr')[0]
+    var key = $(this).data('key')
+
+    if ($('#warn-on-del').prop('checked')){
+      if(confirm("This will delete the key:\n\n\""+ key +"\"\n\n...from the DB. Are you sure?") ){
+        doit(this)
+      }
+    } else {
+      // just do it!
+      doit(this)
+    }
+    
+    function doit(element){
+      $.post($(element).attr('href'), function(response) {
+        RedisUI.keytable.fnDeleteRow(row);
+      })
+    }
+  })
+
+
+
+
+
+  function maybe_auto_refresh() {
+    if($('#auto-refresh').prop('checked')) {
+      $.ajax({
+        type: 'get',
+        dataType: 'html',
+        accepts: 'html',
+        url: window.location.href, 
+        success: function(response) {
+          $('#namespaces').replaceWith($('#namespaces', response))
+          $('#data_table').replaceWith($('#data_table', response))
+        }
+      });
+    }
+    window.setTimeout(maybe_auto_refresh, 2000);
+  }
+
+  //window.setTimeout(maybe_auto_refresh, 2000);
+
+})

data/lib/static/stylesheets/redis-ui.css

@@ -46,7 +46,7 @@ table.dataTable {
     margin-bottom: 10px;
 }
 
-table td a{display:block; color:#333;}
+table td a{color:#333;}
 
 table th {
     text-align:left;
@@ -80,6 +80,13 @@ table li {
     margin-left: 1ex;
 }
 
+
+
+
+
+
+
+
 #container>ul{padding:0.5em; margin:1em;}
 #container>li{padding:0.5em 0;}
 

data/lib/views/_namespace_tree.html.erb

@@ -0,0 +1,9 @@
+<ul>
+  <% tree.each do |k, v| %>
+  <li>
+    <% param = namespace ? "#{namespace}:#{k}" : k %>
+    <a href="/namespace/<%= CGI.escape param %>"><%= k %></a>
+    <%= partial :namespace_tree, tree: v, namespace: param %>
+  </li>
+  <% end %>
+</ul>

data/lib/views/index.html.erb

@@ -1,14 +1,13 @@
-<!--
 <div id="options" class="panel">
   <h2>Options</h2>
-  <p><input id="auto-refresh" name="auto-refresh" type="checkbox" checked="checked" /> <label for="auto-refresh">Auto-Refresh?</label></p>
+  <!-- <p><input id="auto-refresh" name="auto-refresh" type="checkbox" checked="checked" /> <label for="auto-refresh">Auto-Refresh?</label></p> -->
+  <p><input class="pref-cb" id="warn-on-del" name="warn-on-del" type="checkbox" checked="checked" /> <label for="warn-on-del">Warn on Delete?</label></p>
 </div>
--->
 
 <div id="namespaces" class="panel">
   <h2>Namespaces</h2>
   <div id="namespace_tree">
-    <%= render_tree(@namespace_tree) %>
+    <%= partial :namespace_tree, tree: @namespace_tree, namespace: RedisUI.namespace %>
   </div>
   <div class="clear"></div>
 </div>
@@ -18,16 +17,20 @@
   <table class="keys">
     <thead>
       <tr>
+        <th class="del-column"></th>
         <th>Key</th>
         <th>Type</th>
         <th>Value</th>
       </tr>
     </thead>
     <tbody>
-      <% @keys.each do |key| %>
-        <tr class="key">
+      <% @keys.each_with_index do |key, i| %>
+        <tr class="key" id="key<%= i %>">
+          <td style="width: 20px;">
+            <a class="del" href="/del/<%= CGI.escape key[:key] %>" data-key="<%= key[:key] %>">X</a>
+          </td>
           <td>
-            <a href="/keys/<%= key[:key] %>">
+            <a href="/keys/<%= CGI.escape key[:key] %>">
               <%= key[:key] %>
             </a>
           </td>

data/lib/views/layout.html.erb

@@ -6,7 +6,8 @@
     <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6/jquery.js"></script>
     <script src="http://ajax.aspnetcdn.com/ajax/jquery.dataTables/1.9.1/jquery.dataTables.min.js"></script>
     <script src="/js/lib/jstree/jquery.jstree.js"></script>
-    <script src="/js/lib/redis-ui.js"></script>
+    <script src="/js/redis-ui.js"></script>
+    <script src="/js/lib/jquery.cookie.js"></script>
   </head>
 
   <body>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-ui
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000Z
+date: 2012-06-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bacon
-  requirement: &2168562820 !ruby/object:Gem::Requirement
+  requirement: &2177777680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168562820
+  version_requirements: *2177777680
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2168562400 !ruby/object:Gem::Requirement
+  requirement: &2177777260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168562400
+  version_requirements: *2177777260
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2165601840 !ruby/object:Gem::Requirement
+  requirement: &2177808320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165601840
+  version_requirements: *2177808320
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &2165601420 !ruby/object:Gem::Requirement
+  requirement: &2177807900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165601420
+  version_requirements: *2177807900
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2165601000 !ruby/object:Gem::Requirement
+  requirement: &2177807480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165601000
+  version_requirements: *2177807480
 - !ruby/object:Gem::Dependency
   name: sinatra-respond_to
-  requirement: &2165600580 !ruby/object:Gem::Requirement
+  requirement: &2177807060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165600580
+  version_requirements: *2177807060
 - !ruby/object:Gem::Dependency
   name: vegas
-  requirement: &2165600160 !ruby/object:Gem::Requirement
+  requirement: &2177806640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165600160
+  version_requirements: *2177806640
 - !ruby/object:Gem::Dependency
   name: deep_merge
-  requirement: &2165599740 !ruby/object:Gem::Requirement
+  requirement: &2177806220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,7 +99,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165599740
+  version_requirements: *2177806220
 description: View and manage redis store
 email:
 - james@supermatter.com
@@ -118,7 +118,9 @@ files:
 - bin/redis-ui
 - config.ru
 - lib/redis-ui.rb
+- lib/redis-ui/helpers.rb
 - lib/redis-ui/version.rb
+- lib/static/js/lib/jquery.cookie.js
 - lib/static/js/lib/jstree/jquery.jstree.js
 - lib/static/js/lib/jstree/themes/apple/bg.jpg
 - lib/static/js/lib/jstree/themes/apple/d.png
@@ -139,8 +141,9 @@ files:
 - lib/static/js/lib/jstree/themes/default/d.png
 - lib/static/js/lib/jstree/themes/default/style.css
 - lib/static/js/lib/jstree/themes/default/throbber.gif
-- lib/static/js/lib/redis-ui.js
+- lib/static/js/redis-ui.js
 - lib/static/stylesheets/redis-ui.css
+- lib/views/_namespace_tree.html.erb
 - lib/views/index.html.erb
 - lib/views/layout.html.erb
 - lib/views/show.html.erb

data/lib/static/js/lib/redis-ui.js

@@ -1,35 +0,0 @@
-$(function() {
-
-  $('table.keys').dataTable({
-    "bStateSave": true
-  });
-  
-  $('#namespace_tree').bind("loaded.jstree", function (event, data) {
-    $(this).jstree("open_all");
-  }).jstree({
-    "core" : {
-      "animation": 20
-    },
-    "plugins" : [ "themes", "html_data" ]
-  });
-
-
-  function maybe_auto_refresh() {
-    if($('#auto-refresh').prop('checked')) {
-      $.ajax({
-        type: 'get',
-        dataType: 'html',
-        accepts: 'html',
-        url: window.location.href, 
-        success: function(response) {
-          $('#namespaces').replaceWith($('#namespaces', response))
-          $('#data_table').replaceWith($('#data_table', response))
-        }
-      });
-    }
-    window.setTimeout(maybe_auto_refresh, 2000);
-  }
-
-  //window.setTimeout(maybe_auto_refresh, 2000);
-
-})