fukuzatsu 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f07664e5fec8ebb4806db7425780356672dbff2
-  data.tar.gz: d53ab4e6300ee913f663ab334cb71599a89a7d7b
+  metadata.gz: eb84e0a6f11ae010959c1aa9d657c22bae0983d1
+  data.tar.gz: 159ee1f749fa2e8527194ed519627b5a5167897e
 SHA512:
-  metadata.gz: 32d568e9018a733ea7e9a3b98c3df9cabad1917aa5ce0d2ba96f2ade60d7f65677afae5939ffaa80db506aa8bff44b827f3407d3b160df05e050fdfde69c411f
-  data.tar.gz: 097cbc999cd38da8c69eab575c8143754f1498b97a5f6b861682b6d2057be2531ff9114f4dd7e756526d37517a0a0b5c54d601fb583b8d9ff5c55e030fdc83b1
+  metadata.gz: 780f5c5b5fbe79f397c34eea73253d001fbc2fe18eee713210b0774886f3a8f14383322935242fc97e4d2e83ee733db81c25c606034d4e2e0b992148e86aa714
+  data.tar.gz: fd6bf7dc7e6efccba8badae0d4f4273fbffb88fa44876364022ab392d32e257c10b182dc58255808fbd336856a9f2bd2e55311622499e99207e89296b4074230

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,13 @@
-# CODE OF CONDUCT
-
-This project has adopted version 0.4 of the [Contributor Covenant](https://github.com/bantik/contributor_covenant/).
+# Contributor Code of Conduct
 
 As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
 
-If any participant in this project has issues or takes exception with a contribution, they are obligated to provide constructive feedback and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
 
 Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
 
-We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, ability or disability, ethnicity, religion, or level of experience.
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/fukuzatsu.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.1'
 
   spec.add_dependency "analyst", ">= 0.16.0"
   spec.add_dependency "ephemeral"

data/lib/fukuzatsu.rb

@@ -19,8 +19,8 @@ require_relative "fukuzatsu/summary"
 require_relative "fukuzatsu/version"
 
 module Fukuzatsu
-  def self.new(path_to_files, formatter=:text, threshold=0)
-    Fukuzatsu::Parser.new(path_to_files, formatters[formatter], threshold)
+  def self.new(path_to_files, formatter=:text, threshold=0, output_path=nil)
+    Fukuzatsu::Parser.new(path_to_files, formatters[formatter], threshold, output_path)
   end
 
   def self.formatters

data/lib/fukuzatsu/cli.rb

@@ -8,12 +8,13 @@ module Fukuzatsu
     desc_text = "Formats are text (default, to STDOUT), html, and csv. "
     desc_text << "Example: fuku check foo/ -f html"
 
-    desc "check PATH_TO_FILE [-f FORMAT] [-t MAX_COMPLEXITY_ALLOWED]", desc_text
+    desc "check PATH_TO_FILE [-f FORMAT] [-t MAX_COMPLEXITY_ALLOWED] [-o OUTPUT_PATH]", desc_text
     method_option :format, :type => :string, :default => 'text', :aliases => "-f"
     method_option :threshold, :type => :numeric, :default => 0, :aliases => "-t"
+    method_option :output, :type => :string, :aliases => "-o"
 
     def check(path="./")
-      Fukuzatsu.new(path, formatter, options['threshold']).report
+      Fukuzatsu.new(path, formatter, options['threshold'], options['output']).report
     end
 
     default_task :check

data/lib/fukuzatsu/formatters/base.rb

@@ -4,24 +4,24 @@ module Fukuzatsu
 
     module Base
 
-      BASE_OUTPUT_DIRECTORY = "doc/fukuzatsu/"
-
       def self.included(klass)
         klass.send(:attr_accessor, :summary)
         klass.send(:attr_accessor, :source)
+        klass.send(:attr_accessor, :base_output_path)
         klass.extend(ClassMethods)
       end
 
-      def initialize(source: nil, summary:nil)
+      def initialize(source: nil, summary:nil, base_output_path:)
         self.source = source
         self.summary = summary
+        self.base_output_path = base_output_path
       end
 
       def export
         begin
           File.open(path_to_results, 'w') {|outfile| outfile.write(content)}
         rescue Exception => e
-          puts "Unable to write output: #{e} #{e.backtrace}"
+          puts "Unable to write output to #{path_to_results}: #{e} #{e.backtrace}"
         end
       end
 
@@ -30,7 +30,7 @@ module Fukuzatsu
       end
 
       def output_directory
-        BASE_OUTPUT_DIRECTORY + file_extension.gsub(".","")
+        self.base_output_path + "/" + file_extension.gsub(".","")
       end
 
       def output_path
@@ -49,11 +49,11 @@ module Fukuzatsu
 
       module ClassMethods
 
-        def index(summaries)
+        def index(summaries, base_output_path)
         end
 
-        def reset_output_directory
-          directory = new.output_directory
+        def reset_output_directory(base_output_path)
+          directory = new(base_output_path: base_output_path).output_directory
           begin
             FileUtils.remove_dir(directory)
           rescue Errno::ENOENT
@@ -61,9 +61,10 @@ module Fukuzatsu
           FileUtils.mkpath(directory)
         end
 
-        def explain(count)
-          puts "Processed #{count} file(s). Results written to #{new.output_directory}."
+        def writes_to_file_system?
+          true
         end
+
       end
     end
 

data/lib/fukuzatsu/formatters/html.rb

@@ -8,8 +8,8 @@ module Fukuzatsu
 
       include Formatters::Base
 
-      def self.index(summaries)
-        Fukuzatsu::Formatters::HtmlIndex.new(summaries).export
+      def self.index(summaries, base_output_path)
+        Fukuzatsu::Formatters::HtmlIndex.new(summaries, base_output_path).export
       end
 
       def columns

data/lib/fukuzatsu/formatters/html_index.rb

@@ -8,8 +8,9 @@ module Fukuzatsu
 
       attr_reader :summaries
 
-      def initialize(summaries)
+      def initialize(summaries, base_output_path)
         @summaries = summaries
+        @base_output_path = base_output_path
       end
 
       def content

data/lib/fukuzatsu/formatters/json.rb

@@ -6,8 +6,8 @@ module Fukuzatsu
 
       include Formatters::Base
 
-      def self.index(summaries)
-        Fukuzatsu::Formatters::JsonIndex.new(summaries).export
+      def self.index(summaries, base_output_path)
+        Fukuzatsu::Formatters::JsonIndex.new(summaries, base_output_path).export
       end
 
       def as_json
@@ -19,7 +19,7 @@ module Fukuzatsu
         }
         if summary.is_class_or_module?
           result[:average_complexity] = summary.average_complexity
