forewarn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aabd513081492a7b1da1723b00b2815b184a1a4f
+  data.tar.gz: 839cc7260ff5aed0312e8369109bed058053461e
+SHA512:
+  metadata.gz: 9c71014c1163c1f5dbb789af78ec060c71b8ecc43536b4c6780bf9d5a8d4b6703ee84eca08342aae04746c0f4354c434544fc9bdb53dc3d980361ae7e1803481
+  data.tar.gz: b641a3c64d217cd8961927e8072f88cf20256d8199c52c8cb5e8fe0554c772ee8cc02f67bf818e750314d0e5701485c9d1f2d7a353a7a00fa13fe1232046809d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in forewarn.gemspec
+gemspec
+
+gem 'gimme'
+gem 'pry'

data/README.md

@@ -0,0 +1,39 @@
+# Forewarn
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/forewarn`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'forewarn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forewarn
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/forewarn/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

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/test_*.rb"
+end
+
+task :default => [:test]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "forewarn"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/forewarn.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forewarn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forewarn"
+  spec.version       = Forewarn::VERSION
+  spec.authors       = ["Justin Searls"]
+  spec.email         = ["searls@gmail.com"]
+
+  spec.summary       = %q{log deprecated or unsafe method invocations}
+  spec.description   = %q{allows users to write and configure their own method blacklists to warn of dangerous invocations (e.g. deprecated methods, unsafe methods after an impending upgrade, etc.)}
+  spec.homepage      = "https://github.com/testdouble/forewarn"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/forewarn.rb

@@ -0,0 +1,12 @@
+require "forewarn/version"
+
+require "forewarn/config"
+require "forewarn/reporters"
+require "forewarn/values"
+require "forewarn/sets_up_warnings"
+
+module Forewarn
+  def self.start!
+    SetsUpWarnings.new.set_up!
+  end
+end

data/lib/forewarn/builds_method_values.rb

@@ -0,0 +1,11 @@
+require "forewarn/values/method"
+
+module Forewarn
+  class BuildsMethodValues
+    def build(warner)
+      warner.methods.map do |method_object|
+        Values::Method.new(warner, method_object)
+      end
+    end
+  end
+end

data/lib/forewarn/config.rb

@@ -0,0 +1,20 @@
+require "forewarn/reporters/json"
+require "forewarn/warners/string_mutation"
+
+module Forewarn
+  DEFAULT_CONFIG = {
+    :enabled => true,
+    :logger => Kernel.method(:warn),
+# TODO: implement a JSON reporter
+#    :reporter => Forewarn::Reporters::Json,
+#    :report_destination => "log/usage_warning.json",
+    :warners => [Forewarn::Warners::StringMutation]
+  }.freeze
+
+  @__config = DEFAULT_CONFIG.dup
+
+  def self.config(overrides = {})
+    @__config.merge!(overrides)
+  end
+end
+

data/lib/forewarn/overrides_methods.rb

@@ -0,0 +1,16 @@
+require "forewarn/triggers_warning"
+
+module Forewarn
+  class OverridesMethods
+    def override!(methods)
+      triggers_warning = TriggersWarning.new
+      methods.each do |method|
+        real_method = method.method
+        real_method.owner.send(:define_method, real_method.name) do |*args, &blk|
+          triggers_warning.trigger!(method, caller_locations(1,1)[0].to_s)
+          method.bind(self).call(*args, &blk)
+        end
+      end
+    end
+  end
+end

data/lib/forewarn/remembers_wrapped_methods.rb

@@ -0,0 +1,8 @@
+module Forewarn
+  class RemembersWrappedMethods
+    def remember!(methods)
+      # TODO: remember which methods were wrapped so we can implement stop!
+    end
+  end
+end
+

data/lib/forewarn/reporters.rb

@@ -0,0 +1 @@
+require "forewarn/reporters/json"

data/lib/forewarn/reporters/json.rb

@@ -0,0 +1,6 @@
+module Forewarn
+  module Reporters
+    class Json
+    end
+  end
+end

data/lib/forewarn/sets_up_warnings.rb

@@ -0,0 +1,21 @@
+require "forewarn/builds_method_values"
+require "forewarn/remembers_wrapped_methods"
+require "forewarn/overrides_methods"
+
+module Forewarn
+  class SetsUpWarnings
+    def initialize
+      @builds_method_values = BuildsMethodValues.new
+      @remembers_wrapped_methods = RemembersWrappedMethods.new
+      @overrides_methods = OverridesMethods.new
+    end
+
+    def set_up!
+      methods = Forewarn.config[:warners].map(&:new).map {|w|
+        @builds_method_values.build(w)
+      }.flatten
+      @overrides_methods.override!(methods)
+      @remembers_wrapped_methods.remember!(methods)
+    end
+  end
+end

data/lib/forewarn/triggers_warning.rb

@@ -0,0 +1,22 @@
+module Forewarn
+  class TriggersWarning
+    def trigger!(method, kaller)
+      return if backtrace_includes_ourself?
+      Forewarn.config[:logger].call(build_warning(method, kaller))
+    end
+
+  private
+
+    # Need to bail out to prevent infinite recursion… Woo!
+    def backtrace_includes_ourself?
+      caller_locations.select { |location|
+        location.to_s.include?(File.join(%w{forewarn lib forewarn triggers_warning}))
+      }.size > 1
+    end
+
+    def build_warning(method, kaller)
+      "WARN: #{method.warner.message} '#{method.name}' was invoked! (Called from: \"#{kaller}\")"
+    end
+  end
+end
+

data/lib/forewarn/values.rb

@@ -0,0 +1 @@
+require "forewarn/values/method"

data/lib/forewarn/values/method.rb

@@ -0,0 +1,30 @@
+module Forewarn
+  module Values
+    class Method
+      attr_reader :warner, :method
+
+      def initialize(warner = nil, method = nil)
+        @warner = warner
+        @method = method
+      end
+
+      def instance_method?
+        !@method.owner.singleton_class?
+      end
+
+      def name
+        @method.to_s[/:\s*(.*)>/, 1]
+      end
+
+      def bind(new_owner)
+        if @method.respond_to?(:unbind)
+          @method.unbind.bind(new_owner)
+        else
+          @method.bind(new_owner)
+        end
+      end
+
+    end
+  end
+end
+

data/lib/forewarn/version.rb

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

data/lib/forewarn/warners.rb

@@ -0,0 +1 @@
+require "forewarn/warners/string_mutation"

data/lib/forewarn/warners/string_mutation.rb

@@ -0,0 +1,27 @@
+module Forewarn
+  module Warners
+    class StringMutation
+      def message
+        "String mutation method"
+      end
+
+      def methods
+        method_names.map { |m| String.instance_method(m) }
+      end
+
+    private
+
+      def method_names
+        String.instance_methods.select { |method_name|
+          method_name.to_s.end_with?('!')
+        } + [
+          :"[]=", :"<<", :clear, :concat, :extend, :insert,
+          :instance_variable_set, :prepend, :replace, :setbyte, :taint
+        ] - [
+          :"!" # <-- lol BasicObject#! is A-okay.
+        ]
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: forewarn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Searls
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: allows users to write and configure their own method blacklists to warn
+  of dangerous invocations (e.g. deprecated methods, unsafe methods after an impending
+  upgrade, etc.)
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- forewarn.gemspec
+- lib/forewarn.rb
+- lib/forewarn/builds_method_values.rb
+- lib/forewarn/config.rb
+- lib/forewarn/overrides_methods.rb
+- lib/forewarn/remembers_wrapped_methods.rb
+- lib/forewarn/reporters.rb
+- lib/forewarn/reporters/json.rb
+- lib/forewarn/sets_up_warnings.rb
+- lib/forewarn/triggers_warning.rb
+- lib/forewarn/values.rb
+- lib/forewarn/values/method.rb
+- lib/forewarn/version.rb
+- lib/forewarn/warners.rb
+- lib/forewarn/warners/string_mutation.rb
+homepage: https://github.com/testdouble/forewarn
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: log deprecated or unsafe method invocations
+test_files: []
+has_rdoc: