rails_no_database_in_view 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,37 @@
+rails_no_database_in_view
+===========
+
+Prevent database access from the view.
+
+Force loading all data from the controller by raising when the database
+is accessed from the view. This can help create effective database
+queries and help avoid SQL N+1 problems.
+
+## Installation
+
+    gem install rails_no_database_in_view
+
+## Usage
+
+Enable in controller:
+
+```ruby
+class ItemsController < ActionController::Base
+
+  no_database_access_from_view! if Rails.env.development?
+
+  ...
+
+end
+```
+
+If the database is accessed from the view, a DatabaseAccessFromViewError
+will be raised.
+
+## Badness
+
+You can't tell where in the view the exception came from. Yeah, that's pretty bad.
+
+## Disclaimer
+
+Don't use this. It probably doesn't work. :)

data/lib/rails_no_database_in_view.rb

@@ -0,0 +1,8 @@
+require File.expand_path "./rails_no_database_in_view/version", File.dirname(__FILE__)
+require File.expand_path "./rails_no_database_in_view/database_access_from_view_error", File.dirname(__FILE__)
+require File.expand_path "./rails_no_database_in_view/controller_instance_methods", File.dirname(__FILE__)
+require File.expand_path "./rails_no_database_in_view/controller_class_methods", File.dirname(__FILE__)
+require File.expand_path "./rails_no_database_in_view/railtie", File.dirname(__FILE__)
+
+module RailsNoDatabaseInView
+end

data/lib/rails_no_database_in_view/controller_class_methods.rb

@@ -0,0 +1,11 @@
+module RailsNoDatabaseInView
+  module ControllerClassMethods
+
+    def no_database_access_from_view!
+      self.class_eval do
+        include ControllerInstanceMethods
+      end
+    end
+
+  end
+end

data/lib/rails_no_database_in_view/controller_instance_methods.rb

@@ -0,0 +1,58 @@
+module RailsNoDatabaseInView
+  module ControllerInstanceMethods
+
+    def self.included base
+      base.instance_eval do
+        unless respond_to? :render_without_database_disconnected_for_rendering
+          alias_method :render_without_database_disconnected_for_rendering, :render
+          alias_method :render, :render_with_database_disconnected_for_rendering
+        end
+      end
+    end
+
+    def render_with_database_disconnected_for_rendering *args
+      with_database_disconnected_for_rendering do
+        render_without_database_disconnected_for_rendering *args
+      end
+    end
+
+    private
+
+    def with_database_disconnected_for_rendering
+      retval = nil
+      begin
+        @no_db_inside_render_call ||= 0
+        @no_db_inside_render_call += 1
+        if @no_db_inside_render_call > 1
+          retval = yield
+        else
+          no_db_disconnect
+          begin
+            retval = yield
+          rescue StandardError => e
+            if e.class.to_s.include?('ActiveRecord::') || e.message['not connected'] || e.message['closed database']
+              raise DatabaseAccessFromViewError.new(e)
+            else
+              raise e
+            end
+          ensure
+            no_db_reconnect
+          end
+        end
+      ensure
+        @no_db_inside_render_call -= 1
+      end
+      retval
+    end
+
+    def no_db_disconnect
+      ActiveRecord::Base.connection.disconnect!
+    end
+
+    def no_db_reconnect
+      ActiveRecord::Base.connection.reconnect!
+      ActiveRecord::Base.establish_connection
+    end
+
+  end
+end

data/lib/rails_no_database_in_view/database_access_from_view_error.rb

@@ -0,0 +1,16 @@
+module RailsNoDatabaseInView
+  class DatabaseAccessFromViewError < StandardError
+
+    def initialize error
+      @error = error
+    end
+
+    def message
+      "A database call was made from the view.\n" \
+      "The database had been temporarily disable while rendering the view so we could catch situations like this.\n" \
+      "\nOriginal error:\n" \
+      "#{@error.message} (#{@error.class})"
+    end
+
+  end
+end

data/lib/rails_no_database_in_view/railtie.rb

@@ -0,0 +1,7 @@
+module RailsNoDatabaseInView
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ActionController::Base.extend ControllerClassMethods
+    end
+  end
+end

data/lib/rails_no_database_in_view/version.rb

@@ -0,0 +1,3 @@
+module RailsNoDatabaseInView
+  VERSION = "0.0.2"
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_no_database_in_view
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Joel Plane
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-02 00:00:00 Z
+date: 2013-02-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -56,8 +56,14 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib/rails_no_database_in_view/controller_class_methods.rb
+- lib/rails_no_database_in_view/database_access_from_view_error.rb
+- lib/rails_no_database_in_view/controller_instance_methods.rb
+- lib/rails_no_database_in_view/version.rb
+- lib/rails_no_database_in_view/railtie.rb
+- lib/rails_no_database_in_view.rb
+- README.md
 homepage: https://github.com/joelplane/rails_no_database_in_view
 licenses: []