github_deprecations 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_deprecations.gemspec
+gemspec
+
+group :debug do
+  gem 'debugger'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jerry Cheung
+
+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,61 @@
+# GithubDeprecations
+
+Create GitHub issues for `ActiveSupport::Deprecation` messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'github_deprecations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_deprecations
+
+## Usage
+
+To catch as many deprecations as possible, require this as early as possible.
+
+```ruby
+require 'github_deprecations'
+
+GithubDeprecations.configure({
+  :login       => 'jch',
+  :oauth_token => 'oauth2token',
+  :repo        => 'org/repo-name',
+
+  :subscribe   => %r{^deprecation},  # optional: string or regex of deprecation types
+  :labels      => ['deprecations']   # optional: labels to apply to created issues
+}).register!
+```
+
+## Development
+
+To run integration tests, you need to specify two environment variables:
+
+* `GH_LOGIN` - your github login
+* `GH_OAUTH_TOKEN` - oauth access token with 'repo,delete_repo' scopes
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+
+## TODO
+
+* better way to test with octokit
+* pluggable background job backends. Would be nice to use Rails Queue API
+* bin/github-access-token prompts for user/pass and returns an access token
+* integrate with haystack
+* smarter search
+* optionally also log the deprecation
+* error handling
+* if issue is already closed, add a comment and re-open it?

data/Rakefile

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

data/github_deprecations.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_deprecations/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "github_deprecations"
+  gem.version       = GithubDeprecations::VERSION
+  gem.authors       = ["Jerry Cheung"]
+  gem.email         = ["jch@whatcodecraves.com"]
+  gem.description   = %q{Create GitHub issues based on ActiveSupport deprecation errors}
+  gem.summary       = %q{Create GitHub issues based on ActiveSupport deprecation errors}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport',   '~> 3'
+  gem.add_dependency 'octokit',         '~> 1.7'
+  gem.add_dependency 'resque',          '~> 1.19'
+  gem.add_dependency 'hashie',          '~> 1'
+
+  gem.add_development_dependency 'mocha',       '~> 0.12'
+  gem.add_development_dependency 'resque-mock', '~> 0.1'
+end

data/lib/github_deprecations/version.rb

@@ -0,0 +1,3 @@
+module GithubDeprecations
+  VERSION = "0.0.1"
+end

data/lib/github_deprecations.rb

