crufty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ddf1c6b724208c924b911979499a2d4349d75bd
+  data.tar.gz: 061e47b640b247068c2ca27f94dfd8df0ee7af6b
+SHA512:
+  metadata.gz: eabb4d1015e356f4f725f0483e7638c70f6a86f23b1b60896310ef3bec09bb80ed56c6c741d0246f2fa609a9981fd0ada35b705aea3f5b5745b935f37b274448
+  data.tar.gz: 74ee577c84eef5706b44878cbcc084cc417a2db625cece835984ecaaf646c8ae9ba093a3d81c12d25e7de0d903bf295480b95a7622b7aa701b7c58f572d9e029

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Righi
+
+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,58 @@
+# Crufty
+
+Don't let quick fixes turn into permanently crufty code. Give it an expiration date.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crufty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crufty
+
+## Usage
+
+```ruby
+WARN_AFTER =  DateTime.parse("2015-12-15 10:00AM -800")
+ERROR_AFTER = DateTime.parse("2015-12-20 10:00AM -800")
+
+# TODO: Remove this code before it starts to spit out warnings, 
+# and DEFINITELY remove it before it starts raising errors.
+crufty(WARN_AFTER, ERROR_AFTER) do
+  # Hacky code goes here
+end
+
+# If you just want the warnings and never want it to error:
+
+crufty(WARN_AFTER) do
+  # Hacky code goes here
+end
+
+
+# Explicit Usage:
+
+crufty(best_by: WARN_AFTER, expires: ERROR_AFTER) do
+  # Hacky code goes here
+end
+
+
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/righi/crufty. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) 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 "crufty"
+
+# 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/crufty.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crufty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crufty"
+  spec.version       = Crufty::VERSION
+  spec.authors       = ["Michael Righi"]
+  spec.email         = ["michael@righi.me"]
+
+  spec.summary       = %q{Self-destruct your crufty code to ensure it doesn't become permanent.}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/righi/crufty"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "pry", '0.10.1'
+  spec.add_development_dependency "pry-byebug", '2.0.0'
+end

data/lib/crufty.rb

@@ -0,0 +1,64 @@
+require "crufty/version"
+require "crufty/context"
+require "crufty/exceptions"
+require "logger"
+
+module Crufty
+  class << self
+    attr_accessor :logger, :stale_handler, :expired_handler
+    attr_writer :env
+
+    def env
+      @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+    end
+
+    def on_stale(&block)
+      self.stale_handler = block
+    end
+
+    def on_expired(&block)
+      self.expired_handler = block
+    end
+  end
+
+  DEFAULT_ON_STALE_HANDLER = proc do |ctx|
+    stale_detail = (ctx.best_by.nil?) ? "Crufty code" : "Code went crufty at #{ctx.best_by} and"
+    expires_detail = (ctx.expires.nil?) ? "should be removed" : "will stop working at #{ctx.expires}"
+    Crufty.logger.warn("#{stale_detail} #{expires_detail}: #{ctx.backtrace[0]}")
+  end
+
+  DEFAULT_ON_EXPIRED_HANDLER = proc do |ctx|
+    raise ::Crufty::CodeExpired.new(ctx), "Crufty code expired at #{ctx.expires}", ctx.backtrace
+  end
+
+  if defined?(Rails) && Rails.logger
+    self.logger = Rails.logger
+  else
+    self.logger = Logger.new($stdout)
+  end
+
+  self.stale_handler = DEFAULT_ON_STALE_HANDLER
+  self.expired_handler = DEFAULT_ON_EXPIRED_HANDLER
+
+  module Methods
+    def crufty(warn_after = nil, error_after = nil, best_by: nil, expires: nil)
+      raise ArgumentError if (warn_after && best_by) || (error_after && expires)
+
+      best_by = warn_after || best_by
+      expires = error_after || expires
+
+      ctx = ::Crufty::Context.new(best_by, expires, caller)
+
+      if ctx.state == :expired
+        Crufty.expired_handler.call(ctx)
+      elsif ctx.state == :stale
+        Crufty.stale_handler.call(ctx)
+        yield
+      else
+        yield
+      end
+    end
+  end
+end
+
+Object.send :include, Crufty::Methods

data/lib/crufty/context.rb

@@ -0,0 +1,57 @@
+require 'date'
+
+module Crufty
+  class Context
+    attr_reader :best_by, :expires, :backtrace, :invoked_at, :invoke
+
+    def initialize(best_by, expires, backtrace=nil)
+      @invoke = true
+
+      if datetimeish?(best_by) && datetimeish?(expires)
+        @invoked_at = DateTime.now
+      elsif timeish?(best_by) && timeish?(expires)
+        @invoked_at = Time.now
+      else
+        raise ArgumentError, "Unexpected time params: #{best_by.class} and #{expires.class}"
+      end
+      
+      @best_by = best_by
+      @expires = expires
+      @backtrace = backtrace
+    end
+
+    def state
+      @state ||= (expired? ? :expired : (stale? ? :stale : :fresh))
+    end
+
+    def fresh?
+      !stale? && !expired?
+    end
+
+    def stale?
+      if @best_by.nil?
+        true
+      else
+        @invoked_at >= @best_by
+      end
+    end
+
+    def expired?
+      if @expires.nil?
+        false
+      else
+        @invoked_at >= @expires
+      end
+    end
+
+    private
+
+      def datetimeish?(time)
+        time.nil? || time.is_a?(DateTime)
+      end
+
+      def timeish?(time)
+        time.nil? || time.is_a?(Time)
+      end
+  end
+end

data/lib/crufty/exceptions.rb

@@ -0,0 +1,12 @@
+module Crufty
+  class CodeExpired < StandardError
+    attr_reader :best_by, :expires
+
+    def initialize(context)
+      @best_by = context.best_by
+      @expires = context.expires
+
+      set_backtrace(context.backtrace)
+    end
+  end
+end

data/lib/crufty/version.rb

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

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: crufty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Righi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 
+email:
+- michael@righi.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crufty.gemspec
+- lib/crufty.rb
+- lib/crufty/context.rb
+- lib/crufty/exceptions.rb
+- lib/crufty/version.rb
+homepage: https://github.com/righi/crufty
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: Self-destruct your crufty code to ensure it doesn't become permanent.
+test_files: []