debug-bar 1.0.0

data/spec/recipe_book_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe DebugBar::RecipeBook::Base do
+
+  class RecipeTestBook < DebugBar::RecipeBook::Base
+
+    def time_recipe
+      return Proc.new {|b| ['Time', Time.now, {}]}
+    end
+
+    # Places all key value pairs between vertical pipes.
+    # Ex: {:foo => 'bar'} --> '|foo|bar|'
+    def opts_recipe(opts={})
+      return Proc.new {|b| ['Opts', '|' + opts.to_a.flatten.join('|') + '|', {}]}
+    end
+
+    def render_recipe(opts={})
+      locals = {:content => 'River Song'}.merge(opts)
+      return Proc.new {|b| ['Render', render_template(:content, :locals => locals), {}]}
+    end
+
+    def helper_method
+      return :helper_method_result_standin
+    end
+
+  end
+
+  class BindingContext
+
+    def fetch_binding
+      return binding
+    end
+
+  end
+
+  before(:each) do
+    @book = RecipeTestBook.new
+  end
+
+  describe 'recipe introspection' do
+
+    it 'should give the list of all known recipes as symbols' do
+      @book.recipes.sort.should == [:time, :opts, :render].sort
+    end
+
+    it 'should allow checking for knowledge of a recipe by symbol' do
+      @book.include?(:time).should be_true
+      @book.include?(:zeta).should be_false
+    end
+
+    it 'should allow checking for knowledge of a recipe by string' do
+      @book.include?('time').should be_true
+      @book.include?('zeta').should be_false
+    end
+
+  end
+
+  describe 'recipe fetching' do
+
+    before(:each) do
+      @binding = BindingContext.new.fetch_binding
+    end
+
+    [:time, 'time'].each do |key|
+      it "should return the generated callback of a recipe reference by #{key.class.name}" do
+        recipe = @book.recipe(key)
+        recipe.should be_kind_of(Proc)
+        title, body = recipe.call(@binding)
+        title.should == 'Time'
+      end
+    end
+
+    it 'should pass an options hash to the recipe when given.' do
+      recipe = @book.recipe(:opts, :name => 'Amelia Pond')
+      recipe.should be_kind_of(Proc)
+      title, body= recipe.call(@binding)
+      title.should == 'Opts'
+      body.should == '|name|Amelia Pond|'
+    end
+
+    it 'should get the callback for a recipe that has opts even when they are not given.' do
+      recipe = @book.recipe(:opts)
+      recipe.should be_kind_of(Proc)
+      title, body= recipe.call(@binding)
+      title.should == 'Opts'
+      body.should == '||'
+    end
+
+    it 'should alias [] to recipe' do
+      @book.method(:[]).should == @book.method(:recipe)
+    end
+
+  end
+
+  describe 'templates' do
+
+    before(:each) do
+      @book.send(:template_search_paths=, [Pathname.new(__FILE__).dirname + 'support' + 'templates'])
+    end
+
+    it 'should have configurable template search paths' do
+      @book = RecipeTestBook.new # Need a clean book for this test.
+      @book.send(:template_search_paths).should == []
+
+      @book.send(:template_search_paths=, ['foo', 'bar'])
+
+      @book.send(:template_search_paths).each {|pn| pn.should be_kind_of(Pathname)}
+      @book.send(:template_search_paths).first.basename.to_s.should == 'foo'
+      @book.send(:template_search_paths).last.basename.to_s.should == 'bar'
+    end
+
+    it 'should read template names by symbol from the search path' do
+      template = @book.send(:read_template, :basic)
+
+      template.should be_kind_of(String)
+      template.index('id="basic"').should_not be_nil
+    end
+
+    it 'should read template names by string from the search path' do
+      template = @book.send(:read_template, 'basic')
+
+      template.should be_kind_of(String)
+      template.index('id="basic"').should_not be_nil
+    end
+
+    it 'should raise an ArgumenError when the template is not found' do
+      lambda {@book.send(:read_template, :gallifrey)}.should raise_error(ArgumentError)
+    end
+
+    it 'should render the template' do
+      html = @book.send(:render_template, :basic)
+      html.index('id="basic"').should_not be_nil
+    end
+
+    it 'should render the template with :locals' do
+      html = @book.send(:render_template, :content, :locals => {:content => 'The Doctor'})
+
+      html.index('id="content"').should_not be_nil
+      html.index('River Song').should be_nil
+      html.index('The Doctor').should_not be_nil
+    end
+
+    it 'should render the template within a recipe' do
+      title, html = @book.recipe(:render).call(@binding)
+
+      html.index('id="content"').should_not be_nil
+      html.index('River Song').should_not be_nil
+      html.index('The Doctor').should be_nil
+    end
+
+    it 'should render the template with locals from within a recipe' do
+      title, html = @book.recipe(:render, :content => 'The Doctor').call(@binding)
+
+      html.index('id="content"').should_not be_nil
+      html.index('River Song').should be_nil
+      html.index('The Doctor').should_not be_nil
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec'
+#require 'vcr'
+
+require 'debug-bar'
+
+#WP::Config::set_config_root(File.expand_path(File.join(File.dirname(__FILE__),'data')))
+#
+#VCR.configure do |c|
+#  c.cassette_library_dir = File.dirname(__FILE__) + '/fixtures/vcr_cassettes'
+#  c.hook_into :webmock
+#end
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
+
+# Require ruby-debugger if it is available, otherwise don't.
+begin
+  require 'ruby-debugger'
+rescue LoadError
+end

data/spec/support/templates/basic.html.erb

@@ -0,0 +1 @@
+<div id="basic">Basic</div>

data/spec/support/templates/content.html.erb

@@ -0,0 +1 @@
+<div id="content"><%= content %></div>

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: debug-bar
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jeff Reinecke
+- Keith Stone
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Base generic debug bar implementation.
+email: 
+- jreinecke@whitepages.com
+- kstone@whitepages.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rbenv-version
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- debug-bar.gemspec
+- lib/debug-bar.rb
+- lib/debug-bar/base.rb
+- lib/debug-bar/default.rb
+- lib/debug-bar/ext.rb
+- lib/debug-bar/ext/binding.rb
+- lib/debug-bar/ext/object.rb
+- lib/debug-bar/ext/string.rb
+- lib/debug-bar/recipe_book.rb
+- lib/debug-bar/recipe_book/base.rb
+- lib/debug-bar/recipe_book/default.rb
+- lib/debug-bar/version.rb
+- lib/templates/callback_box.html.erb
+- lib/templates/error.html.erb
+- lib/templates/layout.html.erb
+- spec/base_spec.rb
+- spec/binding_spec.rb
+- spec/recipe_book_spec.rb
+- spec/spec_helper.rb
+- spec/support/templates/basic.html.erb
+- spec/support/templates/content.html.erb
+homepage: https://github.com/whitepages/debug-bar
+licenses: 
+- BSD
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Debug Bar
+test_files: []
+
+has_rdoc: