ghaki-stats 2011.11.29.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Gerald Kalafut
+
+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

@@ -0,0 +1,23 @@
+= Ghaki Stats - Simple statistics.
+
+Ghaki Stats is simple tracker for counted statistics.
+
+== Download
+
+The latest version of Ghaki Stats can be found at
+
+* git@github.com:ghaki/ghaki-stats.git
+
+== Installation
+
+The preferred method of installing Ghaki Stats is through its GEM file.
+
+  % [sudo] gem install ghaki-stats-1.0.0.gem
+
+== License
+
+Ghaki Stats is released under the MIT license.
+
+== Support
+
+Contact mailto:gerald@kalafut.org

data/VERSION

@@ -0,0 +1 @@
+2011.11.29.1

data/lib/ghaki/stats/app.rb

@@ -0,0 +1,14 @@
+require 'ghaki/app/plugin'
+require 'ghaki/stats/base'
+
+module Ghaki #:nodoc:
+module Stats #:nodoc:
+
+  # Application wide statistics tracker.
+
+  class App < Ghaki::App::Plugin
+    app_plugin_make Base, :stats
+    app_plugin_link :stats
+  end
+
+end end

data/lib/ghaki/stats/base.rb

@@ -0,0 +1,216 @@
+require 'ghaki/stats/errors'
+require 'ghaki/stats/format/logger'
+
+############################################################################
+module Ghaki #:nodoc
+module Stats #:nodoc
+
+  class Base
+
+    attr_accessor :title # Title of statistics output report.
+    attr_writer :format  # Statistics output report Formatting object.
+
+=begin
+[+format+] Statistics report formatting object.
+[+title+]  Title of statistics output report.
+=end
+
+    def initialize opts={}
+      clear
+      @format = opts[:format]
+      @title  = opts[:title] || ''
+    end
+
+    # Get the formatter for the statistical report.
+    #
+    # Note: Will generate default formatting object if not already set.
+
+    def format
+      @format ||= self._format_default
+    end
+
+
+    # Assign zeroe to a stats count if its not already set.
+
+    def def_zero major, minor
+      def_value major, minor, 0
+    end
+
+    # Assign zeroes to multiple stats counts if they're not already set.
+
+    def def_zeros major_to_minor
+      major_to_minor.each_pair do |major,minor_s|
+        [*minor_s].each do |minor|
+          def_zero major, minor
+        end
+      end
+    end
+
+    # Assign multiple stats counts if not already set.
+
+    def def_values major, value, *minors
+      minors.each { |minor| def_value major, minor, value }
+    end
+
+    # Assign default stats count value if not already set.
+
+    def def_value major, minor, value
+      @stats[major] ||= {}
+      @stats[major][minor] = value unless @stats[major].has_key?(minor)
+    end
+
+    # Increase stats count by 1.
+
+    def incr major, minor
+      incr_by major, minor, 1
+    end
+
+    # Decrease stats count by 1.
+
+    def decr major, minor
+      decr_by major, minor, 1
+    end
+
+    # Increase stats count by a given value.
+
+    def incr_by major, minor, value
+      def_zero major, minor
+      @stats[major][minor] += value
+    end
+
+    # Decrease stats count by a given value
+
+    def decr_by major, minor, value
+      def_zero major, minor
+      @stats[major][minor] -= value
+    end
+
+    # Set stats count to a given value.
+
+    def put major, minor, value
+      @stats[major] ||= {}
+      @stats[major][minor] = value
+    end
+
+    # Is stat present?
+
+    def has? major, minor=nil
+      if @stats.has_key?(major)
+        if minor.nil?
+          true
+        else
+          @stats[major].has_key?(minor)
+        end
+      else
+        false
+      end
+    end
+
+    # Is stat missing?
+
+    def lacks? major, minor=nil
+      ! has?(major,minor)
+    end
+
+    # Throw exception if stat is mising.
+
+    def has! major, minor=nil
+      return self if has? major, minor
+      if minor.nil?
+        raise MissingMajorStatsError.new(major)
+      else
+        raise MissingMinorStatsError.new(major, minor)
+      end
+    end
+
+    # Get current value of stats count. Defaults to zero when not present.
+
+    def get major, minor
+      return 0 unless @stats.has_key?(major)
+      return 0 unless @stats[major].has_key?(minor)
+      return @stats[major][minor]
+    end
+
+    # Get current value or throw exception.
+
+    def get! major, minor
+      has!(major,minor).get(major,minor)
+    end
+
+    # Get current value of stats count. Defaults to specified when not present.
+
+    def get? major, minor, defval=nil
+      if has? major, minor
+        get major, minor
+      else
+        defval
+      end
+    end
+
+    # Set stats value if given value is greater than current value.
+
+    def set_gt major, minor, value
+      if not @stats.has_key?(major)
+        @stats[major] = { minor => value }
+      elsif not @stats[major].has_key?(minor)
+        @stats[major][minor] = value
+      elsif @stats[major][minor] < value
+        @stats[major][minor] = value
+      end
+    end
+
+    # Set stats value if given value is less than current value.
+
+    def set_lt major, minor, value
+      if not @stats.has_key?(major)
+        @stats[major] = { minor => value }
+      elsif not @stats[major].has_key?(minor)
+        @stats[major][minor] = value
+      elsif @stats[major][minor] > value
+        @stats[major][minor] = value
+      end
+    end
+
+    # Clears statistic counts.
+
+    def clear
+      @stats = {}
+    end
+
+    # Writes statistics report to specified output file.
+
+    def dump out_file, title=@title
+      format.dump @stats, out_file, title
+    end
+
+    # Logger specific dump. (DEPRECATED)
+
+    def log_dump logger, title=@title
+      warn "[DEPRECATED] 'log_dump' is deprecated.  Please use 'dump' instead."
+      dump logger, title
+    end
+
+    # Writes statistics report to specified output file, and clears statistic counts.
+    def flush out_file, title=@title
+      dump out_file, title
+    ensure
+      clear
+    end
+
+    # Logger specific flush. (DEPRECATED)
+
+    def log_flush logger, title=@title
+      warn "[DEPRECATED] 'log_flush' is deprecated.  Please use 'flush' instead."
+      flush logger, title
+    end
+
+    protected
+
+    def _format_default #:nodoc
+      opts = {}
+      opts[:title] = @title unless @title.nil?
+      Ghaki::Stats::Format::Logger.new( opts )
+    end
+
+  end
+end end

data/lib/ghaki/stats/errors.rb

@@ -0,0 +1,27 @@
+require 'ghaki/stats/errors'
+
+module Ghaki #:nodoc:
+
+  class MissingMajorStatsError < RuntimeError
+    attr_accessor :major
+    def blurb
+      " Major (#{@major})"
+    end
+    def initialize maj, msg='Missing Statistic'
+      @major = maj
+      super( msg + ':' + blurb() )
+    end
+  end
+
+  class MissingMinorStatsError < MissingMajorStatsError
+    attr_accessor :minor
+    def blurb
+      super() + " Minor (#{@minor})"
+    end
+    def initialize maj, min, msg='Missing Statistic'
+      @minor = min
+      super( maj, msg )
+    end
+  end
+
+end

data/lib/ghaki/stats/format/base.rb

@@ -0,0 +1,39 @@
+############################################################################
+module Ghaki  #:nodoc:
+module Stats  #:nodoc:
+module Format #:nodoc:
+
+  # Base for Statistics Report formatting objects.
+
+  class Base
+
+    attr_accessor :title # Name of statistics report.
+
+    def initialize opts={}
+      @title = opts[:title] || ''
+    end
+
+    # Dump output from statistics object.
+
+    def dump stats, out, title=@title
+      dump_head stats, out, title
+      dump_body stats, out, title
+      dump_tail stats, out, title
+    end
+
+    # Generate header of report.
+
+    def dump_head stats, out, title
+    end
+
+    # Generate body of report.
+    def dump_body stats, out, title
+    end
+
+    # Generate footer of report.
+
+    def dump_tail stats, out, title
+    end
+
+  end
+end end end

data/lib/ghaki/stats/format/logger.rb

@@ -0,0 +1,33 @@
+require 'ghaki/stats/format/output'
+
+############################################################################
+module Ghaki  #:nodoc:
+module Stats  #:nodoc:
+module Format #:nodoc:
+
+  # Default formatting for generating Statistics Reports using a Logger object.
+
+  class Logger < Output
+
+    # Dump heading info, which in this case is a minor began log.
+
+    def dump_head stats, log, title
+      if title.empty?
+        log.minor.began 'dumping statistics'
+      else
+        log.box title
+      end
+    end
+
+    # Dump footer info, which in this case is a minor ended log.
+
+    def dump_tail stats, log, title
+      if title.empty?
+        log.minor.ended 'dumping statistics'
+      else
+        log.liner
+      end
+    end
+
+  end # class
+end end end

data/lib/ghaki/stats/format/null.rb

@@ -0,0 +1,12 @@
+require 'ghaki/stats/format/base'
+
+module Ghaki  #:nodoc:
+module Stats  #:nodoc:
+module Format #:nodoc:
+
+  # Write formatting to nowhere. Null sink.
+
+  class Null < Base
+  end
+
+end end end

data/lib/ghaki/stats/format/output.rb

@@ -0,0 +1,24 @@
+require 'ghaki/stats/format/base'
+
+module Ghaki  #:nodoc:
+module Stats  #:nodoc:
+module Format #:nodoc:
+
+# Default formatting for generating Statistics Reports using an output file object.
+
+class Output < Base
+
+  # Dumps body of stats.
+
+  def dump_body stats, log, title
+    stats.keys.sort.each do |major|
+      log.puts major + ':'
+      stats[major].keys.sort.each do |minor|
+        count = stats[major][minor]
+        log.puts '    ' + count.to_s.rjust(8) + ' : ' + minor
+      end
+    end
+  end
+
+end # class
+end end end

data/lib/ghaki/stats/mixin.rb

@@ -0,0 +1,27 @@
+require 'ghaki/app/mixable'
+require 'ghaki/stats/base'
+
+module Ghaki #:nodoc
+module Stats #:nodoc
+
+  # Mixin stats object with auto-first use object creation.
+  #
+  # Note: Creates new Base stats object, does not grab copy from App Engine.
+  # ==== Example
+  #
+  #   class MyAction
+  #     include Ghaki::Stats::Mixin
+  #     def do_something
+  #       stats.incr 'Did', 'Something'
+  #     end
+  #   end
+  #
+  #   myact = MyAction.new
+  #   myact.do_something
+
+  module Mixin
+    include Ghaki::App::Mixable
+    app_mixin_accessor Base, :stats
+  end
+
+end end

data/lib/ghaki/stats/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'ghaki/stats/base'
+require 'ghaki/stats/format/null'
+
+module Ghaki #:nodoc:
+module Stats #:nodoc:
+
+# Helper for mocking Ghaki::Stats objects in unit tests.
+module SpecHelper
+
+  DEF_CLASS=Ghaki::Stats::Base
+
+  # Creates Ghaki::Stats object:
+  # - Using null sink formatting to avoid file access.
+  def make_safe_stats klass=DEF_CLASS
+    obj = klass.new
+    obj.format = Ghaki::Stats::Format::Null.new
+    obj
+  end
+
+  # Creates @stats member using :make_safe_stats
+  def setup_safe_stats klass=DEF_CLASS
+    @stats = make_safe_stats(klass)
+  end
+
+end
+end end

data/spec/ghaki/stats/app_engine_spec.rb

@@ -0,0 +1,36 @@
+require 'ghaki/stats/app'
+
+describe Ghaki::App::Engine do
+
+  before(:all) do
+    @app_eng = Ghaki::App::Engine.instance
+    @sta_app = Ghaki::Stats::App.instance
+  end
+
+  context 'singleton' do
+    subject { @app_eng }
+    it { should respond_to :stats }
+    it { should respond_to :stats= }
+    it { should respond_to :stats_opts }
+    it { should respond_to :stats_opts= }
+    it { should respond_to :stats_defs }
+    it { should respond_to :stats_defs= }
+  end
+
+  describe '#stats' do
+    subject { @app_eng.stats }
+    specify { should be_an_instance_of(Ghaki::Stats::Base) }
+    specify { should equal(@sta_app.stats ) }
+  end
+
+  describe '#stats_opts' do
+    subject { @app_eng.stats_opts }
+    specify { should be_an_instance_of(::Hash) }
+  end
+
+  describe '#stats_defs' do
+    subject { @app_eng.stats_defs }
+    specify { should be_an_instance_of(::Hash) }
+  end
+
+end

data/spec/ghaki/stats/app_stats_spec.rb

@@ -0,0 +1,45 @@
+############################################################################
+require 'ghaki/stats/app'
+
+############################################################################
+module Ghaki module Stats module AppTesting
+  describe Ghaki::Stats::App do
+
+    ########################################################################
+    context 'singleton' do
+      subject { Ghaki::Stats::App.instance }
+      it { should respond_to :stats }
+      it { should respond_to :stats= }
+      it { should respond_to :stats_opts }
+      it { should respond_to :stats_opts= }
+    end
+
+    ########################################################################
+    context 'singleton methods' do
+
+      describe '#stats' do
+        subject { Ghaki::Stats::App.instance.stats }
+        specify { should be_an_instance_of(Ghaki::Stats::Base) }
+      end
+
+      describe '#stats_opts' do
+        subject { Ghaki::Stats::App.instance.stats_opts }
+        specify { should be_an_instance_of(::Hash) }
+      end
+
+      context 'default settings' do
+        describe '#title' do
+          subject { Ghaki::Stats::App.instance.stats.title }
+          specify { should be_empty }
+        end
+        describe '#format' do
+          subject { Ghaki::Stats::App.instance.stats.format }
+          specify { should be_an_instance_of(Ghaki::Stats::Format::Logger) }
+        end
+      end
+
+    end
+
+  end
+end end end
+############################################################################

data/spec/ghaki/stats/base_spec.rb

@@ -0,0 +1,302 @@
+require 'ghaki/stats/errors'
+require 'ghaki/stats/base'
+require 'ghaki/stats/spec_helper'
+
+module Ghaki module Stats module Base_Testing
+describe Ghaki::Stats::Base do
+  include Ghaki::Stats::SpecHelper
+
+  before(:each) do
+    setup_safe_stats
+  end
+
+  subject { @stats }
+
+  it { should respond_to :title }
+  it { should respond_to :title= }
+  it { should respond_to :format= }
+
+  describe '#put' do
+    it 'stores value' do
+      subject.put 'inputs', 'wrote', 3
+      subject.get('inputs','wrote').should == 3
+    end
+  end
+
+  describe '#has?' do
+    context 'using major only' do
+      it 'detects missing' do
+        subject.put 'a', 'b', 3
+        subject.has?('c').should be_false
+      end
+      it 'detects present' do
+        subject.put 'a', 'b', 3
+        subject.has?('a').should be_true
+      end
+    end
+    context 'using major and minor' do
+      it 'detects missing' do
+        subject.put 'a', 'b', 3
+        subject.has?('a','c').should be_false
+      end
+      it 'detects present' do
+        subject.put 'a', 'b', 3
+        subject.has?('a','b').should be_true
+      end
+    end
+  end
+
+  describe '#lacks?' do
+    context 'using major only' do
+      it 'detects missing' do
+        subject.put 'a', 'b', 3
+        subject.lacks?('c').should be_true
+      end
+      it 'detects present' do
+        subject.put 'a', 'b', 3
+        subject.lacks?('a').should be_false
+      end
+    end
+    context 'using major and minor' do
+      it 'detects missing' do
+        subject.put 'a', 'b', 3
+        subject.lacks?('a','c').should be_true
+      end
+      it 'detects present' do
+        subject.put 'a', 'b', 3
+        subject.lacks?('a','b').should be_false
+      end
+    end
+  end
+
+  describe '#has!' do
+    context 'using major only' do
+      it 'fails on missing' do
+        subject.put 'a', 'b', 3
+        lambda do
+          subject.has!('c')
+        end.should raise_error(MissingMajorStatsError)
+      end
+      it 'detects present' do
+        subject.put 'a', 'b', 3
+        subject.has!('a').should == subject
+      end
+    end
+    context 'using major and minor' do
+      it 'fails on missing' do
+        subject.put 'a', 'b', 3
+        lambda do
+          subject.has!('a','c')
+        end.should raise_error(MissingMinorStatsError)
+      end
+      it 'detects present' do
+        subject.put 'a', 'b', 3
+        subject.has!('a','b').should == subject
+      end
+    end
+  end
+
+  describe '#get' do
+    it 'retrieves value when set' do
+      subject.put 'inputs','present',23
+      subject.get('inputs','present').should == 23
+    end
+    it "defaults to zero when not set" do
+      subject.get('inputs','bogus').should == 0
+    end
+  end
+
+  describe '#get?' do
+    context 'when stat is present' do
+      it 'gets value' do
+        subject.put 'inputs','present',23
+        subject.get?('inputs','present').should == 23
+      end
+    end
+    context 'when stat is missing' do
+      it 'returns nil without specified default' do
+        subject.get?('inputs','bogus').should be_nil
+      end
+      it 'returns specified default' do
+        subject.get?('inputs','bogus',54).should == 54
+      end
+    end
+  end
+
+  describe '#get!' do
+    it 'fails on missing' do
+      subject.put 'a', 'b', 3
+      lambda do
+        subject.get!('c','b')
+      end.should raise_error(MissingMinorStatsError)
+    end
+    it 'detects present' do
+      subject.put 'a', 'b', 3
+      subject.has!('a','b').should == subject
+    end
+  end
+
+  describe '#clear' do
+    it 'removes all values' do
+      subject.put 'inputs', 'broke', 3
+      subject.clear
+      subject.has?('inputs','broke').should be_false
+    end
+  end
+
+  describe '#def_value' do
+    it 'stores given value when not present' do
+      subject.def_value 'inputs', 'shadoobie', 23
+      subject.get('inputs','shadoobie').should == 23
+    end
+    it "leaves stored value alone" do
+      subject.put 'inputs', 'shapoopie', 67
+      subject.def_value 'inputs', 'shapoopie', 23
+      subject.get('inputs','shapoopie').should == 67
+    end
+  end
+
+  describe '#def_values' do
+    it 'stores given value when not present' do
+      subject.def_values 'output', 100, 'zip', 'zap'
+      subject.get('output','zip').should == 100
+      subject.get('output','zap').should == 100
+    end
+  end
+
+  describe '#def_zero' do
+    it "stores zero when not present" do
+      subject.def_zero 'inputs', 'newbie'
+      subject.get('inputs','newbie').should == 0
+    end
+    it "leaves stored value alone" do
+      subject.put('inputs','boogie',23)
+      subject.def_zero 'inputs', 'boogie'
+      subject.get('inputs','boogie').should == 23
+    end
+  end
+
+  describe '#def_zeros' do
+    it "stores zeros when not present" do
+      subject.def_zeros({ 'animal' => 'cow', 'animal' => 'bear' })
+      subject.get('animal','bear').should == 0
+      subject.get('animal','cow').should == 0
+    end
+  end
+
+  describe '#decr' do
+    it "decrements stored value" do
+      subject.put 'inputs', 'lost', 100
+      subject.decr 'inputs', 'lost'
+      subject.get('inputs','lost').should == 99
+    end
+  end
+
+  describe '#incr' do
+    it "increments stored value" do
+      subject.put 'inputs', 'found', 100
+      subject.incr 'inputs', 'found'
+      subject.get('inputs','found').should == 101
+    end
+  end
+
+  describe '#decr_by' do
+    it 'decrements stored value by a given value' do
+      subject.put 'inputs', 'mu', 100
+      subject.decr_by 'inputs', 'mu', 3
+      subject.get('inputs','mu').should == 97
+    end
+  end
+
+  describe '#incr_by' do
+    it 'increments stored value by a given value' do
+      subject.put 'inputs', 'pu', 100
+      subject.incr_by 'inputs', 'pu', 3
+      subject.get('inputs','pu').should == 103
+    end
+  end
+
+  describe '#set_lt' do
+    it 'should set when less' do
+      subject.put 'particle', 'proton', 100
+      subject.set_lt 'particle', 'proton', 90
+      subject.get('particle','proton').should == 90
+    end
+    it 'should ignore when not less' do
+      subject.put 'particle', 'proton', 100
+      subject.set_lt 'particle', 'proton', 110
+      subject.get('particle','proton').should == 100
+    end
+  end
+
+  describe '#set_gt' do
+    it 'should set when greater' do
+      subject.put 'particle', 'proton', 100
+      subject.set_gt 'particle', 'proton', 110
+      subject.get('particle','proton').should == 110
+    end
+    it 'should ignore when not greater' do
+      subject.put 'particle', 'proton', 100
+      subject.set_gt 'particle', 'proton', 90
+      subject.get('particle','proton').should == 100
+    end
+  end
+
+  def setup_fake_values
+    @stats.put 'a', 'b', 3
+    @stats.put 'c', 'd', 5
+    @expected_hash = { 'a' => { 'b' => 3 }, 'c' => { 'd' => 5 } }
+  end
+  def setup_fake_output
+    @out = stub_everything()
+  end
+
+  describe '#dump' do
+    before(:each) do setup_fake_values; setup_fake_output end
+    it 'outputs to formatter' do
+      subject.format.expects(:dump).with(@expected_hash,@out,'msg').once
+      subject.dump @out, 'msg'
+    end
+  end
+
+  describe '#flush' do
+    before(:each) do setup_fake_values; setup_fake_output end
+    it 'dumps to formatter' do
+      subject.expects(:dump).with(@out,'msg').once
+      subject.flush @out, 'msg'
+    end
+    it 'clears all values' do
+      subject.flush @out, 'msg'
+      subject.has?('a','b').should be_false
+      subject.has?('c','d').should be_false
+    end
+  end
+
+  describe '#log_dump' do
+    before(:each) do setup_fake_output end
+    it 'warns of deprecation' do
+      subject.expects(:warn).with(regexp_matches(%r{\[DEPRECATED\]})).once
+      subject.log_flush @out, 'msg'
+    end
+    it 'calls #dump' do
+      subject.expects(:warn).once
+      subject.expects(:dump).with(@out,'msg').once
+      subject.log_dump @out, 'msg'
+    end
+  end
+
+  describe '#log_flush' do
+    before(:each) do setup_fake_output end
+    it 'warns of deprecation' do
+      subject.expects(:warn).with(regexp_matches(%r{\[DEPRECATED\]})).once
+      subject.log_flush @out, 'msg'
+    end
+    it 'calls #flush' do
+      subject.expects(:warn).once
+      subject.expects(:flush).with(@out,'msg').once
+      subject.log_flush @out, 'msg'
+    end
+  end
+
+end
+end end end

