metric_fu 4.4.2 → 4.4.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTFmYmRkMmExNTg1MDBhMDI0MTQ1OTFiMGJkNDc1MTY2OTdlYTJiNQ==
-  data.tar.gz: !binary |-
-    ZDQ5OGMzN2QwNWE0M2JmMTM0ZTljYTA4OTFhYjBhNzgzZGVkYjYzMA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTFlNDhmNDE1NjM1ZmMxODlmYjQ1NDZjMDI4MWE4NzBiMDFjNDc5YTBkODc2
-    NzZkZTA1ZTA1OWRhYjYyZmZmZDcxOGVmMGE1ODcxY2E1ZWEzMTliNDUxOTgx
-    NDdkYTNkNGViYTBmZmFhYWFjYzFlNTk1ZTNkZGRlOTFhY2VmNTc=
-  data.tar.gz: !binary |-
-    OTY3Y2ZkMGVlZmJjNzM4MDQxZmMyNWIyNjU1OThmZTVmZDI4YTQyZjYxMDJi
-    MjYxMGQyYjM4YTcyNjliYTdlMjlkYzFmMjhlYjA0OTA2OTJiNDI1NzUwODM4
-    MzZkOTkyMzBmM2Q1N2IwYWNmMjc5MDQ2ZDJlYTFlNjhiNjkwZWI=
+SHA1:
+  metadata.gz: 8b6f6cc83dd1f84b3b744197df56b2fa179390c7
+  data.tar.gz: 2059f5c9368c4246db6d724ed18396a0fa891b17
+SHA512:
+  metadata.gz: 07b0c5284d8c083cb8259d529450960aa9a842d2fe835e7daa3428c38190c96b23efbc3d55f4fa39289d4c2bb24deab2b829eeabfde0023d40e9c250664b928a
+  data.tar.gz: 1bc9bf9f893e4f8745b30eec8e508d72245341563d208757b3540511c86ec0b5dfc17e25354027564b78029b76a8dd173366f61f497901b7bea25baa366303e7

data/HISTORY.md

@@ -10,6 +10,14 @@ As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.
 * Fixes
 * Misc
 
