Write necessary documentation for essential methods and classes

Make rubocop happy 👮

Author: Envek

.rubocop.yml

@@ -10,6 +10,9 @@ Metrics/BlockLength:
   - "Gemfile"
   - "spec/**/*"
 
+Metrics/LineLength:
+  Max: 120
+
 Style/BracesAroundHashParameters:
   EnforcedStyle: context_dependent
 

.travis.yml

@@ -3,7 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-- 2.5.1
-- 2.4.4
-- 2.3.7
-before_install: gem install bundler -v 1.16.5
+- 2.5.3
+- 2.4.5
+- 2.3.8
+before_install: gem install bundler -v 1.17.0

Rakefile

@@ -2,7 +2,10 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: %i[rubocop spec]

lib/yabeda.rb

@@ -5,22 +5,26 @@
 require "yabeda/version"
 require "yabeda/dsl"
 
+# Extendable framework for collecting and exporting metrics from Ruby apps
 module Yabeda
   include DSL
 
   class << self
+    # @return [Hash<String, Yabeda::Metric>] All registered metrics
     def metrics
       @metrics ||= Concurrent::Hash.new
     end
 
+    # @return [Hash<String, Yabeda::BaseAdapter>] All loaded adapters
     def adapters
       @adapters ||= Concurrent::Hash.new
     end
 
+    # @return [Array<Proc>] All collectors for periodical retrieving of metrics
     def collectors
       @collectors ||= Concurrent::Array.new
     end
- 
+
     # @param [Symbol] name
     # @param [BaseAdapter] instance
     def register_adapter(name, instance)

lib/yabeda/base_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Yabeda
+  # Base class for adapters to particular monitoring systems
   class BaseAdapter
     def register!(metric)
       case metric

lib/yabeda/dsl.rb

@@ -6,33 +6,44 @@
 require "yabeda/histogram"
 
 module Yabeda
+  # DSL for ease of work with Yabeda
   module DSL
     def self.included(base)
       base.extend ClassMethods
     end
 
+    # rubocop: disable Style/Documentation
     module ClassMethods
+      # Block for grouping and simplifying configuration of related metrics
       def configure(&block)
         class_exec(&block)
         @group = nil
       end
 
+      # Define the actions that should be performed
       def collect(&block)
         ::Yabeda.collectors.push(block)
       end
 
+      # Specify metric category or group for all consecutive metrics in this
+      # +configure+ block.
+      # On most adapters it is only adds prefix to the metric name but on some
+      # (like NewRelic) it is treated individually and have special meaning.
       def group(group_name)
         @group = group_name
       end
 
+      # Register a growing-only counter
       def counter(*args, **kwargs)
         register(Counter.new(*args, **kwargs, group: @group))
       end
 
+      # Register a gauge
       def gauge(*args, **kwargs)
         register(Gauge.new(*args, **kwargs, group: @group))
       end
 
+      # Register an histogram
       def histogram(*args, **kwargs)
         register(Histogram.new(*args, **kwargs, group: @group))
       end
@@ -49,5 +60,6 @@ def register(metric)
         metric
       end
     end
+    # rubocop: enable Style/Documentation
   end
 end

lib/yabeda/gauge.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Yabeda
-  # Arbitrary value
+  # Arbitrary value, can be changed in both sides
   class Gauge < Metric
     def set(tags, value)
       values[tags] = value

lib/yabeda/histogram.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Yabeda
+  # Base class for complex metric for measuring time values that allow to
+  # calculate averages, percentiles, and so on.
   class Histogram < Metric
     option :buckets
 

spec/yabeda_spec.rb

@@ -5,9 +5,9 @@
     expect(Yabeda::VERSION).not_to be nil
   end
 
-  it 'exposes the public api' do
-    expect(Yabeda.metrics).to eq({})
-    expect(Yabeda.adapters).to eq({})
-    expect(Yabeda.collectors).to eq([])
+  it "exposes the public api" do
+    expect(described_class.metrics).to eq({})
+    expect(described_class.adapters).to eq({})
+    expect(described_class.collectors).to eq([])
   end
 end