@@ -0,0 +1,111 @@
+require "active_support"  # should be lazy anyways
+require "date"
+require "hashie"
+require "github_deprecations/version"
+require "octokit"
+require "resque"
+
+module GithubDeprecations
+  def configure(options = {}, &blk)
+    config = Config.new(options)
+    blk.call(config) if blk
+    config
+  end
+  module_function :configure
+
+  class Config < Hashie::Dash  # add Dash#verify! so that it's not checked on initialization
+    property :login,       :required => true
+    property :oauth_token, :required => true
+    property :repo,        :required => true
+    property :subscribe,   :default => %r{^deprecation}
+    property :labels,      :default => ['deprecations']
+
+    # Register to intercept deprecation warnings.
+    #
+    # For each deprecation, enqueue a background job
+    # to create or update an issue.
+    def register!
+      ActiveSupport::Deprecation.behavior = :notify
+      @subscriber = ActiveSupport::Notifications.subscribe(@subscribe) do |*args|
+        Resque.enqueue Worker, self, args
+      end
+    end
+
+    def reset!
+      ActiveSupport::Notifications.unsubscribe(@subscriber) if @subscriber
+    end
+  end
+
+  class Worker
+    @queue = :deprecations
+
+    def self.perform(options, event_params)
+      new(options).submit_issue!(event_params)
+    end
+
+    def initialize(options)
+      @options = Hashie::Mash.new(options)  # serialization drops mash
+    end
+
+    # Create or update an issue based on deprecation warning.
+    #
+    # if we wanted to be fancy
+    # calculating an edit-distance probably removes a lot of duplicates
+    # test: when title is too long, then what? what about sha-ing the title and prefixing that to the title?
+    def submit_issue!(event_params)
+      # datetime objects are being serialized to string?
+      event_params[1] = DateTime.parse(event_params[1])
+      event_params[2] = DateTime.parse(event_params[2])
+
+      event   = ActiveSupport::Notifications::Event.new(*event_params)
+      payload = Hashie::Mash.new(event.payload)
+      title   = normalize_title(payload[:message])
+      body    = "```\n" + payload[:callstack].join("\n") + "\n```\n" # ghetto markdown-ify
+
+      create_labels
+      match = find_issue(title)
+      res = match ?
+        update_issue(match.number, title, body) :
+        create_issue(title, body)
+    end
+
+    # Create any missing issue labels.
+    def create_labels
+      @options.labels.each do |label|
+        client.add_label(@options.repo, label)
+      end
+    rescue Octokit::UnprocessableEntity => e
+      # assume label already exists and do nothing
+    end
+
+    # Find an existing issue with the same message.
+    #
+    # Returns Hashie::Mash of issue if found, otherwise nil
+    def find_issue(title)
+      issues = client.list_issues(@options.repo, :labels => @options.labels.join(','))
+      issues.detect {|i| i.title == title}
+    end
+
+    def create_issue(title, body)
+      client.create_issue(@options.repo, title, body, :labels => @options.labels)
+    end
+
+    def update_issue(issue_number, title, body)
+      client.update_issue(@options.repo, issue_number, title, body)
+    end
+
+    def client
+      @client ||= Octokit::Client.new({
+        :login       => @options.login,
+        :oauth_token => @options.oauth_token
+      })
+    end
+
+    # Shorten warnings and remove common stuff
+    def normalize_title(warning)
+      warning.
+        gsub(%r{DEPRECATION WARNING: ?}, '').
+        gsub(%r{ *\(called from.*}, '')
+    end
+  end
+end

data/test/github_deprecations_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class GithubDeprecations::WorkerTest < Test::Unit::TestCase
+  def setup
+    @worker = GithubDeprecations::Worker.new({
+      :login       => 'jch',
+      :oauth_token => 'oauth2token',
+      :repo        => 'org/repo-name',
+      :labels      => []
+    })
+    # name, start, ending, transaction_id, payload. see ActiveSupport::Notifications::Event
+    @event = [
+      'deprecation.rails',
+      '2012-07-27 20:33:56 -0700',
+      '2012-07-27 20:34:03 -0700',
+      '13',
+      {
+        :message   => "DEPRECATION WARNING: Ooga Booga. (called from irb_binding at (irb):1)",
+        :callstack => ['stack1', 'stack2']
+      }
+    ]
+  end
+
+  def test_create_issue
+    # name, start, ending, transaction_id, payload
+    @worker.stubs(:find_issue).returns(nil)
+    @worker.expects(:create_issue)
+    @worker.submit_issue!(@event)
+  end
+
+  def test_update_existing_issue
+    issue = stub(:number => '5')
+    @worker.stubs(:find_issue).returns(issue)
+    @worker.expects(:update_issue).with('5', any_parameters, any_parameters)
+    @worker.submit_issue!(@event)
+  end
+
+  def test_title_normalization
+    normalized = @worker.normalize_title("DEPRECATION WARNING: Ooga Booga. (called from irb_binding at (irb):1)")
+    assert_equal "Ooga Booga.", normalized
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+# Access token requires 'repo,delete_repo' scope
+class IntegrationTest < Test::Unit::TestCase
+  if ENV['GH_LOGIN'] && ENV['GH_OAUTH_TOKEN']
+    def setup
+      @test_repo = "github_deprecations_test_#{Time.now.to_i + rand(1000)}"
+      @user_repo = [ENV['GH_LOGIN'], @test_repo].join('/')
+
+      Resque.mock!
+      @app = GithubDeprecations.configure({
+        :login       => ENV['GH_LOGIN'],
+        :oauth_token => ENV['GH_OAUTH_TOKEN'],
+        :repo        => @user_repo
+      })
+      @app.register!
+    end
+
+    def teardown
+      @app.reset!
+    end
+
+    def with_repo(&blk)
+      client.create_repository(@test_repo)
+      blk.call @user_repo
+    ensure
+      client.delete_repository(@user_repo)
+    end
+
+    def client
+      @client ||= Octokit::Client.new({
+        :login       => ENV['GH_LOGIN'],
+        :oauth_token => ENV['GH_OAUTH_TOKEN'],
+      })
+    end
+
+    def test_create
+      with_repo do |repo|
+        ActiveSupport::Deprecation.warn "Roh oh #{Time.now.to_i}"
+        issues = client.list_issues(repo)
+        assert_equal 1, issues.size
+      end
+    end
+
+    def test_update
+      with_repo do |repo|
+        num = Time.now.to_i
+        ActiveSupport::Deprecation.warn "Roh oh #{num}"
+        ActiveSupport::Deprecation.warn "Roh oh #{num}"
+        issues = client.list_issues(repo)
+        assert_equal 1, issues.size
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+
+require 'github_deprecations'
+require 'test/unit'
+require 'mocha'
+require 'resque/mock'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: github_deprecations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jerry Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: resque-mock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Create GitHub issues based on ActiveSupport deprecation errors
+email:
+- jch@whatcodecraves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github_deprecations.gemspec
+- lib/github_deprecations.rb
+- lib/github_deprecations/version.rb
+- test/github_deprecations_test.rb
+- test/integration_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Create GitHub issues based on ActiveSupport deprecation errors
+test_files:
+- test/github_deprecations_test.rb
+- test/integration_test.rb
+- test/test_helper.rb
+has_rdoc: