partially_useful 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3125492f037d17719f62948a550602aae2e899ff
-  data.tar.gz: 63a73461a02c79816ce041ff42fb3a894ceb3d2b
+  metadata.gz: 7779586c58e09f7a1c848fd0b264d62c1472ab1f
+  data.tar.gz: 4f92003a40579b34591eacb1e6464dea72005e94
 SHA512:
-  metadata.gz: 23923df7213aec35ea957213f0158617fe1e53125ea79984d0c3cf6cb43bee1322e856f75bee16c5b5fc002c74531063704119506e82c9024e221e97fa3f93dd
-  data.tar.gz: 563f125fb9e34443a905a04b5352036cb40be9ddb298cb5d2be976784d861ca44838676891eea1763f2e4bae0a8d688f2ed7e2af73bd42940defb24c9d1a8bdc
+  metadata.gz: bdfbd42e87f9affbc4b4c7674c06bad733e9e6768927c8ff0d97b28b74663f22fe4783b7565ca629cfe23956ef4908810687e80f859418b0f12d5765853a9645
+  data.tar.gz: 7b31e5e9c615a219d273b5f23f8e5d2e9ddebd38c50d6b694115bfdf120bb77aaa4b7482dc5d43799360688007b267f4b959d87b4ea3a281584aef3647f51379

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.0
+
+* comments only for html request
+
 # 0.1.1
 
 * fix the gemspec

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "byebug"

data/Gemfile.lock

@@ -1,44 +1,51 @@
 PATH
   remote: .
   specs:
-    partially_useful (0.1.1)
+    partially_useful (0.2.0)
       railties (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.1.0)
-      actionview (= 4.1.0)
-      activesupport (= 4.1.0)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.0)
-      activesupport (= 4.1.0)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activesupport (4.1.0)
+    activesupport (4.1.1)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
     builder (3.2.2)
+    byebug (3.1.2)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
     erubis (2.7.0)
     i18n (0.6.9)
     json (1.8.1)
-    minitest (5.3.3)
+    json (1.8.1-java)
+    minitest (5.3.4)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    railties (4.1.0)
-      actionpack (= 4.1.0)
-      activesupport (= 4.1.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.3.1)
+    rake (10.3.2)
     thor (0.19.1)
-    thread_safe (0.3.3)
-    tzinfo (1.1.0)
+    thread_safe (0.3.4)
+    thread_safe (0.3.4-java)
+    tzinfo (1.2.1)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -47,5 +54,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.6)
+  byebug
   partially_useful!
   rake

data/lib/partially_useful/partial_renderer.rb

@@ -6,8 +6,20 @@ module PartiallyUseful
     end
 
     def render(context, options, block)
-      msg = "rendering '#{options[:partial]}' with locals '#{(options[:locals] || {}).keys}'"
-      "<!-- start #{msg}-->\n#{original_rails_render(context, options, block)}\n<!-- end #{msg}-->\n".html_safe
+      if html_context?(context)
+        msg = "rendering '#{options[:partial]}' with locals '#{(options[:locals] || {}).keys}'"
+        "<!-- start #{msg}-->\n#{original_rails_render(context, options, block)}\n<!-- end #{msg}-->\n".html_safe
+      else
+        original_rails_render(context, options, block)
+      end
+    end
+
+    private
+
+    def html_context?(context)
+      if context && context.request
+        context.request.format.html?
+      end
     end
   end
 end

data/lib/partially_useful/version.rb

@@ -1,3 +1,3 @@
 module PartiallyUseful
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/dummy/app/controllers/welcome_controller.rb

@@ -1,2 +1,7 @@
 class WelcomeController < ApplicationController
+  respond_to :html, :json, :xml
+
+  def index
+    respond_with({})
+  end
 end

data/test/dummy/app/views/welcome/_content.xml.erb

@@ -0,0 +1 @@
+SOME TEXT

data/test/dummy/app/views/welcome/index.xml.erb

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<welcome><%= render 'content' %></welcome>

data/test/partially_useful_test.rb

@@ -3,8 +3,23 @@ require 'test_helper'
 class PartiallyUsefulTest < ActionController::TestCase
   tests WelcomeController
 
-  test "should get index" do
+  test "rendering the index template for html adds partial rendering comments to the source" do
     get :index
+
     assert_match "<!-- start rendering 'header' with locals '[]'-->", @response.body
+    assert_match "<h1>Hellooooo</h1>", @response.body
+  end
+
+  test "calling the json endpoint does nothing" do
+    get :index, format: :json
+
+    assert_equal "{}", @response.body
+  end
+
+  test "calling the xml endpoint does not include any rendering comments" do
+    get :index, format: :xml
+
+    xml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<welcome>SOME TEXT</welcome>"
+    assert_equal xml, @response.body
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: partially_useful
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -77,8 +77,10 @@ files:
 - test/dummy/app/views/application/_footer.html.erb
 - test/dummy/app/views/application/_header.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/welcome/_content.xml.erb
 - test/dummy/app/views/welcome/_welcome.html.erb
 - test/dummy/app/views/welcome/index.html.erb
+- test/dummy/app/views/welcome/index.xml.erb
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
@@ -127,8 +129,10 @@ test_files:
 - test/dummy/app/views/application/_footer.html.erb
 - test/dummy/app/views/application/_header.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/welcome/_content.xml.erb
 - test/dummy/app/views/welcome/_welcome.html.erb
 - test/dummy/app/views/welcome/index.html.erb
+- test/dummy/app/views/welcome/index.xml.erb
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
@@ -146,3 +150,4 @@ test_files:
 - test/dummy/public/favicon.ico
 - test/partially_useful_test.rb
 - test/test_helper.rb
+has_rdoc: