code_keeper 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d30fec72da618c4ce29c0c819fb0a912cb968d829182143337b537ec3a69dbc
-  data.tar.gz: f24e1bc9e08780f4e6c2f1943b4620671da06d1ff71026d8e81a00300137b352
+  metadata.gz: 36a68ad1540e4e6adb062bc85c1ab015c280bfe604ac5644cdfc21dd1df58c9d
+  data.tar.gz: 6850f00648efb8910be1eaf0125a3aa39a799a888a31e2c971946cab337dbdbb
 SHA512:
-  metadata.gz: ef7a1991ea72b93c1c47d6d07376008ca0d0e9b0da1156bdcedee4cd7efa96b9896912680c0520d8516a9a8486052d753b799fb836610787a794bc0b5001e5fe
-  data.tar.gz: 1c66dd84f996a705b93513bcd45b342cf1d3fba28d4773b84c882489b860c86024293096a0285580e38bde529e4dc53feb84b5cb719afe4ec0c8735ff078b7d5
+  metadata.gz: 87718f55c24471bee5b26d21d108445103111b135e117872d8c0e709b20a21cdbd6b865d06db277e29722eb607ba3bb687f8eef6c509e68a47c1563052d7b2e3
+  data.tar.gz: 63938e0590f3c9faa32ef9f71d7a1b45cc3685d0a46d2a53aaa6d8c222eefaf3119cb2bb5aac2eeb618a0bf092999c4283f3b98fc36554218624c4a9027b9054

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unrelease
 
+## 0.4.0 (2021-09-15)
+### New features
+- [#30](https://github.com/ebihara99999/code_keeper/pull/30): Support CSV and JSON format.
+
 ## 0.3.0 (2021-09-15)
 
 ### New features

data/README.md

@@ -3,7 +3,7 @@ The CodeKeeper measures metrics especially about complexity and size of Ruby fil
 
 Mesuring metrics leads to keep codebase simple and clean, and I name the gem CodeKeeper.
 
-Now CodeKeeper supports the cyclomatic complexity of a file, the ABC software metric of a file, and class length. The scores are output to stdout.
+Now CodeKeeper supports the cyclomatic complexity of a file, the ABC software metric of a file, and class length. The scores are output to stdout of a json or csv format.
 
 ## Installation
 
@@ -25,18 +25,11 @@ Or install it yourself as:
 Run CodeKeeper and you get scores of metrics from stdout like 
 
 ```rb
-$ bundle exec code_keeper ./app/models
-Scores:
-
-Metric: cyclomatic_complexity
-Filename: app/models/admin.rb
-Score: 1
----
-Metric: cyclomatic_complexity
-Filename: app/models/user.rb
-Score: 23
----
+$ bundle exec code_keeper app/models/user.rb app/models/admin.rb > metrics.json
+$ cat metrics.json
+{"cyclomatic_complexity":{"app/models/admin.rb":9,"app/models/user.rb":23},"class_length":{"Admin":86,"User":1475},"abc_metric":{"app/models/admin.rb":76.909,"app/models/user.rb":1546.4155}}
 ```
+If you need a csv format, change the configuration as explained later.
 
 ### Run CodeKeeper
 To measure metrics of all the ruby files recursively in the current directory, run
@@ -55,9 +48,11 @@ CodeKeeper makes you configure the following way:
 ```rb
 CodeKeeper.configure do |config|
   # If you choose metrics, specify as follows:
-  config.metrics = [:cyclomatic_complexity]
+  config.metrics = %i(cyclomatic_complexity abc_metric class_length)
   # The number of threads. The default is 2. Executed sequentially if you set 1.
   config.number_of_threads = 4
+  # The default is json
+  config.format = :json
 end
 ```
 

data/lib/code_keeper/config.rb

@@ -3,11 +3,12 @@
 module CodeKeeper
   # Provide configuration
   class Config
-    attr_accessor :metrics, :number_of_threads
+    attr_accessor :metrics, :number_of_threads, :format
 
     def initialize
       @metrics = %i[cyclomatic_complexity class_length abc_metric]
       @number_of_threads = 2
+      @format = :json # json and csv are supported.
     end
   end
 end

data/lib/code_keeper/formatter.rb

@@ -1,32 +1,25 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 module CodeKeeper
   # Format a result and make it human-readable.
   class Formatter
     class << self
       def format(result)
-        title = "Scores:\n\n"
-        formatted_result = +title
+        return result.scores.to_json if CodeKeeper.config.format == :json
 
+        # csv is supported besides json
+        csv_array = []
         result.scores.each_key do |metric|
-          result.scores[metric].each do |k, v|
-            klass_or_file_key = if metric == :class_length
-                                  'Class'
-                                else
-                                  'Filename'
-                                end
+          result.scores[metric].each { |k, v| csv_array << [metric, k, v] }
+        end
 
-            formatted_result.concat(
-              <<~EOS
-                Metric: #{metric}
-                #{klass_or_file_key}: #{k}
-                Score: #{v}
-                ---
-              EOS
-            )
-          end
+        headers = %w[metric file score]
+        CSV.generate(headers: true) do |csv|
+          csv << headers
+          csv_array.each { |array| csv << array }
         end
-        formatted_result
       end
     end
   end

data/lib/code_keeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeKeeper
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_keeper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yusuke Ebihara