wrapt 0.1.0 → 0.1.1

data/Users/dneighman/Projects/wrapt/Gemfile

@@ -11,5 +11,5 @@ group(:test) do
   gem 'ZenTest'
   gem 'haml'
   gem 'rake'
-  gem 'jeweler'
+  gem 'rack-test'
 end

data/Users/dneighman/Projects/wrapt/Gemfile.lock

@@ -28,7 +28,7 @@ dependencies:
     group: 
     - :test
     version: ">= 0"
-  jeweler: 
+  rack-test: 
     group: 
     - :test
     version: ">= 0"
@@ -47,25 +47,17 @@ specs:
 - any_view: 
     version: 0.2.0pre
     source: 0
-- json_pure: 
-    version: 1.4.2
-- gemcutter: 
-    version: 0.5.0
-- git: 
-    version: 1.2.5
 - haml: 
     version: 2.2.24
 - hashie: 
     version: 0.2.0
-- rubyforge: 
-    version: 2.0.4
-- jeweler: 
-    version: 1.4.0
 - rack: 
     version: 1.1.0
+- rack-test: 
+    version: 0.5.3
 - rspec: 
     version: 1.3.0
-hash: 5219adb34705354844440dcaeead99c7e6b271c5
+hash: 418544cd843b148c4469663f63faf3628ffce373
 sources: 
 - Git: 
     uri: git://github.com/hassox/any_view.git

data/Users/dneighman/Projects/wrapt/README.textile

@@ -129,6 +129,29 @@ Once that content is set, you may then use it in the layout by yielding to the l
   = yield :nav # yields the content with the label :nav
 </code></pre>
 
+h3. Preventing Layouts from the Client
+
+Wrapt allows you to prevent layouts from being applied when requested by the client.
+
+This means that when using ajax, or esi, you can request the content without layout.  There is no magic formula for this, because there could be any number of ways to provide this facility.  Instead of prescribing a method to allow requests to not include the layout, you may configure wrapt with a block which checks the request.  From there you can choose to ignore the layout request.
+
+h4. Example
+
+<pre><code>
+use Wrapt do |wrapt|
+  wrapt.ignore_layout do |env|
+    request = Rack::Request.new(env)
+    request.params['ignore_layout'] == 'true'
+  end
+end
+
+run MyApp
+</code></pre>
+
+Now when you make a request to any url, you may tell it to ignore the layout by including an 'ignore_layout=true' on the url.
+
+GET '/foo?ignore_layout=true'
+
 h3. Helpers
 
 You can include any helpers you need into the layout by including them into

data/Users/dneighman/Projects/wrapt/Rakefile