+### MetricFu [4.4.3 / 2013-09-25](https://github.com/metricfu/metric_fu/compare/v4.4.1...v4.4.3)
+
+* Features
+* Fixes
+  * Scratch directory no longer dependent on generator class name. Saikuro works again! (Benjamin Fleischer, #141)
+* Misc
+  * Metric scratch directory now set via Metric `run_options[:output_directory] || MetricFu::Io::FileSystem.scratch_directory(metric)` (Benjamin Fleischer, #141)
+
 ### MetricFu [4.4.2 / 2013-09-25](https://github.com/metricfu/metric_fu/compare/v4.4.1...v4.4.2)
 
 * Features

data/checksum/metric_fu-4.4.2.gem.sha512

@@ -0,0 +1 @@
+1beb22d0d940c4d5297efbfa5a2c6ad46a5f64fd68a0695bc1d81a7b3d85fdafc9004ede390272f2602a2a87f306137fccf53e8225b9dd9943e87ef5c7103c78

data/lib/metric_fu/configuration.rb

@@ -80,7 +80,7 @@ module MetricFu
       # TODO: Remove calls to self and/or allow querying the
       #   template/filesystem/metric/graph/environment, etc settings
       #   from the configuration instance
-      MetricFu::Io::FileSystem.set_directories(self)
+      MetricFu::Io::FileSystem.set_directories
       MetricFu::Formatter::Templates.configure_template(self)
       @formatters = []
       @graph_engine_config = MetricFu::GraphEngine.new
@@ -107,6 +107,7 @@ module MetricFu
     end
 
     def configure_metrics
+      MetricFu::Io::FileSystem.set_directories
       MetricFu::Metric.metrics.each do |metric|
         if block_given?
           yield metric

data/lib/metric_fu/io.rb

@@ -18,12 +18,16 @@ module MetricFu
       def directory(name)
         directories.fetch(name) { raise "No such directory configured: #{name}" }
       end
+
+      def scratch_directory(name)
+        File.join(directory('scratch_directory'), name.to_s)
+      end
+
       def file_globs_to_ignore
         @file_globs_to_ignore ||= []
       end
 
-      # TODO: Remove call to config
-      def set_directories(config)
+      def set_directories
         @directories = {}
         @directories['base_directory']    = MetricFu.artifact_dir
         @directories['scratch_directory'] = MetricFu.scratch_dir
@@ -35,7 +39,7 @@ module MetricFu
         # TODO Though this is true of the general AwesomeTemplate, it is not necessarily true of templates within each Metric.  Each metric should probably know how to use AwesomeTemplate (or whatever)
         @directories['template_directory'] = File.join(@directories.fetch('root_directory'), 'lib', 'templates')
         @file_globs_to_ignore = []
-        set_code_dirs(config)
+        set_code_dirs
       end
 
       def create_directories(*dirs)
@@ -47,7 +51,7 @@ module MetricFu
       end
 
       # Add the 'app' directory if we're running within rails.
-      def set_code_dirs(config)
+      def set_code_dirs
         @directories['code_dirs'] = %w(app lib).select{|dir| Dir.exists?(dir) }
       end
 

data/lib/metric_fu/metrics/generator.rb

@@ -24,20 +24,18 @@ module MetricFu
   #
   # Based on the class name of the concrete class implementing a
   # Generator, the Generator class will create a 'metric_directory'
-  # named after the class under the MetricFu.scratch_directory, where
+  # named after the metric under the scratch_directory, where
   # any output from the #emit method should go.
   #
-  # It will also create the MetricFu.output_directory if neccessary, and
+  # It will also create the output_directory if neccessary, and
   # in general setup the directory structure that the MetricFu system
   # expects.
   class Generator
+
     attr_reader :result, :template, :options
 
     def initialize(options={})
       @options = options
-      create_metric_dir_if_missing
-      create_output_dir_if_missing
-      create_data_dir_if_missing
     end
 
     @generators = []
@@ -54,46 +52,18 @@ module MetricFu
       @generators << subclass
     end
 
-    # Provides the unqualified class name of an implemented concrete
-    # class, as a string.  For example:
-    #
-    #   class Flay < Generator; end
-    #   klass = Flay.new
-    #   klass.class_name
-    #   > "flay"
-    #
-    # @return String
-    #   The unqualified class name of this concrete class, returned
-    #   as a string.
-    def self.class_name
-      self.to_s.split('::').last.downcase
-    end
-
     # Returns the directory where the Generator will write any output
     def self.metric_directory
-      File.join(MetricFu::Io::FileSystem.directory('scratch_directory'), class_name)
-    end
-
-    def create_metric_dir_if_missing #:nodoc:
-      unless File.directory?(metric_directory)
-        FileUtils.mkdir_p(metric_directory, :verbose => false)
-      end
-    end
-
-    def create_output_dir_if_missing #:nodoc:
-      unless File.directory?(MetricFu::Io::FileSystem.directory('output_directory'))
-        FileUtils.mkdir_p(MetricFu::Io::FileSystem.directory('output_directory'), :verbose => false)
-      end
-    end
-
-    def create_data_dir_if_missing #:nodoc:
-      unless File.directory?(MetricFu::Io::FileSystem.directory('data_directory'))
-        FileUtils.mkdir_p(MetricFu::Io::FileSystem.directory('data_directory'), :verbose => false)
-      end
+      @metric_directory ||=
+        MetricFu::Metric.get_metric(metric).run_options[:output_directory] ||
+        begin
+          metric_directory = MetricFu::Io::FileSystem.scratch_directory(metric)
+          FileUtils.mkdir_p(metric_directory, :verbose => false)
+        end
     end
 
-    # @return String
-    #   The path of the metric directory this class is using.
+    # @return [String]
+    # The path of the metric directory this class is using.
     def metric_directory
       self.class.metric_directory
     end

data/lib/metric_fu/metrics/saikuro/init.rb

@@ -6,13 +6,15 @@ module MetricFu
     end
 
     def default_run_options
-      { :output_directory => "#{MetricFu::Io::FileSystem.directory('scratch_directory')}/saikuro",
-                    :input_directory =>MetricFu::Io::FileSystem.directory('code_dirs'),
-                    :cyclo => "",
-                    :filter_cyclo => "0",
-                    :warn_cyclo => "5",
-                    :error_cyclo => "7",
-                    :formater => "text"}
+      {
+        :output_directory => MetricFu::Io::FileSystem.scratch_directory(name),
+        :input_directory =>MetricFu::Io::FileSystem.directory('code_dirs'),
+        :cyclo => "",
+        :filter_cyclo => "0",
+        :warn_cyclo => "5",
+        :error_cyclo => "7",
+        :formater => "text",
+      }
     end
 
     def has_graph?

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.4.2"
+  VERSION = "4.4.3"
 end

data/spec/metric_fu/metrics/generator_spec.rb

@@ -27,52 +27,13 @@ describe MetricFu::Generator do
     @concrete_class = ConcreteClass.new
   end
 
-  describe "ConcreteClass#class_name" do
-    it "should be 'concreteclass'" do
-      ConcreteClass.class_name.should == 'concreteclass'
-    end
-  end
-
   describe "ConcreteClass#metric_directory" do
     it "should be 'tmp/metric_fu/scratch/concreteclass'" do
+      concrete_metric = double('concrete_metric')
+      MetricFu::Metric.should_receive(:get_metric).with(:concrete).and_return(concrete_metric)
+      concrete_metric.should_receive(:run_options).and_return({})
       compare_paths(ConcreteClass.metric_directory,
-                    "tmp/metric_fu/scratch/concreteclass")
-    end
-  end
-
-  describe "#create_metric_dir_if_missing " do
-    describe "when the metric_dir exists " do
-      it 'should not call mkdir_p on FileUtils' do
-        File.stub(:directory?).and_return(true)
-        FileUtils.should_not_receive(:mkdir_p)
-        @concrete_class.create_metric_dir_if_missing
-      end
-    end
-
-    describe "when the metric_dir does not exist " do
-      it 'should call mkdir_p on FileUtils' do
-        File.stub(:directory?).and_return(false)
-        FileUtils.should_receive(:mkdir_p)
-        @concrete_class.create_metric_dir_if_missing
-      end
-    end
-  end
-
-  describe "#create_output_dir_if_missing" do
-    describe "when the output_dir exists " do
-      it 'should not call mkdir_p on FileUtils' do
-        File.stub(:directory?).and_return(true)
-        FileUtils.should_not_receive(:mkdir_p)
-        @concrete_class.create_output_dir_if_missing
-      end
-    end
-
-    describe "when the output_dir does not exist " do
-      it 'should call mkdir_p on FileUtils' do
-        File.stub(:directory?).and_return(false)
-        FileUtils.should_receive(:mkdir_p)
-        @concrete_class.create_output_dir_if_missing
-      end
+                    "tmp/metric_fu/scratch/concrete")
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.4.3
 platform: ruby
 authors:
 - Jake Scruggs
@@ -19,13 +19,13 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.1
     - - ~>
@@ -35,7 +35,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.1
     - - ~>
@@ -59,7 +59,7 @@ dependencies:
   name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 4.1.1
     - - ~>
@@ -69,7 +69,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 4.1.1
     - - ~>
@@ -79,7 +79,7 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
     - - ~>
@@ -89,7 +89,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.3
     - - ~>
@@ -99,7 +99,7 @@ dependencies:
   name: cane
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.2
     - - ~>
@@ -109,7 +109,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.5.2
     - - ~>
@@ -119,7 +119,7 @@ dependencies:
   name: rails_best_practices
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.14.3
     - - ~>
@@ -129,7 +129,7 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.14.3
     - - ~>
@@ -139,14 +139,14 @@ dependencies:
   name: metric_fu-Saikuro
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.1.0
 - !ruby/object:Gem::Dependency
@@ -181,56 +181,56 @@ dependencies:
   name: redcard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bluff
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Code Statistics,
@@ -279,6 +279,7 @@ files:
 - checksum/metric_fu-4.3.1.gem.sha512
 - checksum/metric_fu-4.4.0.gem.sha512
 - checksum/metric_fu-4.4.1.gem.sha512
+- checksum/metric_fu-4.4.2.gem.sha512
 - config/roodi_config.yml
 - gem_tasks/build.rake
 - gemfiles/Gemfile.travis
@@ -488,17 +489,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: metric_fu
-rubygems_version: 2.0.8
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A fistful of code metrics, with awesome templates and graphs