outpost-cms 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c9cd74072ad0fa1a8984e87e473b45a7279eb8d
-  data.tar.gz: e5f9937a7b34e095fc055ea4a49225e0ada5a7f3
+  metadata.gz: 7ce97adc9d0450c98c8798c59f0c11de677a0d36
+  data.tar.gz: 736e9d336fdf5bfbdec6dd19c165e82092c406da
 SHA512:
-  metadata.gz: 477424d6cc1b69199e68b204e7834823a8ca8723be2d258b3b0b5c989416a550bb8771d1a6d044a068c0a02e2d09bd43e5b67fe5923df512856dad672947e4a8
-  data.tar.gz: 2d1a39fd30466b412fd26843e5e27e30d74afc43d78bb6cd0466d5628b30a6445f784357dda649e462638dc7583eb0252b4e59c2c9a9b0d3d0ae17046b153c61
+  metadata.gz: 425816b1d2cf23091744e7be3349b5dcf0849dcf072321d6cef62599f6da6bf9119c39b6174f5424fdc1b2c60ef75f962a744f8d0d0b2fb4439009a0ee27c6ba
+  data.tar.gz: 8877ae325754f8c33c877fcc63b5f53ebd2e2cc4665e91c9e1be3d1c3ad08a0cd0d5d9f6d2111ce58dcbb2cd85c76e4e579ba882e6181a8bdb6d787f2bb442b1

data/README.md

@@ -65,15 +65,7 @@ end
 
 ### Authentication
 Much like Devise, Outpost provides a basic `SessionsController` and
-corresponding views. To use these, just add them to your routes:
-
-```ruby
-namespace :outpost do
-  resources :sessions, only: [:create, :destroy]
-  get 'login'  => "sessions#new", as: :login
-  get 'logout' => "sessions#destroy", as: :logout
-end
-```
+corresponding views. Their routes are part of the `Outpost::Engine` routes.
 
 Outpost also provides the `Outpost::Model::Authentication` module,
 which you should include into your User model to work with the provided
@@ -108,20 +100,29 @@ end
 
 ##### Routes
 
-Note that this gem doesn't provide any routes for you. It is expected that you'll want to use the path globbing to render Outpost-style 404's inside of Outpost (rather than your application's 404 page), so it gets too messy and complicated to try to combine your routes with path globbing.
-
-You'll want to put this at the bottom of your `outpost` namespace in your routes:
+Mount Outpost's routes outside of your `outpost` namespace. Your custom-defined namespace will be mostly for defining resources. You can also add a catch-all route (see example) at the very bottom of the namespace to use outpost-specific 404 pages. If you don't add this line, then 404 pages in the `/outpost` namespace will render your app's normal 404 page.
 
 ```ruby
-root to: 'home#dashboard'
+Rails.application.routes.draw do
+  # ...
+
+  mount Outpost::Engine, at: "outpost"
 
-resources :sessions, only: [:create, :destroy]
-get 'login'  => "sessions#new", as: :login
-get 'logout' => "sessions#destroy", as: :logout
+  namespace :outpost do
+    resources :posts
 
-get "*path" => 'errors#not_found'
+    # Add outpost-specific 404 pages.
+    # This must be at the very bottom of the namespace.
+    get "*path" => 'errors#not_found'
+  end
+end
 ```
 
+This mount provides a few routes:
+* `outpost.root_path` - The path to the dashboard.
+* `outpost.login_path` - Login
+* `outpost.logout_path` - Logout
+
 
 ### Authorization
 Outpost comes with a built-in `Permission` model, whose only attribute is
@@ -152,7 +153,7 @@ method:
 
 ```ruby
 if !current_user.can_manage?(Post)
-  redirect_to outpost_root_path, alert: "Not Authorized"
+  redirect_to outpost.root_path, alert: "Not Authorized"
 end
 ```
 

data/app/controllers/outpost/application_controller.rb

@@ -10,10 +10,22 @@ module Outpost
     before_filter :root_breadcrumb
     before_filter :set_sections
 
+
+    private
+
+    #----------------------
+    # This method was originally introduced to get around
+    # a kaminari bug: https://github.com/amatsuda/kaminari/issues/457
+    # But it could stick around and be useful anyways.
+    def route_proxy
+      nil
+    end
+    helper_method :route_proxy
+
     #------------------------
     # Always want to add this link to the Breadcrumbs
     def root_breadcrumb
-      breadcrumb "Outpost", outpost_root_path
+      breadcrumb "Outpost", outpost.root_path
     end
 
     #----------------------
@@ -22,8 +34,6 @@ module Outpost
       @sections = {}
     end
 
-    #----------------------
-
     def with_rollback(object)
       object.transaction do
         yield if block_given?

data/app/controllers/outpost/base_controller.rb

@@ -1,3 +1,2 @@
 class Outpost::BaseController < Outpost::ApplicationController
-  include Outpost::Controller::CustomErrors
 end

data/app/controllers/outpost/home_controller.rb

@@ -1,2 +1,5 @@
 class Outpost::HomeController < Outpost::BaseController
