kolekti 0.0.1.alpha2 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6c651093055fa4f70cf6f1353451dd75262158c
-  data.tar.gz: 2ab2060449ab84096802701738bc760a4ed25d2d
+  metadata.gz: a8a35b55e3e9052e2d77a36771badbbac87fabe5
+  data.tar.gz: 2760adecf3b8b465c4d44e77dbdf712ca4c8e460
 SHA512:
-  metadata.gz: 93ec4ebf8b4416a25569e379ecee8be46a9723e5ee33644b3ce1e604961af090042b182e447b3fd74e7f23813d0adf82318028a64bd957e0c6db78cdf5b6f73e
-  data.tar.gz: 948d62897e4a94c6c630e67834ff39b06906f8babb190c45009631d5478c1a0df872a40d16551d57736e33f0579a324e4acf527153395a61006a22e2da7472ba
+  metadata.gz: 82c77eefb5ce285cdb44d57148482548cb6fd3a1255cc2cae44dd9f7353f4afe86da95e59fd7c2eefd270bf433b074b747b890a1001a0cd57483bd445dd2d623
+  data.tar.gz: 9df971c7e8bc8a8a25d2a18451dacf4e52a2700af44d264227495ae3ff775c8be9003fd9fb48079cff0a284c08e21fbfc749c894669b90cb681521785f351847

data/README.md

@@ -1,16 +1,21 @@
 # Kolekti
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kolekti`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Code Climate](https://codeclimate.com/github/mezuro/kolekti.png)](https://codeclimate.com/github/mezuro/kalibro_client)
 
-TODO: Delete this and the text above, and describe your gem
+Kolekti is a code metric results parser framework. You can use it whenever you want structured unique output for different metric collectors.
+
+## Contributing
+
+Please, have a look the wiki pages about development workflow and code standards:
+
+* https://github.com/mezuro/mezuro/wiki/Development-workflow
+* https://github.com/mezuro/mezuro/wiki/Standards
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'kolekti'
-```
+    gem 'kolekti'
 
 And then execute:
 
@@ -22,15 +27,12 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You have one key class you need to extend `Kolekti::Collector` implementing the following methods:
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
+* `collect_metrics(code_directory, wanted_metric_configurations)`
+* `clean(code_directory, wanted_metric_configurations)`
+* `default_value_from(metric_configuration)`
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kolekti.
+Actual examples are:
 
+* [KolektiAnalizo](https://github.com/mezuro/kolekti_analizo)

data/kolekti.gemspec

@@ -6,12 +6,18 @@ require 'kolekti/version'
 Gem::Specification.new do |spec|
   spec.name          = "kolekti"
   spec.version       = Kolekti::VERSION
-  spec.authors       = ["Rafael Reggiani Manzo"]
-  spec.email         = ["rr.manzo@gmail.com"]
+  spec.authors       = ["Daniel Miranda",
+                        "Diego Araújo",
+                        "Eduardo Araújo",
+                        "Rafael Reggiani Manzo"]
+  spec.email         = ["danielkza2@gmail.com",
+                        "diegoamc90@gmail.com",
+                        "duduktamg@hotmail.com",
+                        "rr.manzo@protonmail.com"]
   spec.license       = "LGPLv3"
 
-  spec.summary       = %q{Provides basic API for KalibroProcessor Collector}
-  spec.description   = %q{This gem defines how KalibroCollector expects his collectors to provide the parsed data so it can persist and process those results}
+  spec.summary       = %q{Kolekti is a code metric results parser framework.}
+  spec.description   = %q{Kolekti is a code metric results parser framework. You can use it whenever you want structured unique output for different metric collectors.}
   spec.homepage      = "https://github.com/mezuro/kolekti"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/kolekti/memory_persistence_strategy.rb

@@ -0,0 +1,42 @@
+module Kolekti
+  class MemoryPersistenceStrategy < Kolekti::PersistenceStrategy
+    attr_reader :tree_metric_results, :hotspot_metric_results, :related_hotspot_metric_results
+
+    def initialize
+      @tree_metric_results = []
+      @hotspot_metric_results = []
+      @related_hotspot_metric_results = []
+    end
+
+    def create_tree_metric_result(metric_configuration, module_name, value, granularity)
+      @tree_metric_results << {
+        metric_configuration: metric_configuration,
+        module_name: module_name,
+        value: value,
+        granularity: granularity
+      }
+    end
+
+    def create_hotspot_metric_result(metric_configuration, module_name, line, message)
+      result = {
+        metric_configuration: metric_configuration,
+        module_name: module_name,
+        line: line,
+        message: message
+      }
+      @hotspot_metric_results << result
+      result
+    end
+
+    def create_related_hotspot_metric_results(metric_configuration, results)
+      related_results = []
+
+      results.each do |result|
+        result = create_hotspot_metric_result(metric_configuration, result['module_name'], result['line'], result['message'])
+        related_results << result
+      end
+
+      related_hotspot_metric_results << related_results
+    end
+  end
+end

data/lib/kolekti/version.rb

@@ -1,3 +1,3 @@
 module Kolekti
-  VERSION = "0.0.1.alpha2"
+  VERSION = "0.0.1"
 end

data/lib/kolekti.rb

@@ -2,6 +2,7 @@ require 'kolekti/version'
 require 'kolekti/collector'
 require 'kolekti/runner'
 require 'kolekti/persistence_strategy'
+require 'kolekti/memory_persistence_strategy'
 require 'kolekti/errors'
 
 module Kolekti

metadata

@@ -1,9 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: kolekti
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha2
+  version: 0.0.1
 platform: ruby
 authors:
+- Daniel Miranda
+- Diego Araújo
+- Eduardo Araújo
 - Rafael Reggiani Manzo
 autorequire: 
 bindir: exe
@@ -136,10 +139,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem defines how KalibroCollector expects his collectors to provide
-  the parsed data so it can persist and process those results
+description: Kolekti is a code metric results parser framework. You can use it whenever
+  you want structured unique output for different metric collectors.
 email:
-- rr.manzo@gmail.com
+- danielkza2@gmail.com
+- diegoamc90@gmail.com
+- duduktamg@hotmail.com
+- rr.manzo@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -160,6 +166,7 @@ files:
 - lib/kolekti.rb
 - lib/kolekti/collector.rb
 - lib/kolekti/errors.rb
+- lib/kolekti/memory_persistence_strategy.rb
 - lib/kolekti/persistence_strategy.rb
 - lib/kolekti/runner.rb
 - lib/kolekti/version.rb
@@ -178,13 +185,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Provides basic API for KalibroProcessor Collector
+summary: Kolekti is a code metric results parser framework.
 test_files: []