metric_fu 4.2.1 → 4.3.0

data/lib/metric_fu/reporting/report.rb

@@ -1,111 +0,0 @@
-module MetricFu
-
-  # MetricFu.report memoizes access to a Report object, that will be
-  # used throughout the lifecycle of the MetricFu app.
-  def self.report
-    @report ||= Report.new
-  end
-
-  # = Report
-  #
-  # The Report class is responsible two things:
-  #
-  # It adds information to the yaml report, produced by the system
-  # as a whole, for each of the generators used in this test run.
-  #
-  # It also handles passing the information from each generator used
-  # in this test run out to the template class set in
-  # MetricFu::Configuration.
-  class Report
-
-    # Renders the result of the report_hash into a yaml serialization
-    # ready for writing out to a file.
-    #
-    # @return YAML
-    #   A YAML object containing the results of the report generation
-    #   process
-    def as_yaml
-      report_hash.to_yaml
-    end
-
-    def per_file_data
-      @per_file_data ||= {}
-    end
-
-    def report_hash #:nodoc:
-      @report_hash ||= {}
-    end
-
-    # Instantiates a new template class based on the configuration set
-    # in MetricFu::Configuration, or through the MetricFu.config block
-    # in your rake file (defaults to the included AwesomeTemplate),
-    # assigns the report_hash to the report_hash in the template, and
-    # tells the template to to write itself out.
-    def save_templatized_report
-      @template = MetricFu.template_class.new
-      @template.report = report_hash
-      @template.per_file_data = per_file_data
-      @template.write
-    end
-
-    # Adds a hash from a passed report, produced by one of the Generator
-    # classes to the aggregate report_hash managed by this hash.
-    #
-    # @param report_type Hash
-    #   The hash to add to the aggregate report_hash
-    def add(report_type)
-      mf_debug "report requested #{report_type}"
-      clazz = MetricFu.const_get(report_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
-      mf_debug "report class found #{clazz}"
-      metric_options = MetricFu.send(report_type)
-      inst = clazz.new(metric_options)
-
-      report_hash.merge!(inst.generate_report)
-
-      inst.per_file_info(per_file_data) if inst.respond_to?(:per_file_info)
-    end
-
-    # Saves the passed in content to the passed in directory.  If
-    # a filename is passed in it will be used as the name of the
-    # file, otherwise it will default to 'index.html'
-    #
-    # @param content String
-    #   A string containing the content (usually html) to be written
-    #   to the file.
-    #
-    # @param dir String
-    #   A dir containing the path to the directory to write the file in.
-    #
-    # @param file String
-    #   A filename to save the path as.  Defaults to 'index.html'.
-    #
-    def save_output(content, dir, file='index.html')
-      open("#{dir}/#{file}", "w") do |f|
-        f.puts content
-      end
-    end
-
-    # Checks to discover whether we should try and open the results
-    # of the report in the browser on this system.  We only try and open
-    # in the browser if we're on OS X and we're not running in a
-    # CruiseControl.rb environment.  See MetricFu.configuration for more
-    # details about how we make those guesses.
-    #
-    # @return Boolean
-    #   Should we open in the browser or not?
-    def open_in_browser?
-      MetricFu.configuration.platform.include?('darwin') &&
-      ! MetricFu.configuration.is_cruise_control_rb?
-    end
-
-    # Shows 'index.html' from the passed directory in the browser
-    # if we're able to open the browser on this platform.
-    #
-    # @param dir String
-    #   The directory path where the 'index.html' we want to open is
-    #   stored
-    def show_in_browser(dir)
-      system("open #{dir}/index.html") if open_in_browser?
-    end
-  end
-end

data/spec/metric_fu/reporting/report_spec.rb

@@ -1,148 +0,0 @@
-require "spec_helper"
-
-describe MetricFu do
-
-  describe "#report" do
-    it 'should return an instance of Report' do
-      MetricFu.report.instance_of?(Report).should be(true)
-    end
-  end
-end
-
-describe MetricFu::Report do
-
-  before(:each) do
-    @report = MetricFu::Report.new
-  end
-
-  describe "#as_yaml" do
-    it 'should call #report_hash' do
-      report_hash = mock('report_hash')
-      report_hash.should_receive(:to_yaml)
-
-      @report.should_receive(:report_hash).and_return(report_hash)
-      @report.as_yaml
-    end
-  end
-
-  describe "#report_hash" do
-  end
-
-  describe "#save_templatized_report" do
-    it 'should create a new template class assign a report_hash '\
-       'to the template class, and ask it to write itself out' do
-      template_class = mock('template_class')
-      template_class.should_receive(:new).and_return(template_class)
-      MetricFu.should_receive(:template_class).and_return(template_class)
-      template_class.should_receive(:report=)
-      template_class.should_receive(:per_file_data=)
-      template_class.should_receive(:write)
-      @report.save_templatized_report
-    end
-  end
-
-  describe "#add" do
-    it 'should add a passed hash to the report_hash instance variable' do
-      report_type = mock('report_type')
-      report_type.should_receive(:to_s).any_number_of_times.and_return('type')
-
-      report_inst = mock('report_inst')
-      report_type.should_receive(:new).and_return(report_inst)
-
-      report_inst.should_receive(:generate_report).and_return({:a => 'b'})
-      report_inst.should_receive(:respond_to?).and_return(false)
-
-      MetricFu.should_receive(:send).with(report_type).and_return({})
-      MetricFu.should_receive(:const_get).
-               with('Type').and_return(report_type)
-      report_hash = mock('report_hash')
-      report_hash.should_receive(:merge!).with({:a => 'b'})
-      @report.should_receive(:report_hash).and_return(report_hash)
-      @report.add(report_type)
-    end
-  end
-
-  describe "#save_output" do
-    it 'should write the passed content to dir/index.html' do
-      f = mock('file')
-      content = 'content'
-      @report.should_receive(:open).with('dir/file', 'w').and_yield(f)
-      f.should_receive(:puts).with(content)
-      @report.save_output(content, 'dir', 'file')
-    end
-  end
-
-  describe '#open_in_browser? ' do
-
-    before(:each) do
-      @config = mock('configuration')
-    end
-
-    describe 'when the platform is os x ' do
-
-      before(:each) do
-        @config.should_receive(:platform).and_return('darwin')
-      end
-
-      describe 'and we are in cruise control ' do
-
-        before(:each) do
-          @config.should_receive(:is_cruise_control_rb?).and_return(true)
-          MetricFu.stub!(:configuration).and_return(@config)
-        end
-
-        it 'should return false' do
-          @report.open_in_browser?.should be_false
-        end
-      end
-
-      describe 'and we are not in cruise control' do
-
-        before(:each) do
-          @config.should_receive(:is_cruise_control_rb?).and_return(false)
-          MetricFu.stub!(:configuration).and_return(@config)
-        end
-
-        it 'should return true' do
-          @report.open_in_browser?.should be_true
-        end
-      end
-    end
-
-    describe 'when the platform is not os x ' do
-      before(:each) do
-        @config.should_receive(:platform).and_return('other')
-      end
-
-      describe 'and we are in cruise control' do
-        before(:each) do
-          MetricFu.stub!(:configuration).and_return(@config)
-        end
-
-        it 'should return false' do
-          @report.open_in_browser?.should be_false
-        end
-      end
-
-      describe 'and we are not in cruise control' do
-        before(:each) do
-          MetricFu.stub!(:configuration).and_return(@config)
-        end
-
-        it 'should return false' do
-          @report.open_in_browser?.should be_false
-        end
-      end
-    end
-  end
-
-
-  describe '#show_in_browser' do
-    it 'should call open with the passed directory' do
-      @report.should_receive(:open_in_browser?).and_return(true)
-      @report.should_receive(:system).with("open my_dir/index.html")
-      @report.show_in_browser('my_dir')
-    end
-
-  end
-end