ghaki-report 2011.11.30.1 → 2011.12.06.1

data/VERSION

@@ -1 +1 @@
-2011.11.30.1
+2011.12.06.1

data/lib/ghaki/report/errors.rb

@@ -1,6 +1,5 @@
 module Ghaki  #:nodoc:
-module Report #:nodoc:
 
 class ReportContentError < RuntimeError; end
 
-end end
+end

data/lib/ghaki/report/{base.rb → mixin/basic.rb}

@@ -3,17 +3,20 @@ require 'ghaki/stats/mixin'
 
 module Ghaki  #:nodoc:
 module Report #:nodoc:
+module Mixin  #:nodoc:
 
-class Base
+module Basic
   include Ghaki::Logger::Mixin
   include Ghaki::Stats::Mixin
 
-  ######################################################################
-  class << self
+  module ClassMethods
     attr_accessor :report_name
   end
 
-  ######################################################################
+  def self.included klass #:nodoc:
+    klass.extend ClassMethods
+  end
+
   def initialize opts={}
     self.report_name = opts[:report_name] unless opts[:report_name].nil?
     @stats = opts[:stats]
@@ -26,23 +29,26 @@ class Base
     end
   end
 
-  ######################################################################
   def report_name= title
-    self.class.report_name = title
+    if title.nil?
+      @report_name = self.class.report_name
+    elsif title[0,1] == '.'
+      @report_name = (@report_name || self.class.report_name) + title
+    else
+      @report_name = title
+    end
   end
 
-  ######################################################################
   def report_name title=nil
     if title.nil?
-      self.class.report_name
+      @report_name || self.class.report_name
     elsif title[0,1] == '.'
-      self.class.report_name + title
+      (@report_name || self.class.report_name) + title
     else
       title
     end
   end
 
-  ######################################################################
   def minor_report_wrap title=nil, &block
     logger.minor.wrap( report_name(title) ) do
       begin
@@ -53,7 +59,6 @@ class Base
     end
   end
 
-  ######################################################################
   def major_report_wrap title=nil, &block
     logger.major.wrap( report_name(title) ) do
       begin
@@ -65,4 +70,4 @@ class Base
   end
 
 end
-end end
+end end end

data/lib/ghaki/report/mixin/output_file.rb

@@ -0,0 +1,34 @@
+require 'ghaki/core_ext/file/with_temp'
+
+module Ghaki  #:nodoc:
+module Report #:nodoc:
+module Mixin  #:nodoc:
+
+module OutputFile
+
+  attr_accessor :output_file
+
+  def initialize opts={} ; super opts
+    @output_file = opts[:output_file]
+  end
+
+  def output_report
+    output_prepare
+    File.with_opened_temp @output_file do |tmp_file|
+      output_to_format tmp_file
+    end
+    output_finish
+  end
+
+  def output_finish
+  end
+
+  def output_prepare
+    logger.info 'output file: ' + @output_file
+  end
+
+  def output_to_format out_file
+  end
+
+end
+end end end

data/spec/ghaki/report/mixin/basic_spec.rb

@@ -0,0 +1,145 @@
+require 'ghaki/report/mixin/basic'
+require 'ghaki/logger/spec_helper'
+require 'ghaki/stats/spec_helper'
+
+module Ghaki module Report module Mixin module Basic_Testing
+describe Basic do
+  include Ghaki::Logger::SpecHelper
+  include Ghaki::Stats::SpecHelper
+
+  SET_NAME = 'SET_NAME'
+  DEF_NAME = 'DEFAULT_NAME'
+  SUB_NAME = '.SUB_NAME'
+  SET_SUB_FULL = 'SET_NAME.SUB_NAME'
+  DEF_SUB_FULL = 'DEFAULT_NAME.SUB_NAME'
+
+  class MyReport
+    include Ghaki::Report::Mixin::Basic
+    self.report_name = DEF_NAME
+  end
+
+  context 'meta class' do
+    subject { MyReport }
+    it { should respond_to :report_name  }
+    it { should respond_to :report_name= }
+  end
+
+  context 'object instance' do
+
+    before(:each) do
+      setup_safe_stats
+      reset_safe_logger
+      @my_report = MyReport.new({
+        :logger => @logger,
+        :stats  => @stats,
+      })
+    end
+
+    subject { @my_report }
+
+    it { should be_kind_of(Ghaki::Logger::Mixin) }
+    it { should be_kind_of(Ghaki::Stats::Mixin) }
+
+    it { should respond_to :logger  }
+    it { should respond_to :logger= }
+    it { should respond_to :stats  }
+    it { should respond_to :stats= }
+
+    describe '#initialize' do
+      context 'using option :report_name' do
+        it 'accepts full name' do
+          MyReport.new( :report_name => SET_NAME ).report_name == SET_NAME
+        end
+        it 'defaults to meta report name' do
+          MyReport.new.report_name.should == DEF_NAME
+        end
+        it 'accepts partial name using default' do
+          MyReport.new( :report_name => SUB_NAME ).report_name == DEF_SUB_FULL
+        end
+      end
+      context 'using option :stats' do
+        it 'defaults' do
+          Ghaki::Stats::Base.expects(:new).returns(@stats)
+          MyReport.new.
+            stats.should == @stats
+        end
+        it 'accepts' do
+          MyReport.new( :stats => @stats ).
+            stats.should == @stats
+        end
+      end
+      context 'using option :logger' do
+        it 'defaults' do
+          Ghaki::Logger::Base.expects(:new).returns(@logger)
+          MyReport.new.
+            logger.should == @logger
+        end
+        it 'accepts' do
+          MyReport.new( :logger => @logger).
+            logger.should == @logger
+        end
+      end
+    end
+
+    describe '#report_name' do
+      it 'defaults to meta report name' do
+        subject.report_name.should == DEF_NAME
+      end
+      it 'accepts full report name' do
+        subject.report_name(SET_NAME).should == SET_NAME
+      end
+      it 'accepts partial name with default' do
+        subject.report_name(SUB_NAME).should == DEF_SUB_FULL
+      end
+      it 'accepts partial name after override' do
+        subject.report_name = SET_NAME
+        subject.report_name(SUB_NAME).should == SET_SUB_FULL
+      end
+    end
+
+    describe '#report_name=' do
+      it 'assigns report name' do
+        subject.report_name = SET_NAME
+        subject.report_name.should == SET_NAME
+      end
+      it 'resets to default name on nil' do
+        subject.report_name = SET_NAME
+        subject.report_name = nil
+        subject.report_name.should == DEF_NAME
+      end
+      it 'accepts partial name with default' do
+        subject.report_name = SUB_NAME
+        subject.report_name.should == DEF_SUB_FULL
+      end
+      it 'accepts partial name after override' do
+        subject.report_name = SET_NAME
+        subject.report_name = SUB_NAME
+        subject.report_name.should == SET_SUB_FULL
+      end
+    end
+
+    describe '#minor_report_wrap' do
+      it 'calls logger minor mode with default report name' do
+        @logger.minor.expects(:wrap).with(DEF_NAME).once
+        subject.minor_report_wrap do end
+      end
+      it 'calls logger minor mode with given report name' do
+        @logger.minor.expects(:wrap).with(SET_NAME).once
+        subject.minor_report_wrap SET_NAME do end
+      end
+    end
+
+    describe '#major_report_wrap' do
+      it 'calls logger major mode with default report name' do
+        @logger.major.expects(:wrap).with(DEF_NAME).once
+        subject.major_report_wrap do end
+      end
+      it 'calls logger major mode with given report name' do
+        @logger.major.expects(:wrap).with(SET_NAME).once
+        subject.major_report_wrap SET_NAME do end
+      end
+    end
+
+  end
+end
+end end end end

data/spec/ghaki/report/mixin/linear_parser_spec.rb

@@ -1,15 +1,16 @@
+require 'ghaki/report/mixin/basic'
+require 'ghaki/report/mixin/linear_parser'
 require 'ghaki/logger/spec_helper'
 require 'ghaki/stats/spec_helper'
-require 'ghaki/report/base'
-require 'ghaki/report/mixin/linear_parser'
 
 module Ghaki module Report module Mixin module LinearParser_Testing
 describe LinearParser do
   include Ghaki::Logger::SpecHelper
   include Ghaki::Stats::SpecHelper
 
-  class MyParser < Base
-    include LinearParser
+  class MyParser
+    include Ghaki::Report::Mixin::Basic
+    include Ghaki::Report::Mixin::LinearParser
   end
 
   before(:each) do
@@ -32,10 +33,6 @@ describe LinearParser do
   it { should respond_to :parser_warn_max  }
   it { should respond_to :parser_warn_max= }
 
-  before(:each) do
-    @stats.clear
-  end
-
   describe '#parser_startup' do
     it 'defaults parser unknown max' do
       subject.parser_unknown_max = nil

data/spec/ghaki/report/mixin/output_file_spec.rb

