look_of_performance 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTYxNTk5ZjA5ODkxY2NhNjhlZWQ3MjQyOGEzOGZjYWZmYTE3ZDdjYQ==
+  data.tar.gz: !binary |-
+    OTE2MThhMzJkMDY1NDMyYzI3NTI5NjE0YWM0MzdkYzExYjY3ZmE5MQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzZkNmQ3MDhhMDM5NTNmODg2NDU2OTVlZDA2MTFlNDUzN2UwZjVmY2M3YWMw
+    OTk4OTk4ZjEwY2E2NjczNzhmNGY4Y2YzNmY4NDgzMDZlYzc0YzhhYjcwOGEz
+    ZWI4YjdlZDFjZDJhODRmZTI2ZGI1MzViODcwNmMxYmUxMWQzMjc=
+  data.tar.gz: !binary |-
+    ZWEzY2I0MTQwY2RkYjJhYmIyMzhkNzVhZTFiZGQ1ZGE0Y2Q2Y2E0ZjA3OGM1
+    Y2MzZDVlY2EwYWE4YmM4ZGNkOTdjZTljZGZmYmI1MTkzOTViMDgyYjhjMTg1
+    ZjIxYTcyNGU5ZmZiYWVlZWIyYzQ2YzQyNmU3NzNlNDA2ZTljZjk=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jon Evans
+
+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,77 @@
+# LookOfPerformance
+
+This gem will print out a look of disapproval in your development log when your action takes too long to process.
+
+It's primarily an experiment into using `ActiveSupport::LogSubscriber`.
+
+It's Rails-specific as it hooks into `ActionController`.
+
+If you would find having `ಠ_ಠ`s thrown at you motivating, then this gem's for you.
+
+You'll get one `ಠ_ಠ` per 100 ms that your action takes to process by default.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'look_of_performance'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install look_of_performance
+
+## Usage
+
+Add `require 'look_of_performance'` to your `ApplicationController` to get logging added to every action. Alternatively, you can just require it in specific controllers where you need motivation to improve the performance.
+
+## Configuration
+
+### Options
+
+    scolding
+
+The string that you get once per every `limit` milliseconds.
+
+Defaults to ಠ_ಠ
+
+    delimiter
+
+The string that is included between each `scolding` that your slowness has earned you.
+
+Defaults to " "
+
+    limit
+
+The number of milliseconds you're trying to beat. If your action takes more than the `limit` to load, you'll get at least one `scolding` thrown at you. Every additional `limit` ms the response takes, you'll get an additional `scolding`.
+
+Defaults to 100. Is that optimistic? Yeah, probably.
+
+### Overriding
+
+You can override the default configuration by creating an initializer (e.g. `config/intitializers/look_of_performance.rb`) and setting the values yourself, like so:
+
+```ruby
+LookOfPerformance::Configuration.scolding = "bananas"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/look_of_performance/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
+
+## About Foraker Labs
+
+<img src="http://assets.foraker.com/foraker_logo.png" width="400" height="62">
+
+This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.
+
+Foraker Labs is a Boulder-based Ruby on Rails and iOS development shop. Please reach out if we can [help build your product](http://www.foraker.com).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/look_of_performance.rb

@@ -0,0 +1,4 @@
+require "look_of_performance/version"
+require "look_of_performance/configuration"
+require "look_of_performance/output"
+require "look_of_performance/log_subscriber"

data/lib/look_of_performance/configuration.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module LookOfPerformance
+  module Configuration
+    def self.scolding
+      @scolding || "ಠ_ಠ"
+    end
+
+    def self.scolding=(scolding)
+      @scolding = scolding
+    end
+
+    def self.delimiter
+      @delimiter || " "
+    end
+
+    def self.delimiter=(delimiter)
+      @delimiter = delimiter
+    end
+
+    def self.limit
+      @limit || 100
+    end
+
+    def self.limit=(limit)
+      @limit = limit
+    end
+  end
+end

data/lib/look_of_performance/log_subscriber.rb

@@ -0,0 +1,12 @@
+module LookOfPerformance
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def process_action(event)
+      output = Output.new(event.duration)
+
+      return unless output.sendable?
+      info output.to_s
+    end
+  end
+end
+
+LookOfPerformance::LogSubscriber.attach_to :action_controller

data/lib/look_of_performance/output.rb

@@ -0,0 +1,36 @@
+module LookOfPerformance
+  class Output < String
+    def initialize(duration, config = ::LookOfPerformance::Configuration)
+      self.duration = duration
+      self.config   = config
+    end
+
+    def to_s
+      (1..times).map { |_| scolding }.join(delimiter)
+    end
+
+    def sendable?
+      duration > limit
+    end
+
+    private
+
+    attr_accessor :duration, :config
+
+    def times
+      (duration / limit).floor
+    end
+
+    def limit
+      config.limit
+    end
+
+    def scolding
+      config.scolding
+    end
+
+    def delimiter
+      config.delimiter
+    end
+  end
+end

data/lib/look_of_performance/version.rb

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

data/look_of_performance.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'look_of_performance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "look_of_performance"
+  spec.version       = LookOfPerformance::VERSION
+  spec.authors       = ["Jon Evans"]
+  spec.email         = ["jle@foraker.com"]
+  spec.summary       = %q{Shame yourself into better performance.}
+  spec.description   = %q{Be scolded with looks of disapproval when your app is slow.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.0"
+
+  spec.add_dependency "activesupport", "> 3"
+end

data/spec/lib/look_of_performance/configuration_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../../../lib/look_of_performance/configuration'
+
+module LookOfPerformance
+  describe Configuration do
+    describe 'scolding' do
+      it 'can be set and retrieved' do
+        subject.scolding = 'bananas'
+        expect(subject.scolding).to eq 'bananas'
+      end
+    end
+
+    describe 'delimiter' do
+      it 'can be set and retrieved' do
+        subject.delimiter = '|'
+        expect(subject.delimiter).to eq '|'
+      end
+    end
+
+    describe 'limit' do
+      it 'can be set and retrieved' do
+        subject.limit = 1000
+        expect(subject.limit).to eq 1000
+      end
+    end
+  end
+end

data/spec/lib/look_of_performance/output_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../../../lib/look_of_performance/output'
+require 'ostruct'
+
+module LookOfPerformance
+
+  TestConfig = OpenStruct.new(
+    scolding:  'slow',
+    delimiter: ' ',
+    limit:     100
+  )
+
+  describe Output do
+    let(:duration) { 100 }
+    let(:output)   { described_class.new(duration, TestConfig) }
+
+    describe '#to_s' do
+      let(:duration) { 200 }
+
+      it 'is the output string joined by delimiter the right number of times' do
+        expect(output.to_s).to eq 'slow slow'
+      end
+    end
+
+    describe '#sendable?' do
+      context 'when duration is less than limit' do
+        let(:duration) { 50 }
+
+        it 'is false' do
+          expect(output).to_not be_sendable
+        end
+      end
+
+      context 'when duration is equal to limit' do
+        let(:duration) { 100 }
+
+        it 'is false' do
+          expect(output).to_not be_sendable
+        end
+      end
+
+      context 'when duration is greater than limit' do
+        let(:duration) { 150 }
+
+        it 'is true' do
+          expect(output).to be_sendable
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: look_of_performance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Be scolded with looks of disapproval when your app is slow.
+email:
+- jle@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/look_of_performance.rb
+- lib/look_of_performance/configuration.rb
+- lib/look_of_performance/log_subscriber.rb
+- lib/look_of_performance/output.rb
+- lib/look_of_performance/version.rb
+- look_of_performance.gemspec
+- spec/lib/look_of_performance/configuration_spec.rb
+- spec/lib/look_of_performance/output_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Shame yourself into better performance.
+test_files:
+- spec/lib/look_of_performance/configuration_spec.rb
+- spec/lib/look_of_performance/output_spec.rb