kitestrings 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f8cfadafb753d3b207291378f33d28c54544695
-  data.tar.gz: 353789de7071c765b2a09134199761d43b1b2220
+  metadata.gz: e359fb5855cd726d02dd9c2a51508e1d0a3bb848
+  data.tar.gz: 2cf04623592f47430d13f1da9c0bf81f3f78c122
 SHA512:
-  metadata.gz: 8954419b577c34c1e9cf80930521ee623e01a6cd58aec11e7fd87c3b488e5da53ac8555342b1c52ec0f4a329cd14cb726df826201ed9383240451eec757ba1ce
-  data.tar.gz: a9f4038bc92af401e244105262d79bb6b138881c08090612eb542db17fb07363d2017ad86ee0c5dd7d5bcecb713521816188b05a56f27917ed483238a8d3253a
+  metadata.gz: 9b02af42e038270039c4ce945729900c9c232086708c53988221bc26f3380367c44501b3c5c4b22641df175a2fe8406f631216fc4654d7b2fd6c7602c8c5a8d5
+  data.tar.gz: fa7776a4bc5cab3baf5b54cd82f0959b3b3215b70ffad2cbe96a9308f059c03eeee76f21396d0922a2e0ff39e5d3c971f21ecb54d741a2cb772ae7c56e0ca568

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 .idea
+tmp/

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Version history:
 
+## Next
+
+* Added Kitestrings::Menu classes/modules to assist with rendering menus in web pages.
+* Added generator: kitestrings:messages to add a scaffold model and controller.
+
+## 1.0.3
+
+* Added an Access Denied page to be shown when a CanCan::AccessDenied error occurs (except in develop/test)
+* Added UAT and INTEG environments and deploy files to install generator.
+
 ## 1.0.2
 
 * Added FormObject#update to behave like persisted active record model objects.

data/kitestrings.gemspec

@@ -19,12 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rails", ">= 3.2"
-  spec.add_runtime_dependency "activemodel", ">= 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "generator_spec"
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "activerecord", ">= 3.2"
 end

data/lib/generators/kitestrings/install_generator.rb

@@ -8,12 +8,10 @@ module Kitestrings
 
       desc "Copies 2rk relevant templates to the relevant directory"
 
-      def copy_deploy
-        copy_file "deploy.rb", "config/deploy.rb"
-      end
-
-      def copy_deploy_files
-        directory "deploy", "config/deploy"
+      def copy_config_files
+        copy_file "config/deploy.rb", "config/deploy.rb"
+        directory "config/deploy", "config/deploy"
+        directory "config/environments", "config/environments"
       end
 
       def copy_haml_files
@@ -35,6 +33,28 @@ module Kitestrings
       def copy_app_view_files
         copy_file "views/application/_navigation.html.haml", "app/views/application/_navigation.html.haml"
         copy_file "views/layouts/application.html.haml", "app/views/layouts/application.html.haml"
+        copy_file "views/public/403.html", "app/views/public/403.html"
+      end
+
+      def setup_application_controller
+        inject_into_file "app/controllers/application_controller.rb", :after => /protect_from_forgery.*$/ do
+          <<-EOF
+
+
+  unless Rails.application.config.consider_all_requests_local
+    rescue_from CanCan::AccessDenied do |exception|
+      # Notify errbit if you would like to:
+      # Airbrake.notify(exception)
+      render 'public/403', status: 403, layout: 'none'
+    end
+  end
+          EOF
+        end
+      end
+
+      def setup_directories
+        empty_directory("lib/capistrano")
+        create_file("lib/capistrano/.keep")
       end
     end
   end

data/lib/generators/kitestrings/message_templates/default.text.erb

@@ -0,0 +1,7 @@
+<%- @message.subject = "Message" %>
+
+Message link: <%= @message.view_link %>
+
+
+-----------
+example.com

data/lib/generators/kitestrings/message_templates/index.html.haml

@@ -0,0 +1,26 @@
+.page-header
+  %h1 Listing messages
+
+.row
+  .col-md-12
+    %table.table.table-striped
+      %tr
+        %th.subject= sortable_title :subject
+        %th= sortable_title :sent_at
+        %th= sortable_title :user_name
+        %th Link
+        %th= sortable_title :clicked_at
+        %th= sortable_title :id
+
+      - @messages.each do |message|
+        %tr
+          %td.subject= message.user && link_to(message.subject || "(none)", user_message_path(message.user_id, message))
+          %td= l message.created_at
+          %td= message.user && link_to_if(can?(:show, message.user), message.user.try(:full_name), user_path(message.user.id))
+          %td= link_to message.link, message_path(message)
+          %td= message.clicked_at ? l(message.clicked_at) : nil
+          %td= message.id
+    %br
+
+    %p.pagination
+      = paginate @messages

