dalli-ui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 351ef4201908c15cbff4ccd2e105df63749ac11e
+  data.tar.gz: eb3dee89f9b42b416a5fe8616e517bfcd40ec801
+SHA512:
+  metadata.gz: d1ca82398d1355fa59cf92eed2bc76720535eee2a972417be1dcc7876afa06420e922314b9c5013bbc5959fd2588e5003d47a3cdf3ccda522dad6d489bb65225
+  data.tar.gz: 23353777c93aa6687ce2f053a7cd5493a778d07cde02785fe8abfe6fc2ee2939eed6f734c66d410754196ff4410a1ee49e86a37431475e26bed7a37355c2d62b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Pete Hawkins
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DalliUi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/dalli/ui/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/dalli/ui/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/dalli/ui/application_controller.rb

@@ -0,0 +1,6 @@
+module Dalli
+  module Ui
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/dalli/ui/cache_controller.rb

@@ -0,0 +1,34 @@
+require 'dalli/ui/stats_presenter'
+
+module Dalli
+  module Ui
+    class CacheController < ApplicationController
+      layout "dalli/ui/application"
+
+      def index
+        @stats = wrap_presenters Rails.cache.dalli.stats
+      end
+
+      def flush
+        Rails.logger.info "Dalli::Ui Flushed Dalli cache store"
+        Rails.cache.dalli.flush
+
+        flash[:dalli_ui_notice] = "Flushed cache store"
+        redirect_to dalli_ui_path
+      end
+
+      private
+
+        def wrap_presenters(stats)
+          stats_presnters = {}
+
+          stats.each do |server, stats|
+            stats_presnters[server] = Dalli::Ui::StatsPresenter.new(stats, view_context)
+          end
+
+          stats_presnters
+        end
+
+    end
+  end
+end

data/app/views/dalli/ui/cache/index.html.erb

@@ -0,0 +1,53 @@
+<% @stats.each do |host, stats| %>
+  <div class="page-header">
+    <h1><%= host %> <small>Stats</small></h1>
+  </div>
+
+  <div class="row">
+    <div class="col-md-6">
+      <canvas id="hit_rate_chart_<%= stats.host_id(host) %>"></canvas>
+    </div>
+
+    <div class="col-md-6">
+      <div class="table-responsive">
+        <table class="table">
+          <tr>
+            <th>Memcached instance size</th>
+            <td><%= stats.cache_size %></td>
+          </tr>
+          <tr>
+            <th>Hit rate</th>
+            <td><%= stats.hit_rate %>%</td>
+          </tr>
+          <tr>
+            <th>Total items</th>
+            <td><%= stats.dalli.total_items %></td>
+          </tr>
+          <tr>
+            <th>Current Connections</th>
+            <td><%= stats.dalli.curr_connections %></td>
+          </tr>
+          <tr>
+            <th>Total Connections</th>
+            <td><%= stats.dalli.total_connections %></td>
+          </tr>
+        </table>
+      </div>
+    </div>
+
+
+  </div>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+        var chart_context = document.getElementById("hit_rate_chart_<%= stats.host_id(host) %>").getContext("2d");
+
+        var data = <%== MultiJson.dump(stats.chart_data) %>;
+
+        var hit_rate_chart = new Chart(chart_context).Doughnut(data, {
+            responsive: true,
+            tooltipTemplate: "<%%if (label){%><%%=label%>: <%%}%><%%= value %>%",
+        });
+    });
+  </script>
+<% end %>

data/app/views/layouts/dalli/ui/application.html.erb

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dalli UI</title>
+
+  <link href="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">
+  <%= stylesheet_link_tag    "dalli/ui/application", media: "all" %>
+
+  <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+  <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/Chart.js/1.0.1-beta.2/Chart.min.js"></script>
+  <%= javascript_include_tag "dalli/ui/application" %>
+
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+  <nav class="navbar navbar-default navbar-fixed" role="navigation">
+    <div class="container">
+      <div class="navbar-header">
+        <a class="navbar-brand" href="#">Dalli UI</a>
+      </div>
+
+      <form action="<%= dalli_ui_flush_path %>" method="POST" class="navbar-form navbar-right">
+        <%= tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => form_authenticity_token) %>
+        <input type="submit" value="Flush cache!" class="btn btn-danger">
+      </form>
+
+    </div><!-- /.container -->
+  </nav>
+
+  <% if flash[:dalli_ui_notice] %>
+    <div class="ui-notification"><p><%= flash[:dalli_ui_notice] %></p></div>
+  <% end %>
+
+  <div class="container">
+    <%= yield %>
+  </div>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Dalli::Ui::Engine.routes.draw do
+  get "/" => "cache#index", as: :dalli_ui
+  post "/flush" => "cache#flush", as: :dalli_ui_flush
+end

data/lib/dalli/ui.rb

@@ -0,0 +1,7 @@
+require_relative "ui/engine"
+require_relative "ui/stats_presenter"
+
+module Dalli
+  module Ui
+  end
+end

data/lib/dalli/ui/engine.rb

@@ -0,0 +1,7 @@
+module Dalli
+  module Ui
+    class Engine < ::Rails::Engine
+      isolate_namespace Dalli::Ui
+    end
+  end
+end

data/lib/dalli/ui/stats_presenter.rb

@@ -0,0 +1,56 @@
+require 'hashie'
+require 'digest/sha1'
+
+module Dalli
+  module Ui
+    class StatsPresenter
+      attr_accessor :dalli
+
+      def initialize(dalli_stats, template)
+        @dalli = Hashie::Mash.new(dalli_stats)
+        @template = template
+      end
+
+      def hit_rate
+        hit_rate = 0
+        total = Integer(dalli.get_hits) + Integer(dalli.get_misses)
+        hit_rate = Integer(dalli.get_hits).to_f / total.to_f * 100 if total > 0
+        hit_rate.round
+      end
+
+      def cache_size
+        h.number_to_human_size(dalli.limit_maxbytes)
+      end
+
+      def host_id(host)
+        Digest::SHA1.hexdigest host
+      end
+
+      def chart_data
+        [
+          {
+            value: 100 - hit_rate,
+            count: dalli.get_misses,
+            color: "#F7464A",
+            highlight: "#FF5A5E",
+            label: "Miss rate"
+          },
+          {
+            value: hit_rate,
+            count: dalli.get_hits,
+            color: "#46BFBD",
+            highlight: "#5AD3D1",
+            label: "Hit rate"
+          }
+        ]
+      end
+
+      private
+
+        def h
+          @template
+        end
+
+    end
+  end
+end

data/lib/tasks/dalli_ui_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dalli_ui do
+#   # Task goes here
+# end

data/readme.md

@@ -0,0 +1,27 @@
+# Dalli UI
+
+Dalli UI is a mountable engine for Rails apps that displays information about your [dalli](https://github.com/mperham/dalli) memcached instance and allows you to flush it from a web interface.
+
+## Rails 4 installation
+
+Add **dalli** and **dalli-ui** to your gemfile and `bundle install`.
+
+```rb
+# Gemfile
+gem 'dalli'
+gem 'dalli-ui'
+```
+
+Setup [dalli](https://github.com/mperham/dalli) as your Rails cache store.
+
+```rb
+# config/application.rb
+config.cache_store = :dalli_store
+```
+
+Mount Dalli UI on a route of your choosing
+
+```rb
+# config/routes.rb
+mount Dalli::Ui::Engine, at: "dalli"
+```

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>