nightlight 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1caf1cc8adbb6c0ea6d5188eeff9c1f03d245f7d
-  data.tar.gz: 8981ae37e69dfa27501f979f94c45d29791a303c
+  metadata.gz: 2bb3cd1cd8137453589cf7d5ea5abb33cbc24b22
+  data.tar.gz: 2db2bb4da64d15f3745cef25033f920d33634fb8
 SHA512:
-  metadata.gz: ecf5aa3b1da5be86c50855c377cdf0bb2e52634ffd81280862448f10b92a59c77e98abebbb785d5c51f7a10c6664d63ee32d4cadec2a95cd2e591bbf966bd69f
-  data.tar.gz: 62767315fe6f34688dadeb5fc5b002f3a06d3ba525c2c051fe318002aa2fecf6dcad230b0c88cbf83fd56ea9c3a4edd2056e7bdc04a9c639d3f0124abaa39b07
+  metadata.gz: ddb80147493befe0b7bf2a7b61ab8ffdd3efd3d85d0f55c40ad6acee24cd0154fccec91eca46c360ffdaa63b3488a5c546ff771e3dbc3e074f564ea20280c5b8
+  data.tar.gz: 2a9655cce8c3d3e57caa5ac1fb3a6bac3d4a2583bacdfa4bea4c5c7d47dd3d5b0c2ad3b5a07ee5b74479e27b58ee27079686983f4c0923cbd7c9ba8e5776ec05

data/README.md

@@ -2,10 +2,26 @@
 
 Shed light on the dark corners of your app
 
-Nightlight helps you make sure all pages in your app are getting the love and attention they deserve
+Nightlight is an admin interface for tracking what pages are (not) being checked by your team
 
 Inspired by [Cap Watkins](https://twitter.com/cap)' [The Dark Corners of Your UI](http://blog.capwatkins.com/dark-corners)
 
+## Features
+
+- Indicate when you've checked a page and leave a comment (all good? bugs? link to Trello card?)
+- See what pages haven't been checked in a while
+- Sync with `GET` routes from `config/routes.rb`, or maintain your own list of pages
+- Assign pages to yourself to check, and see who's already checking what
+- Get a random page to check that nobody else is checking
+
+## Benefits
+
+- Keep fresh eyes on pages you don't see very often (onboarding, edge cases)
+- Discover things your automated tests aren't catching (CSS bugs, typos, bad impressions, forgot-to-update-that-too's)
+- Discover things that user feedback isn't catching
+- Improve product quality and internal product awareness (each person check a random page every day?)
+- Share page-level meta info across a team (useful notes, gotchyas, how-to's, please-don't's)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -56,7 +72,7 @@ authenticate :user, lambda{|user| user.admin? } do
 end
 ```
 
-### Credit
+## Credit
 
 Inspired by:
 - [Cap Watkins](https://twitter.com/cap)' [The Dark Corners of Your UI](http://blog.capwatkins.com/dark-corners)

data/app/assets/stylesheets/nightlight/application.css

@@ -7,6 +7,7 @@
 
 body {
   padding-top: 30px;
+  padding-bottom: 100px;
 }
 
 table tr td {

data/app/controllers/nightlight/activities_controller.rb

@@ -1,11 +1,12 @@
 module Nightlight
   class ActivitiesController < BaseController
 
+    before_action :enforce_current_user, only: [:create]
     before_action :set_page
 
     def create
       @status = @page.activities.status.new activity_params
-      @status.user = current_user if respond_to?(:current_user)
+      @status.user = current_user
       if @status.save
         flash[:success] = "Status updated."
         redirect_to page_url(@page)

data/app/controllers/nightlight/base_controller.rb

@@ -12,5 +12,14 @@ module Nightlight
     end
 
     layout "nightlight/application"
+
+    private
+
+    def enforce_current_user
+      unless respond_to?(:current_user) && current_user
+        flash[:error] = "This feature requires a logged in user."
+        redirect_to root_url
+      end
+    end
   end
 end

data/app/controllers/nightlight/pages_controller.rb

@@ -1,5 +1,7 @@
 module Nightlight
   class PagesController < BaseController
+
+    before_action :enforce_current_user, only: [:edit, :update, :new, :create, :destroy, :assign, :unassign, :checked, :add_yes, :add_no, :random]
     before_action :set_page, only: [:show, :edit, :update, :destroy, :assign, :unassign, :checked]
     before_action :authorize_assignee, only: [:unassign]
 
@@ -8,7 +10,8 @@ module Nightlight
       @new_pages = routes_pages.select do |r|
         Nightlight::Page.where(path: r[:path]).none?
       end
-      if params[:hidden]
+
+      if params[:all]
         @hidden_pages = Nightlight::Page.hidden
       end
     end
@@ -45,21 +48,31 @@ module Nightlight
       end
     end
 
+    def destroy
+      @page.destroy
+      flash[:success] = "Page deleted."
+      redirect_to root_url
+    end
+
     def add_yes
       @page = Page.new page_params
-      @page.save
-      respond_to do |format|
-        format.js { render 'nightlight/pages/add' }
+      if @page.save
+        flash[:success] = "Page added."
+      else
+        flash[:error] = @page.errors.full_messages.first
       end
+      redirect_to root_url
     end
 
     def add_no
       @page = Page.new page_params
       @page.hidden = true
-      @page.save
-      respond_to do |format|
-        format.js { render 'nightlight/pages/add' }
+      if @page.save
+        flash[:success] = "Settings saved."
+      else
+        flash[:error] = @page.errors.full_messages.first
       end
+      redirect_to root_url
     end
 
     def assign
@@ -110,8 +123,8 @@ module Nightlight
       all_routes = Rails.application.routes.routes
       require 'action_dispatch/routing/inspector'
       inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
-      routes = inspector.send(:collect_routes, all_routes)
-      routes.select{|r| r[:verb]=="GET" }
+      routes = inspector.send(:collect_routes, all_routes).dup
+      routes.select{|route| route.tap{|r| r[:path] = r[:path].sub(/\(\.:format\)$/,'') }[:verb]=="GET" }
     end
 
     def set_page

data/app/helpers/nightlight/pages_helper.rb

@@ -2,13 +2,16 @@ module Nightlight
   module PagesHelper
 
     def avg_page_brightness pages
-      avg = pages.map(&:brightness).sum.to_f / pages.size.to_f
-      avg.to_i
+      if pages.any?
+        avg = pages.map(&:brightness).sum.to_f / pages.size.to_f
+        avg.to_i
+      else
+        0
+      end
     end
 
     def link_to_page page
       path = page.sample_path.presence || page.path
-      path = path.sub(/\(\.:format\)$/,'')
       link_to page.path, path, target: '_blank'
     end
 

data/app/models/nightlight/page.rb

@@ -10,7 +10,11 @@ module Nightlight
     scope :unassigned, ->{ where assignee_id: nil }
 
     def to_param
-      [id, name.gsub("'", "").parameterize].join("-")
+      if name.present?
+        [id, name.gsub("'", "").parameterize].join("-")
+      else
+        id
+      end
     end
 
     def brightness

data/app/views/layouts/nightlight/_alert.html.erb

@@ -1,11 +1,16 @@
 <%- success = success || flash[:success] %>
 <%- error = error || flash[:error] %>
+<%- notice = notice || flash[:notice] %>
 <% if success %>
-  <div class="alert alert-success">
+  <div class="alert alert-success text-center">
     <%= success %>
   </div>
 <% elsif error %>
-  <div class="alert alert-danger">
+  <div class="alert alert-danger text-center">
     <%= error %>
   </div>
+<% elsif notice %>
+  <div class="alert alert-warning text-center">
+    <%= notice %>
+  </div>
 <% end %>

data/app/views/nightlight/pages/_pages.html.erb

@@ -22,7 +22,7 @@
             <%= last_checked_at page %>
           </td>
           <td>
-            <% if page.assignee && page.assignee==current_user %>
+            <% if page.assignee && respond_to?(:current_user) && page.assignee==current_user %>
               <%= link_to 'You', page_path(page), class: 'btn btn-primary btn-xs' %>
             <% elsif page.assignee %>
               <%= link_to page.assignee.name, page_path(page), class: 'btn btn-warning btn-xs' %>

data/app/views/nightlight/pages/edit.html.erb

@@ -15,3 +15,5 @@
 </div>
 
 <%= render 'nightlight/pages/form' %>
+
+<%= link_to 'Delete this page', page_path(@page), data: {method: :delete, confirm: "Are you sure?"}, class: 'text-danger pull-right' %>

data/app/views/nightlight/pages/index.html.erb

@@ -1,14 +1,20 @@
 <div class="clearfix" style="margin-bottom:20px">
   <div class="pull-right">
     <%= link_to "New Page", new_page_path, class: 'btn btn-default' %>
-    <%= link_to "Check Random Page", random_pages_path, class: 'btn btn-primary', data: {method: :post} %>
+    <%= link_to "Check Random Page", random_pages_path, class: "btn btn-primary #{'disabled' unless @pages.any?}", data: {method: :post} %>
   </div>
   <h3 style="margin:0"><%= render 'nightlight/pages/brightness', brightness: avg_page_brightness(@pages) %></h3>
 </div>
 
+<% if @pages.empty? %>
+  <div class="alert alert-success text-center">
+    Welcome! <code>GET</code> routes in your <code>config/routes.rb</code> can be imported below. You can also register pages manually by clicking <strong>New Page</strong>.
+  </div>
+<% end %>
+
 <% if @new_pages.any? %>
   <div class="panel panel-warning">
-    <div class="panel-heading" style="text-align:center">New pages found</div>
+    <div class="panel-heading" style="text-align:center">New <code>GET</code> routes found in <code>config/routes.rb</code>:</div>
     <div class="panel-body">
       <table class="table">
         <thead>
@@ -27,8 +33,8 @@
               <td><%= page[:path] %></td>
               <td><%= page[:reqs] %></td>
               <td>
-                <%= link_to 'Yes', add_yes_pages_path(page: {name: page[:name], path: page[:path], reqs: page[:reqs]}), class: 'btn btn-default btn-xs', data: {remote: true, method: :post} %>
-                <%= link_to 'No', add_no_pages_path(page: {name: page[:name], path: page[:path], reqs: page[:reqs]}), class: 'btn btn-default btn-xs', data: {remote: true, method: :post} %>
+                <%= link_to 'Yes', add_yes_pages_path(page: {name: page[:name], path: page[:path], reqs: page[:reqs]}), class: 'btn btn-default btn-xs', data: {method: :post} %>
+                <%= link_to 'No', add_no_pages_path(page: {name: page[:name], path: page[:path], reqs: page[:reqs]}), class: 'btn btn-default btn-xs', data: {method: :post} %>
               </td>
             </tr>
           <% end %>
@@ -36,15 +42,27 @@
       </table>
     </div>
   </div>
+<% elsif @pages.empty? %>
+  <div class="alert alert-warning text-center">
+    No <code>GET</code> routes found in <code>config/routes.rb</code>.
+  </div>
 <% end %>
 
 <h2>Pages</h2>
-<%= render 'nightlight/pages/pages', pages: @pages %>
+<% if @pages.any? %>
+  <%= render 'nightlight/pages/pages', pages: @pages %>
+<% else %>
+  <p class="text-muted">There are no pages.</p>
+<% end %>
 
-<% if @hidden_pages %>
-  <h2 id="hidden">Hidden Pages</h2>
-  <%= render 'nightlight/pages/pages', pages: @hidden_pages, hidden: true %>
+<% if params[:all] %>
+  <h4 id="hidden">Hidden Pages</h4>
+  <% if @hidden_pages.any? %>
+    <%= render 'nightlight/pages/pages', pages: @hidden_pages, hidden: true %>
+  <% else %>
+    <p class="text-muted">There are no hidden pages.</p>
+  <% end %>
 <% else %>
-  <%= link_to "Show hidden pages", pages_path(hidden: true, anchor: 'hidden') %>
+  <%= link_to "Show all pages", pages_path(all: true) %>
 <% end %>
 

data/app/views/nightlight/pages/show.html.erb

@@ -25,7 +25,7 @@
 
 <div class="well text-center">
 <% if @page.assignee %>
-  <% if @page.assignee == current_user %>
+  <% if respond_to?(:current_user) && @page.assignee == current_user %>
     <h3 style="margin-top:0">You are checking this</h3>
     <%= link_to "Done!", checked_page_path(@page), class: 'btn btn-primary btn-lg', data: {method: :post} %>
     <br/>

data/lib/nightlight/version.rb

@@ -1,3 +1,3 @@
 module Nightlight
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nightlight
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Benjamin Sullivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,7 +88,6 @@ files:
 - app/views/nightlight/pages/_brightness.html.erb
 - app/views/nightlight/pages/_form.html.erb
 - app/views/nightlight/pages/_pages.html.erb
-- app/views/nightlight/pages/add.js.erb
 - app/views/nightlight/pages/edit.html.erb
 - app/views/nightlight/pages/index.html.erb
 - app/views/nightlight/pages/new.html.erb

data/app/views/nightlight/pages/add.js.erb

@@ -1,13 +0,0 @@
-<% if @page.valid? %>
-
-var html = "<%= j(render('layouts/nightlight/alert', success: "Settings saved.")) %>";
-$('#alerts').html(html);
-var path = "<%= j(@page.path) %>";
-$('.new-page[data-path="'+path+'"]').remove();
-
-<% else %>
-
-var html = "<%= j(render('layouts/nightlight/alert', error: @page.errors.full_messages.first)) %>";
-$('#alerts').html(html);
-
-<% end %>