strict_templates 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad65aaa77460ae4b7b2b9d75ada8f28ef12f2283
-  data.tar.gz: 91251e1096a2c3f8fac84fc8398c7f88aee5ab53
+  metadata.gz: 330ac4e189172743eefe10ad36e7f339041625b6
+  data.tar.gz: d36000298f92b650d15d1d50c57c9fc242f01db3
 SHA512:
-  metadata.gz: d439ec62591c419d55d57b20596ee82631c9c73b091c44c086dc1b4491dfe83cb2930008fd97530bf5dfaea7429c0d8a743f9b861d5bc72e353f7ef925691068
-  data.tar.gz: ddb9c9d6dd9ccc7e21283ce78c2800c19cda05dd3770a27047ea39da2e44057db8dbc0b5510de02e9fabc0c8319089cc996d1d41c7416fb19f5d43e25511b18f
+  metadata.gz: a5706e18d6df56217b877db175302a13379caf0bb1e6caafac19893db176441d7cb18e38f5e96a69c4e4e4a4afa90322cf2cf112cfb916b968fb5839ce0f4648
+  data.tar.gz: 54efbeb76df432aaed43e99732db46b65d9acb8880d71b276a35fe7071da2d82bf414e9d2f4b2d9a70cfb2b1d0d42f1f5b5349908236c7807715ff6fd8a93146

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,10 +1,12 @@
-# StrictTemplates
+# StrictTemplates [![Build Status](https://travis-ci.org/kellysutton/strict_templates.svg?branch=master)](https://travis-ci.org/kellysutton/strict_templates)
 
-A gem for ensuring that database queries do not execute while
-rendering templates in a Rails application.
+A gem for ensuring that database queries do not execute while rendering templates in a Rails application.
 
-This is a work in progress, as it does not currently work in multi-threaded
-environments (e.g. Puma).
+With great power comes great responsibility. ERB is an extremely flexible templating language, but can also . Gems like [`bullet`](https://github.com/flyerhzm/bullet) are great for detecting N+1 queries within an application. But for those of us that want to go the extra mile and **prevent any database access from within a template**, this gem is for you.
+
+Doing this helps keep all database access centralized to your controller layer.
+
+Pull Requests welcome to enable other methods of generating responses (RABL, etc.)
 
 ## Installation
 
@@ -16,14 +18,21 @@ group :development, :test do
 end
 ```
 
-And then execute:
+And then do your normal:
 
     $ bundle
 
+Next, include `StrictTemplates::Concern` in all controllers you wish to prevent database queries while rendering. If it's a new app, you should include it in your `ApplicationController`, e.g.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include StrictTemplates::Concern
+end
+```
+
 ## Usage
 
-Errors will be raised whenever a request issues a SQL statement from
-within a template.
+Errors will be raised whenever a request issues a SQL statement from within a template.
 
 ## Development
 
@@ -33,7 +42,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/strict_templates. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kellysutton/strict_templates. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/strict_templates/concern.rb

@@ -10,7 +10,7 @@ module StrictTemplates
       def render(*args, &block)
         callback = lambda do |name, start, finish, id, payload|
           if !should_ignore_sql_statement?(payload[:name])
-            raise SqlPerformedWithinTemplateError.new("A SQL request was issued within the template: \n  #{payload[:sql]}")
+            raise SQLPerformedWithinTemplateError.new("A SQL request was issued within the template: \n  #{payload[:sql]}")
           end
         end
 

data/lib/strict_templates/version.rb

@@ -1,3 +1,3 @@
 module StrictTemplates
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strict_templates
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kelly Sutton