data/spec/ghaki/stats/format/base_spec.rb

@@ -0,0 +1,44 @@
+require 'ghaki/stats/format/base'
+
+module Ghaki module Stats module Format module Base_Testing
+describe Ghaki::Stats::Format::Base do
+
+  before(:all) do
+    @subj = Format::Base.new
+    @stats = {}
+    @out = 'file'
+    @title = 'msg'
+  end
+
+  subject { @subj }
+
+  describe '#initialize' do
+    it 'accepts option :title' do
+      Format::Base.new( :title => 'msg' ).title.should == 'msg'
+    end
+    it 'defaults option: title' do
+      Format::Base.new().title.should == ''
+    end
+  end
+
+  it { should respond_to :dump_head }
+  it { should respond_to :dump_body }
+  it { should respond_to :dump_tail }
+
+  describe '#dump' do
+    it 'dump header' do
+      subject.expects(:dump_head).with(@stats,@out,@title).once
+      subject.dump @stats, @out, @title
+    end
+    it 'dump stats body' do
+      subject.expects(:dump_body).with(@stats,@out,@title).once
+      subject.dump @stats, @out, @title
+    end
+    it 'dump footer' do
+      subject.expects(:dump_tail).with(@stats,@out,@title).once
+      subject.dump @stats, @out, @title
+    end
+  end
+
+end
+end end end end

