visibility_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a97c69888ffc6c2932d6639d64ad3f01e953b19ab9085dbb7c71870df7f08743
+  data.tar.gz: 4f423b3176100a06932e8ce2cabe5555e150e2f108ab93bf5c53983c0660cb2c
+SHA512:
+  metadata.gz: 5b255d73acaa07d47b2dedaf6b3c0b9d0cf295ab10d846c0d5de42480ddd7b39ddfe9058802499076034500a179128546bfb1f85781637a88b698b8d275abc03
+  data.tar.gz: be0c1ce503a2b47591579779c3ce4a91714ff5c57c6d0dd17958f922ce498d10ebc1389acee02dc009f74147a586f045f9b509265110c7090eabcd4cdfce66d0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.o
+*.bundle
+ext/*/Makefile
+*.so
+Gemfile.lock

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in visibility_monitor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dylan Thacker-Smith
+
+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,69 @@
+# VisibilityMonitor
+
+Provides a way to monitor a module for method visibility changes with MRI ruby.
+
+This might be useful when using Module#method_added to detect method
+definitions where the visibility of the method is also of interest.
+The problem is that the method visibility might be changed immediately
+after the method is defined (e.g. when using `private def` to define
+a private method).
+
+Although the visibility methods (private, protected and public) can
+be overridden in pure ruby code to detect visibility changes,
+calling `super` doesn't change the visibility scope when the visibility
+method is called without arguments (e.g. `private`). This gem works
+around this limitation by overriding these visibility methods in a C
+extension, so they don't interfere with setting the visibility scope.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'visibility_monitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install visibility_monitor
+
+## Usage
+
+```ruby
+class Example
+  extend VisibilityMonitor
+
+  def self.visibility_set(method_name, visibility_symbol)
+    puts "method :#{method_name} has been marked :#{visibility_symbol}"
+  end
+
+  private def example
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` 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/dylanahsmith/visibility_monitor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new("visibility_monitor_c")
+
+Rake::TestTask.new(test: :compile) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "visibility_monitor"
+
+# 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/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/ext/visibility_monitor_c/ext.c

@@ -0,0 +1,51 @@
+#include <ruby.h>
+
+VALUE sym_public, sym_protected, sym_private;
+ID intern_visibility_set;
+
+static VALUE visibility_set(int argc, VALUE *argv, VALUE mod, VALUE visibility_sym) {
+    if (argc > 0) {
+        for (int i = 0; i < argc; i++) {
+            VALUE method_name = argv[i];
+            ID id = rb_check_id(&method_name);
+            if (id) {
+                method_name = rb_id2sym(id);
+            }
+            rb_call_super(1, &method_name);
+            rb_funcall(mod, intern_visibility_set, 2, method_name, visibility_sym);
+        }
+        return mod;
+    } else {
+        return rb_call_super(argc, argv);
+    }
+}
+
+static VALUE monitor_public(int argc, VALUE *argv, VALUE mod) {
+    return visibility_set(argc, argv, mod, sym_public);
+}
+
+static VALUE monitor_protected(int argc, VALUE *argv, VALUE mod) {
+    return visibility_set(argc, argv, mod, sym_protected);
+}
+
+static VALUE monitor_private(int argc, VALUE *argv, VALUE mod) {
+    return visibility_set(argc, argv, mod, sym_private);
+}
+
+static VALUE monitor_set_visibility_placeholder(VALUE mod, VALUE method_name, VALUE visibility_sym) {
+    return Qnil;
+}
+
+void Init_visibility_monitor_c() {
+    VALUE mVisibilityMonitor = rb_define_module("VisibilityMonitor");
+
+    rb_define_method(mVisibilityMonitor, "public", monitor_public, -1);
+    rb_define_method(mVisibilityMonitor, "protected", monitor_protected, -1);
+    rb_define_method(mVisibilityMonitor, "private", monitor_private, -1);
+    rb_define_method(mVisibilityMonitor, "visibility_set", monitor_set_visibility_placeholder, 2);
+
+    sym_public = RB_ID2SYM(rb_intern("public"));
+    sym_protected = RB_ID2SYM(rb_intern("protected"));
+    sym_private = RB_ID2SYM(rb_intern("private"));
+    intern_visibility_set = rb_intern("visibility_set");
+}

data/ext/visibility_monitor_c/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+$CFLAGS << ' -Wall -Werror'
+create_makefile("visibility_monitor_c")

data/lib/visibility_monitor.rb

@@ -0,0 +1,2 @@
+require "visibility_monitor/version"
+require "visibility_monitor_c"

data/lib/visibility_monitor/version.rb

@@ -0,0 +1,3 @@
+module VisibilityMonitor
+  VERSION = "0.1.0"
+end

data/visibility_monitor.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "visibility_monitor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "visibility_monitor"
+  spec.version       = VisibilityMonitor::VERSION
+  spec.authors       = ["Dylan Thacker-Smith"]
+  spec.email         = ["Dylan.Smith@shopify.com"]
+
+  spec.summary       = "Provide a hook into method visibility changes"
+  spec.homepage      = "https://github.com/dylanahsmith/visibility_monitor"
+  spec.license       = "MIT"
+
+  spec.extensions    = ['ext/visibility_monitor_c/extconf.rb']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 1.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: visibility_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Thacker-Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- Dylan.Smith@shopify.com
+executables: []
+extensions:
+- ext/visibility_monitor_c/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/visibility_monitor_c/ext.c
+- ext/visibility_monitor_c/extconf.rb
+- lib/visibility_monitor.rb
+- lib/visibility_monitor/version.rb
+- lib/visibility_monitor/visibility_monitor.bundle
+- lib/visibility_monitor_c.bundle
+- visibility_monitor.gemspec
+homepage: https://github.com/dylanahsmith/visibility_monitor
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Provide a hook into method visibility changes
+test_files: []