data/lib/generators/kitestrings/{templates → message_templates}/message.rb.erb

@@ -9,7 +9,7 @@ class Message < ActiveRecord::Base
 <% end %>
   serialize :options
 
-  include Rails.application.routes_url_helpers
+  include Rails.application.routes.url_helpers
 
   after_create :send_email
 
@@ -41,7 +41,7 @@ class Message < ActiveRecord::Base
 
   # prepare a mail object ready for delivery by email or display on the screen
   def mail
-    @mail ||= MessageMailer.prepare_message(self, context)
+    @mail ||= MessageMailer.prepare_message(self)
   end
 
   # The "view" link. This is the link to the messages controller that marks the message
@@ -53,4 +53,21 @@ class Message < ActiveRecord::Base
   def name
     "Message ID: #{id}"
   end
+
+  def add_attachments(mailer)
+    # This is called by the mailer to add any attachments. For example:
+    # if context.is_a? CalendarEvent
+    #   mailer.attachments.inline["calendar.ics"] = context.to_ical
+    # end
+  end
+
+  # return the mail body as a string, skipping any attachment parts that may be in the message
+  def mail_body
+    if mail.multipart?
+      part = mail.parts.select { |p| p.text? && !p.attachment? }.first
+      part.body.to_s
+    else
+      mail.body.to_s
+    end
+  end
 end

data/lib/generators/kitestrings/message_templates/message_mailer.rb

@@ -0,0 +1,19 @@
+class MessageMailer < ActionMailer::Base
+  #TODO set default from address
+  default from: "noreply@example.com"
+
+  attr :subject
+
+  def prepare_message(message)
+    @message = message
+    @user = message.user
+
+    # ask the message model if we need any attachments added
+    message.add_attachments(self)
+
+    m = mail(to: message.user.email, subject: message.subject, template_name: message.template || :default)
+    # allow template to override subject in the view by doing: <% @message.subject = "new subject" %>
+    m.subject = message.subject
+    m
+  end
+end

data/lib/generators/kitestrings/message_templates/message_migration.rb

@@ -0,0 +1,20 @@
+class CreateMessages < ActiveRecord::Migration
+  def change
+    create_table :messages do |t|
+      t.references :user
+      t.string :template
+      t.string :context_type
+      t.integer :context_id
+      t.string :link
+      t.string :subject
+      t.datetime :clicked_at
+      t.datetime :sent_at
+      t.text :options
+
+      t.timestamps
+    end
+
+    add_index :messages, :user_id
+    add_index :messages, [:context_type, :context_id]
+  end
+end

data/lib/generators/kitestrings/message_templates/message_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Message do
+
+  let(:freeze_1) { Time.zone.now.change(:usec => 0) }
+
+  common_lets
+
+  context "relationships" do
+    it { should belong_to(:user) }
+    it { should belong_to(:context) }
+  end
+
+  context "validations" do
+    # validate the common_lets generated message instance:
+    it { expect(message).to be_valid }
+    it { should validate_presence_of(:user) }
+  end
+
+  describe 'latest' do
+    before do
+      Timecop.freeze(Time.local(1990)) do
+        message_other
+        message
+      end
+    end
+    it { expect(Message.latest).to match_array([message_other, message]) }
+  end
+
+  describe "#mail" do
+    # Example test for mail content:
+    # let(:message) { Message.new(template: "report_untag", context: relation, options: {foo: "bar"}, user: user_owner) }
+    # context "rendering email" do
+    #   subject { message.mail }
+    #   it { expect(subject.subject).to eq("Tag Removed Notification") }
+    #   it { expect(subject.body).to include("The following tag has just been removed") }
+    # end
+  end
+
+  describe "#view_link" do
+    subject { message }
+    it "production" do
+      Rails.application.routes.stub(:default_url_options => {:host => 'example.com'})
+      Rails.env.stub(:production? => true)
+      expect(subject.view_link).to eq("http://example.com/messages/#{message.id}")
+    end
+    it "development" do
+      expect(subject.view_link).to eq("http://localhost/messages/#{message.id}")
+    end
+  end
+
+
+  context '#send_email' do
+    context 'build only' do
+      before do
+        message.update_column(:sent_at, nil)
+        ActionMailer::Base.deliveries.clear
+        message.mail
+      end
+      it { expect(message.sent_at).to be_nil }
+      it { ActionMailer::Base.deliveries.should be_empty }
+    end
+
+    context 'build and send' do
+      before do
+        Timecop.freeze(freeze_1) { message.send_email }
+      end
+
+      it { ActionMailer::Base.deliveries.last.to.should == [user.email] }
+      it { message.sent_at.should == freeze_1 }
+    end
+  end
+end

data/lib/generators/kitestrings/message_templates/messages.rb

