autobench 0.0.1alpha1 → 0.0.1alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c5f2e2376802ee01016f1887d3ff724f3547ee0
-  data.tar.gz: 2e96794b47c4a29d977cbd4bc47735a765090935
+  metadata.gz: eb07d4dd989fe35bccf9d269ad2b147fae15612f
+  data.tar.gz: 91001aaf61ff58aa97b86083ec0e458d0998c7b4
 SHA512:
-  metadata.gz: cf4ff282040334a17e19b8097f67d38809933223eabe5b5c528a382a4ba3fc56dec0262cf20f9dbb028c3c00ce7ccdceecf0e7feb302cd66b2949a780357f005
-  data.tar.gz: 80d4181decbd594c9d7b664fbf3bd7ccaa40ae352305fe18f09b72f372f6f513bb2f581c1f8552111f05a821fa24a33bf472de143fcd967fb10ea1a676de85b6
+  metadata.gz: dd3a64064908c4ece15d284936ee76badf1fe674788bb7d56e2dd01733cf93fabe7983328b0633589c486c70f8cdd9805248d8f13b643b5610a86959187d62ce
+  data.tar.gz: a9f30cb8b3c3b9ed18182c7c0eb197fb88aae621f6710ff9ceed9fbefcf86f543a7a9499688af29aa109e9f6473c77d2c768c0fca1ec64b04987db531fff6dee

data/Gemfile

@@ -13,4 +13,10 @@ group :development do
   gem "pry-doc"
 end
 
+group :examples do
+  # for testing examples
+  gem "autobench"
+  gem "rspec"
+end
+
 # vim:ft=ruby:

data/README.md

@@ -1,24 +1,69 @@
 # autobench
 
-> NOTE: This is still very much under development and I've written the README to define how I plan for it to work.
->
-> TODOs:
->
-> * Currently, yslow.js and phantomas do not work, unless
->   you're running this from within the root directoy. I'm
->   still trying to figure out why.
+[![Build Status](https://travis-ci.org/jmervine/autobench.png?branch=master)](https://travis-ci.org/jmervine/autobench)
 
-### TODO: Installation
 
-    gem install autobench
+Autobench, as follow up to [Autoperf](http://mervine.net/gems/autoperf), was created to allow for benchmarking web pages 
+in three different ways. 
+
+1. Render Metrics -- using [`httperf`](http://mervine.net/httperf] and [`HTTPerf.rb`](http://mervine.net/gems/httperfrb], it 
+   grabs a snapshot of how long it takes to access, (server side) render and download your page. You can set thresholds 
+   in your configuration for almost all of httperf's output. Additionally, if you use 
+   [my version of httperf](http://mervine.net/httperf-0-9-1-with-individual-connection-times) you'll get percentile
+   support as well.
+2. Client Metrics -- using [`phantomas`](https://github.com/macbre/phantomas), a sweet [PhantomJS](http://mervine.net/phantomjs)
+   script that grabs all kinds of useful DOM information from loading your page. See `phantomas` for more details.
+3. YSlow Metrics -- using [`yslow.js`](http://yslow.org/phantomjs), a [PhantomJS](http://mervine.net/phantomjs) script
+   written to inspect your page and give you all kinds of useful grading and information. See [YSlow](http://yslow.org)
+   for more details.
+
+
+## Installation
+
+    gem install autobench --pre
 
     # or...
 
     bundle init
-    echo "gem 'autobench'" >> Gemfile
+    echo "gem 'autobench', '0.0.1alpha1'" >> Gemfile
     bundle install --path vendor/bundle
 
-### Usage
+## Usage
+
+### With [Minitest](https://github.com/seattlerb/minitest)
+
+    :::ruby
+    require "minitest/autorun"
+    require "autobench"
+
+    class TestBenchmarks < Minitest::Test
+        def setup
+            @autobench = Autobench.new("./config/mervine.yml")
+        end
+
+        def test_autobench_render
+            @autobench.render.benchmark
+            assert @autobench.render.passed?,
+                "Passed:\n#{@autobench.render.successes}\nFailed:\n#{@autobench.render.failures}"
+
+        end
+
+        def test_autobench_client
+            @autobench.client.benchmark
+            assert @autobench.client.passed?,
+                "Passed:\n#{@autobench.client.successes}\nFailed:\n#{@autobench.client.failures}"
+        end
+
+        def test_autobench_yslow
+            @autobench.yslow.benchmark
+            assert @autobench.yslow.passed?,
+                "Passed:\n#{@autobench.yslow.successes}\nFailed:\n#{@autobench.yslow.failures}"
+        end
+    end
+
+    See [github.com/jmervine/autobench/examples](http://github.com/jmervine/autobench/examples)
+
+### CLI
 
 #### `autobench`
 
@@ -83,41 +128,3 @@ all possible values in their current state.
     Misc. Arguments:
         -h, --help                       Show this message
 
-### Minitest Integration
-
-> #### TODO
-> Advanced Examples
-
-    require "minitest/autorun"
-    require "autobench"
-
-    class TestBenchmarks < Minitest::Test
-        def setup
-            @autobench = Autobench.new( "./path/to/config.yml", { ... config overides ... } )
-        end
-
-        def test_autobench_render
-            @autobench.render.benchmark
-            assert @autobench.render["connection_time_median"] < 500 # ms
-
-            # or...
-            assert @autobench.render.passed?
-        end
-
-        def test_autobench_yslow
-            @autobench.yslow.benchmark
-            assert @autobench.yslow["overall"] >= 95 # score
-
-            # or...
-            assert @autobench.yslow.passed?
-        end
-
-        def test_autobench_client
-            @autobench.client.benchmark
-            assert @autobench["requests"] < 100 # connections
-
-            # or...
-            assert @autobench.client.passed?
-        end
-    end
-

data/lib/autobench/version.rb

@@ -1,3 +1,3 @@
 class Autobench
-  VERSION = '0.0.1alpha1'
+  VERSION = '0.0.1alpha2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autobench
 version: !ruby/object:Gem::Version
-  version: 0.0.1alpha1
+  version: 0.0.1alpha2
 platform: ruby
 authors:
 - Joshua Mervine
@@ -109,7 +109,7 @@ files:
 - bin/autobench
 - README.md
 - Gemfile
-homepage: http://mervine.net/gems/autoperf
+homepage: http://mervine.net/gems/autobench
 licenses: []
 metadata: {}
 post_install_message: