nesta-plugin-diskcached 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.*sw*
+vendor/bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nesta-plugin-diskcached.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joshua Mervine
+
+MIT License
+
+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/README.md

@@ -0,0 +1,56 @@
+# Nesta::Plugin::Diskcached
+
+### [Documentation](http://jmervine.github.com/nesta-plugin-diskcached/doc/index.html) | [Why?](https://github.com/jmervine/nesta-plugin-diskcached/blob/master/WHY.md) | [NestaCMS.com](http://nestacms.com) | [Diskcached](http://diskcached.rubyops.net/)
+
+A Nesta Plugin for disk cache via diskcached. It is an alternative to using Nesta's built in Sinatra::Cache, which wasn't working quite right for me.
+
+## Installation
+
+> ONCE COMPLETED -- This doesn't work yet!
+
+Add this line to your application's Gemfile:
+
+    gem 'nesta-plugin-diskcached'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nesta-plugin-diskcached
+
+## Usage
+
+Add optional params to your config/config.yml
+
+  diskcached: true # default
+  diskcached_timeout: 3600 # default (in seconds)
+  diskcached_dir: /tmp/diskcached 
+    # defaults to "Nesta::Env.root/diskcached"
+    # 
+    # Values added for 'diskcached_dir' should
+    # be a full path starting with '/', otherwise
+    # Nesta::Env.root will be added to the beginning
+    # of the path string.
+
+## Notes
+
+1. This has not been tested with nesta-plugin-simplicity and does
+   not include overrides to include cacheing for anything Nesta's
+   default renderers, namely:
+   - haml
+   - erb
+2. Currently this creates cache files for everything passed through
+   rendering, which mean it creates a lot of extra and unused files.
+   Ideally, it would only create a file for the final rendered result.
+   It really doesn't hurt performance, but is just a bit ugly.
+   
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :doc do
+  puts %x{ yard --protected ./lib }
+end
+
+task :pages do
+  puts %x{ git checkout gh-pages && git merge master && git push }
+  puts %x{ git checkout - }
+end

data/WHY.md

@@ -0,0 +1,56 @@
+# Why?
+
+> Both tests are with Unicorn running 1 worker.
+
+### With Diskcached
+
+        httperf --client=0/1 --server=localhost --port=8080 --uri=/ --send-buffer=4096 --recv-buffer=16384 --num-conns=100 --num-calls=1
+        Maximum connect burst length: 1
+
+        Total: connections 100 requests 100 replies 100 test-duration 0.991 s
+
+        Connection rate: 100.9 conn/s (9.9 ms/conn, <=1 concurrent connections)
+        Connection time [ms]: min 5.4 avg 9.9 max 136.0 median 6.5 stddev 13.3
+        Connection time [ms]: connect 0.1
+        Connection length [replies/conn]: 1.000
+
+        Request rate: 100.9 req/s (9.9 ms/req)
+        Request size [B]: 62.0
+
+        Reply rate [replies/s]: min 0.0 avg 0.0 max 0.0 stddev 0.0 (0 samples)
+        Reply time [ms]: response 9.6 transfer 0.2
+        Reply size [B]: header 308.0 content 5203.0 footer 0.0 (total 5511.0)
+        Reply status: 1xx=0 2xx=100 3xx=0 4xx=0 5xx=0
+
+        CPU time [s]: user 0.65 system 0.34 (user 65.5% system 34.3% total 99.8%)
+        Net I/O: 549.2 KB/s (4.5*10^6 bps)
+
+        Errors: total 0 client-timo 0 socket-timo 0 connrefused 0 connreset 0
+        Errors: fd-unavail 0 addrunavail 0 ftab-full 0 other 0
+
+
+### Without Diskcached
+
+        httperf --verbose --client=0/1 --server=localhost --port=8080 --uri=/ --send-buffer=4096 --recv-buffer=16384 --num-conns=100 --num-calls=1
+        httperf: maximum number of open descriptors = 1024reply-rate = 9.6     Maximum connect burst length: 1Total: connections 100 requests 100 replies 100 test-duration 9.898 s
+        Connection rate: 10.1 conn/s (99.0 ms/conn, <=1 concurrent connections)
+        Connection time [ms]: min 83.0 avg 99.0 max 155.0 median 96.5 stddev 12.6
+        Connection time [ms]: connect 0.1
+        Connection length [replies/conn]: 1.000
+
+        Request rate: 10.1 req/s (99.0 ms/req)
+        Request size [B]: 62.0
+
+        Reply rate [replies/s]: min 9.6 avg 9.6 max 9.6 stddev 0.0 (1 samples)
+        Reply time [ms]: response 98.6 transfer 0.3
+        Reply size [B]: header 308.0 content 5203.0 footer 0.0 (total 5511.0)
+        Reply status: 1xx=0 2xx=100 3xx=0 4xx=0 5xx=0
+
+        CPU time [s]: user 6.36 system 3.52 (user 64.2% system 35.6% total 99.8%)
+        Net I/O: 55.0 KB/s (0.5*10^6 bps)
+
+        Errors: total 0 client-timo 0 socket-timo 0 connrefused 0 connreset 0
+        Errors: fd-unavail 0 addrunavail 0 ftab-full 0 other 0
+
+
+

data/doc/Nesta/App.html

@@ -0,0 +1,131 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Nesta::App
+  
+    &mdash; Documentation by YARD 0.8.2.1
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Nesta.html" title="Nesta (module)">Nesta</a></span></span>
+     &raquo; 
+    <span class="title">App</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Nesta::App
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Nesta::App</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/nesta-plugin-diskcached/init.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Setup diskcached global right off the bat!</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Aug 23 01:20:42 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.2.1 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>