memory-profiler-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74ba682ef47f7e3cf22b21e6846d240019f7cb38
+  data.tar.gz: 9f29f064a715963ab447acfcd9b9fa05437b39b9
+SHA512:
+  metadata.gz: 25b7e978afd5eeba044dde7cb1480e9893a7077039f3257575862456d7ab6aa4fb976b257eec3850e5a04333511e0e22d0835ffbbeaecb1ac1878b3f5e7eb3e5
+  data.tar.gz: dfe30d2e94a273f271f38204cf6a63918a5f450df3cc258aa1c5c179ed975f47d07b2c91375db60bd01331cfc38103fcd036a342da36e15475e33a83d32888af

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hieuk09@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hieu Nguyen
+
+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,53 @@
+# Memory::Profiler
+
+This is a simple implementation based o Ruby native profiler to be able to
+calculate the number of object generated in each piece of code
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memory-profiler-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memory-profiler-rb
+
+## Usage
+
+You can take a look at the code in `examples/` folder
+
+```
+require 'memory/profiler'
+
+Memory::Profiler.start_profiling
+
+# your code here
+
+Memory::Profiler.end_profiling
+
+Memory::Profiler.print_profiling
+```
+
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hieuk09/memory-profiler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "memory/profiler"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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/examples/profiler_1.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/memory/profiler'
+
+Memory::Profiler.start_profiling
+array = 1000.times.map { |i| Object.new }
+Memory::Profiler.end_profiling
+
+Memory::Profiler.print_profiling

data/lib/memory/profiler.rb

@@ -0,0 +1,62 @@
+require_relative "profiler/version"
+
+module Memory
+  module Profiler
+    class Wrapper < Struct.new(:defined_class, :method_id, :hash) # :nodoc:
+      private :defined_class=, :method_id=, :hash=
+
+      def initialize(klass, mid)
+        super(klass, mid, nil)
+        self.hash = Struct.instance_method(:hash).bind(self).call
+      end
+
+      def to_s
+        "#{defined_class.inspect}#".sub(/\A\#<Class:(.*)>#\z/, '\1.') << method_id.to_s
+      end
+      alias inspect to_s
+    end
+
+    @@stack = nil
+    @@record = nil
+
+    PROFILE_CALL_PROC = TracePoint.new(:call, :c_call, :b_call) do |tp|
+      data = ObjectSpace.count_objects
+      @@stack.push(data)
+    end
+
+    PROFILE_RETURN_PROC = TracePoint.new(:return, :c_return, :b_return) do |tp|
+      previous_data = @@stack.pop
+
+      if previous_data
+        data = ObjectSpace.count_objects
+        key = Wrapper.new(tp.defined_class, tp.method_id)
+        @@record[key] ||= [
+          0, # number of object this method use
+          0, # number of time this method is called
+        ]
+        @@record[key][0] += data[:T_OBJECT] - previous_data[:T_OBJECT]
+        @@record[key][1] += 1
+      end
+    end
+
+  module_function
+
+    def start_profiling
+      @@stack = []
+      @@record = {}
+      PROFILE_CALL_PROC.enable
+      PROFILE_RETURN_PROC.enable
+    end
+
+    def end_profiling
+      PROFILE_CALL_PROC.disable
+      PROFILE_RETURN_PROC.disable
+    end
+
+    def print_profiling
+      @@record.each do |key, value|
+        puts "#{key} #{value}"
+      end
+    end
+  end
+end

data/lib/memory/profiler/version.rb

@@ -0,0 +1,5 @@
+module Memory
+  module Profiler
+    VERSION = "0.0.1"
+  end
+end

data/memory-profiler.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memory/profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memory-profiler-rb"
+  spec.version       = Memory::Profiler::VERSION
+  spec.authors       = ["Hieu Nguyen"]
+  spec.email         = ["hieuk09@gmail.com"]
+
+  spec.summary       = "A simple ruby memory profiler"
+  spec.description   = "A gem based on ruby native profiler, which helps check memory consumption of one piece of code"
+  spec.homepage      = "https://github.com/hieuk09/memory-profiler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: memory-profiler-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hieu Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem based on ruby native profiler, which helps check memory consumption
+  of one piece of code
+email:
+- hieuk09@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/profiler_1.rb
+- lib/memory/profiler.rb
+- lib/memory/profiler/version.rb
+- memory-profiler.gemspec
+homepage: https://github.com/hieuk09/memory-profiler
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple ruby memory profiler
+test_files: []