bradphelan-sinatras-hat 0.1.2

data/spec/actions/index_spec.rb

@@ -0,0 +1,72 @@
+require 'spec/spec_helper'
+
+describe "handle index" do
+  attr_reader :maker, :app, :request
+  
+  before(:each) do
+    build_models!
+    mock_app {  }
+    @maker = new_maker(Article)
+    @request = fake_request
+  end
+  
+  def handle(*args)
+    maker.handle(:index, *args)
+  end
+  
+  it "takes a request" do
+    maker.handle(:index, request)
+  end
+  
+  it "loads all records" do
+    mock.proxy(maker.model).all(anything) { [] }
+    handle(request)
+  end
+  
+  describe "rendering a response" do
+    context "when there's a :format param" do
+      before(:each) do
+        @newest_article = Article.create!
+        @request = fake_request(:format => "yaml")
+        stub(maker.model).all(anything).returns([@newest_article, @article])
+      end
+
+      it "sets ETag header" do
+        mock(request).etag(anything)
+        handle(request)
+      end
+      
+      describe "setting the last_modified params" do
+        context "when the last record was the most recently updated" do
+          it "sets last_modified param to the last updated record's updated_at" do
+            mock(request).last_modified(anything)
+            handle(request)
+          end
+        end
+        
+        context "when the last record was not the most recently updated" do
+          before(:each) do
+            @article.update_attribute :name, "Updated recently"
+          end
+          
+          it "sets last_modified param to the last updated record's updated_at" do
+            mock(request).last_modified(anything)
+            handle(request)
+          end
+        end
+      end
+    end
+    
+    context "when there's no :format param" do
+      before(:each) do
+        @request = fake_request
+        stub(maker.model).all(anything).returns([:article])
+      end
+      
+      it "renders the index template" do
+        mock.proxy(maker.responder).success(:index, request, [:article])
+        handle(request)
+      end
+    end
+  end
+end

data/spec/actions/new_spec.rb

@@ -0,0 +1,39 @@
+require 'spec/spec_helper'
+
+describe "handle index" do
+  attr_reader :maker, :app, :request
+  
+  before(:each) do
+    build_models!
+    mock_app {  }
+    @maker = new_maker(Article)
+    @request = fake_request
+  end
+  
+  def handle(*args)
+    maker.handle(:new, *args)
+  end
+  
+  it "takes a request" do
+    maker.handle(:new, request)
+  end
+  
+  it "loads a new record" do
+    mock.proxy(maker.model).new(anything) { :article }
+    handle(request)
+  end
+  
+  describe "rendering a response" do
+    context "when there's no :format param" do
+      before(:each) do
+        @request = fake_request
+        stub(maker.model).new(anything).returns(:article)
+      end
+      
+      it "renders the index template" do
+        mock.proxy(maker.responder).success(:new, request, :article)
+        handle(request)
+      end
+    end
+  end
+end

data/spec/actions/show_spec.rb

@@ -0,0 +1,85 @@
+require 'spec/spec_helper'
+
+describe "handle show" do
+  attr_reader :maker, :app, :request
+  
+  before(:each) do
+    build_models!
+    mock_app {  }
+    @maker = new_maker(Article)
+    @request = fake_request(:id => @article.to_param)
+  end
+  
+  def handle(*args)
+    maker.handle(:show, *args)
+  end
+  
+  it "takes a request" do
+    handle(request)
+  end
+  
+  it "loads correct record" do
+    mock.proxy(maker.model).find(:id => @article.to_param) { :article }
+    handle(request)
+  end
+  
+  describe "rendering a successful response" do
+    context "when there's a :format param" do
+      before(:each) do
+        params = { :format => "yaml", :id => @article.to_param }
+        @request = fake_request(params)
+        stub(maker.model).find(params).returns(@article)
+      end
+      
+      it "sets last_modified header" do
+        mock(request).last_modified(@article.updated_at)
+        handle(request)
+      end
+      
+      it "sets ETag header" do
+        mock(request).etag(anything)
+        handle(request)
+      end
+    end
+    
+    context "when there's no :format param" do
+      before(:each) do
+        params = { :id => @article.to_param }
+        @request = fake_request(params)
+        stub(maker.model).find(anything).returns(@article)
+      end
+      
+      it "uses the success response" do
+        mock.proxy(maker.responder).success(:show, request, @article)
+        handle(request)
+      end
+      
+      it "sets last_modified param" do
+        mock(request).last_modified(@article.updated_at)
+        handle(request)
+      end
+      
+      it "sets ETag header" do
+        mock(request).etag(anything)
+        handle(request)
+      end
+    end
+  end
+  
+  describe "rendering not_found" do
+    before(:each) do
+      stub(maker.model).find(request.params).returns(nil)
+      stub(request).not_found # because it throws :halt otherwise
+    end
+    
+    it "returns not_found" do
+      mock(request).not_found
+      handle(request)
+    end
+    
+    it "does not set last_modified param" do
+      mock(request).last_modified(@article.updated_at).never
+      handle(request)
+    end
+  end
+end

