octopress-debugger 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c131591fc3151c379b8e994522ae21562e2ad2e
-  data.tar.gz: cfdd31bb6f9f2bfc89444a8b53613ab0c0f1acb6
+  metadata.gz: 7463b0ffbd9905868c17f0acc61818c5f0d6c337
+  data.tar.gz: b7cf05d2359a3f821c096f6c2dcc0fc8ca4749ac
 SHA512:
-  metadata.gz: d976963a417013811726685d5d9fd4c129202a9585d0619b9c354787689eadc90daa2932fd1ea1ad3d8de971e42199711dd8af55f1cc0b1d8df97fc70c4ea65d
-  data.tar.gz: dbb5ab3b0c1141e77a207941229af982d385bf4d57887b457c3ce329712810e9c0e81b9c4b60373bd7e80464f979ab857fe84dae902a925473b6093738290141
+  metadata.gz: c91d450b9a341f77af542252ccf62529edbd8c6c5c86b584285fd981a1a15f37b67fc85681239be9d95f3c99b354e31380ba9ce2b32e3783f9779f099d58c84b
+  data.tar.gz: 0fa3961ef081f06cd4973cf5f0d6d81d1a031a29ca7b6cb9349b2fa7c986983653d4f8a3e529c11a55a3c5e56ff4ccedf2b2da34549b13d6bfb503e868ec7385

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.0.2 (2015-01-12)
+- New convenience methods
+- Documentation improvements
+
 ### 1.0.1 (2015-01-12)
 - Added scopes quick var
 - Improved docs

data/README.md

@@ -28,14 +28,38 @@ Then add the gem to your Jekyll configuration.
 
 ## Usage
 
-Add the `{% debug %}` tag to any page to get access to the `site` and `page` instance from the debugger console.
+Add the `{% debug %}` tag to any page to get access to the debugger console when that page is generated.
 
 This will launch an interactive debugging console where you can do some cool things.
 
-- Type `site` to interact with the site instance.
-- Type `page` to interact with the current page instance.
-- Type `page_hash` to view the page instance as a hash.
-- Type `scopes` to view current template variables.
+Some useful debugger commands:
+
+- `continue` - to go to the next `{% debug %}` tag, or step through a loop.
+- `abort` - to exit the debugger.
+- `help` - show manual for the debugger and learn other commands.
+
+I've added some convenience methods for working with the Liquid context.
+
+- `c` - Liquid's context
+- `site` - Jekyll's Site class instance.
+- `page` - Current Page class instance.
+- `scopes` - Scopes for local variables.
+
+You can pass strings to the `c` method to inspect variables.
+
+```ruby
+c 'site' # => current site payload hash
+c 'page' # => current page payload hash
+```
+
+Dot notation works too:
+
+```ruby
+c 'site.pages'        # => Array of site posts
+c 'site.posts.first'  # => First post instance in site posts array
+c 'page.layout'       # => Read data from current page
+c 'foo'               # => Read locally assigned vars
+```
 
 ### Example:
 
@@ -66,7 +90,7 @@ In the debugger you can type `scopes` to see a hash representing variables in th
 You can see the value of post and interact with the post instance with `scopes.first['post']` and even see all the available data on
 the for loop. 
 
-Then you can enter `continue` or `c` to step through the loop.
+Then you can type `continue` to step through the loop or go to the next `{% debug %}` tag.
 
 ## Contributing
 

data/lib/octopress-debugger.rb

@@ -11,14 +11,43 @@ module Octopress
   module Debugger
     class Tag < Liquid::Tag
       def render(context)
-        site = context.registers[:site]
-        page_hash = context.registers[:page]
-        page = site.pages.find{|p| p.url == page_hash['url'] }
-        scopes = context.scopes
+        @context = context
+
+        # HELP: How does this work?
+        #
+        # Try these commands:
+        #  site   => Jekyll's Site instance
+        #  page   => Current Page instance
+        #  scopes => View local variable scopes
+        #
+        # Use `c` to read variables from Liquid's context 
+        #  c 'site' => site hash
+        #  c 'page' => page hash
+        #
+        # Dot notation works too:
+        #  c 'site.posts.first'
+        #  c 'page.content'
+        #  c 'post.tags'
 
         binding.pry
 
-        return ''
+        return '' # Debugger halts on this line
+      end
+
+      def c(var=nil)
+        var.nil? ? @context : @context[var]
+      end
+
+      def site
+        site = @context.registers[:site]
+      end
+
+      def page
+        @page ||= site.pages.find{|p| p.url == c('page')['url'] }
+      end
+
+      def scopes
+        @context.scopes
       end
     end
   end

data/lib/octopress-debugger/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Debugger
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-debugger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll