advisor 0.1.0 → 0.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dce5c0242a387f50ef334a97a2583cade06759e3
-  data.tar.gz: 3eccbc9c38091e8ab6eafd8f4a64f5fa2ecb07e7
+  metadata.gz: cc4b02e3e1fcc423abfbce5f70d121ac973ec5f4
+  data.tar.gz: b9f60ba8b0437012e6334eef615fa158a457f293
 SHA512:
-  metadata.gz: 3d749fa9ae030a74fa61ee73b3a96cf739f48c0233ba110575453150d3adb73030a4522fb61d80bc1f1a00b189b6b0cc949f2d5e3120448767c9e9cf84311cc0
-  data.tar.gz: 4427ed176fb927dda723ff41fdbc84ad07107dc02f5b255e6363177abd0f6fc207bf435b6591f68799d9ffb59d4c2f15e646a6a0d51845e1dcb4785dcad34958
+  metadata.gz: 7cf7cf08b21ec53349f10453f3be8653a8ec2c2e0cd2f03f7d014fa487410a52d882688e1a91eec2399be061baad8df5083e6fba3600371c44a209d9c35b8f11
+  data.tar.gz: a3fa5127caf63ac8259a74c45b6b3757e07a9998690e0ebb0688c0d47a6b0857405d0fade6e9f841f8a9c24e0f5f57c3264097d0a97501a8a490d8f50ab85c5d

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - '2.0.0'
+  - '2.1.0'
+  - '2.1.5'
+  - '2.2'
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    advisor (0.1.0)
+    advisor (0.2.0)
+      metriks
 
 GEM
   remote: https://rubygems.org/
@@ -9,9 +10,17 @@ GEM
     ast (2.0.0)
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
+    atomic (1.1.99)
+    avl_tree (1.2.1)
+      atomic (~> 1.1)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    hitimes (1.2.2)
     method_source (0.8.2)
+    metriks (0.9.9.7)
+      atomic (~> 1.0)
+      avl_tree (~> 1.2.0)
+      hitimes (~> 1.1)
     parser (2.2.0.3)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.0)

data/Readme.org

@@ -1,5 +1,7 @@
 * Advisor: Solve your cross-cutting concerns without mumbo-jumbo.
 
+  [[https://travis-ci.org/rranelli/advisor.svg?branch=master][https://travis-ci.org/rranelli/advisor.svg]]
+
   =Advisor= is Ruby gem that enables you to solve cross-cutting concerns without
   the usual =method-renaming= present in most alternatives.
 

data/advisor.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'metriks'
+
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/advisor/advices/metriks.rb

@@ -0,0 +1,97 @@
+require 'logger'
+require 'metriks'
+
+module Advisor
+  module Advices
+    class Metriks
+      class << self
+        attr_accessor :default_logger
+      end
+      self.default_logger = Logger.new(STDOUT)
+
+      def initialize(object, method, _call_args, **opts)
+        @object = object
+        @method = method
+
+        @instruments = Array(opts.fetch(:with)).uniq
+        @logger = opts[:logger] || Metriks.default_logger
+
+        fail 'No instruments defined' if instruments.empty?
+        fail 'Unknown Instrument' unless instruments.all?(&known_instrument?)
+      end
+
+      attr_reader :object, :method, :logger, :instruments
+
+      INSTRUMENTS = [
+        :counter, :timer, :gauge, :call_meter, :result_meter
+      ]
+
+      def self.applier_method
+        :measure
+      end
+
+      def call
+        (timed? ? timed_call { yield } : yield)
+          .tap { |result| instruments.each(&measure(result)) }
+      rescue => e
+        logger.warn(e)
+        raise
+      end
+
+      private
+
+      def timed_call
+        timer.time
+        yield.tap do
+          timer.stop
+        end
+      end
+
+      def measure(result)
+        # How I wish I had currying...
+        lambda do |instrument|
+          is_numeric = result.is_a?(Fixnum)
+
+          case instrument
+          when :counter      then counter.increment
+          when :call_meter   then call_meter.mark
+          when :result_meter then is_numeric && result_meter.mark(result)
+          when :gauge        then is_numeric && gauge.set(result)
+          end
+        end
+      end
+
+      def timed?
+        instruments.include?(:timer)
+      end
+
+      def metric_prefix
+        "#{object.class}##{method}"
+      end
+
+      def timer
+        ::Metriks.timer("#{metric_prefix}_#{__callee__}")
+      end
+
+      def counter
+        ::Metriks.counter("#{metric_prefix}_#{__callee__}")
+      end
+
+      def gauge
+        ::Metriks.gauge("#{metric_prefix}_#{__callee__}")
+      end
+
+      def call_meter
+        ::Metriks.meter("#{metric_prefix}_#{__callee__}")
+      end
+
+      def result_meter
+        ::Metriks.meter("#{metric_prefix}_#{__callee__}")
+      end
+
+      def known_instrument?
+        -> (instrument) { INSTRUMENTS.include?(instrument) }
+      end
+    end
+  end
+end

data/lib/advisor/advices.rb

@@ -1 +1,2 @@
 require_relative 'advices/call_logger'
+require_relative 'advices/metriks'

data/lib/advisor/builtin_advisors.rb

@@ -2,4 +2,5 @@ require 'logger'
 
 module Advisor
   Loggable = Factory.new(Advices::CallLogger).build
+  Measurable = Factory.new(Advices::Metriks).build
 end

data/lib/advisor/factory.rb

@@ -4,6 +4,10 @@ module Advisor
       @advice_klass = advice_klass
     end
 
+    def self.build(advice_klass)
+      new(advice_klass).build
+    end
+
     def build
       advice_klazz = advice_klass
       advisor_module = method(:advisor_module)

data/lib/advisor/version.rb

@@ -1,3 +1,3 @@
 module Advisor
-  VERSION = '0.1.0'
+  VERSION = '0.2.0.pre'
 end

data/spec/advisor/advices/call_logger_spec.rb

@@ -12,7 +12,7 @@ module Advisor
       let(:args) { ['the universe', 'and everything'] }
       let(:logger) { instance_double(Logger) }
 
-      let(:block) { -> () { :bla } }
+      let(:block) { -> { :bla } }
 
       describe '#call' do
         subject(:call) { advice.call(&block) }

data/spec/advisor/advices/metriks_spec.rb

@@ -0,0 +1,178 @@
+require 'ostruct'
+
+module Advisor
+  module Advices
+    describe Metriks do
+      subject(:advice) do
+        described_class.new(
+          object,
+          method,
+          args,
+          logger: logger,
+          with: instruments
+        )
+      end
+
+      let(:object) { OpenStruct.new(when: '2015-12-18') }
+      let(:method) { 'the_force_awakens' }
+      let(:args) { ['vai ser zika', 'demais'] }
+      let(:logger) { instance_double(Logger, warn: nil) }
+
+      let(:block) { -> { 42 } }
+
+      context 'when no instruments are specified' do
+        let(:instruments) { [] }
+
+        it { expect { call }.to raise_error }
+      end
+
+      describe '.applier_method' do
+        subject { Metriks.applier_method }
+        it { is_expected.to eq(:measure) }
+      end
+
+      describe '#call' do
+        subject(:call) { advice.call(&block) }
+
+        let(:instruments) { %i(counter result_meter call_meter gauge) }
+
+        shared_examples_for 'instruments && measuring' do
+          it('returns the block call value') { is_expected.to eq(42) }
+
+          it 'instantiates a counter with the right metric name' do
+            expect(::Metriks).to receive(:counter)
+              .with('OpenStruct#the_force_awakens_counter')
+              .and_call_original
+
+            subject
+          end
+
+          it 'instantiates gauge with the right metric name' do
+            expect(::Metriks).to receive(:gauge)
+              .with('OpenStruct#the_force_awakens_gauge')
+              .and_call_original
+
+            subject
+          end
+
+          it 'instantiates a method call and a meter with the right metric names' do
+            expect(::Metriks).to receive(:meter)
+              .with('OpenStruct#the_force_awakens_call_meter')
+              .and_call_original
+
+            expect(::Metriks).to receive(:meter)
+              .with('OpenStruct#the_force_awakens_result_meter')
+              .and_call_original
+
+            subject
+          end
+
+          let(:result_meter) { instance_double(::Metriks::Meter) }
+          let(:call_meter) { instance_double(::Metriks::Meter) }
+
+          it 'increments a method call counter' do
+            expect(::Metriks).to receive_message_chain(
+              :counter, :increment
+            )
+
+            subject
+          end
+
+          it 'marks a method call and a block result value meter' do
+            expect(::Metriks).to receive(:meter)
+              .with('OpenStruct#the_force_awakens_result_meter')
+              .and_return(result_meter)
+
+            expect(result_meter).to receive(:mark)
+              .with(42)
+
+            expect(::Metriks).to receive(:meter)
+              .with('OpenStruct#the_force_awakens_call_meter')
+              .and_return(call_meter)
+
+            expect(call_meter).to receive(:mark)
+
+            subject
+          end
+
+          it 'sets the block result value gauge' do
+            expect(::Metriks).to receive_message_chain(
+              :gauge, :set
+            ).with(42)
+
+            subject
+          end
+
+          context 'when the block return value is not numeric' do
+            let(:block) { -> { :war_in_the_stars } }
+
+            it 'does not instantiate a block return value meter' do
+              expect(::Metriks).to receive(:meter)
+                .with('OpenStruct#the_force_awakens_call_meter')
+                .and_return(call_meter)
+              expect(call_meter).to receive(:mark)
+
+              expect(::Metriks).not_to receive(:meter)
+                .with('OpenStruct#the_force_awakens_result_meter')
+
+              subject
+            end
+
+            it 'does not instantiate a block return value gauge' do
+              expect(::Metriks).not_to receive(:gauge)
+
+              subject
+            end
+
+            it 'instantiates a method call meter and marks it' do
+              expect(::Metriks).to receive(:counter)
+                .and_call_original
+
+              subject
+            end
+          end
+        end
+
+        it_behaves_like 'instruments && measuring'
+
+        context 'when using a timer' do
+          let(:instruments) { %i(counter result_meter call_meter gauge timer) }
+
+          let(:timer) { instance_double(::Metriks::Timer) }
+
+          before do
+            allow(::Metriks).to receive(:timer)
+              .and_return(timer)
+
+            allow(timer).to receive(:time)
+            allow(timer).to receive(:stop)
+          end
+
+          it_behaves_like 'instruments && measuring'
+
+          it 'finds the right timer metric' do
+            expect(::Metriks).to receive(:timer)
+              .with('OpenStruct#the_force_awakens_timer')
+
+            call
+          end
+
+          it 'times the method call' do
+            expect(timer).to receive(:time)
+            expect(timer).to receive(:stop)
+
+            call
+          end
+        end
+
+        context 'when there are duplicate instruments' do
+          let(:instruments) do
+            %i(counter result_meter call_meter counter gauge gauge)
+          end
+
+          it_behaves_like 'instruments && measuring'
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: advisor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.pre
 platform: ruby
 authors:
 - Renan Ranelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: metriks
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -99,10 +114,12 @@ files:
 - lib/advisor.rb
 - lib/advisor/advices.rb
 - lib/advisor/advices/call_logger.rb
+- lib/advisor/advices/metriks.rb
 - lib/advisor/builtin_advisors.rb
 - lib/advisor/factory.rb
 - lib/advisor/version.rb
 - spec/advisor/advices/call_logger_spec.rb
+- spec/advisor/advices/metriks_spec.rb
 - spec/advisor/builtin_advisors_spec.rb
 - spec/advisor/factory_spec.rb
 - spec/spec_helper.rb
@@ -121,9 +138,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2