redis_web_manager 0.1.6 → 0.1.8

data/app/helpers/redis_web_manager/application_helper.rb

@@ -2,6 +2,22 @@
 
 module RedisWebManager
   module ApplicationHelper
+    require 'pagy'
+
+    include ::Pagy::Frontend
+
+    def status(value)
+      if value
+        content_tag(:kbd, 'ON', class: 'bg-success bounce')
+      else
+        content_tag(:kbd, 'OFF', class: 'bg-danger bounce')
+      end
+    end
+
+    def url(value)
+      content_tag(:kbd, value, class: 'bg-dark')
+    end
+
     def expire(value)
       if value == -1
         'No expiration date'

data/app/helpers/redis_web_manager/dashboard_helper.rb

@@ -17,4 +17,4 @@ module RedisWebManager
       end
     end
   end
-end
+end

data/app/views/redis_web_manager/dashboard/index.html.erb

@@ -1,7 +1,7 @@
 <div class="container">
   <%= render 'redis_web_manager/shared/status' %>
   <div class="row my-4">
-    <div class="col-sm-12 col-md-12">
+    <div class="col-sm-12 col-md-9">
       <div class="row mb-4">
         <div class="col-12">
           <div class="card">
@@ -45,5 +45,24 @@
         </div>
       </div>
     </div>
+    <div class="col-sm-12 col-md-3">
+      <div class="card">
+        <div class="card-header">
+          <h5 class="card-title mb-0">
+            Information
+          </h5>
+        </div>
+        <div class="card-body p-0">
+          <ul class="list-group list-group-flush">
+            <% @information.each do |data| %>
+              <li class="list-group-item d-flex justify-content-between">
+                <div class="font-weight-normal"><%= data[:name] %></div>
+                <div class="font-weight-light"><%= data[:value] %></div>
+              </li>
+            <% end %>
+          </ul>
+        </div>
+      </div>
+    </div>
   </div>
 </div>

data/app/views/redis_web_manager/keys/edit.html.erb

@@ -0,0 +1,14 @@
+<div class="container">
+  <div class="row my-4">
+    <div class="col-sm-6 offset-sm-3">
+      <%= form_tag update_key_path, method: :put, class: "form-horizontal center" do %>
+        <div class="form-group">
+          <%= label_tag :key, "Name key:", class: "control-label" %>
+          <%= text_field_tag :key, @key[:key], class: "form-control" %>
+          <%= hidden_field_tag :old_key, @key[:key] %>
+        </div>
+        <%= submit_tag "Submit", class: "btn btn-default btn-primary" %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/redis_web_manager/keys/index.html.erb

@@ -0,0 +1,54 @@
+<div class="container">
+  <%= render 'redis_web_manager/shared/status' %>
+  <div class="row my-4">
+    <div class="col-12">
+      <div class="card">
+        <div class="card-header">
+          <h5 class="card-title mb-0">
+            Keys
+          </h5>
+        </div>
+        <div class="card-body p-0">
+          <%= form_tag(keys_path, method: :get, class: 'p-4', enforce_utf8: false) do %>
+            <div class="input-group">
+              <%= text_field_tag :query, params[:query], class: 'form-control', placeholder: 'Search key(s)' %>
+              <div class="input-group-append">
+                <%= submit_tag 'Search', class: 'btn btn-primary', name: nil %>
+              </div>
+            </div>
+          <% end %>
+          <div class="table-responsive">
+            <table class="table mb-0">
+              <thead>
+              <tr>
+                <th>Name</th>
+                <th>Expiration Date</th>
+                <th>Size</th>
+                <th>Type</th>
+                <th>Options</th>
+              </tr>
+              </thead>
+              <tbody>
+              <% @keys.each do |key| %>
+                <tr>
+                  <td><%= link_to (key[:key]).truncate(45), key_path(key: key[:key]), title: "Show #{key[:key]}" %></td>
+                  <td><%= expire(key[:expire]) %></td>
+                  <td><code><%= number_to_human_size(key[:memory]) %></code></td>
+                  <td><kbd class="bg-dark"><%= key[:type] %></kbd></td>
+                  <td>
+                    <%= link_to 'Edit', edit_key_path(key: key[:key]), title: "Edit #{key[:key]}", class: 'btn btn-sm btn-primary ml-2' %>
+                    <%= link_to 'Delete', destroy_key_path(key: key[:key]), method: :delete, data: {confirm: 'Are you sure ?'}, title: "Delete #{key[:key]}", class: 'btn btn-sm btn-danger ml-2' %>
+                  </td>
+                </tr>
+              <% end %>
+              </tbody>
+            </table>
+          </div>
+        </div>
+      </div>
+      <div class="d-flex align-items-center justify-content-center mt-3">
+        <%= pagy_bootstrap_nav(@pagy).html_safe %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/redis_web_manager/keys/show.html.erb