data/spec/actions/update_spec.rb

@@ -0,0 +1,83 @@
+require 'spec/spec_helper'
+
+describe "handle create" do
+  attr_reader :maker, :app, :request, :article
+  
+  before(:each) do
+    build_models!
+    mock_app {  }
+    @maker = new_maker(Article)
+    @request = fake_request("article[name]" => "Hooray!")
+    stub(request).redirect(anything)
+  end
+  
+  def handle(*args)
+    maker.handle(:update, *args)
+  end
+  
+  describe "when the record doesn't exist" do
+    before(:each) do
+      stub(maker.model).find(anything) { nil }
+    end
+    
+    it "returns not_found" do
+      mock.proxy(request).not_found
+      catch(:halt) { handle(request) }
+    end
+  end
+  
+  describe "attempting to update a record" do
+    it "finds a record and updates its attributes" do
+      mock.proxy(article).attributes = { "name" => "Hooray!" }
+      mock.proxy(article).save
+      mock.proxy(maker.model).find(anything) { article }
+      handle(request)
+    end
+    
+    context "when the save is successful" do
+      before(:each) do
+        stub(maker.model).find(anything).returns(article)
+        stub(article).save { true }
+      end
+      
+      context "when there's no format" do
+        it "redirects to that record's path" do
+          mock(request).redirect("/articles/#{article.id}")
+          mock.proxy(maker.responder).success(:update, request, article)
+          handle(request)
+        end
+      end
+
+      # context "when there is a format" do
+      #   it "serializes the record" do
+      #     request_with_format = fake_request(:format => "yaml")
+      #     mock.proxy(maker.responder).serialize("yaml", article)
+      #     handle(request_with_format)
+      #   end
+      # end
+    end
+
+    context "when the save is not successful" do
+      before(:each) do
+        stub(maker.model).find(anything).returns(article)
+        stub(article).save { false }
+      end
+      
+      context "when there's no format" do
+        it "renders edit template" do
+          mock(request).erb :"articles/edit"
+          mock.proxy(maker.responder).failure(:update, request, article)
+          handle(request)
+        end
+      end
+
+      # context "when there is a format" do
+      #   it "serializes the record" do
+      #     request_with_format = fake_request(:format => "yaml")
+      #     mock.proxy(maker.responder).serialize("yaml", article)
+      #     handle(request_with_format)
+      #   end
+      # end
+    end
+  end
+end

data/spec/extendor_spec.rb

@@ -0,0 +1,78 @@
+require 'spec/spec_helper'
+
+describe Sinatra::Hat::Extendor do
+  describe "mount" do
+    context "when used at top level" do
+      it "takes a klass" do
+        proc {
+          mock_app { mount(Article) }
+        }.should_not raise_error
+      end
+      
+      it "uses Rack::MethodOverride" do
+        app = mock_app
+        mock.proxy(app).use(Rack::MethodOverride)
+        app.class_eval { mount(Article) }
+      end
+
+      it "takes an options hash" do
+        proc {
+          mock_app { mount(Article, :only => [:index]) }
+        }.should_not raise_error
+      end
+
+      it "instantiates a new Sinatra::Hat::Maker" do
+        mock.proxy(Sinatra::Hat::Maker).new(Article, { })
+        mock_app { mount(Article) }
+      end
+
+      it "instance_eval's the block in the new maker" do
+        mock.proxy(maker = new_maker).instance_eval
+        mock.proxy(Sinatra::Hat::Maker).new(Article, { }) { maker }
+        mock_app { mount(Article, &proc { }) }
+      end
+
+      it "generates routes" do
+        mock.proxy.instance_of(Sinatra::Hat::Maker).setup(anything)
+        mock_app { mount(Article) }
+      end
+    end
+
+    context "when used in nested #mount calls" do
+      attr_reader :app, :maker
+      
+      before(:each) do
+        @app = mock_app
+        @maker = new_maker(Article)
+        maker.setup(app)
+      end
+      
+      it "takes a klass" do
+        proc {
+          maker.mount(Comment)
+        }.should_not raise_error
+      end
+
+      it "takes an options hash" do
+        proc {
+          maker.mount(Comment, :only => :index)
+        }.should_not raise_error
+      end
+
+      it "instantiates a new Sinatra::Hat::Maker" do
+        mock.proxy(Sinatra::Hat::Maker).new(Comment, { })
+        maker.mount(Comment)
+      end
+      
+      it "sets the :parent option" do
+        mock.proxy(Sinatra::Hat::Maker).new(Comment, { })
+        maker.mount(Comment).parent.should == maker
+      end
+
+      it "generates routes" do
+        mock.proxy.instance_of(Sinatra::Hat::Maker).setup(app)
+        maker.mount(Comment)
+      end
+    end
+  end
+end

data/spec/fixtures/views/articles/edit.erb

@@ -0,0 +1 @@
+Edit Article!

data/spec/fixtures/views/articles/index.erb

@@ -0,0 +1 @@
+HEY: <%= @articles.inspect %>

data/spec/fixtures/views/articles/new.erb

@@ -0,0 +1 @@
+New Article!

data/spec/fixtures/views/articles/show.erb

@@ -0,0 +1 @@
+SHOW: <%= @article.inspect %>

data/spec/hash_mutator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec/spec_helper'
+
+describe Sinatra::Hat::HashMutator do
+  attr_reader :mutator, :hash
+  
+  before(:each) do
+    @hash = {
+      :success => proc { :ftw! },
+      :failure => proc { :fail }
+    }
+    @mutator = Sinatra::Hat::HashMutator.new(hash)
+  end
+  
+  it "lets you alter the success key of the passed in hash" do
+    mutator.success { :pwnd! }
+    hash[:success][].should == :pwnd!
+  end
+  
+  it "lets you alter the failure key of the passed in hash" do
+    mutator.failure { :pwnd! }
+    hash[:failure][].should == :pwnd!
+  end
+end

data/spec/maker_spec.rb

@@ -0,0 +1,411 @@
+require 'spec/spec_helper'
+
+class Article; end
+class Comment; end
+
+describe Sinatra::Hat::Maker do
+  attr_reader :model, :maker, :request
+
+  describe "initializing" do
+    it "takes a klass" do
+      proc {
+        new_maker(Article)
+      }.should_not raise_error
+    end
+    
+    it "takes options" do
+      proc {
+        new_maker(Article, :only => :index)
+      }.should_not raise_error
+    end
+    
+    it "merges options hash with defaults" do
+      maker = new_maker(Article, :only => :index)
+      maker.options[:only].should == :index
+    end
+  end
+  
+  describe "setup" do
+    before(:each) do
+      stub.instance_of(Sinatra::Hat::Router).generate(:app)
+    end
+    
+    it "stores reference to app" do
+      maker = new_maker
+      maker.setup(:app)
+      maker.app.should == :app
+    end
+  end
+  
+  it "has a klass" do
+    new_maker(Article).klass.should == Article
+  end
+  
+  describe "protect" do
+    before(:each) do
+      @maker = new_maker
+    end
+    
+    it "sets the protected actions" do
+      maker.protect :index, :show
+      maker.protect.should == [:index, :show]
+    end
+    
+    it "can set the protected actions to :all" do
+      maker.protect :all
+      maker.protect.should == maker.only
+    end
+    
+    it "can set the credentials" do
+      maker.protect :username => "admin", :password => "awesome", :realm => "awesome app"
+      maker.credentials.should == { :username => "admin", :password => "awesome", :realm => "awesome app" }
+    end
+  end
+  
+  describe "handling actions" do
+    before(:each) do
+      @request = fake_request
+      @maker = new_maker
+      stub(Sinatra::Hat::Maker.actions[:index])[:fn].returns proc { |passed_request| [self, passed_request] }
+    end
+    
+    it "takes an action and instance_exec's its event handler" do
+      mock(Sinatra::Hat::Maker.actions[:index])[:fn].returns proc { |passed_request| [self, passed_request] }
+      maker.handle(:index, request).should == [maker, request]
+    end
+    
+    context "when the action is protected" do
+      before(:each) do
+        maker.protect :index
+      end
+      
+      context "when the user is not authenticated" do
+        it "protects the action" do
+          proc {
+            maker.handle(:index, request)
+          }.should throw_symbol(:halt)
+        end
+      end
+      
+      context "when the user is authenticated" do
+        before(:each) do
+          request.env['REMOTE_USER'] = 'hello'
+        end
+        
+        it "allows the request" do
+          proc {
+            maker.handle(:index, request)
+          }.should_not throw_symbol(:halt)
+        end
+      end
+    end
+    
+    context "when the action is not part of the :only list" do
+      before(:each) do
+        maker.only :show
+      end
+      
+      it "returns 404" do
+        mock.proxy(request).error(404)
+        catch(:halt) { maker.handle(:index, request) }
+      end
+    end
+
+  end
+  
+  describe "default options" do
+    before(:each) do
+      @maker = new_maker(Article)
+    end
+    
+    it "has a default options hash" do
+      maker.options.should_not be_nil
+    end
+    
+    describe ":only" do
+      it "returns all actions" do
+        maker.options[:only].should include(:index, :show, :new, :create, :edit, :update, :destroy)
+      end
+      
+      it "is methodized" do
+        maker.only.should == maker.options[:only]
+      end
+      
+      it "has methodized setter" do
+        maker.only :index, :show
+        maker.only.should have(2).entries
+        maker.only.should include(:index)
+        maker.only.should include(:show)
+      end
+    end
+    
+    describe ":formats" do
+      it "is an empty hash" do
+        maker.options[:formats].should == { }
+      end
+      
+      it "is methodized" do
+        maker.formats.should === maker.options[:formats]
+      end
+    end
+    
+    describe ":to_param" do
+      it "is :id by default" do
+        maker.options[:to_param].should == :id
+      end
+      
+      it "is methodized" do
+        maker.to_param.should == :id
+      end
+      
+      it "has methodized setter" do
+        maker.to_param :permalink
+        maker.to_param.should == :permalink
+      end
+    end
+    
+    describe ":parent" do
+      it "is nil" do
+        maker.options[:parent].should be_nil
+      end
+      
+      it "is methodized" do
+        maker.parent.should === maker.options[:parent]
+      end
+    end
+    
+    describe ':format' do
+      it 'is nil by default' do
+        maker.options[:format].should be_nil
+        maker.options.should have_key(:format)
+      end
+      
+      it 'is methodized' do
+        maker.options[:format] = :json
+        maker.format.should == :json
+      end
+      
+      it 'has methodized setter' do
+        maker.format :json
+        maker.format.should == :json
+      end
+    end
+    
+    describe ":protect" do
+      it "is empty by default" do
+        maker.options[:protect].should be_empty
+      end
+      
+      it "is methodized" do
+        maker.protect.should === maker.options[:protect]
+      end
+      
+      it "has methodized setter" do
+        maker.protect :index, :show
+        maker.protect.should == [:index, :show]
+      end
+    end
+    
+    describe ":finder" do
+      it "finds all for the model" do
+        mock(Article).all
+        maker.options[:finder][Article, { }]
+      end
+    end
+    
+    describe ":authenticator" do
+      it "finds all for the model" do
+        mock(Article).all
+        maker.options[:finder][Article, { }]
+      end
+      
+      it "has a block setter" do
+        fn = proc { |u, p| [u, p] }
+        maker.authenticator(&fn)
+        maker.authenticator[:user, :pass].should == [:user, :pass]
+      end
+    end
+    
+    describe ":credentials" do
+      it "has username" do
+        maker.options[:credentials][:username].should_not be_nil
+      end
+      
+      it "has password" do
+        maker.options[:credentials][:password].should_not be_nil
+      end
+      
+      it "has realm" do
+        maker.options[:credentials][:realm].should_not be_nil
+      end
+    end
+    
+    describe ":record" do
+      it "loads a single record" do
+        mock(Article).find_by_id(2)
+        maker.options[:record][Article, { :id => 2 }]
+      end
+    end
+  end
+  
+  describe "finder" do
+    context "when no block is provided" do
+      it "returns the finder option" do
+        maker = new_maker
+        maker.finder.should == maker.options[:finder]
+      end
+    end
+    
+    context "when a block is provided" do
+      it "sets the finder option" do
+        maker = new_maker
+        block = proc { |model, params| model.find_by_id(params[:id]) }
+        maker.finder(&block)
+        maker.options[:finder].should == block
+      end
+    end
+  end
+  
+  describe "record" do
+    context "when no block is provided" do
+      it "returns the record option" do
+        maker = new_maker
+        maker.record.should == maker.options[:record]
+      end
+    end
+    
+    context "when a block is provided" do
+      it "sets the record option" do
+        maker = new_maker
+        block = proc { |model, params| model.find_by_id(params[:id]) }
+        maker.record(&block)
+        maker.options[:record].should == block
+      end
+    end
+  end
+  
+  describe "prefix" do
+    context "when used as a method" do
+      before(:each) do
+        @maker = new_maker(Article)
+      end
+
+      it "is a getter if called without argument" do
+        maker.prefix.should == maker.options[:prefix]
+      end
+
+      it "is a setter if called with an argument" do
+        maker.prefix 'super/heroes'
+        maker.prefix.should == 'super/heroes'
+        maker.prefix.should == maker.options[:prefix]
+      end
+    end
+
+    context "when specified as an option" do
+      it "returns the option value" do
+        new_maker(Article, :prefix => "posts").prefix.should == "posts"
+      end
+    end
+    
+    context "when it's not specified as an option" do
+      it "returns the pluralized, downcased klass name" do
+        new_maker(Article).prefix.should == "articles"
+      end
+      
+      it "snakecases" do
+        stub(klass = Class.new).name { "AwesomePerson" }
+        new_maker(klass).prefix.should == 'awesome_people'
+      end
+    end
+  end
+  
+  describe "parents" do
+    context "when there are none" do
+      it "is empty" do
+        new_maker.parents.should be_empty
+      end
+    end
+    
+    context "when there is one" do
+      it "includes the parent" do
+        parent = new_maker(Article)
+        child = new_maker(Comment, :parent => parent)
+        child.parents.should == [parent]
+      end
+    end
+    
+    context "when there are many" do
+      it "includes all ancestors" do
+        grand_parent = new_maker(Article)
+        parent = new_maker(Article, :parent => grand_parent)
+        child = new_maker(Comment, :parent => parent)
+        child.parents.should == [grand_parent, parent]
+      end
+    end
+  end
+  
+  describe "#model" do
+    it "returns an instance of Sinatra::Hat::Model" do
+      maker = new_maker
+      mock.proxy(Sinatra::Hat::Model.new(maker))
+      maker.model
+    end
+  end
+  
+  describe "#responder" do
+    it "returns an instance of Sinatra::Hat::Responder" do
+      maker = new_maker
+      mock.proxy(Sinatra::Hat::Responder.new(maker))
+      maker.responder
+    end
+  end
+  
+  describe "generating routes" do
+    it "generates routes for maker instance" do
+      maker = new_maker
+      router = Sinatra::Hat::Router.new(maker)
+      mock.proxy(Sinatra::Hat::Router).new(maker) { router }
+      mock(router).generate(maker.app)
+      maker.generate_routes!
+    end
+  end
+  
+  describe "#after" do
+    before(:each) do
+      @maker = new_maker
+    end
+    
+    it "takes the name of an action" do
+      proc {
+        maker.after(:create) { }
+      }.should_not raise_error
+    end
+    
+    it "passes a new hash mutator to the block" do
+      maker.after(:create) { |arg| arg }.should be_kind_of(Sinatra::Hat::HashMutator)
+    end
+    
+    it "lets you alter the default options" do
+      maker.after(:create) do |on|
+        on.success { :new_default! }
+      end
+      maker.responder.defaults[:create][:success][].should == :new_default!
+    end
+    
+    describe "when there are nested resources" do
+      before(:each) do
+        @child_maker = new_maker(Comment)
+        @child_maker.parent = @maker
+      end
+      
+      it "mutates the child's response" do
+        @child_maker.after(:create) do |on|
+          on.success { :child_response }
+        end
+        
+        @child_maker.responder.defaults[:create][:success][].should == :child_response
+        @maker.responder.defaults[:create][:success].should_not === @child_maker.responder.defaults[:create][:success]
+      end
+    end
+  end
+end