data/spec/ghaki/stats/format/logger_spec.rb

@@ -0,0 +1,54 @@
+require 'ghaki/stats/format/logger'
+require 'ghaki/logger/spec_helper'
+
+module Ghaki module Stats module Format module Logger_Testing
+describe Format::Logger do
+  include Ghaki::Logger::SpecHelper
+
+  before(:each) do
+    setup_safe_logger
+    @subj = Format::Logger.new
+    @stats = {
+      'a' => { 'b' => 12 },
+      'c' => { 'd' => 34 },
+    }
+    @out = 'file'
+    @title = 'msg'
+  end
+
+  subject { @subj }
+
+  it { should be_kind_of(Format::Output) }
+
+  describe '#dump_head' do
+    context 'with no title' do
+      it 'logs start of dump' do
+        @logger.minor.expects(:began).with('dumping statistics').once
+        subject.dump_head @stats, @logger, ''
+      end
+    end
+    context 'with given title' do
+      it 'logs header title' do
+        @logger.expects(:box).with(@title).once
+        subject.dump_head @stats, @logger, @title
+      end
+    end
+  end
+
+  describe '#dump_tail' do
+    context 'with no title' do
+      it 'logs ending of dump' do
+        @logger.minor.expects(:ended).with('dumping statistics').once
+        subject.dump_tail @stats, @logger, ''
+      end
+    end
+    context 'with given title' do
+      it 'logs footer line' do
+        @logger.expects(:liner).once
+        subject.dump_tail @stats, @logger, @title
+      end
+    end
+  end
+
+end
+end end end end

data/spec/ghaki/stats/format/null_spec.rb

@@ -0,0 +1,15 @@
+require 'ghaki/stats/format/null'
+
+module Ghaki module Stats module Format module Null_Testing
+describe Ghaki::Stats::Format::Null do
+
+  before(:all) do
+    @subj = Format::Null.new
+  end
+
+  subject { @subj }
+
+  it { should be_kind_of(Format::Base) }
+
+end
+end end end end

data/spec/ghaki/stats/format/output_spec.rb

@@ -0,0 +1,37 @@
+require 'ghaki/stats/format/output'
+require 'ghaki/logger/spec_helper'
+
+module Ghaki module Stats module Format module Output_Testing
+describe Format::Output do
+  include Ghaki::Logger::SpecHelper
+
+  before(:each) do
+    setup_safe_logger
+    @subj = Format::Output.new
+    @stats = {
+      'a' => { 'b' => 12 },
+      'c' => { 'd' => 34 },
+    }
+    @out = 'file'
+    @title = 'msg'
+  end
+
+  subject { @subj }
+
+  it { should be_kind_of(Format::Base) }
+
+  describe '#dump_body' do
+    it 'writes output' do
+      subject.dump_body @stats, @logger, @title
+      @logger.with_file do |file|
+        file.rewind
+        file.read.split("\n").should == [
+          '# a:', sprintf('#     %8s : %c', 12, 'b'),
+          '# c:', sprintf('#     %8s : %s', 34, 'd'),
+        ]
+      end
+    end
+  end
+
+end
+end end end end

data/spec/ghaki/stats/mixin_spec.rb

@@ -0,0 +1,25 @@
+############################################################################
+require 'ghaki/stats/mixin'
+
+############################################################################
+module Ghaki module Stats module MixinTesting
+  describe Ghaki::Stats::Mixin do
+
+    class UsingMixin
+      include Ghaki::Stats::Mixin
+    end
+
+    context 'object including' do
+      subject { UsingMixin.new }
+      it { should respond_to :stats  }
+      it { should respond_to :stats= }
+    end
+
+    context '#stats' do
+      subject { UsingMixin.new.stats }
+      specify { should be_an_instance_of(Ghaki::Stats::Base) }
+    end
+
+  end
+end end end
+############################################################################

data/spec/ghaki/stats/spec_helper_spec.rb

@@ -0,0 +1,41 @@
+require 'ghaki/stats/spec_helper'
+
+module Ghaki module Stats module SpecHelper_Testing
+describe SpecHelper do
+  include Ghaki::Stats::SpecHelper
+
+  class Fake < Stats::Base
+  end
+
+  before(:each) do
+    @stats = nil
+  end
+
+  describe '#make_safe_stats' do
+    it 'returns stats object' do
+      @stats = make_safe_stats()
+      @stats.should be_instance_of(Ghaki::Stats::Base)
+    end
+    it 'uses null sink for formatting' do
+      @stats = make_safe_stats()
+      @stats.format.should be_instance_of(Ghaki::Stats::Format::Null)
+    end
+    it 'accepts stats class' do
+      @stats = make_safe_stats(Fake)
+      @stats.should be_instance_of(Fake)
+    end
+  end
+
+  describe '#setup_safe_stats' do
+    it 'creates stats member value' do
+      setup_safe_stats()
+      @stats.should be_instance_of(Ghaki::Stats::Base)
+    end
+    it 'accepts stats class' do
+      setup_safe_stats(Fake)
+      @stats.should be_instance_of(Fake)
+    end
+  end
+
+end
+end end end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'mocha'
+
+RSpec.configure do |cfg|
+  cfg.mock_with :mocha
+  cfg.color_enabled = true
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ghaki-stats
+version: !ruby/object:Gem::Version
+  version: 2011.11.29.1
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Kalafut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ghaki-app
+  requirement: &85199070 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *85199070
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &85198850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *85198850
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &85198620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *85198620
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &85198390 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.9.4
+  type: :development
+  prerelease: false
+  version_requirements: *85198390
+- !ruby/object:Gem::Dependency
+  name: ghaki-logger
+  requirement: &85198160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2011.11.29.1
+  type: :development
+  prerelease: false
+  version_requirements: *85198160
+description: Simple tracker for counted statistics.
+email: gerald@kalafut.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- lib/ghaki/stats/mixin.rb
+- lib/ghaki/stats/format/output.rb
+- lib/ghaki/stats/format/null.rb
+- lib/ghaki/stats/format/logger.rb
+- lib/ghaki/stats/format/base.rb
+- lib/ghaki/stats/spec_helper.rb
+- lib/ghaki/stats/errors.rb
+- lib/ghaki/stats/app.rb
+- lib/ghaki/stats/base.rb
+- README
+- LICENSE
+- VERSION
+- spec/ghaki/stats/base_spec.rb
+- spec/ghaki/stats/spec_helper_spec.rb
+- spec/ghaki/stats/app_stats_spec.rb
+- spec/ghaki/stats/mixin_spec.rb
+- spec/ghaki/stats/format/null_spec.rb
+- spec/ghaki/stats/format/output_spec.rb
+- spec/ghaki/stats/format/base_spec.rb
+- spec/ghaki/stats/format/logger_spec.rb
+- spec/ghaki/stats/app_engine_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ghaki
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ghaki-stats
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Statistical tracking
+test_files:
+- spec/ghaki/stats/base_spec.rb
+- spec/ghaki/stats/spec_helper_spec.rb
+- spec/ghaki/stats/app_stats_spec.rb
+- spec/ghaki/stats/mixin_spec.rb
+- spec/ghaki/stats/format/null_spec.rb
+- spec/ghaki/stats/format/output_spec.rb
+- spec/ghaki/stats/format/base_spec.rb
+- spec/ghaki/stats/format/logger_spec.rb
+- spec/ghaki/stats/app_engine_spec.rb
+- spec/spec_helper.rb