@@ -0,0 +1,30 @@
+<div class="container mt-4">
+  <div class="row">
+    <div class="col-12">
+      <label class="font-weight-normal">Key:</label>
+      <p class="font-weight-light">
+        <code><%= @key[:key] %></code>
+      </p>
+      <label class="font-weight-normal">Value:</label>
+      <p class="font-weight-light">
+        <code><%= @key[:node][:value] %></code>
+      </p>
+      <label class="font-weight-normal">Expires in:</label>
+      <p class="font-weight-light">
+        <%= expire(@key[:expire]) %>
+      </p>
+      <label class="font-weight-normal">Size:</label>
+      <p class="font-weight-light">
+        <code><%= number_to_human_size(@key[:memory]) %></code>
+      </p>
+      <label class="font-weight-normal">Type:</label>
+      <p class="font-weight-light">
+        <kbd class="bg-dark"><%= @key[:type] %></kbd>
+      </p>
+      <p class="font-weight-light">
+        <%= link_to 'Delete', destroy_key_path(key: @key[:key]), method: :delete, data: {confirm: 'Are you sure ?'}, title: "Delete #{@key}", class: 'btn btn-sm btn-danger w-100 mb-2' %>
+        <%= link_to 'Back', keys_path, title: 'View keys', class: 'btn btn-sm btn-primary w-100' %>
+      </p>
+    </div>
+  </div>
+</div>

data/app/views/redis_web_manager/shared/_header.html.erb

@@ -23,15 +23,25 @@
         </li>
       </ul>
       <ul class="navbar-nav ml-auto">
+        <li class="nav-item">
+          <%= link_to 'Reset statistics',
+                      reset_path,
+                      title: 'Reset statistics',
+                      method: :delete,
+                      data: {
+                          confirm: 'Are you sure you want to reset statistics ?'
+                      },
+                      class: 'btn btn-sm btn-info nav-link text-white mr-xs-0 mr-lg-2 mb-2 mb-lg-0' %>
+        </li>
         <li class="nav-item">
           <%= link_to 'Flush ALL',
-                      flushall_url,
+                      flushall_path,
                       title: 'Flush ALL',
                       method: :delete,
                       data: {
                           confirm: 'Are you sure you want to flush all DB ?'
                       },
-                      class: 'btn btn-sm btn-danger nav-link text-white mr-xs-0 mr-lg-2 mb-2 mb-lg-0' %>
+                      class: 'btn btn-sm btn-dark nav-link text-white mr-xs-0 mr-lg-2 mb-2 mb-lg-0' %>
         </li>
         <li class="nav-item">
           <%= link_to 'Flush DB',

data/app/views/redis_web_manager/shared/_status.html.erb

@@ -1,6 +1,6 @@
 <div class="row my-4">
   <div class="col-12">
-    <%= @url %>
-    <%= @status %>
+    <%= url(@url) %>
+    <%= status(@status) %>
   </div>
 </div>

data/bin/rails

@@ -17,4 +17,4 @@ require 'rails'
 require 'action_controller/railtie'
 require 'action_view/railtie'
 require 'sprockets/railtie'
