log_elapsed_time 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,64 @@
+log_elapsed_time
+========
+
+I found myself wanting a quick and easy way to log out how much time certain operations were taking (HTTP requests to external APIs, in my case). Since I found myself doing this in a bunch of places, I decided to extract the code into something reusable, which is what you see here.
+
+
+Installation
+------------
+
+    gem install log_elapsed_time
+
+
+Usage
+-----
+
+Requiring the gem in your project will add a global method named `log_elapsed_time`, which you can use like so:
+
+    log_elapsed_time("Request to external service took") do
+      HTTP.post(...)
+    end
+
+This would write `Request to external service took 2048ms` to `Rails.logger.info` and return the result of the POST. If you needed to do something with the result, you could keep the return value:
+
+    response = log_elapsed_time do
+      HTTP.get(...)
+    end
+
+There is one slight gotcha: variables set in the block aren't accessible outside of it, so the following would not work.
+
+    log_elapsed_time do
+      response = HTTP.get(...)
+    end
+
+If you tried to use `response` later, it wouldn't be defined.
+
+
+Todo
+----
+
+* Don't depend directly on `Rails.logger`, or allow a way to customize the logger.
+* Flesh out the pending specs.
+
+Contributing
+------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+Contact
+-------
+
+Problems, comments, and pull requests all welcome. [Find me on GitHub.](http://github.com/tfe/)
+
+
+Copyright
+---------
+
+Copyright © 2014 [Todd Eichel](http://toddeichel.com/). See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/log_elapsed_time.rb

@@ -1,10 +1,3 @@
-# Usage:
-# log_elapsed_time("Request to external service took") do
-#   HTTP.post(...)
-# end
-# This would log "Request to external service took 2048ms" and return the
-# result of the POST.
-
 def log_elapsed_time(message_prefix = nil, &block)
   start_time = Time.now
   return_value = yield

data/log_elapsed_time.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "log_elapsed_time"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Todd Eichel"]
+  s.date = "2014-03-19"
+  s.description = "Quick and easy way to log the time it takes code to run."
+  s.email = "todd@toddeichel.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/log_elapsed_time.rb",
+    "log_elapsed_time.gemspec",
+    "spec/log_elapsed_time_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/tfe/log_elapsed_time"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Quick and easy way to log the time it takes code to run."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_elapsed_time
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -97,17 +97,18 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/log_elapsed_time.rb
+- log_elapsed_time.gemspec
 - spec/log_elapsed_time_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/tfe/log_elapsed_time
@@ -125,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2110752389062959253
+      hash: -2890960856251512107
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= log_elapsed_time
-
-Description goes here.
-
-== Contributing to log_elapsed_time
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2014 Todd Eichel. See LICENSE.txt for
-further details.
-