@@ -0,0 +1,51 @@
+require 'ghaki/report/mixin/basic'
+require 'ghaki/report/mixin/output_file'
+require 'ghaki/logger/spec_helper'
+require 'ghaki/stats/spec_helper'
+require 'ghaki/core_ext/file/spec_helper/fake_temp'
+
+module Ghaki module Report module Mixin module OutputFileTesting
+describe OutputFile do
+  include Ghaki::Logger::SpecHelper
+  include Ghaki::Stats::SpecHelper
+  include Ghaki::CoreExt::File::SpecHelper::FakeTemp
+
+  FAKE_OUT = '/tmp/myfile.txt'
+
+  class MyReport
+    include Ghaki::Report::Mixin::Basic
+    include Ghaki::Report::Mixin::OutputFile
+  end
+
+  before(:each) do
+    setup_safe_stats
+    reset_safe_logger
+    setup_fake_tempfile
+    @subj = MyReport.new({
+      :logger => @logger,
+      :stats  => @stats,
+      :output_file => FAKE_OUT,
+    })
+  end
+
+  subject { @subj }
+
+  it { should respond_to :output_file }
+  it { should respond_to :output_file= }
+  it { should respond_to :output_report }
+  it { should respond_to :output_finish }
+  it { should respond_to :output_prepare }
+  it { should respond_to :output_to_format }
+
+  describe '#output_report' do
+    it 'should create file' do
+      abc = sequence('reporting')
+      subject.expects(:output_prepare).once.in_sequence(abc)
+      subject.expects(:output_to_format).with(@fake_tempfile).once.in_sequence(abc)
+      subject.expects(:output_finish).once.in_sequence(abc)
+      subject.output_report
+    end
+  end
+
+end
+end end end end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghaki-report
 version: !ruby/object:Gem::Version
-  version: 2011.11.30.1
+  version: 2011.12.06.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000Z
+date: 2011-12-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ghaki-app
-  requirement: &80031340 !ruby/object:Gem::Requirement
+  requirement: &80503420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2011.11.29.1
   type: :runtime
   prerelease: false
-  version_requirements: *80031340
+  version_requirements: *80503420
 - !ruby/object:Gem::Dependency
   name: ghaki-ext-file
-  requirement: &80031120 !ruby/object:Gem::Requirement
+  requirement: &80503200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2011.11.29.1
   type: :runtime
   prerelease: false
-  version_requirements: *80031120
+  version_requirements: *80503200
 - !ruby/object:Gem::Dependency
   name: ghaki-logger
-  requirement: &80030900 !ruby/object:Gem::Requirement
+  requirement: &80502980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2011.11.29.1
   type: :runtime
   prerelease: false
-  version_requirements: *80030900
+  version_requirements: *80502980
 - !ruby/object:Gem::Dependency
   name: ghaki-match
-  requirement: &80030680 !ruby/object:Gem::Requirement
+  requirement: &80502760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2011.11.30.1
   type: :runtime
   prerelease: false
-  version_requirements: *80030680
+  version_requirements: *80502760
 - !ruby/object:Gem::Dependency
   name: ghaki-stats
-  requirement: &80030460 !ruby/object:Gem::Requirement
+  requirement: &80502540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 2011.11.29.1
   type: :runtime
   prerelease: false
-  version_requirements: *80030460
+  version_requirements: *80502540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80030240 !ruby/object:Gem::Requirement
+  requirement: &80502320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *80030240
+  version_requirements: *80502320
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &80030010 !ruby/object:Gem::Requirement
+  requirement: &80502090 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *80030010
+  version_requirements: *80502090
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &80029780 !ruby/object:Gem::Requirement
+  requirement: &80501860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: 3.9.4
   type: :development
   prerelease: false
-  version_requirements: *80029780
+  version_requirements: *80501860
 description: Collection of extensions for basic reporting.
 email: gerald@kalafut.org
 executables: []
@@ -106,16 +106,16 @@ extensions: []
 extra_rdoc_files:
 - README
 files:
+- lib/ghaki/report/mixin/basic.rb
 - lib/ghaki/report/mixin/linear_parser.rb
-- lib/ghaki/report/output_file.rb
+- lib/ghaki/report/mixin/output_file.rb
 - lib/ghaki/report/errors.rb
-- lib/ghaki/report/base.rb
 - README
 - LICENSE
 - VERSION
-- spec/ghaki/report/base_spec.rb
+- spec/ghaki/report/mixin/basic_spec.rb
 - spec/ghaki/report/mixin/linear_parser_spec.rb
-- spec/ghaki/report/output_file_spec.rb
+- spec/ghaki/report/mixin/output_file_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ghaki
 licenses: []
@@ -142,7 +142,7 @@ signing_key:
 specification_version: 3
 summary: Basic reporting helpers
 test_files:
-- spec/ghaki/report/base_spec.rb
+- spec/ghaki/report/mixin/basic_spec.rb
 - spec/ghaki/report/mixin/linear_parser_spec.rb
-- spec/ghaki/report/output_file_spec.rb
+- spec/ghaki/report/mixin/output_file_spec.rb
 - spec/spec_helper.rb

data/lib/ghaki/report/output_file.rb

@@ -1,41 +0,0 @@
-require 'ghaki/core_ext/file/with_temp'
-require 'ghaki/report/base'
-
-module Ghaki  #:nodoc:
-module Report #:nodoc:
-
-class OutputFile < Base
-
-  ######################################################################
-  attr_accessor :output_file
-
-  ######################################################################
-  def initialize opts={} ; super opts
-    self.class.report_name ||= 'WRITING REPORT'
-    @output_file = opts[:output_file]
-  end
-
-  ######################################################################
-  def output_report
-    output_prepare
-    logger.info 'output file: ' + @output_file
-    File.with_opened_temp @output_file do |tmp_file|
-      output_to_format tmp_file
-    end
-    output_finish
-  end
-
-  ######################################################################
-  def output_finish
-  end
-
-  ######################################################################
-  def output_prepare
-  end
-
-  ######################################################################
-  def output_to_format out_file
-  end
-
-end
-end end

data/spec/ghaki/report/base_spec.rb

@@ -1,70 +0,0 @@
-require 'ghaki/report/base'
-
-module Ghaki module Report module BaseTesting
-describe Base do
-
-  before(:all) do
-    @log = stub_everything()
-    @maj = stub_everything()
-    @min = stub_everything()
-  end
-
-  class MyReport < Base
-    self.report_name = 'my_report'
-  end
-
-  context 'eigen class' do
-    subject { MyReport }
-    it { should respond_to :report_name }
-    describe '#report_name' do
-      it 'specifies report name' do
-        MyReport.report_name.should == 'my_report'
-      end
-    end
-  end
-
-  subject do MyReport.new( :logger => @log ) end
-
-  context 'object instance' do
-    it { should respond_to :logger }
-    it { should respond_to :logger= }
-    it { should respond_to :stats }
-  end
-
-  describe '#report_name' do
-    it 'defaults to eigen report name' do
-      subject.report_name == 'my_report'
-    end
-    it 'accepts normal report name' do
-      subject.report_name('quack').should == 'quack'
-    end
-    it 'accepts period leading report nmae' do
-      subject.report_name('.moo').should == 'my_report.moo'
-    end
-  end
-
-  describe '#report_name=' do
-    it 'assigns report name' do
-      subject.report_name = 'zap'
-      subject.report_name.should == 'zap'
-    end
-  end
-
-  describe '#minor_report_wrap' do
-    it 'calls logger minor mode' do
-      @log.expects(:minor).returns(@min).once
-      @min.expects(:wrap).with('my_report').once
-      subject.minor_report_wrap do end
-    end
-  end
-
-  describe '#major_report_wrap' do
-    it 'calls logger major mode' do
-      @log.expects(:major).returns(@maj).once
-      @maj.expects(:wrap).with('my_report').once
-      subject.major_report_wrap do end
-    end
-  end
-
-end
-end end end

data/spec/ghaki/report/output_file_spec.rb

@@ -1,32 +0,0 @@
-require 'ghaki/report/output_file'
-
-module Ghaki module Report module OutputFileTesting
-describe OutputFile do
-
-  before(:all) do
-    @log = stub_everything()
-    @out = '/tmp/myfile.txt'
-  end
-
-  subject do OutputFile.new( :logger => @log, :output_file => @out ) end
-
-  it { should respond_to :output_file }
-  it { should respond_to :output_file= }
-  it { should respond_to :output_report }
-  it { should respond_to :output_finish }
-  it { should respond_to :output_prepare }
-  it { should respond_to :output_to_format }
-
-  describe '#output_report' do
-    it 'should create file' do
-      abc = sequence('reporting')
-      subject.expects(:output_prepare).once.in_sequence(abc)
-      ::File.expects(:with_opened_temp).with(@out).yields(@out).once.in_sequence(abc)
-      subject.expects(:output_to_format).with(@out).once.in_sequence(abc)
-      subject.expects(:output_finish).once.in_sequence(abc)
-      subject.output_report
-    end
-  end
-
-end
-end end end