partial_logging 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31887d2d34bf4551ddd900d6d960458be95b4002
-  data.tar.gz: a2d700cb21c1aecf67eea39d6d7dfa602d01db3b
+  metadata.gz: 9cf5322b38adebb5c59d25638475d5585e6527ca
+  data.tar.gz: f7b966167261faf3474581707ff10e19ea6ed0b4
 SHA512:
-  metadata.gz: 2272905ed87fb3e99575bf0a694a8f15f789b3b2fe4f2728051db7d0fa507cd58cd4d68edc010efe4661467dcfcd4e0aea994654177ce03a4044110778af1e1c
-  data.tar.gz: 6f2409b514904dd043dbc7b7f3e9882c60df9804b24d97b02a5d9fd04fec1d1384871b09513b3ba628903db974467456dc7218ba8e0320a7314bc33bfac33e21
+  metadata.gz: 34a463b8d01018da19778edb5520926b5064be68c7d9d8f22ff39a5e19ff22c5ec7d93192603c8f85d88987c22ea2ca86e248f051ade0bc17aed83a4e6b0a8c8
+  data.tar.gz: 81438d325ccf00a52b611952fee7648c43d96519f70c2affd824ef2cf42e4c4c9ee4dfec111373b77be37d98129b94e0b28a98e65f2bc1a3a7f21cd9d1df6d3b

data/README.md

@@ -2,9 +2,14 @@
 
 For figuring out where the heck this HTML is coming from.
 
+This has been used successfully in Rails 3.2 and 4.1 applications, but as it relies on
+the internal state of Rails may break at any time.
+
+Be smart and don't use in production :)
+
 ## Configuration
 
-There is only one configuration option at the moment, and that is `log_partials`.
+The most important configuration options is `log_partials`.
 This takes a block that should return true or false, which will be executed to determine whether or not to log partials.
 
 ```ruby
@@ -15,6 +20,13 @@ PartialLogging.config do |config|
   config.log_partials do
     Rails.env.development?
   end
+
+  # Other config options:
+
+  # absolute_path: whether to show the full file system path or just
+  # `(app_root)/app/views/partials/_party.html.erb`
+  # Default: false
+  # config.absolute_path true
 end
 ```
 

data/lib/partial_logging/configuration.rb

@@ -1,5 +1,6 @@
 module PartialLogging
   class Configuration
+    attr_writer :absolute_path
 
     def log_partials(&block)
       @log_partials = block
@@ -8,5 +9,19 @@ module PartialLogging
     def log_partials?
       @log_partials && @log_partials.call
     end
+
+    # If true, render the absolute path to the partial,
+    # otherwise render '(app root)/app/views/chill/_sauce.html.erb'
+    def absolute_path(show_full_path=nil)
+      if show_full_path.nil?
+        @absolute_path
+      else
+        self.absolute_path = show_full_path
+      end
+    end
+
+    def absolute_path?
+      !!absolute_path
+    end
   end
 end

data/lib/partial_logging/partial_renderer_with_logging.rb

@@ -9,12 +9,20 @@ class PartialLogging::PartialRendererWithLogging < ActionView::PartialRenderer
     if @lookup_context.rendered_format == :html
       output_buffer = ActionView::OutputBuffer.new
       output_buffer.safe_concat """
-      <!-- START #{identifier} -->
+      <!-- START #{formatted_partial_identifier(identifier)} -->
         #{content}
-      <!-- END #{identifier} -->
+      <!-- END #{formatted_partial_identifier(identifier)} -->
       """
       content = output_buffer
     end
     content
   end
+
+  def formatted_partial_identifier(identifier)
+    if PartialLogging.config.absolute_path?
+      identifier
+    else
+      identifier.sub(/#{Rails.root.to_s}/, '(app root)')
+    end
+  end
 end

data/lib/partial_logging/version.rb

@@ -2,7 +2,7 @@ module PartialLogging
   class Version
     MAJOR = 0 unless defined? MAJOR
     MINOR = 1 unless defined? MINOR
-    PATCH = 2 unless defined? PATCH
+    PATCH = 3 unless defined? PATCH
     PRE = nil unless defined? PRE
 
     class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partial_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Chris Maddox