@@ -1,23 +1,6 @@
 require 'rubygems'
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "wrapt"
-    gem.summary = %Q{TODO: one-line summary of your gem}
-    gem.description = %Q{TODO: longer description of your gem}
-    gem.email = "has.sox@gmail.com"
-    gem.homepage = "http://github.com/hassox/wrapt"
-    gem.authors = ["Daniel Neighman"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
@@ -30,8 +13,6 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
 require 'rake/rdoctask'

data/Users/dneighman/Projects/wrapt/lib/wrapt/layout.rb

@@ -2,10 +2,12 @@ class Wrapt
   class Layout
     include Enumerable
     attr_accessor :wrapt, :env, :template_name, :format
+    attr_reader   :request
 
     def initialize(wrapt, env)
       @env = env
       @wrapt = wrapt
+      @request = Rack::Request.new(@env)
       @content_for = Hashie::Mash.new
     end
 
@@ -50,7 +52,7 @@ class Wrapt
       layout.template_name  = opts[:layout] if opts[:layout]
 
       layout.content = content
-      layout.map.join
+      layout.render_layout(false)
     end
 
     def dup
@@ -111,6 +113,15 @@ class Wrapt
     # The interface for rack.
     # @api public
     def each
+      result = render_layout(@wrapt.ignore_layout?(env))
+      yield result
+      result
+    end
+
+    # @api private
+    def render_layout(ignore_layout = false)
+      return content_for[:content] if ignore_layout
+
       opts = {}
       opts[:format]   ||= format
       template = template_name
@@ -125,7 +136,6 @@ class Wrapt
       else
         content_for[:content]
       end
-      yield output
       output
     end
   end

data/Users/dneighman/Projects/wrapt/lib/wrapt/wrapt.rb

@@ -27,6 +27,8 @@
 # If you don't want a layout, simply don't use the wrapt object.
 class Wrapt
 
+  IGNORE_LAYOUT = lambda{|e| false}
+
   # Wrapt is initialized as middleware in a Rack stack
   # @block the wrapt instance is passed to the block for further configuration
   #   You can set layout template directories,
@@ -57,6 +59,39 @@ class Wrapt
     !!@master
   end
 
+  # Wrapt allows you to ignore layouts from the client side.
+  #
+  # This may be useful for esi, or ajax, where you want the content, but not the layout
+  #
+  # @block Provide a block to act as a guard for ignoring the layout from the client side.
+  # The block is provided with the Rack environment from the request
+  #
+  # @see Wrapt#ignore_layout?
+  # @api public
+  def ignore_layout(&block)
+    @ignore_layout = block
+  end
+
+  # Checks to see if the layout should be ignored for this request.
+  #
+  # @example
+  #   use Wrapt do |wrapt|
+  #     wrapt.ignore_layout do |env|
+  #       request = Rack::Request.new(env)
+  #       params["apply_layout"] == false
+  #     end
+  #   end
+  #   run MyApp
+  #
+  # GET "/?apply_layout=false" # Layout is ignored
+  #
+  # @see Wrapt#ignore_layout
+  # @api public
+  def ignore_layout?(env)
+    @ignore_layout ||= IGNORE_LAYOUT
+    @ignore_layout.call(env)
+  end
+
   def call(env)
     env['request.variables'] ||= Hashie::Mash.new
     layout = env['layout']

data/Users/dneighman/Projects/wrapt/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'spec'
 require 'spec/autorun'
 require 'rack'
 require 'haml'
+require 'rack/test'
 
 Spec::Runner.configure do |config|
 

data/Users/dneighman/Projects/wrapt/spec/wrapt_spec.rb

@@ -71,6 +71,22 @@ describe Wrapt do
       @wrapt.default_format.should == :html
     end
 
+    it "should not ignore the layout by default" do
+      env = Rack::MockRequest.env_for("/")
+      @wrapt.ignore_layout?(env).should be_false
+    end
+
+    it "should allow me to setup a condition that the layout is ignored on" do
+      @wrapt.ignore_layout do |env|
+        env['ignore_layout']
+      end
+
+      env = Rack::MockRequest.env_for("/")
+      env['ignore_layout'] = true
+
+      @wrapt.ignore_layout?(env).should be_true
+    end
+
     it "should provide a hook for me to work out the format to use"
   end
 
@@ -105,18 +121,17 @@ describe Wrapt do
   describe "injecting into the environment" do
     before do
       @wrapt = Wrapt.new(SpecWraptApp){|w| w.default_template = :wrapper}
+      @env = Rack::MockRequest.env_for("/")
     end
 
     it "should inject a Wrapt::Layout object into the environment" do
-      env = {}
-      @wrapt.call(env)
-      env['layout'].should be_an_instance_of(Wrapt::Layout)
+      @wrapt.call(@env)
+      @env['layout'].should be_an_instance_of(Wrapt::Layout)
     end
 
     it "should make sure there's a request.variables key in the env" do
-      env = {}
-      @wrapt.call(env)
-      vars = env['request.variables']
+      @wrapt.call(@env)
+      vars = @env['request.variables']
       vars.should_not be_nil
       vars.should respond_to(:[])
       vars.should respond_to(:[]=)
@@ -241,5 +256,71 @@ describe Wrapt do
       result.should include("<div class='content'>Main Content</div>")
       result.should include("<div class='foo'>Foo Content</div>")
     end
+
+    describe "integrated in a rack stack" do
+      include Rack::Test::Methods
+      before do
+        dirs = layouts_dirs
+        builder = Rack::Builder.new do
+          use Wrapt do |w|
+            w.default_template = "wrapper"
+            w.layout_dirs = dirs
+            w.ignore_layout do |e|
+              r = Rack::Request.new(e)
+              r.params['apply_layout'] == 'false'
+            end
+          end
+          run SpecWraptApp
+        end
+
+        @app = builder.to_app
+        $message = nil
+      end
+
+      def app
+        @app
+      end
+
+      it "should wrap the content in the layout" do
+        $message = "Content For This Page"
+        r = get "/"
+        r.body.should include("Wrapper Template")
+        r.body.should include("Content For This Page")
+      end
+
+      it "should not layout when there is an apply_layout=false parameter" do
+        $message = "Unwrapped Content"
+        r = get "/", :apply_layout => :false
+        r.body.should include("Unwrapped Content")
+        r.body.should_not include("Wrapper Template")
+      end
+
+      it "should layout when wrapping the applciation manually" do
+        $wrapped_content = nil
+        dirs = layouts_dirs
+        builder = Rack::Builder.new do
+          use Wrapt do |w|
+            w.default_template = "wrapper"
+            w.layout_dirs = dirs
+            w.ignore_layout do |e|
+              r = Rack::Request.new(e)
+              r.params['apply_layout'] == 'false'
+            end
+          end
+          run(lambda do |e|
+            layout = e['layout']
+            $wrapped_content = layout.wrap("Manual Wrap", :layout => "other")
+            layout.content = "Unwrapped Content"
+            Rack::Response.new(layout).finish
+          end)
+        end
+
+        @app = builder.to_app
+        result = get "/", :apply_layout => "false"
+        result.body.to_s.should == "Unwrapped Content"
+        $wrapped_content.should include("Manual Wrap")
+        $wrapped_content.should include("Other Template")
+      end
+    end
   end
 end

data/Users/dneighman/Projects/wrapt/wrapt.gemspec

@@ -3,7 +3,7 @@ require 'bundler'
 
 Gem::Specification.new do |s|
   s.name = %q{wrapt}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Neighman"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Daniel Neighman
@@ -83,6 +83,7 @@ files:
 - /Users/dneighman/Projects/wrapt/spec/spec_helper.rb
 - /Users/dneighman/Projects/wrapt/spec/wrapt_spec.rb
 - /Users/dneighman/Projects/wrapt/VERSION
+- /Users/dneighman/Projects/wrapt/wrapt-0.1.0.gem
 - /Users/dneighman/Projects/wrapt/wrapt.gemspec
 has_rdoc: true
 homepage: http://github.com/hassox/wrapt