-require 'rails/engine/commands'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -7,10 +7,18 @@ RedisWebManager::Engine.routes.draw do
   # Information
   get :information, to: 'information#index'
 
+  # Keys
+  get 'keys' => 'keys#index'
+  get 'key' => 'keys#show'
+  get 'key/edit' => 'keys#edit', as: :edit_key
+  put 'keys' => 'keys#update', as: :update_key
+  delete 'keys' => 'keys#destroy', as: :destroy_key
+
   # Clients
   get :clients, to: 'clients#index'
 
   # Actions
+  delete :reset, to: 'actions#reset'
   delete :flushdb, to: 'actions#flushdb'
   delete :flushall, to: 'actions#flushall'
 

data/lib/redis_web_manager.rb

@@ -10,8 +10,8 @@ require 'redis'
 
 module RedisWebManager
   mattr_accessor :redis, default: ::Redis.new
-  mattr_accessor :authenticate, default: nil
   mattr_accessor :lifespan, default: 15.days
+  mattr_accessor :authenticate, default: nil
 
   class << self
     def configure

data/lib/redis_web_manager/action.rb

@@ -18,4 +18,4 @@ module RedisWebManager
       redis.rename(old_name, new_name)
     end
   end
-end
+end

data/lib/redis_web_manager/data.rb

@@ -4,14 +4,30 @@ module RedisWebManager
   class Data < Base
     BASE = 'RedisWebManager'
 
+    def keys
+      data.map { |key| JSON.parse(redis.get(key), symbolize_names: true) }
+    end
+
     def perform
       now = Time.now.to_i
       seconds = (now + lifespan.to_i) - now
       redis.setex("#{BASE}_#{now}", seconds, serialize.to_json)
     end
 
+    def flush
+      data.map { |key| redis.del(key) }
+    end
+
     private
 
+    def data
+      @data ||= redis.scan_each(match: "#{BASE}_*").to_a
+    end
+
+    def lifespan
+      @lifespan ||= RedisWebManager.lifespan
+    end
+
     def serialize
       {
         date: Time.now,

data/lib/redis_web_manager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedisWebManager
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end

data/redis_web_manager.gemspec

@@ -10,11 +10,10 @@ Gem::Specification.new do |spec|
   spec.name        = 'redis_web_manager'
   spec.version     = RedisWebManager::VERSION
 
-  spec.authors     = ['Boris BRESCIANI', 'Benjamin DARCET', 'Olivier DUMAS', 'Sylvain KRAISIN']
+  spec.authors     = ['Boris BRESCIANI', 'Benjamin DARCET', 'Olivier DUMAS']
   spec.email       = %w[boris2bresciani@gmail.com
                         b.darcet@gmail.com
-                        dumas.olivier@outlook.fr
-                        sylvain.kraisin@gmail.com]
+                        dumas.olivier@outlook.fr]
 
   spec.summary     = 'Manage your Redis instance (See keys, memory used, connected client, etc...)'
   spec.description = 'Manage your Redis instance (See keys, memory used, connected client, configuration, information)'
@@ -35,8 +34,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.test_files = Dir['spec/**/*']
 
+  spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'rspec-rails', '= 4.0.0.beta3'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 
+  spec.add_dependency 'pagy', '~> 3.7'
   spec.add_dependency 'rails', '>= 5.2', '< 7'
   spec.add_dependency 'redis', '~> 4.1.0'
-end
+end

data/spec/controllers/redis_web_manager/actions_controller_spec.rb

@@ -5,9 +5,24 @@ require 'rails_helper'
 RSpec.describe RedisWebManager::ActionsController, type: :controller do
   routes { RedisWebManager::Engine.routes }
 
+  describe 'DELETE #reset' do
+    it 'returns a success response' do
+      delete :reset
+      expect(response).to be_redirect
+    end
+  end
+
   describe 'DELETE #flushdb' do
+    it 'returns a success response' do
+      delete :flushdb
+      expect(response).to be_redirect
+    end
   end
 
   describe 'DELETE #flushall' do
