quick_mem 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7565407689659edeb05b71cb00b50be51f9c618a
+  data.tar.gz: f22618bf4aa69405e9815161034e467d306a73cb
+SHA512:
+  metadata.gz: 066525a7fa05e68c01216377908442be8f0cf6f20cecf2f0d2a6e6f0e06caeb893662a4b1485dca38af80a38d808fe964b98aa087e433711ebb17083250c6fb5
+  data.tar.gz: bc53aec114d2ea8d0ec65cd3dcc24ba92a938759bcbede18f410259a3320ccf6c4ac897590fd348ff1b9ebe6411d92ddf33c62348b73f8df04987d62a74685e2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+quick_mem.sublime-workspace

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby_version

@@ -0,0 +1 @@
+2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quick_mem.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rajiv Nair
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# QuickMem
+
+A simple gem to dump memory stats. Primarily written to tick off the "I wrote a gem" box.
+I'll probably improve it to be some kind of analyzer/profiler if time permits.
+Suggestions welcome!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quick_mem'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quick_mem
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/rajivrnair/quick_mem/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Useful Reading
+http://www.atdot.net/~ko1/activities/rubyconf2013-ko1_pub.pdf
+http://www.omniref.com/blog/blog/2014/03/27/ruby-garbage-collection-still-not-ready-for-production/
+http://samsaffron.com/archive/2014/04/08/ruby-2-1-garbage-collection-ready-for-production
+http://samsaffron.com/archive/2013/11/22/demystifying-the-ruby-gc
+http://thorstenball.com/blog/2014/03/12/watching-understanding-ruby-2.1-garbage-collector/
+http://www.rubyenterpriseedition.com/documentation.html#_garbage_collector_performance_tuning
+http://stackoverflow.com/questions/16850551/ruby-gcprofiler-use-size-is-greater-than-total-size
+https://github.com/ko1/gc_tracer/
+
+https://quickleft.com/blog/engineering-lunch-series-step-by-step-guide-to-building-your-first-ruby-gem/
+http://www.smashingmagazine.com/2014/04/08/how-to-build-a-ruby-gem-with-bundler-test-driven-development-travis-ci-and-coveralls-oh-my/
+http://recipes.sinatrarb.com/p/development/bundler

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task :default => :spec

data/lib/quick_mem/gc_constants.rb

@@ -0,0 +1,13 @@
+module QuickMem
+  class GCConstants
+
+    def self.slot_size
+      @@rvalue_size ||= GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
+    end
+
+    def self.slots_per_page
+      @@heap_obj_limit ||= GC::INTERNAL_CONSTANTS[:HEAP_OBJ_LIMIT]
+    end
+
+  end
+end

data/lib/quick_mem/quick_mem.rb

@@ -0,0 +1,41 @@
+require 'quick_mem/version'
+require 'quick_mem/gc_constants'
+
+module QuickMem
+  class QuickMemory
+
+    def self.version
+      QuickMem::VERSION
+    end
+
+    def self.show_config
+      gc_stat = GC.stat
+      config = Hash.new
+      gc_counts(config, gc_stat)
+      heap_statistics(config, gc_stat)
+      config
+    end
+
+    private
+
+    def self.heap_statistics(config, gc_stat)
+      config[:heap_allocated] = gc_stat[:heap_length] * slot_size * slots_per_page
+      config[:heap_used] = gc_stat[:heap_eden_page_length] * slot_size * slots_per_page
+    end
+
+    def self.gc_counts(config, gc_stat)
+      config[:major_gc_count] = gc_stat[:major_gc_count]
+      config[:minor_gc_count] = gc_stat[:minor_gc_count]
+      config[:total_gc_count] = gc_stat[:count]
+    end
+
+    def self.slot_size
+      QuickMem::GCConstants.slot_size
+    end
+
+    def self.slots_per_page
+      QuickMem::GCConstants.slots_per_page
+    end
+
+  end
+end

data/lib/quick_mem/version.rb

@@ -0,0 +1,3 @@
+module QuickMem
+  VERSION = '0.0.1'
+end

data/quick_mem.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quick_mem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quick_mem"
+  spec.version       = QuickMem::VERSION
+  spec.authors       = ["Rajiv Nair"]
+  spec.email         = ["rajivrnair@gmail.com"]
+  spec.summary       = %q{Quickly look at GC stats}
+  spec.description   = %q{A simple gem to dump memory stats}
+  spec.homepage      = "https://github.com/rajivrnair/quick_mem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~>3.1.0'
+end
+
+# group :test do
+#   gem 'rspec', '3.1.0'
+#   gem 'json_spec', '1.1.2'
+#   gem 'shoulda-matchers', '2.6.1'
+#   gem 'webmock', '1.17.4'
+#   gem 'rubocop', '0.19.1', require: false
+#   gem 'timecop', '0.7.1'
+#   gem 'capybara', '2.3.0'
+#   gem 'cane', '2.6.1'
+#   gem 'reek', '1.3.6'
+#   gem 'flay', '2.4.0'
+#   gem 'flog', '4.2.0'
+#   gem 'simplecov', '~> 0.7.1'
+#   gem 'rack-test', '0.6.2', require: 'rack/test'
+#   gem 'faker', '1.3.0'
+# end

data/quick_mem.sublime-project

@@ -0,0 +1,15 @@
+{
+  "folders":
+  [
+    {
+      "name": "Quick Mem",
+      "path": ".",
+      "folder_exclude_patterns": [ "coverage", "log", "pkg", "tmp", ".bundle", "vendor", "bin" ]
+    }
+  ],
+  "settings":
+  {
+    "tab_size": 2,
+    "translate_tabs_to_spaces": true
+  }
+}

data/quick_mem.txt

@@ -0,0 +1,29 @@
+Total Heap size/ Heap size used / % used / % free
+Total number of objects
+Total Allocated slots / slots used
+
+RUBY_GC_MALLOC_LIMIT
+RUBY_GC_HEAP_INIT_SLOTS
+RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR
+RUBY_HEAP_MIN_SLOTS
+RUBY_HEAP_SLOTS_INCREMENT
+RUBY_HEAP_SLOTS_GROWTH_FACTOR
+RUBY_HEAP_FREE_MIN
+
+
+GC.allocated_size
+GC.num_allocations
+
+ObjectSpace.live_objects
+ObjectSpace.allocated_objects
+
+slot_size: GC::INTERNAL_CONSTANTS[:RVALUE_SIZE]
+slots_per_page: GC::INTERNAL_CONSTANTS[:HEAP_OBJ_LIMIT]
+
+GC.stat[:heap_length] - total pages allocated.
+GC.stat[:heap_used] - total pages used.
+GC.stat[:heap_increment]
+
+allocated_memory: heap_length * slots_per_page * slot_size
+used_memory: heap_eden_page_length * slots_per_page * slot_size
+live_objects: heap_live_slot

data/spec/quick_mem/quick_mem_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+require 'quick_mem/quick_mem'
+
+module QuickMem
+  describe QuickMemory do
+
+    describe '#version' do
+    subject { QuickMemory.version }
+
+      it 'outputs the correct version number' do
+        expect(subject).to eq '0.0.1'
+      end
+    end
+
+    describe '#show_config' do
+      subject { QuickMemory.show_config }
+      let(:mem_options) {
+        {
+          count: 22,
+          heap_eden_page_length: 226,
+          heap_final_slot: 0,
+          heap_free_slot: 829,
+          heap_increment: 0,
+          heap_length: 237,
+          heap_live_slot: 91292,
+          heap_swept_slot: 22651,
+          heap_tomb_page_length: 0,
+          heap_used: 226,
+          major_gc_count: 4,
+          malloc_increase: 545344,
+          malloc_limit: 16777216,
+          minor_gc_count: 18,
+          old_object: 54719,
+          old_object_limit: 56776,
+          oldmalloc_increase: 6406440,
+          oldmalloc_limit: 16777216,
+          remembered_shady_object: 811,
+          remembered_shady_object_limit: 758,
+          total_allocated_object: 524356,
+          total_freed_object: 433064
+        }
+      }
+
+      before do
+        # assuming default values for
+        # GC::INTERNAL_CONSTANTS[:RVALUE_SIZE] = 40
+        # GC::INTERNAL_CONSTANTS[:HEAP_OBJ_LIMIT] = 408
+
+        allow(GC).to receive(:stat) { mem_options }
+      end
+
+      it 'spits out the number of major GCs' do
+        expect(subject[:major_gc_count]).to eq(4)
+      end
+
+      it 'spits out the number of minor GCs' do
+        expect(subject[:minor_gc_count]).to eq(18)
+      end
+
+      it 'spits out the total number of GCs' do
+        expect(subject[:total_gc_count]).to eq(22)
+      end
+
+      it 'spits out the total heap allocated in bytes' do
+        expect(subject[:heap_allocated]).to eq(3867840)
+      end
+
+      it 'spits out the heap used in bytes' do
+        expect(subject[:heap_used]).to eq(3688320)
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+Bundler.require :default, :test

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: quick_mem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rajiv Nair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: A simple gem to dump memory stats
+email:
+- rajivrnair@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby_version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quick_mem/gc_constants.rb
+- lib/quick_mem/quick_mem.rb
+- lib/quick_mem/version.rb
+- quick_mem.gemspec
+- quick_mem.sublime-project
+- quick_mem.txt
+- spec/quick_mem/quick_mem_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/rajivrnair/quick_mem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Quickly look at GC stats
+test_files:
+- spec/quick_mem/quick_mem_spec.rb
+- spec/spec_helper.rb