bradphelan-sinatras-hat 0.1.2

data/ci.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'dash-ci'
+
+CI.register('sinatras-hat') do
+  build :specs, 'spec spec/'
+  build :cucumber, 'cucumber -f progress features/'
+end
+
+CI.run('sinatras-hat', :token => ENV['DASH_TOKEN'])

data/example/app-with-auth.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/lib/common.rb'
+
+class MountedApp < Sinatra::Base
+  set :app_file, __FILE__
+  set :logging, true
+  mount(Post) do
+    protect :index,
+      :username => 'bliggety',
+      :password => 'blam',
+      :realm => "Use Protection"
+  end
+  
+  run!
+end

data/example/app-with-cache.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/lib/common.rb'
+require 'rack/cache'
+
+class MountedApp < Sinatra::Base
+  set :app_file, __FILE__
+  set :logging, true
+  
+  use Rack::Cache do
+    set :verbose, true
+    set :metastore,   'heap:/'
+    set :entitystore, 'heap:/'
+  end
+  
+  get '/' do
+    redirect '/posts'
+  end
+  
+  mount(Post) do
+    finder { |model, params| model.all }
+    record { |model, params| model.first(:id => params[:id]) }
+    
+    # Mount children as a nested resource
+    mount(Comment) do
+      finder { |model, params| model.all }
+      record { |model, params| model.first(:id => params[:id]) }
+    end
+  end
+end
+
+MountedApp.run!

data/example/app.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/lib/common.rb'
+
+class MountedApp < Sinatra::Base
+  set :app_file, __FILE__
+  set :logging, true
+  
+  get '/' do
+    "You created a post, and this is a custom response."
+  end
+  
+  mount(Post) do
+    finder { |model, params| model.all }
+    record { |model, params| model.first(:id => params[:id]) }
+    
+    # Mount children as a nested resource
+    mount(Comment) do
+      finder { |model, params| model.all }
+      record { |model, params| model.first(:id => params[:id]) }
+    end
+  end
+end
+
+MountedApp.run! if __FILE__ == $0

data/example/lib/comment.rb

@@ -0,0 +1,13 @@
+require 'dm-core'
+require 'dm-serializer'
+
+class Comment
+  include DataMapper::Resource
+  include DataMapper::Serialize
+
+  property :id, Serial, :key => true
+  property :post_id, Integer
+  property :body, Text
+  
+  belongs_to :post
+end

data/example/lib/common.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'sinatra'
+require 'lib/sinatras-hat'
+
+# Models
+require 'post'
+require 'comment'
+
+configure do
+  DataMapper.setup(:default, 'sqlite3:db.sqlite3')
+  Post.auto_migrate!
+  Comment.auto_migrate!
+  Post.create :name => 'A test', :body => "Some sort of thing"
+  new_post = Post.create :name => 'Another test', :body => "This is some other sort of thing"
+  new_post.comments.create :body => "A comment"
+end

data/example/lib/post.rb

@@ -0,0 +1,16 @@
+require 'dm-core'
+require 'dm-serializer'
+require 'dm-timestamps'
+
+class Post
+  include DataMapper::Resource
+  include DataMapper::Serialize
+
+  property :id, Serial, :key => true
+  property :name, String
+  property :body, Text
+  property :created_at, DateTime
+  property :updated_at, DateTime
+  
+  has n, :comments
+end

data/example/simple-app.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/lib/common.rb'
+
+# This is the simplest possible app
+mount(Post)

data/example/views/comments/index.erb

@@ -0,0 +1,6 @@
+<div>
+  <% @comments.each do |comment| %>
+    <h3>Comments on <a href="/posts/<%= comment.post.id %>"><%= comment.post.name %></a>:</h3>
+    <blockquote><%= comment.body %></blockquote>
+  <% end %>
+</div>

data/example/views/comments/show.erb

@@ -0,0 +1 @@
+<h1><%= @comment.body %></h1>

data/example/views/posts/index.erb

@@ -0,0 +1,8 @@
+<h1>Posts! <small><a href="/posts/new">Create one.</a></small></h1>
+<div>
+  <% @posts.each do |post| %>
+    <h1><%= post.name %></h1>
+    <p><%= post.body %></p>
+    <small><a href="/posts/<%= post.id %>">Click here to go there.</a></small>
+  <% end %>
+</div>

data/example/views/posts/new.erb

