rss_observer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2a9029cb2676680915fd9536a2d5687f93a7b49f5a26f4e25408169f148645
-  data.tar.gz: c228a4a65ecbb54993a0ad8e549293a92d89d563d6f5eb33dedfa71732966edc
+  metadata.gz: 01b6866b2c0c8f0f076d7d829bd95e6677df5092c49be485ef593294bfb03f3f
+  data.tar.gz: 4eec4fb6c71ad0d12549e3e2f7ae421546300a5a710a72eddba9a15f4c0d8a12
 SHA512:
-  metadata.gz: 12e390587a75867a3d9bf20657fcbdf5bb6c3fd86ed4c91f2688f9f01be0a55d617d700cb43b64732a6f0d28b6c82d444be9c3c5f3bf3bbe1448a835b3b78f22
-  data.tar.gz: bc19e017e7973c6375943fa853dc860baed1ff95058a7a5a9cff4565bda0883490dd8b6e2b3ca30af1a080701827530bb7bb75f48b7a7e1de7696c0cb392219b
+  metadata.gz: e21876c184ce78bee4a43008bb3264e048b1d3ee0756a3e0ae8be70b47ab831014dfb8d2e4778e0212ec67c5919afc0afa377c126cb3965e96da99aa1e1ce869
+  data.tar.gz: 6833c9dd2f384bf7c1ca0d80744c25cd2994e000f9663d8b819de4e8cbbefa3a013eebbac16bbba99efdda536356add11e546ff40985e8551b05761cac6f0afd

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rss_observer (0.1.0)
+    rss_observer (0.2.0)
       get_process_mem (~> 0.2)
 
 GEM

data/README.md

@@ -1,9 +1,10 @@
 # RssObserver
 
-Rails middleware for observing of RSS changes around the request.
+Rails middleware for observing of RSS memory changes around the request. Under the hood, it utilizes [the get_process_mem](https://github.com/schneems/get_process_mem) gem.
 
 [![CircleCI](https://circleci.com/gh/irvingwashington/rss_observer.svg?style=svg)](https://circleci.com/gh/irvingwashington/rss_observer)
 
+
 # Installation
 
 Add the line
@@ -15,11 +16,11 @@ to your Gemfile and run bundle install.
 To use this middleware in a Rails application, modify relevant environment file (or application.rb to log rss in all environments).
 You can use the supplied STDOUT logger and insert the RssObserver middleware after `Rails::Rack::Logger`.
 ```ruby
-require 'rss_observer/logger'
+require 'rss_observer/logger_handler'
 module FooApp
   class Application < Rails::Application
     # ...
-    config.middleware.insert_after Rails::Rack::Logger, RssObserver::Middleware, RssObserver::Logger.new
+    config.middleware.insert_after Rails::Rack::Logger, RssObserver::Middleware, RssObserver::LoggerHandler.new
   end
 end
 ```
@@ -31,8 +32,12 @@ the usage log with actual request logs.
 ```ruby
 # lib/rails_logger_handler.rb
 class RailsLoggerHandler
-  def call(kilobytes)
-    Rails.logger.info "RSS change: #{kilobytes} KB"
+  def initial_memory(kilobytes)
+    Thread.current[:_initial_memory] = kilobytes
+  end
+
+  def final_memory(kilobytes)
+    Rails.logger.info "Memory change: #{final_memory - Thread.current[:_initial_memory]} KB"
   end
 end
 
@@ -53,4 +58,4 @@ RssObserver vs Default Rails request logs
 ```
 I, [2019-09-03T14:56:22.735264 #7290]  INFO -- : [96956f1a-7f7f-4836-a8a1-bc3c05696433] Completed 200 OK in 47ms (Views: 29.7ms | ActiveRecord: 6.3ms | Allocations: 18614)
 I, [2019-09-03T14:56:22.737113 #7290]  INFO -- : [96956f1a-7f7f-4836-a8a1-bc3c05696433] Memory change: 264.0 KB
-```
+```

data/lib/rss_observer.rb

@@ -3,6 +3,13 @@
 # Top level namespace of the Gem
 module RssObserver
   Error = Class.new(StandardError)
+
+  def self.current_memory
+    @mem ||= GetProcessMem.new
+    @mem.kb
+  rescue StandardError
+    nil
+  end
 end
 
 require 'rss_observer/version'

data/lib/rss_observer/logger_handler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RssObserver
+  # Basic handler, outputting the memory change information to standard output
+  class LoggerHandler
+    KEY = :_rss_observer_initial_memory
+
+    # @param logger [Logger]
+    def initialize(logger = Logger.new(STDOUT))
+      @logger = logger
+    end
+
+    # @param kilobytes [Float]
+    def initial_memory(kilobytes)
+      Thread.current[KEY] = kilobytes
+    end
+
+    # @param kilobytes [Float]
+    def final_memory(kilobytes)
+      initial_memory = Thread.current[KEY]
+      return unless initial_memory
+
+      change = kilobytes - initial_memory
+      initial_memory(nil)
+      logger.info "Memory change: #{change} KB"
+    end
+
+    private
+
+    attr_reader :logger
+  end
+end

data/lib/rss_observer/middleware.rb

@@ -11,8 +11,11 @@ module RssObserver
     # @param handler [Object] Handler that accepts memory change updates
     def initialize(app, handler)
       @app = app
-      unless handler.respond_to?(:call)
-        raise UnsupportedHandlerError, 'Handler must respond to the #call(kilobytes) method'
+      unless handler.respond_to?(:initial_memory)
+        raise UnsupportedHandlerError, 'Handler must respond to the #initial_memory(kilobytes) method'
+      end
+      unless handler.respond_to?(:final_memory)
+        raise UnsupportedHandlerError, 'Handler must respond to the #final_memory(kilobytes) method'
       end
 
       @handler = handler
@@ -21,11 +24,9 @@ module RssObserver
     # @param env [Hash] Full application environment hash
     # @return [Array] Status code, hash of headers, response body
     def call(env)
-      before_memory = current_memory
-
+      handler.initial_memory(current_memory)
       app.call(env).tap do
-        memory_change = current_memory - before_memory
-        handler.call(memory_change)
+        handler.final_memory(current_memory)
       end
     end
 
@@ -34,8 +35,7 @@ module RssObserver
     attr_reader :app, :handler
 
     def current_memory
-      @mem ||= GetProcessMem.new
-      @mem.kb
+      RssObserver.current_memory
     end
   end
 end

data/lib/rss_observer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RssObserver
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/rss_observer.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.circleci|bin)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rss_observer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maciek Dubiński
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -101,22 +101,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/rubocop.sh
-- bin/setup
 - lib/rss_observer.rb
-- lib/rss_observer/logger.rb
+- lib/rss_observer/logger_handler.rb
 - lib/rss_observer/middleware.rb
 - lib/rss_observer/version.rb
 - rss_observer.gemspec

data/.circleci/config.yml

@@ -1,61 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-version: 2
-jobs:
-  build:
-    docker:
-      # specify the version you desire here
-      - image: circleci/ruby:2.4.1-node-browsers
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
-              circleci tests split --split-by=timings)"
-
-            bundle exec rspec \
-              --format progress \
-              --format RspecJunitFormatter \
-              --out /tmp/test-results/rspec.xml \
-              --format progress \
-              $TEST_FILES
-      - run:
-          name: run rubocop
-          command: bash bin/rubocop.sh
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.2

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rss_observer'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/rubocop.sh

@@ -1,41 +0,0 @@
-#!/usr/bin/env bash
-
-# Inspired by http://takemikami.com/2018/01/30/RubocopPullRequestCI.html
-
-BASE_REMOTE=origin
-BASE_BRANCH=master
-
-git fetch $BASE_REMOTE $BASE_BRANCH
-
-diff_list=()
-commit_list=`git --no-pager log --no-merges $BASE_REMOTE/$BASE_BRANCH...HEAD | grep -e '^commit' | sed -e "s/^commit \(.\{8\}\).*/\1/"`
-
-for f in `git --no-pager diff $BASE_REMOTE/$BASE_BRANCH...HEAD --name-only`; do
-  for c in $commit_list; do
-    diffs=`git --no-pager blame --follow --show-name -s $f | grep $c | sed -e "s/^[^ ]* *\([^ ]*\) *\([0-9]*\)*).*$/\1:\2/"`
-    for ln in $diffs; do
-      diff_list+=("$ln")
-    done
-  done
-done
-
-err_count=0
-err_lines=()
-
-while read line; do
-  for m in ${diff_list[@]}; do
-    if [[ "$line" =~ "$m" ]]; then
-      err_count=$(($err_count + 1))
-      err_lines+=("$line")
-      break
-    fi
-  done
-done < <(bundle exec rubocop --format emacs)
-
-if [ $err_count -ne 0 ]; then
-  echo -e "\033[31m$err_count Lint Errors\033[0;39m"
-  echo -e "\033[31m-----------------------------------\033[0;39m\n"
-  printf '\033[31m%s\n' "${err_lines[@]}"
-  echo -e "\033[31mPlease resolve them before merging.\033[0;39m"
-  exit 1
-fi

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/rss_observer/logger.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module RssObserver
-  # Basic handler, outputting the memory change information to standard output
-  class Logger
-    # @param logger [Logger]
-    def initialize(logger = Logger.new(STDOUT))
-      @logger = logger
-    end
-
-    # @param kilobytes [Float]
-    def call(kilobytes)
-      logger.info "Memory change: #{kilobytes} KB"
-    end
-
-    private
-
-    attr_reader :logger
-  end
-end