+    it 'returns a success response' do
+      delete :flushall
+      expect(response).to be_redirect
+    end
   end
-end
+end

data/spec/controllers/redis_web_manager/clients_controller_spec.rb

@@ -11,4 +11,4 @@ RSpec.describe RedisWebManager::ClientsController, type: :controller do
       expect(response).to be_successful
     end
   end
-end
+end

data/spec/controllers/redis_web_manager/keys_controller_spec.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::KeysController, type: :controller do
+  routes { RedisWebManager::Engine.routes }
+  let(:redis) do
+    ::Redis.new
+  end
+
+  describe 'GET #index' do
+    it 'returns a success response' do
+      get :index
+      expect(response).to be_successful
+      get :index, params: { query: 'Search' }
+      expect(response).to be_successful
+    end
+  end
+
+  describe 'GET #show' do
+    it 'returns a success response' do
+      redis.set('test', 'test')
+      get :show, params: { key: 'test' }
+      expect(response).to be_successful
+    end
+  end
+
+  describe 'GET #edit' do
+    it 'returns a success response' do
+      redis.set('test', 'test')
+      get :edit, params: { key: 'test' }
+      expect(response).to be_successful
+    end
+  end
+
+  describe 'GET #update' do
+    it 'returns a success response' do
+      redis.set('test', 'test')
+      put :update, params: { old_name: 'test', new_name: 'testtest' }
+      expect(response).to be_redirect
+    end
+  end
+
+  describe 'GET #destroy' do
+    it 'returns a success response' do
+      redis.set('test', 'test')
+      delete :destroy, params: { key: 'test' }
+      expect(response).to be_redirect
+    end
+  end
+
+  describe 'Methods' do
+    it 'returns a hash value (get_value - string)' do
+      redis.set('test', 'test')
+      eql = {
+        value: 'test'
+      }
+      expect(controller.send(:get_value, 'test')).to eql(eql)
+    end
+
+    it 'returns a hash value (get_value - hgetall)' do
+      eql = {
+        value: {
+          'name' => {
+            type: 'string',
+            value: 'hgetall'
+          }
+        }
+      }
+      redis.hset('hgetall', 'name', 'hgetall')
+      expect(controller.send(:get_value, 'hgetall')).to eql(eql)
+    end
+
+    it 'returns a hash value (get_value - lrange)' do
+      redis.lpush('lrange', '1')
+      redis.lpush('lrange', '2')
+      eql = {
+        length: 2,
+        values: [
+          {
+            index: 0,
+            type: 'json',
+            value: 2
+          },
+          {
+            index: 1,
+            type: 'json',
+            value: 1
+          }
+        ]
+      }
+      expect(controller.send(:get_value, 'lrange')).to eql(eql)
+    end
+
+    it 'returns a hash value (get_value - set)' do
+      redis.sadd('smembers', 'smembers')
+      eql = {
+        values: [{ type: 'string', value: 'smembers' }]
+      }
+      expect(controller.send(:get_value, 'smembers')).to eql(eql)
+    end
+
+    it 'returns a hash value (get_value - zset)' do
+      redis.zadd('zrange', 10, '1')
+      redis.zadd('zrange', 20, '2')
+      redis.zadd('zrange', 30, '3')
+      eql = {
+        values: [
+          {
+            score: 10.0,
+            type: 'json',
+            value: 1
+          },
+          {
+            score: 20.0,
+            type: 'json',
+            value: 2
+          },
+          {
+            score: 30.0,
+            type: 'json',
+            value: 3
+          }
+        ]
+      }
+      expect(controller.send(:get_value, 'zrange')).to eql(eql)
+    end
+
+    it 'returns a hash value (get_value - not found)' do
+      redis.zadd('zrange', 10, '1')
+      redis.zadd('zrange', 20, '2')
+      redis.zadd('zrange', 30, '3')
+      eql = {
+        value: 'Not found'
+      }
+      expect(controller.send(:get_value, 'testtesttesttesttest')).to eql(eql)
+    end
+  end
+end