tombstone 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4a3886077bcac3593ddafe0e78496ea2db0252d
+  data.tar.gz: e4d595417748732960587423c392424a97cb0e65
+SHA512:
+  metadata.gz: 7bbc2ea1ef642701e33af3bebc77a58a2b40b89b9cce89ff9dde31b0bc28903d2fb1c0dd411873211e71db8369dabb3e862ee8acb57d0a75cdf92355f82091f0
+  data.tar.gz: 8b7b82260e6f91988eb5f6358215c823cdb2214c2e36e7729ca2d5fdd79d0bc4f48fa19802c50cceae6ab3914c8034f4662f33d6dd3eeee0aa93e59ccc949577

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lewis Buckley
+
+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,55 @@
+# Tombstone Introduction
+
+Inspired by David Schnepper's Ignite talk **"Isn't That Code Dead?" - Velocity Santa Clara 2014**
+
+<a href="http://www.youtube.com/watch?feature=player_embedded&v=29UXzfQWOhQ
+" target="_blank"><img src="http://img.youtube.com/vi/29UXzfQWOhQ/0.jpg" 
+alt="Tombstone Youtube Video" width="240" height="180" border="10" /></a>
+
+## Requirements
+
+Ruby 2.0 or above
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tombstone', github: 'lewispb/tombstone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tombstone
+
+## Usage
+
+Not sure if some code is safe to remove? Tombstone it.
+
+Place a Tombstone in your code as follows:
+
+    Tombstone.place('YOUR_LABEL')
+
+You can use todays date as a label, to remind yourself of when you placed the Tombstone. When a Tombstone is encountered it will output to your rails development log like so:
+
+    Tombstone: 2014-11-01 - index - /Users/lewispb/projects/railsapp/app/controllers/welcome_controller.rb Line #: 5
+
+You can use the following command to search your development log for Tombstones. From the root of your rails app run:
+
+    bundle exec tombstone
+
+## Contributing
+
+All contributions very welcome
+
+### Todo
+- Test with non Rails apps
+- Write some tests
+
+1. Fork it ( https://github.com/[my-github-username]/tombstone/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,2 @@
+require "bundler/gem_tasks"
+

data/bin/tombstone

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tombstone'
+
+system('cat log/development.log | grep Tombstone: ')

data/lib/tombstone.rb

@@ -0,0 +1,19 @@
+require "tombstone/version"
+require 'tombstone/railtie' if defined?(Rails)
+
+module Tombstone
+
+  def self.logger
+    @logger ||= Logger.new(STDERR)
+  end
+
+  def place(date_string = '')
+    backtrace = caller_locations(1,1)[0]
+    message = "Tombstone: #{date_string} - #{backtrace.label} - #{backtrace.absolute_path} Line #: #{backtrace.lineno}"
+    logger.warn message
+    # Outputs the above message to the console, colored red
+    puts "\e[31m#{message}\e[0m"
+  end
+  module_function :place
+
+end

data/lib/tombstone/railtie.rb

@@ -0,0 +1,9 @@
+module Tombstone
+
+  class Railties < ::Rails::Railtie
+    initializer 'Rails logger' do |app|
+      @logger = Rails.logger
+    end
+  end
+
+end

data/lib/tombstone/version.rb

@@ -0,0 +1,3 @@
+module Tombstone
+  VERSION = "0.1"
+end

data/tombstone.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tombstone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tombstone"
+  spec.version       = Tombstone::VERSION
+  spec.authors       = ["Lewis Buckley"]
+  spec.email         = ["lewis@lewisbuckley.co.uk"]
+  spec.summary       = %q{Use Tombstone to highlight dead code.}
+  spec.description   = %q{Use Tombstone to highlight dead code. Not sure if some code is safe to remove? Tombstone it.}
+  spec.homepage      = "https://github.com/lewispb/tombstone"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["tombstone"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: tombstone
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Lewis Buckley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Tombstone to highlight dead code. Not sure if some code is safe to
+  remove? Tombstone it.
+email:
+- lewis@lewisbuckley.co.uk
+executables:
+- tombstone
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tombstone
+- lib/tombstone.rb
+- lib/tombstone/railtie.rb
+- lib/tombstone/version.rb
+- tombstone.gemspec
+homepage: https://github.com/lewispb/tombstone
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Use Tombstone to highlight dead code.
+test_files: []