remnant 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    flail (0.1.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    rack (1.1.3)
+    rake (0.9.2.2)
+    rr (1.0.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    sham_rack (1.3.4)
+      rack
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 2.3.8)
+  activerecord (~> 2.3.8)
+  activesupport (~> 2.3.8)
+  fakeweb (~> 1.3.0)
+  flail!
+  rake
+  rr
+  rspec
+  sham_rack (~> 1.3.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 John "asceth" Long
+
+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,46 @@
+Remnant hooks into your Rails and discovers your hidden statistics.
+
+##### Supports
+
+* Rails 2.3.x
+
+
+#### Install
+
+```
+$ [sudo] gem install remnant
+```
+
+```ruby
+# For Rails 2.3.x
+gem 'remnant'
+```
+
+
+#### Usage
+
+
+Add an initializer to configure (or call configure during application startup):
+
+```ruby
+Remnant.configure do
+  # hostname of statsd server
+  host "https://remnant.statsd"
+
+  # port of statsd server
+  port 8125
+
+  # app name or other unique key for multiple app usage
+  tagged "custom"
+
+  # environment of application, defaults to Rails.env
+  # included in payload
+  environment "production"
+end
+```
+
+
+#### Author
+
+
+Original author: John "asceth" Long

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+gemspec = eval(File.read(File.join(Dir.pwd, "flail.gemspec")))
+
+task :build => "#{gemspec.full_name}.gem"
+
+task :test => :spec
+task :default => :spec
+
+file "#{gemspec.full_name}.gem" => gemspec.files + ["flail.gemspec"] do
+  system "gem build flail.gemspec"
+  system "gem install flail-#{Flail::VERSION}.gem"
+end
+

data/lib/remnant/base.rb

@@ -0,0 +1,50 @@
+class Remnant
+  module ClassMethods
+    def configure(&block)
+      configuration.instance_eval(&block)
+    end
+
+    def configuration
+      @configuration ||= Remnant::Configuration.new.defaults!
+    end
+
+    def handler
+      @handler ||= Statsd.new(Remnant.configuration.hostname, Remnant.configuration.port_number)
+    end
+
+    def collect
+      extra_remnant_key = Remnant::Discover.results.delete(:extra_remnant_key)
+
+      if ::Rails.env.production?
+        # send on
+        Remnant::Discover.results.map do |remnant_key, ms|
+          key = [
+                 Remnant.configuration.tag,
+                 Remnant.configuration.env,
+                 extra_remnant_key,
+                 remnant_key
+                ].compact.join('.')
+
+          Remannt.handler.timing(key, ms.to_i)
+        end
+      else
+        # log it
+        Rails.logger.info "--------------Remnants Discovered--------------"
+
+        Remnant::Discover.results.map do |remnant_key, ms|
+          key = [
+                 extra_remnant_key,
+                 remnant_key
+                ].compact.join('.')
+
+          Rails.logger.info "#{ms.to_i}ms\t#{key}"
+        end
+
+        Rails.logger.info "-----------------------------------------------"
+      end
+
+      Remnant::Discover.results.clear
+    end
+  end
+  extend ClassMethods
+end

data/lib/remnant/configuration.rb

@@ -0,0 +1,41 @@
+class Remnant
+  class Configuration
+    # environment of application
+    attr_reader :env
+
+    # hostname to send to
+    attr_reader :hostname
+
+    # port to send to
+    attr_reader :port_number
+
+    # api key to use with payloads
+    attr_reader :tag
+
+    def host(value)
+      @hostname = value
+    end
+
+    def port(value)
+      @port_number = value
+    end
+
+    def tagged(value)
+      @tag = value
+    end
+
+    def environment(value)
+      @env = value
+    end
+
+    def defaults!
+      # configure some defaults
+
+      @hostname = '127.0.0.1'
+      @port_number = 8125
+      @tag = 'remnant'
+
+      self
+    end # end defaults!
+  end
+end

data/lib/remnant/discover.rb

@@ -0,0 +1,61 @@
+class Remnant
+  module Discover
+    module ClassMethods
+      def find(key, klass, method, instance = true)
+        rediscover(key, klass, method, instance) if ActiveSupport::Dependencies.will_unload?(klass)
+
+        klass.class_eval <<-EOL, __FILE__, __LINE__
+          #{"class << self" unless instance}
+          def #{method}_with_remnant(*args, &block)
+            ::Remnant::Discover.measure(#{key.inspect}) do
+              #{method}_without_remnant(*args, &block)
+            end
+          end
+
+          alias_method_chain :#{method}, :remnant
+          #{"end" unless instance}
+        EOL
+      end
+
+      def measure(key, &block)
+        if Remnant::Discover.running.include?(key)
+          yield
+        else
+          result = nil
+          Remnant::Discover.running << key
+          begin
+            Remnant::Discover.results[key] += Benchmark.ms { result = yield }
+          rescue
+            raise
+          ensure
+            Remnant::Discover.running.delete(key)
+          end
+          result
+        end
+      end
+
+      def results
+        Thread.current[:result] ||= Hash.new(0)
+      end
+
+      def running
+        Thread.current[:running] ||= []
+      end
+
+      def remnants_to_rediscover
+        @remnants_to_rediscover ||= []
+      end
+
+      def rediscover(*args)
+        remnants_to_rediscover << args unless remnants_to_rediscover.include?(args)
+      end
+
+      def rediscover!
+        remnants_to_rediscover.map do |(key, klass_name, method, instance)|
+          find(key, klass_name.constantize, method, instance)
+        end
+      end
+    end
+    extend ClassMethods
+  end
+end

data/lib/remnant/rails.rb

@@ -0,0 +1,66 @@
+class Remnant
+  class Rails
+    module ClassMethods
+      def logger
+        ::Rails.logger
+      end
+
+      def setup!
+        Remnant.configure do
+          environment ::Rails.env
+        end
+
+        #
+        # helper hooks
+        #
+
+        # hook into dependency unloading
+        ::ActiveSupport::Dependencies.class_eval do
+          class << self
+            def clear_with_remnant_rediscover(*args, &block)
+              clear_without_remnant_rediscover(*args, &block).tap do
+                Remnant::Discover.rediscover!
+              end
+            end
+            alias_method_chain :clear, :remnant_rediscover
+          end
+        end
+
+
+        #
+        # stat collection below
+        #
+
+        # hook remnants
+        Remnant::Discover.find('request',  ActionController::Dispatcher,            :call)
+        Remnant::Discover.find('dispatch', ActionController::Dispatcher,            :_call)
+        Remnant::Discover.find('process',  ActionController::Base,                  :process)
+        Remnant::Discover.find('filters',  ActionController::Filters::BeforeFilter, :call)
+        Remnant::Discover.find('action',   ActionController::Base,                  :perform_action)
+        Remnant::Discover.find('view',     ActionController::Base,                  :render)
+        Remnant::Discover.find('filters',  ActionController::Filters::AfterFilter,  :call)
+
+        # last hook into request cycle for sending results
+        ::ActionController::Dispatcher.class_eval do
+          def call_with_remnant_discovery(*args, &block) #:nodoc:
+            call_without_remnant_discovery(*args, &block).tap do |status, headers, response|
+              ::Remnant.collect
+              ::Rails.logger.flush if ::Rails.logger.respond_to? :flush
+            end
+          end
+          alias_method_chain :call, :remnant_discovery
+        end
+
+        # hook into perform_action for the extra remnant key
+        ::ActionController::Base.class_eval do
+          def perform_action_with_remnant_key(*args, &block) #:nodoc:
+            ::Remnant::Discover.results[:extra_remnant_key] = "#{params[:controller]}.#{params[:action]}"
+            perform_action_without_remnant_key(*args, &block)
+          end
+          alias_method_chain :perform_action, :remnant_key
+        end
+      end # setup!
+    end
+    extend ClassMethods
+  end
+end

data/lib/remnant/railtie.rb

@@ -0,0 +1,7 @@
+class Remnant
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      Remnant::Rails.setup!
+    end
+  end
+end

data/lib/remnant/version.rb

@@ -0,0 +1,3 @@
+class Remnant
+  VERSION = "0.1.0"
+end

data/lib/remnant.rb

@@ -0,0 +1,7 @@
+require 'statsd'
+
+require 'remnant/base'
+require 'remnant/configuration'
+require 'remnant/rails'
+
+require 'remnant/railtie' if defined?(::Rails::Railtie)

data/remnant.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "remnant/version"
+
+Gem::Specification.new do |s|
+  s.name        = "remnant"
+  s.version     = Remnant::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John 'asceth' Long"]
+  s.email       = ["machinist@asceth.com"]
+  s.homepage    = "https://github.com/asceth/remnant"
+  s.summary     = "Rails statistical discoverer"
+  s.description = "Remnant - peering into your ruby apps and discovering statistics you never knew could be so awful..."
+
+  s.rubyforge_project = "remnant"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'statsd-ruby', '1.0.0'
+
+  s.add_development_dependency 'actionpack', '~> 2.3.8'
+  s.add_development_dependency 'activerecord', '~> 2.3.8'
+  s.add_development_dependency 'activesupport', '~> 2.3.8'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rr'
+end

data/spec/base_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Flail do
+
+  context "#configuration" do
+    it "should return the same object for multiple calls" do
+      Flail.configuration.should == Flail.configuration
+    end
+  end
+
+  context "#configure" do
+    it "should fail without a block" do
+      lambda { Flail.configure }.should raise_error
+    end
+
+    it "should instance_eval the block onto configuration" do
+      block = Proc.new { handle {|payload| } }
+      mock(Flail).configuration.stub!.instance_eval(&block)
+      Flail.configure(&block)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,124 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'rr'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+
+require 'action_controller'
+require 'action_controller/test_process'
+require 'active_record'
+require 'active_support'
+require 'rack'
+require 'sham_rack'
+
+require 'flail'
+require 'flail/rails/controller_methods'
+require 'flail/rails/rescue_action'
+
+
+Dir["#{File.expand_path(File.dirname(__FILE__))}/support/*.rb"].map {|file| require(file)}
+
+class FlailArmory
+
+  module ClassMethods
+    def define_constant(name, value)
+      @defined_constants ||= []
+      Object.const_set(name, value)
+      @defined_constants << name
+    end
+
+    def build_controller_class(&definition)
+      Class.new(ActionController::Base).tap do |klass|
+        klass.__send__(:include, Flail::Rails::ControllerMethods)
+        klass.__send__(:include, Flail::Rails::RescueAction)
+        klass.class_eval(&definition) if definition
+
+        klass.class_eval do
+          def rescue_action_in_public_without_flail(*args)
+          end
+        end
+        define_constant('FlailTestController', klass)
+      end
+    end
+
+    def process_action(options = {}, &action)
+      options[:request] ||= ActionController::TestRequest.new
+      options[:response] ||= ActionController::TestResponse.new
+
+      klass = build_controller_class do
+        cattr_accessor :local
+        define_method(:index, &action)
+
+        def current_user
+          @current_user
+        end
+
+        def local_request?
+          local
+        end
+      end
+
+      if options[:user_agent]
+        if options[:request].respond_to?(:user_agent=)
+          options[:request].user_agent = options[:user_agent]
+        else
+          options[:request].env["HTTP_USER_AGENT"] = options[:user_agent]
+        end
+      end
+
+      klass.consider_all_requests_local = options[:all_local]
+      klass.local = options[:local]
+
+      controller = klass.new
+
+      if options[:user]
+        controller.instance_variable_set(:@current_user, options[:user])
+      end
+
+      options[:request].query_parameters = options[:request].query_parameters.merge(options[:params] || {})
+      options[:request].session = ActionController::TestSession.new(options[:session] || {})
+      options[:request].env['REQUEST_URI'] = options[:request].request_uri
+
+      controller.process(options[:request], options[:response])
+      controller
+    end
+
+    def process_action_with_error(options = {})
+      process_action(options) do
+        raise "Hello"
+      end
+    end
+
+    def setup
+      Flail.configure do
+        handle do |payload|
+          FlailArmory.payload = ActiveSupport::JSON.decode(payload)
+        end
+      end
+      define_constant('RAILS_ROOT', '/path/to/rails/root')
+    end
+
+    def payload=(value)
+      @payload = value
+    end
+
+    def payload
+      @payload
+    end
+
+    def raid
+      @defined_constants.each do |constant|
+        Object.__send__(:remove_const, constant)
+      end
+
+      @payload = nil
+      @defined_constants = []
+    end
+  end
+  extend ClassMethods
+end

data/spec/support/rr.rb

@@ -0,0 +1,42 @@
+# --- add this as spec/support/rr.rb ---
+
+# RR doesn't have support for RSpec 2.
+#
+# Source: <https://github.com/btakita/rr/issues#issue/45>
+
+require 'rr'
+
+module RR
+  module Adapters
+    module RSpec2
+      include RRMethods
+
+      def setup_mocks_for_rspec
+        RR.reset
+      end
+      def verify_mocks_for_rspec
+        RR.verify
+      end
+      def teardown_mocks_for_rspec
+        RR.reset
+      end
+
+      def have_received(method = nil)
+        RR::Adapters::Rspec::InvocationMatcher.new(method)
+      end
+    end
+  end
+end
+
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+      include RR::Adapters::RSpec2
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.mock_framework = RSpec::Core::MockFrameworkAdapter
+  config.backtrace_clean_patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: remnant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John 'asceth' Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Remnant - peering into your ruby apps and discovering statistics you
+  never knew could be so awful...
+email:
+- machinist@asceth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/remnant.rb
+- lib/remnant/base.rb
+- lib/remnant/configuration.rb
+- lib/remnant/discover.rb
+- lib/remnant/rails.rb
+- lib/remnant/railtie.rb
+- lib/remnant/version.rb
+- remnant.gemspec
+- spec/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/rr.rb
+homepage: https://github.com/asceth/remnant
+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: remnant
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails statistical discoverer
+test_files:
+- spec/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/rr.rb