+  def dashboard
+    # Overwrite me
+  end
 end

data/app/controllers/outpost/sessions_controller.rb

@@ -6,7 +6,7 @@ module Outpost
     respond_to :html
 
     def new
-      redirect_to outpost_root_path if current_user
+      redirect_to outpost.root_path if current_user
     end
 
     def create
@@ -16,7 +16,7 @@ module Outpost
         session[:user_id] = user.id
         user.update_column(:last_login, Time.now)
 
-        redirect_to session[:return_to] || outpost_root_path,
+        redirect_to session[:return_to] || outpost.root_path,
           notice: "Logged in."
 
         session[:return_to] = nil
@@ -29,7 +29,7 @@ module Outpost
     def destroy
       @current_user = nil
       session[:user_id] = nil
-      redirect_to outpost_login_path, notice: "Logged Out."
+      redirect_to outpost.login_path, notice: "Logged Out."
     end
 
     private

data/app/models/permission.rb

@@ -1,6 +1,4 @@
 class Permission < ActiveRecord::Base
-  outpost_model
-
   #-------------------
   # Association
   has_many :user_permissions

data/app/views/layouts/outpost/application.html.erb

@@ -14,7 +14,7 @@
 <div class="navbar navbar-fixed-top navbar-inverse">
   <div class="navbar-inner">
     <div class="container">
-      <a href="<%=outpost_root_path%>" class="brand"><%= image_tag "outpost/logo.png" %></a>
+      <a href="<%=outpost.root_path%>" class="brand"><%= image_tag "outpost/logo.png" %></a>
 
       <% if current_user %>
         <ul class="nav">
@@ -57,13 +57,13 @@
           <li class="dropdown">
             <a href="#" class="dropdown-toggle" data-toggle="dropdown"><i class='icon-user icon-white'></i> <%= current_user.name %> <b class="caret"></b></a>
             <ul class="dropdown-menu">
-              <li><%= link_to "Logout", outpost_logout_path, id: "logout" %></li>
+              <li><%= link_to "Logout", outpost.logout_path, id: "logout" %></li>
             </ul>
           </li>
         </ul>
       <% else %>
         <ul class="nav pull-right">
-          <li><%= link_to "Login", outpost_login_path %></li>
+          <li><%= link_to "Login", outpost.login_path %></li>
         </ul>
       <% end %>
     </div>

data/app/views/layouts/outpost/minimal.html.erb

@@ -13,7 +13,7 @@
   <div class="navbar navbar-fixed-top navbar-inverse">
   <div class="navbar-inner">
     <div class="container-fluid">
-      <a href="<%=outpost_root_path%>" class="brand">Outpost</a>
+      <a href="<%=outpost.root_path%>" class="brand">Outpost</a>
     </div>
   </div>
 </div>

data/app/views/outpost/sessions/new.html.erb

@@ -1,6 +1,6 @@
 <% add_to_page_title "Login" %>
 
-<%= form_tag outpost_sessions_path, id: "login" do %>
+<%= form_tag outpost.sessions_path, id: "login" do %>
   <fieldset>
     <legend>Login</legend>
     <%= label_tag @authentication_attribute %>

data/app/views/outpost/shared/_pagination.html.erb

@@ -1,2 +1,2 @@
-<%= paginate records, theme: 'bootstrap', window: 3, left: 1, right: 2 %>
+<%= paginate records, theme: 'bootstrap', route_proxy: route_proxy, window: 3, left: 1, right: 2 %>
 <strong><%= records.size %> records on this page</strong>

data/config/initializers/kaminari_route_proxy_hack.rb

@@ -0,0 +1,18 @@
+# https://github.com/amatsuda/kaminari/issues/457
+module Kaminari
+  module Helpers
+    class Tag
+      def page_url_for(page)
+        t = @options[:route_proxy] || @template
+
+        # master 0.15.1 changed this method from 0.15.1 release in
+        # 544acb4deb8dd9b9f369553b4af4d0eee788e40f
+        if respond_to?(:params_for)
+          t.url_for params_for(page).merge(:only_path => true)
+        else
+          t.url_for @params.merge(@param_name => (page <= 1 ? nil : page))
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,4 +1,7 @@
-Rails.application.routes.draw do
-  namespace :outpost do
-  end
+Outpost::Engine.routes.draw do
+  post 'sessions' => 'outpost/sessions#create'
+  get 'login'  => "outpost/sessions#new", as: :login
+  get 'logout' => "outpost/sessions#destroy", as: :logout
+
+  root to: 'outpost/home#dashboard'
 end

data/lib/outpost/controller/authentication.rb

@@ -27,7 +27,7 @@ module Outpost
       def require_login
         if !current_user
           session[:return_to] = request.fullpath
-          redirect_to outpost_login_path and return false
+          redirect_to outpost.login_path and return false
         end
       end
     end # Authentication

data/lib/outpost/controller/authorization.rb

@@ -19,7 +19,7 @@ module Outpost
 
       # What to do when a user doesn't have proper permissions
       def handle_unauthorized(resource)
-        redirect_to outpost_root_path,
+        redirect_to outpost.root_path,
           alert: "You don't have permission to manage " \
                  "#{resource.to_title.pluralize}"
         return false

data/lib/outpost/controller/custom_errors.rb

@@ -22,9 +22,12 @@ module Outpost
           with: ->(e) { render_error(404, e) and return false }
       end
 
-      #----------------------
 
-      def render_error(status, e=StandardError)
+      private
+
+      # We don't want this to be considered an action method,
+      # so it's private
+      def render_error(status, e=StandardError, template_prefix="outpost/")
         response.status = status
 
         if Rails.application.config.consider_all_requests_local
@@ -33,8 +36,8 @@ module Outpost
           respond_to do |format|
             format.html do
               render(
-                :template   => "/errors/error_#{status}",
-                :layout     => "application",
+                :template   => "#{template_prefix}errors/error_#{status}",
+                :layout     => "#{template_prefix}application",
                 :status     => status,
                 :locals     => { error: e }
               )

data/lib/outpost/engine.rb

@@ -1,5 +1,7 @@
 module Outpost
   class Engine < ::Rails::Engine
+    engine_name "outpost"
+
     config.generators do |g|
       g.test_framework :rspec, fixture: false
       g.fixture_replacement :factory_girl, dir: "spec/factories"

data/lib/outpost/version.rb

@@ -1,3 +1,3 @@
 module Outpost
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/controllers/authentication_spec.rb

@@ -55,7 +55,7 @@ describe Outpost::PeopleController do
       end
 
       it "redirects to login path if current_user is false" do
-        controller.response.should redirect_to outpost_login_path
+        controller.response.should redirect_to outpost.login_path
       end
     end
   end

data/spec/controllers/sessions_controller_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Outpost::SessionsController do
-  # -------------------------
+  routes { Outpost::Engine.routes }
 
   describe "GET /new" do
     it "returns success and renders new template if current_user false" do
@@ -14,7 +14,7 @@ describe Outpost::SessionsController do
     it "redirects to home page if current_user if set" do
       controller.stub(:current_user) { create :user }
       get :new
-      response.should redirect_to outpost_root_path
+      response.should redirect_to outpost.root_path
     end
   end
 
@@ -47,7 +47,7 @@ describe Outpost::SessionsController do
       end
 
       it "redirects to admin root" do
-        controller.response.should redirect_to outpost_root_path
+        controller.response.should redirect_to outpost.root_path
       end
 
       it "sets the flash" do
@@ -71,7 +71,7 @@ describe Outpost::SessionsController do
 
   # -------------------------
 
-  describe "DELETE /destroy" do
+  describe "GET /destroy" do
     let(:user) { create :user }
 
     it "unsets @current_user" do
@@ -88,7 +88,7 @@ describe Outpost::SessionsController do
 
     it "redirects to login page" do
       get :destroy
-      controller.response.should redirect_to outpost_login_path
+      controller.response.should redirect_to outpost.login_path
     end
 
     it "sets the flash" do

data/spec/features/authentication_spec.rb

@@ -4,7 +4,7 @@ describe 'authentication' do
   context 'not logged in' do
     it 'redirects to login path' do
       visit outpost_people_path
-      current_path.should eq outpost_login_path
+      current_path.should eq outpost.login_path
     end
   end
 
@@ -15,7 +15,7 @@ describe 'authentication' do
         :password                 => "secret",
         :password_confirmation    => "secret"
 
-      visit outpost_login_path
+      visit outpost.login_path
     end
 
     context 'incorrect login information' do
@@ -24,7 +24,7 @@ describe 'authentication' do
         fill_in "password", with: "secret"
         click_button "Submit"
 
-        current_path.should eq outpost_sessions_path
+        current_path.should eq outpost.sessions_path
         page.should have_css ".alert-error"
       end
     end
@@ -35,7 +35,7 @@ describe 'authentication' do
         fill_in "password", with: "secret"
         click_button "Submit"
 
-        current_path.should eq outpost_root_path
+        current_path.should eq outpost.root_path
         page.should have_css ".alert-success"
       end
     end

data/spec/features/authorization_spec.rb

@@ -8,7 +8,7 @@ describe 'authorization' do
 
     it 'redirects to the dashboard' do
       visit outpost_people_path
-      current_path.should eq outpost_root_path
+      current_path.should eq outpost.root_path
       page.should have_css ".alert-error"
       page.should have_content "You don't have permission"
     end

data/spec/internal/config/routes.rb

@@ -2,15 +2,10 @@ Rails.application.routes.draw do
   get '/people'       => 'people#index', as: :people
   get '/people/:id'   => 'people#show',  as: :person
 
+  mount Outpost::Engine, at: 'outpost'
+
   namespace :outpost do
     resources :people
-
-    root to: 'home#dashboard'
-
-    resources :sessions, only: [:create, :destroy]
-    get 'login'  => "sessions#new", as: :login
-    get 'logout' => "sessions#destroy", as: :logout
-
     get "*path" => 'errors#not_found'
   end
 end