redis_web_manager 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48c79b5d3723da1e569b6ab98470b268a694b6f3d39a08666945a4349c09666
-  data.tar.gz: f92ce3f1270fdfbf2c41744aa0c6f6c210dc4bd015ed44b645e924d814ffc3f8
+  metadata.gz: 625fca933d689410a7db50bb4108654ad7953f055825b46a13f8fd40e8833660
+  data.tar.gz: 280d3f28e6d82c33dff79a28190c878eefed38d939ce9ad9a2b3da634241085f
 SHA512:
-  metadata.gz: d2246f99e9a53f9bc9cec38b06e95b967250cbab37104544f80f058d06402c6130d7d1f010e7b52cd71428a8c7d45a7d1c806f6628a372a368929119b4d7c8d4
-  data.tar.gz: eac5fb2aea1185697a9ae819b06817b206db4adba61371462a182e5ab3ccf5d9430ddb4a03de80f1045bd4a7d33fa605d7958e07311146f605c4052644bab538
+  metadata.gz: b70d680f8dd17128e020fc872717077012bb8fc1f13be495b4c2b5baa2b81f76ee76b624647fa74356325fcc25cf49ca78c2b2a107d9951acf7d9dbbc646dc54
+  data.tar.gz: f138a669c0d71f1afbba53db6c2a3657f30f756e0a3100a2926f851b39b204be0f62c654560cd4c3b2d7a973ee92bcc8bd573ca231364e0601d6b16d5d236dda

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis_web_manager (0.1.6)
+    redis_web_manager (0.1.9)
       pagy (~> 3.7)
       rails (>= 5.2, < 7)
       redis (~> 4.1.0)
@@ -65,7 +65,7 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -94,10 +94,10 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     nio4r (2.5.2)
-    nokogiri (1.10.7)
+    nokogiri (1.10.8)
       mini_portile2 (~> 2.4.0)
-    pagy (3.7.2)
-    rack (2.1.2)
+    pagy (3.7.3)
+    rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.2.1)
@@ -162,7 +162,7 @@ GEM
       tins (~> 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tins (1.24.0)
+    tins (1.24.1)
       sync
     tzinfo (1.2.6)
       thread_safe (~> 0.1)

data/README.md

@@ -10,7 +10,7 @@
 Web interface that allows you to manage easily your Redis instance (see keys, memory used, connected client, etc...). 
 
 ### Check your stats 
-The Dashboard allows you tu check the Memory usage, CPU and Redis clients.
+The Dashboard allows you to check the Memory usage, CPU and Redis clients.
 
 ![RedisWebManager Dashboard](images/images_dashboard.png)
 
@@ -103,7 +103,6 @@ end
 
 
 ## Todo
-* [ ] Add filters to redis keys (filter by type, by expiration date...)
 * [ ] Add graph for most used commands
 * [ ] Manage multiple redis instances
 * [ ] Real time chart update

data/app/controllers/redis_web_manager/keys_controller.rb

@@ -10,15 +10,9 @@ module RedisWebManager
 
     # GET /keys
     def index
-      query = params[:query].presence
-      @keys = if query.present?
-                info.search(query).map { |key| format_key(key) }
-              else
-                info.keys.map { |key| format_key(key) }
-              end
       @status = info.status
       @url = connection.id
-      @pagy, @keys = pagy_array(@keys)
+      @pagy, @keys = pagy_array(keys)
     end
 
     # GET /key/:key
@@ -54,13 +48,14 @@ module RedisWebManager
 
     private
 
+    # FIXME: - Refactoring
+    #        - Move this part
     def item_type(value)
       ['json', JSON.parse(value)]
     rescue JSON::ParserError
       ['string', value]
     end
 
-    # Get values for Redis List type
     def get_list(key)
       start = 0
       stop  = 99
@@ -74,7 +69,6 @@ module RedisWebManager
       { length: length, values: values }
     end
 
-    # Get values for Redis Set type
     def get_set(key)
       values = info.smembers(key).map do |e|
         type, value = item_type(e)
@@ -84,7 +78,6 @@ module RedisWebManager
       { values: values }
     end
 
-    # Get values for Redis Zset type
     def get_zset(key)
       values = info.zrange(key, 0, -1, withscores: true).map do |e, score|
         type, value = item_type(e)
@@ -94,7 +87,6 @@ module RedisWebManager
       { values: values }
     end
 
-    # Get values for Redis Hash type
     def get_hash(key)
       value = Hash[info.hgetall(key).map do |k, v|
         type, value = item_type(v)
@@ -105,8 +97,7 @@ module RedisWebManager
     end
 
     def get_value(key)
-      type = info.type(key)
-      case type
+      case info.type(key)
       when 'string'
         { value: info.get(key) }
       when 'list'
@@ -125,11 +116,39 @@ module RedisWebManager
     def format_key(key)
       {
         key: key,
-        expire: info.expire(key),
+        expiry: info.expiry(key),
         node: get_value(key),
         type: info.type(key),
         memory: info.memory_usage(key)
       }
     end
+
+    def keys
+      keys = info.search(params[:query].presence).map { |key| format_key(key) }
+      keys = filter_by_type(keys, params[:type].presence)
+      keys = filter_by_expiry(keys, params[:expiry].presence)
+      filter_by_memory(keys, params[:expiry].presence)
+    end
+
+    def filter_by_type(keys, type)
+      return keys if invalid_option(type)
+      keys.select { |key| key[:type] == type }
+    end
+
+    def filter_by_expiry(keys, expiry)
+      return keys if invalid_option(expiry)
+      duration = expiry.to_i
+      return keys.select { |key| key[:expiry] == -1 } if duration == -1
+      keys.select { |key| key[:expiry] != -1 && key[:expiry] < duration }
+    end
+
+    def filter_by_memory(keys, memory)
+      return keys if invalid_option(memory)
+      keys.select { |key| key[:memory] < memory.to_i }
+    end
+
+    def invalid_option(option)
+      option.nil? || option == 'all'
+    end
   end
 end

data/app/helpers/redis_web_manager/application_helper.rb

@@ -18,7 +18,7 @@ module RedisWebManager
       content_tag(:kbd, value, class: 'bg-dark')
     end
 
-    def expire(value)
+    def expiry(value)
       if value == -1
         'No expiration date'
       else

data/app/helpers/redis_web_manager/keys_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RedisWebManager
+  module KeysHelper
+    def types_filters
+      [%w[All all],
+       %w[String string],
+       %w[Hash hash],
+       %w[Set set],
+       %w[Zset zset],
+       %w[List list]]
+    end
+
+    def expiry_filters
+      [%w[All all],
+       ['No expiry', -1],
+       ['Less than 1 hour', 3600],
+       ['Less than 1 week', 604_800],
+       ['Less than 1 month', 2_592_000],
+       ['Less than 6 months', 15_552_000]]
+    end
+
+    def memory_filters
+      [%w[All all],
+       ['Less than 1 KB', 1000],
+       ['Less than 10 KB', 10_000],
+       ['Less than 100 KB', 100_000],
+       ['Less than 1 MB', 1_000_000],
+       ['Less than 10 MB', 10_000_000],
+       ['Less than 100 MB', 100_000_000]]
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+<%= form_tag(keys_path, method: :get, class: 'p-4', enforce_utf8: false) do %>
+  <div class="row">
+    <div class="col-12">
+      <div class="form-group">
+        <%= label_tag :query, 'Name', class: 'font-weight-bolder' %>
+        <%= text_field_tag :query, params[:query], class: 'form-control', placeholder: 'Search key(s)' %>
+      </div>
+    </div>
+  </div>
+  <div class="row">
+    <div class="col-4">
+      <div class="form-group">
+        <%= label_tag :type, 'Type', class: 'font-weight-bolder' %>
+        <%= select_tag :type, options_for_select(types_filters, params[:type]), class: 'form-control custom-select' %>
+      </div>
+    </div>
+    <div class="col-4">
+      <div class="form-group">
+        <%= label_tag :expiry, 'Expiry', class: 'font-weight-bolder' %>
+        <%= select_tag :expiry, options_for_select(expiry_filters, params[:expiry]), class: 'form-control custom-select' %>
+      </div>
+    </div>
+    <div class="col-4">
+      <div class="form-group">
+        <%= label_tag :memory, 'Memory', class: 'font-weight-bolder' %>
+        <%= select_tag :memory, options_for_select(memory_filters, params[:memory]), class: 'form-control custom-select' %>
+      </div>
+    </div>
+  </div>
+  <%= submit_tag 'Search', class: 'btn btn-primary btn-block', name: nil %>
+<% end %>

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

@@ -9,14 +9,12 @@
           </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 %>
+          <a class="btn btn-link p-2" data-toggle="collapse" href="#search" role="button" aria-expanded="false" aria-controls="search">
+            View search
+          </a>
+          <div class="collapse" id="search">
+            <%= render partial: 'redis_web_manager/keys/search' %>
+          </div>
           <div class="table-responsive">
             <table class="table mb-0">
               <thead>
@@ -32,11 +30,11 @@
               <% @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><%= expiry(key[:expiry]) %></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 'Edit', edit_key_path(key: key[:key]), title: "Edit #{key[:key]}", class: 'btn btn-sm btn-primary' %>
                     <%= 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>

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

@@ -11,7 +11,7 @@
       </p>
       <label class="font-weight-normal">Expires in:</label>
       <p class="font-weight-light">
-        <%= expire(@key[:expire]) %>
+        <%= expiry(@key[:expiry]) %>
       </p>
       <label class="font-weight-normal">Size:</label>
       <p class="font-weight-light">

data/lib/redis_web_manager/info.rb

@@ -10,19 +10,15 @@ module RedisWebManager
       @stats ||= redis.info
     end
 
-    def keys
-      @keys ||= redis.keys
-    end
-
     def search(query)
-      redis.scan_each(match: "*#{query.downcase}*").to_a
+      redis.scan_each(match: "*#{query.try(:downcase)}*").to_a
     end
 
     def type(key)
       redis.type(key)
     end
 
-    def expire(key)
+    def expiry(key)
       redis.ttl(key)
     end
 

data/lib/redis_web_manager/version.rb

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

data/spec/controllers/redis_web_manager/keys_controller_spec.rb

@@ -12,7 +12,15 @@ RSpec.describe RedisWebManager::KeysController, type: :controller do
     it 'returns a success response' do
       get :index
       expect(response).to be_successful
-      get :index, params: { query: 'Search' }
+      get :index, params: { query: 'test' }
+      expect(response).to be_successful
+      get :index, params: { type: 'string' }
+      expect(response).to be_successful
+      get :index, params: { expiry: '-1' }
+      expect(response).to be_successful
+      get :index, params: { expiry: '3600' }
+      expect(response).to be_successful
+      get :index, params: { memory: '1000' }
       expect(response).to be_successful
     end
   end

data/spec/helpers/application_helper_spec.rb

@@ -17,11 +17,11 @@ RSpec.describe RedisWebManager::ApplicationHelper, type: :helper do
     end
 
     it 'returns a no expiration' do
-      expect(helper.expire(-1)).to eql('No expiration date')
+      expect(helper.expiry(-1)).to eql('No expiration date')
     end
 
     it 'returns a expiration' do
-      expect(helper.expire(86_400)).to eql('1 day')
+      expect(helper.expiry(86_400)).to eql('1 day')
     end
   end
 end

data/spec/helpers/keys_helper_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RedisWebManager::KeysHelper, type: :helper do
+  describe 'helper' do
+    it 'returns Array of types' do
+      expect(helper.types_filters).to eql([%w[All all],
+                                           %w[String string],
+                                           %w[Hash hash],
+                                           %w[Set set],
+                                           %w[Zset zset],
+                                           %w[List list]])
+    end
+
+    it 'returns Array of expiration' do
+      expect(helper.expiry_filters).to eq(
+        [%w[All all],
+         ['No expiry', -1],
+         ['Less than 1 hour', 3600],
+         ['Less than 1 week', 604_800],
+         ['Less than 1 month', 2_592_000],
+         ['Less than 6 months', 15_552_000]]
+      )
+    end
+
+    it 'returns Array of memories' do
+      expect(helper.memory_filters).to eq(
+        [%w[All all],
+         ['Less than 1 KB', 1000],
+         ['Less than 10 KB', 10_000],
+         ['Less than 100 KB', 100_000],
+         ['Less than 1 MB', 1_000_000],
+         ['Less than 10 MB', 10_000_000],
+         ['Less than 100 MB', 100_000_000]]
+      )
+    end
+  end
+end

data/spec/redis_web_manager_info_spec.rb

@@ -20,9 +20,6 @@ RSpec.describe RedisWebManager::Info do
       expect(info.stats).to be_a_kind_of(Hash)
     end
 
-    it 'returns a Array class (keys)' do
-      expect(info.keys).to be_a_kind_of(Array)
-    end
 
     it 'returns a string value (type)' do
       redis.set('test', 'test', ex: 20.seconds)
@@ -35,7 +32,7 @@ RSpec.describe RedisWebManager::Info do
     end
 
     it 'returns a ttl value (expire)' do
-      expect(info.expire('test')).to eql(20)
+      expect(info.expiry('test')).to eql(20)
     end
 
     it 'returns a memory usage value (memory_usage)' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_web_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Boris BRESCIANI
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-08 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -143,11 +143,13 @@ files:
 - app/helpers/redis_web_manager/application_helper.rb
 - app/helpers/redis_web_manager/clients_helper.rb
 - app/helpers/redis_web_manager/dashboard_helper.rb
+- app/helpers/redis_web_manager/keys_helper.rb
 - app/views/layouts/redis_web_manager/application.html.erb
 - app/views/redis_web_manager/clients/index.html.erb
 - app/views/redis_web_manager/configuration/index.html.erb
 - app/views/redis_web_manager/dashboard/index.html.erb
 - app/views/redis_web_manager/information/index.html.erb
+- app/views/redis_web_manager/keys/_search.html.erb
 - app/views/redis_web_manager/keys/edit.html.erb
 - app/views/redis_web_manager/keys/index.html.erb
 - app/views/redis_web_manager/keys/show.html.erb
@@ -343,6 +345,7 @@ files:
 - spec/helpers/application_helper_spec.rb
 - spec/helpers/clients_helper_spec.rb
 - spec/helpers/dashboard_helper_spec.rb
+- spec/helpers/keys_helper_spec.rb
 - spec/rails_helper.rb
 - spec/redis_web_manager_action_spec.rb
 - spec/redis_web_manager_connection_spec.rb
@@ -570,3 +573,4 @@ test_files:
 - spec/helpers/application_helper_spec.rb
 - spec/helpers/clients_helper_spec.rb
 - spec/helpers/dashboard_helper_spec.rb
+- spec/helpers/keys_helper_spec.rb