@@ -0,0 +1,11 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+FactoryGirl.define do
+  factory :message do
+    link "/"
+    # clicked_at nil
+    # sent_at nil
+    template "default"
+    # options nil
+  end
+end

data/lib/generators/kitestrings/message_templates/messages_controller.rb

@@ -0,0 +1,41 @@
+class MessagesController < ApplicationController
+
+  include PageAndSortHelper
+  include PageAndSortHelper::Controller
+  helper PageAndSortHelper
+
+  before_filter do
+    authenticate_user!
+    load_and_authorize_if_present :user do
+      load_and_authorize :message
+    end
+    load_and_authorize :message
+  end
+
+  def index
+    @messages =
+        case
+          when @user
+            @user.messages
+          when can?(:index_all, Message)
+            Message
+          else
+            current_user.messages
+        end
+
+    @messages = page_and_sort(@messages, default_sort: :created_at, default_direction: :desc)
+  end
+
+  # this one controller action has two totally different functions:
+  #
+  # 1. /users/1/messages/3 => show the message content
+  # 2. /messages/3 => mark the message clicked at time and redirect to the link in the message.
+  def show
+    if @user
+      # show
+    else
+      @message.update_column(:clicked_at, Time.now) if current_user == @message.user
+      redirect_to @message.link
+    end
+  end
+end

data/lib/generators/kitestrings/message_templates/messages_controller_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe MessagesController do
+  render_views
+  common_lets
+
+  before :all do
+    Fracture.define_selector :new_message_link
+    Fracture.define_selector :cancel_new_message_link
+    Fracture.define_selector :edit_message_link
+    Fracture.define_selector :cancel_edit_message_link
+  end
+
+  context 'not logged in' do
+    {index: :get, show: :get}.each do |v, m|
+      it "#{m} #{v} should logout" do
+        self.send(m, v, id: message)
+        should redirect_to new_user_session_path
+      end
+    end
+  end
+
+  context "signed in" do
+    before do
+      sign_in user
+      controller.should_receive(:authenticate_user!).and_call_original
+    end
+
+    context "GET index" do
+      context "not nested" do
+        before do
+          controller.should_receive(:authorize!).with(:index, Message)
+          message; message_other
+          get :index
+        end
+        it { should assign_to(:messages).with_items([message]) }
+        it { should render_template :index }
+        it { should have_only_fractures }
+      end
+
+      context "under user" do
+        before do
+          controller.should_receive(:authorize!).with(:show, user)
+          controller.should_receive(:authorize!).with(:index, user => Message)
+          controller.should_receive(:authorize!).with(:index, Message)
+          message; message_other
+          get :index, :user_id => user.id
+        end
+        it { should assign_to(:messages).with_items([message]) }
+        it { should render_template :index }
+        it { should have_only_fractures }
+      end
+    end
+
+    context "GET show" do
+      context "not nested" do # this is the redirect action. This link appears in the email.
+        before do
+          message.update_column :link, "/some/location"
+          Timecop.freeze(freeze_1) do
+            get :show, id: message
+          end
+        end
+
+        it { should assign_to(:message).with(message) }
+        it { should assign_to("message.clicked_at").with(freeze_1) }
+        it { should_not render_template :show }
+        it { should redirect_to("/some/location") }
+      end
+
+      # context 'not as the owner of the message' do
+      #   it { expects_access_denied { get :show, id: message_other } }
+      # end
+
+      context "under user" do
+        before do
+          controller.should_receive(:authorize!).with(:show, user)
+          controller.should_receive(:authorize!).with(:show, message)
+          get :show, user_id: user, id: message
+        end
+        it { should assign_to(:message).with(message) }
+        it { should render_template :show }
+        it { should have_only_fractures }
+      end
+    end
+  end
+end

data/lib/generators/kitestrings/message_templates/show.html.haml

@@ -0,0 +1,32 @@
+%h1 Message
+
+.row.form-horizontal
+  .col-md-1
+    %label.control-label Subject
+  .col-md-9
+    %p.form-text
+      %b= @message.subject
+.row
+  .col-md-1
+    %label.control-label Date Sent
+  .col-md-9
+    %p.form-text
+      = @message.sent_at ? l(@message.sent_at) : "(not sent)"
+.row
+  .col-md-1
+    %label.control-label Body
+  .col-md-9
+    %p
+      = simple_format(@message.mail_body)
+      -# or add the `gem "rails_autolink"` to Gemfile to detect links in the message body:
+      -#= simple_format(auto_link(@message.mail_body))
+
+-#- if @message.mail.attachments.any?
+-#  .row
+-#    .col-md-1
+-#      %label.control-label Attachments
+-#    .col-md-9
+-#      %ul
+-#        - @message.mail.attachments.each_with_index do |attachment, index|
+-#          %li
+-#            = link_to(attachment.filename, company_user_message_attachment_path(@company, @user, @message, index+1))