-          result[:methods] = summary.summaries.map { |s| Json.new(summary: s).as_json }
+          result[:methods] = summary.summaries.map { |s| Json.new(summary: s, base_output_path: self.base_output_path).as_json }
         end
         result
       end

data/lib/fukuzatsu/formatters/json_index.rb

@@ -8,12 +8,13 @@ module Fukuzatsu
 
       attr_reader :summaries
 
-      def initialize(summaries)
+      def initialize(summaries, base_output_path)
         @summaries = summaries
+        @base_output_path = base_output_path
       end
 
       def content
-        summaries.map { |summary| Json.new(summary: summary).as_json }.to_json
+        summaries.map { |summary| Json.new(summary: summary, base_output_path: self.base_output_path).as_json }.to_json
       end
 
       def filename

data/lib/fukuzatsu/formatters/text.rb

@@ -9,9 +9,7 @@ module Fukuzatsu
 
       include Formatters::Base
 
-      def self.explain(count); end
-
-      def self.reset_output_directory
+      def self.reset_output_directory(args)
       end
 
       def self.writes_to_file_system?

data/lib/fukuzatsu/parser.rb

@@ -5,21 +5,29 @@ module Fukuzatsu
 
   class Parser
 
-    attr_reader :path_to_files, :formatter, :threshold
+    attr_reader :path_to_files, :formatter, :threshold, :output_path
 
-    def initialize(path_to_files, formatter, threshold)
+    DEFAULT_OUTPUT_DIRECTORY = "doc/fukuzatsu/"
+
+    def initialize(path_to_files, formatter, threshold, output_path=nil)
       @path_to_files = path_to_files
       @formatter = formatter
       @threshold = threshold
+      @output_path = output_path || DEFAULT_OUTPUT_DIRECTORY
+    end
+
+    def explain
+      puts "Processed #{summaries.count} file(s)."
+      puts "Results written to #{output_path}." if formatter.writes_to_file_system?
     end
 
     def report
-      self.formatter.reset_output_directory
-      self.formatter.index(summaries)
+      self.formatter.reset_output_directory(output_path)
+      self.formatter.index(summaries, output_path)
       summaries.uniq(&:container_name).each do |summary|
-        self.formatter.new(summary: summary).export
+        self.formatter.new(summary: summary, base_output_path: self.output_path).export
       end
-      self.formatter.explain(summaries.count)
+      explain
       check_complexity
     end
 

data/lib/fukuzatsu/version.rb

@@ -1,3 +1,3 @@
 module Fukuzatsu
-  VERSION = "2.1.1"
+  VERSION = "2.2.1"
 end

data/spec/formatters/csv_spec.rb

@@ -29,7 +29,7 @@ describe Fukuzatsu::Formatters::Csv do
     )
   }
 
-  let (:formatter) { Fukuzatsu::Formatters::Csv.new(summary: summary) }
+  let (:formatter) { Fukuzatsu::Formatters::Csv.new(summary: summary, base_output_path: nil) }
 
   describe "#rows" do
 

data/spec/formatters/html_spec.rb

@@ -26,7 +26,7 @@ describe "Fukuzatsu::Formatters::HTML" do
     )
   }
 
-  let (:formatter) { Fukuzatsu::Formatters::Html.new(summary: summary) }
+  let (:formatter) { Fukuzatsu::Formatters::Html.new(summary: summary, base_output_path: nil) }
 
   describe "#header" do
     it "returns an HTML-formatted header" do

data/spec/formatters/json_spec.rb

@@ -29,7 +29,7 @@ describe "Fukuzatsu::Formatters::Json" do
     )
   }
 
-  let (:formatter) { Fukuzatsu::Formatters::Json.new(summary: summary) }
+  let (:formatter) { Fukuzatsu::Formatters::Json.new(summary: summary, base_output_path: nil) }
 
   describe "#to_json" do
 

data/spec/formatters/text_spec.rb

@@ -10,7 +10,7 @@ describe Fukuzatsu::Formatters::Text do
     )
   }
 
-  let (:formatter) { Fukuzatsu::Formatters::Text.new(summary: summary) }
+  let (:formatter) { Fukuzatsu::Formatters::Text.new(summary: summary, base_output_path: nil) }
 
   describe "#header" do
     it "returns a header array" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fukuzatsu
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: analyst
@@ -267,7 +267,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="