@@ -0,0 +1,11 @@
+<form action="/posts" method="post">
+  <h1>Create a new post:</h1>
+  <input type="text" name="post[name]">
+  <br>
+  <textarea name="post[body]" rows="8" cols="40"></textarea>
+  <p>
+    <input type="submit" value="Create Post!"> or 
+    <a href="/posts">Cancel</a>
+  </p>
+</form>
+

data/example/views/posts/show.erb

@@ -0,0 +1,28 @@
+<h1><%= @post.name %></h1>
+<p><%= @post.body %></p>
+
+<form action="/posts/<%= @post.id %>" method="post">
+  <input type="hidden" name="_method" value="delete">
+  <p><input type="submit" value="Delete"></p>
+</form>
+
+<div>
+  
+  <h4><a href="/posts/<%= @post.id %>/comments">Comments</a></h4>
+  <% @post.comments.each do |comment| %>
+    <blockquote>
+      <%= comment.body %> 
+      <small>
+        <a href="/posts/<%= @post.id %>/comments/<%= comment.id %>">View it.</a>
+      </small>
+    </blockquote>
+  <% end %>
+</div>
+
+<form action="/posts/<%= @post.id %>/comments" method="post">
+  <p>Leave a comment:</p>
+  <textarea name="comment[body]" rows="8" cols="40"></textarea>
+  <p><input type="submit" value="Comment! &rarr;"></p>
+</form>
+
+<small><a href="/posts">Click here to go back.</a></small>

data/features/authenticated.feature

@@ -0,0 +1,12 @@
+Feature: Protected actions
+  As a developer
+  I want to protect certain actions
+  So that I maintain privacy of my app
+
+  Scenario: A request to a protected action
+    Given a model that has a record
+    And I mount the model protecing the show action
+    When I make a GET request for that record
+    Then the status code is 401
+    When Make a GET request to the index without a format
+    Then the status code is 200

data/features/create.feature

@@ -0,0 +1,16 @@
+Feature: Generating a "create" action
+  As a developer
+  I want to generate a "create" action
+  So that I don't have to manually code it
+
+  Scenario: POSTing valid form parameters
+    Given a mounted model
+    When I make a POST request with valid form params
+    Then a record is created
+    And the response redirects to the record show page
+  
+  Scenario: POSTing invalid form parameters
+    Given a mounted model
+    When I make a POST request with invalid form params
+    Then a record is not created
+    And I should see "So, you want to create a new Person?"

data/features/destroy.feature

@@ -0,0 +1,18 @@
+Feature: Generating a "destroy" action
+  As a developer
+  I want to generate a "destroy" action
+  So that I don't have to manually code it
+
+  Scenario: Deleting a record
+    Given a model that has a record
+    And I mount the model
+    When I make a DELETE request to the path for that record
+    Then the record gets destroyed
+    And I am redirected to the index action
+  
+  Scenario: Trying to delete a non-existent record
+    Given a model that does not have a record
+    And I mount the model
+    When I make a DELETE request to a path for a non-existent record
+    Then the status code is 404
+    And the body is empty

data/features/edit.feature

@@ -0,0 +1,17 @@
+Feature: Generating an "edit" action
+  As a developer
+  I want to generate an "edit" action
+  So that I don't have to manually code it
+
+  Scenario: Getting the edit page for a record
+    Given a model that has a record
+    And I mount the model
+    When I get the edit page for that record
+    Then I should see "Editing"
+
+  Scenario: Getting the edit page for a non-existent record
+    Given a model that has a record
+    And I mount the model
+    When I get the edit page for a non-existent record
+    Then the status code is 404
+    And the body is empty

data/features/formats.feature

@@ -0,0 +1,19 @@
+Feature: Custom format handlers
+  As a developer
+  I want to provide custom format handlers
+  So that I expose data in more interesting ways
+
+  Scenario: A valid request with a custom format
+    Given a model that has a record
+    And I mount the model
+    And specify a custom 'ruby' formatter
+    When I make a GET request for that record using the 'ruby' format
+    Then the status code is 200
+    And the body is the custom serialized record
+  
+  Scenario: A request with a known format specified
+    Given a mounted model
+    And the model has some records
+    When Make a GET request to the index using the 'ruby' format
+    Then the status code is 200
+    And the result should be custom serialized

data/features/headers.feature

@@ -0,0 +1,28 @@
+Feature: Setting appropriate headers
+  In order to understand more about a response
+  As a developer
+  I want Sinatra's Hat to set useful headers
+  
+  Scenario: Setting the last_modified for show
+    Given a model that has a record
+    And I mount the model
+    When I get the show page for that record
+    Then "Last-Modified" should be the record "updated_at" time
+    
+  Scenario: Setting the etag for show
+    Given a model that has a record
+    And I mount the model
+    When I get the show page for that record
+    Then "ETag" should be set
+  
+  Scenario: Setting the last_modified for index
+    Given a model that has a record
+    And I mount the model
+    When Make a GET request to the index without a format
+    Then "Last-Modified" should be the record "updated_at" time
+
+  Scenario: Setting the etag for show
+    Given a model that has a record
+    And I mount the model
+    When Make a GET request to the index without a format
+    Then "ETag" should be set

data/features/index.feature

@@ -0,0 +1,23 @@
+Feature: Generating an "index" action
+  As a developer
+  I want to generate an "index" action
+  So that I don't have to manually code it
+
+  Scenario: A request without a format specified
+    Given a mounted model
+    And the model has some records
+    When Make a GET request to the index without a format
+    Then I should see "The people:"
+
+  Scenario: A request with a known format specified
+    Given a mounted model
+    And the model has some records
+    When Make a GET request to the index with a known format
+    Then the result should be serialized
+
+  Scenario: A request with an unknown format
+    Given a mounted model
+    And the model has some records
+    When I make a GET request to the index with an unknown format
+    Then the body is empty
+    And the status code is 406

data/features/layouts.feature

@@ -0,0 +1,11 @@
+Feature: Rendering view layouts
+  In order to reduce duplication
+  As a developer
+  I want use common layouts
+  
+  Scenario: Rendering the default layout
+    Given a mounted model
+    And the model has some records
+    When Make a GET request to the index without a format
+    Then I should see "TEH LAYOUTZ"
+    And I should see "The people:"

data/features/nested.feature

@@ -0,0 +1,20 @@
+Feature: Generating an "index" action for a child resource
+  As a developer
+  I want to generate an "index" action for a child resource
+  So that I don't have to manually code it
+
+  Scenario: Getting the template
+    Given a model that has a record
+    And the record has children
+    And I mount the model
+    When Make a GET request to the nested index without a format
+    Then the status code is 200
+    Then I should see "The nested view!"
+
+  Scenario: Requesting a valid format
+    Given a model that has a record
+    And the record has children
+    And I mount the model
+    When Make a GET request to the nested index with a valid format
+    Then the status code is 200
+    Then the body is the serialized list of children

data/features/new.feature

@@ -0,0 +1,20 @@
+Feature: Generating a "new" action
+  As a developer
+  I want to generate a "new" action
+  So that I don't have to manually code it
+
+  Scenario: Getting the new action without a format
+    Given a mounted model
+    When I get the new page for that record
+    Then I should see "So, you want to create a new Person?"
+  
+  Scenario: Getting the new action with a valid format
+    Given a mounted model
+    When I get the new action with a valid format
+    Then the body is a serialized new record
+
+  Scenario: Getting the new action with an invalid format
+    Given a mounted model
+    When I get the new action with an invalid format
+    Then the status code is 406
+    And the body is empty

data/features/only.feature

@@ -0,0 +1,13 @@
+Feature: Limiting the amount of actions defined
+  As a developer
+  I want to generate specify the actions that get generated
+  So that unnecessary actions don't get defined
+
+  Scenario: Calling only in the block
+    Given a model that has a record
+    And I mount the model for only the :index action
+    When Make a GET request to the index without a format
+    Then I should see "The people:"
+    
+    When I get the show page for that record
+    Then the status code is 404

data/features/show.feature

@@ -0,0 +1,31 @@
+Feature: Generating a "show" action
+  As a developer
+  I want to generate a "show" action
+  So that I don't have to manually code it
+
+  Scenario: A valid request without a format
+    Given a model that has a record
+    And I mount the model
+    When I get the show page for that record
+    Then I should see "The person:"
+  
+  Scenario: Trying to show a record that does not exist
+    Given a model that does not have a record
+    And I mount the model
+    When I get the show page for the non-existent record
+    Then the status code is 404
+    And the body is empty
+  
+  Scenario: A valid request with a built-in format
+    Given a model that has a record
+    And I mount the model
+    When I make a GET request for that record using the 'xml' format
+    Then the status code is 200
+    And the body is the serialized record
+    
+  Scenario: An invalid request with a format
+    Given a model that does not have a record
+    And I mount the model
+    When I get the GET request for a non-existent record with a format
+    Then the status code is 404
+    And the body is empty