proclaim 0.1.0

data/app/views/proclaim/posts/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Edit post</h1>
+
+<%= render 'form' %>

data/app/views/proclaim/posts/index.html.erb

@@ -0,0 +1,30 @@
+<% if policy(Proclaim::Post).new? %>
+	<%= link_to 'New Post', new_post_path %>
+<% end %>
+
+<% if @posts.empty? %>
+	<p>No posts have been made, yet.</p>
+<% else %>
+	<% @posts.each do |post| %>
+		<h1><%= link_to post.title, post %></h1>
+		<div id = "post_<%= post.id %>">
+			<% excerpt = post.excerpt %>
+			<span class = "excerpt"><%= excerpt %></span>
+
+			<% if excerpt.length < post.body.length %>
+				. . . <%= link_to "(more)", post %>
+			<% end %>
+		</div>
+		<div class = "post_excerpt_information">
+			<div style = "float: right;">
+				<% if policy(post).edit? %>
+					<%= link_to 'Edit', edit_post_path(post) %>
+				<% end %>
+				<% if policy(post).destroy? %>
+					<%= link_to 'Delete', post, method: :delete, data: { confirm: 'Are you sure?' } %>
+				<% end %>
+			</div>
+			<%= post.author.send(Proclaim.author_name_method) %>
+		</div>
+	<% end %>
+<% end %>

data/app/views/proclaim/posts/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New post</h1>
+
+<%= render 'form' %>

data/app/views/proclaim/posts/show.html.erb

@@ -0,0 +1,46 @@
+<script type="text/javascript">
+	$(document).ready(function()
+	{
+		new CommentsHandler('div.discussion',
+		                    'div.comment',
+		                    'form.comment_form',
+		                    'form.main_comment_form',
+		                    'button.cancel_comment',
+		                    'a.reply',
+		                    'a.edit',
+		                    'a.delete',
+		                    'input.subscription_subscribe',
+		                    'div.subscription_email')
+	});
+</script>
+
+<div class = "post">
+	<h1 class = "post_title"><%= @post.title %></h1>
+
+	<div class = "post_body show">
+		<%= raw @post.body %>
+	</div>
+
+	<div class = "post_information">
+		<% if @post.published? %>
+			Written <%= timeago_tag @post.published_at, format: "%B %d, %Y" %> by
+		<% else %>
+			Draft last updated <%= timeago_tag @post.updated_at, format: "%B %d, %Y" %> by
+		<% end %>
+		<%= @post.author.send(Proclaim.author_name_method) %>
+	</div>
+
+	<h2>Comments</h2>
+
+	<div id="comments">
+		<%= comments_tree_for @post.comments.hash_tree %>
+	</div>
+
+	<% commentTemplate = @post.comments.build %>
+	<%= render partial: "proclaim/comments/form",
+		        locals: {
+		           comment: commentTemplate,
+		           target: "#comments",
+		           main: true
+		        } %>
+</div>

data/app/views/proclaim/subscription_mailer/new_comment_notification_email.html.erb

@@ -0,0 +1,11 @@
+<table class = "post">
+	<tr>
+		<td class = "post_body"><%= @comment.body %></td>
+	</tr>
+
+	<tr>
+		<td class = "post_information">
+			Written on <%= @comment.created_at.strftime("%B %d, %Y at %I:%M %p %Z") %> by <%= @comment.author %>
+		</td>
+	</tr>
+</div>

data/app/views/proclaim/subscription_mailer/new_post_notification_email.html.erb

@@ -0,0 +1,15 @@
+<table class = "post">
+	<tr>
+		<td class = "post_title"><h1><%= @post.title %></h1></td>
+	</tr>
+
+	<tr>
+		<td class = "post_body"><%= raw @post.body %></td>
+	</tr>
+
+	<tr>
+		<td class = "post_information">
+			Written on <%= @post.published_at.strftime("%B %d, %Y at %I:%M %p %Z") %> by <%= @post.author.send(Proclaim.author_name_method) %>
+		</td>
+	</tr>
+</div>

data/app/views/proclaim/subscription_mailer/welcome_email.html.erb

@@ -0,0 +1,25 @@
+<table class = "post">
+	<tr>
+		<td class = "post_title"><h1>
+			<% if @subscription.post %>
+				You'll be notified!
+			<% else %>
+				Thanks for subscribing!
+			<% end %>
+		</h1></td>
+	</tr>
+
+	<tr>
+		<td class = "post_body">
+			<% if @subscription.post %>
+				<p>
+					You signed up to be notified of any new comments on <%= link_to "this post", @subscription.post %>.
+				</p>
+			<% else %>
+				<p>
+					You'll now begin receiving a notification each time a new post is made at <%= link_to root_url.gsub(/\A.*:\/\//, '').gsub(/\A(.*?)\/*\z/, '\1'), posts_url %>.
+				</p>
+			<% end %>
+		</td>
+	</tr>
+</div>

data/app/views/proclaim/subscriptions/_form.html.erb

@@ -0,0 +1,32 @@
+<%= form_for(@subscription) do |f| %>
+  <% if @subscription.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@subscription.errors.count, "error") %> prohibited this subscription from being saved:</h2>
+
+      <ul>
+      <% @subscription.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :email %><br>
+    <%= f.text_field :email %>
+  </div>
+
+	<%
+		random_number_1 = rand(4)+1
+		random_number_2 = rand(4)+1
+	%>
+	<div class="field">
+		<%= label "antispam", "answer", "Spam bots can't do math. What is #{random_number_1} + #{random_number_2}?" %><br />
+		<%= text_field "antispam", "answer" %><br />
+		<%= hidden_field "antispam", "solution", value: random_number_1+random_number_2 %>
+	</div>
+
+  <div class="actions">
+    <%= f.submit "Subscribe" %>
+  </div>
+<% end %>

data/app/views/proclaim/subscriptions/new.html.erb

@@ -0,0 +1,8 @@
+<h1>New subscription</h1>
+
+<p>
+	Subscribe to receive each new blog post in an email as soon as it's
+	published.
+</p>
+
+<%= render 'form' %>

data/app/views/proclaim/subscriptions/subscribed.html.erb

@@ -0,0 +1,7 @@
+<p>
+	Welcome! You'll now begin receiving emails whenever a post is published on
+	this blog. You should receive a confirmation email soon, along with an
+	unsubscribe link. Not that you'll need it.
+
+	Thank you for your support!
+</p>

data/app/views/proclaim/subscriptions/unsubscribe.html.erb

@@ -0,0 +1,7 @@
+<p>
+	Are you sure you'd like to unsubscribe from this notification item? Note that
+	if you've subscribed elsewhere (e.g. other comments), you'll still receive
+	notifications for them unless you unsubscribe from them as well.
+</p>
+
+<%= link_to "Yes, unsubscribe", unsubscribe_path(@subscription.token), method: :delete %>

data/app/views/proclaim/subscriptions/unsubscribed.html.erb

@@ -0,0 +1,3 @@
+<p>
+	You have successfully unsubscribed from this item.
+</p>

data/config/routes.rb

@@ -0,0 +1,18 @@
+Proclaim::Engine.routes.draw do
+	resources :posts
+
+	resources :images, only: [:create, :destroy]
+	post 'images/cache' => 'images#cache', as: :cache_image
+	post 'images/discard' => 'images#discard', as: :discard_image
+
+	resources :comments, only: [:create, :update, :destroy]
+
+	resources :subscriptions, only: [:new, :create]
+
+	get 'subscriptions/subscribed' => 'subscriptions#subscribed', as: :subscribed
+	get 'subscriptions/unsubscribe' => 'subscriptions#unsubscribed', as: :unsubscribed
+	get 'subscriptions/unsubscribe/:token' => 'subscriptions#unsubscribe', as: :unsubscribe
+	delete 'subscriptions/unsubscribe/:token' => 'subscriptions#destroy'
+
+	root 'posts#index'
+end

data/db/migrate/20141108222616_create_proclaim_posts.rb

@@ -0,0 +1,15 @@
+class CreateProclaimPosts < ActiveRecord::Migration
+	def change
+		create_table :proclaim_posts do |t|
+			t.belongs_to :author, index: true
+
+			t.string :title, null: false, default: ""
+			t.text :body, null: false, default: ""
+
+			t.string :state, null: false, default: "draft", index: true
+
+			t.datetime :published_at
+			t.timestamps null: false
+		end
+	end
+end

data/db/migrate/20141114235359_create_proclaim_comments.rb

@@ -0,0 +1,15 @@
+class CreateProclaimComments < ActiveRecord::Migration
+	def change
+		create_table :proclaim_comments do |t|
+			t.belongs_to :post, index: true
+			t.integer :parent_id
+
+			t.string :author
+			t.text :body
+
+			t.timestamps null: false
+		end
+
+		add_foreign_key :proclaim_comments, :posts
+	end
+end

data/db/migrate/20141115022230_create_proclaim_comment_hierarchies.rb

@@ -0,0 +1,26 @@
+class CreateProclaimCommentHierarchies < ActiveRecord::Migration
+	def change
+		create_table :proclaim_comment_hierarchies, :id => false do |t|
+			# ID of the parent/grandparent/great-grandparent/etc. comments
+			t.integer  :ancestor_id, null: false
+
+			# ID of the target comment
+			t.integer  :descendant_id, null: false
+
+			# Number of generations between the ancestor and the descendant.
+			# Parent/child = 1, for example.
+			t.integer  :generations, null: false
+		end
+
+		# For "all progeny of…" and leaf selects:
+		add_index :proclaim_comment_hierarchies,
+		          [:ancestor_id, :descendant_id, :generations],
+		          :unique => true,
+		          :name => "comment_anc_desc_udx"
+
+		# For "all ancestors of…" selects,
+		add_index :proclaim_comment_hierarchies,
+		          [:descendant_id],
+		          :name => "comment_desc_idx"
+	end
+end

data/db/migrate/20141210234057_create_proclaim_subscriptions.rb

@@ -0,0 +1,17 @@
+class CreateProclaimSubscriptions < ActiveRecord::Migration
+	def change
+		create_table :proclaim_subscriptions do |t|
+			t.belongs_to :post, index: true
+			t.string :email
+
+			t.timestamps null: false
+		end
+
+		add_foreign_key :proclaim_subscriptions, :posts
+
+		# This ensures that even if two clients try to create the same
+		# subscription at exactly the same time, the database won't accept
+		# one of them (Rails would have)
+		add_index :proclaim_subscriptions, [:post_id, :email], :unique => true
+	end
+end

data/db/migrate/20141222224905_create_proclaim_images.rb

@@ -0,0 +1,12 @@
+class CreateProclaimImages < ActiveRecord::Migration
+  def change
+    create_table :proclaim_images do |t|
+      t.belongs_to :post, index: true
+      t.string :image
+
+      t.timestamps null: false
+    end
+
+    add_foreign_key :proclaim_images, :posts
+  end
+end

data/lib/generators/proclaim/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/base'
+
+module Proclaim
+	module Generators
+		class InstallGenerator < Rails::Generators::Base
+			source_root File.expand_path("../templates", __FILE__)
+
+			desc "Creates a Proclaim initializer and mounts Proclaim in routes."
+
+			def install_initializers
+				template "initialize_proclaim.rb", "config/initializers/proclaim.rb"
+			end
+
+			def mount_in_routes
+				route "mount Proclaim::Engine, at: \"/blog\""
+			end
+
+			def show_readme
+				readme "README" if behavior == :invoke
+			end
+		end
+	end
+end

data/lib/generators/proclaim/templates/README

@@ -0,0 +1,27 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure that the mailer has default URL options in each environment. Here is
+     a possible configuration for `config/environments/development.rb`:
+
+       config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+
+     In production, :host should be set to the actual host of your application.
+
+  2. Ensure you have defined root_url to *something* in your config/routes.rb.
+     For example:
+
+       root to: "home#index"
+
+  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+     For example:
+
+       <p class="notice"><%= notice %></p>
+       <p class="alert"><%= alert %></p>
+
+  4. You can copy Proclaim views (for customization) to your app by running:
+
+       rails g proclaim:views
+
+===============================================================================

data/lib/generators/proclaim/templates/initialize_proclaim.rb

@@ -0,0 +1,22 @@
+Proclaim.setup do |config|
+	# The class to which posts belong. Changing this also changes the
+	# `current_author_method` and `authentication_method`. For example, setting
+	# `author_class = "Admin"` changes the default `current_author_method` to be
+	# `:current_admin`, etc.
+	#author_class = "User"
+
+	# Method to obtain the name of the author. This should be a method on the
+	# author class.
+	#author_name_method = :name
+
+	# Method to obtain the currently-authenticated user. Should return nil if
+	# no user is currently authenticated.
+	#current_author_method = :current_user
+
+	# Method to verify that a user is authenticated, and if not, will redirect
+	# to some sort of authentication page.
+	#authentication_method = :authenticate_user!
+
+	# Maximum length for the excerpts shown on the posts index.
+	#excerpt_length = 500
+end

data/lib/generators/proclaim/views_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module Proclaim
+	module Generators
+		class ViewsGenerator < Rails::Generators::Base
+			source_root File.expand_path("../../../../app/views/proclaim", __FILE__)
+
+			desc "Copy all Proclaim views into application"
+
+			def copy_views
+				if options[:views]
+					options[:views].each do |directory|
+						directory directory.to_sym, "app/views/proclaim/#{directory}"
+					end
+				else
+					directory :comments, "app/views/proclaim/comments"
+					directory :posts, "app/views/proclaim/posts"
+					directory :subscription_mailer, "app/views/proclaim/subscription_mailer"
+					directory :subscriptions, "app/views/proclaim/subscriptions"
+				end
+			end
+		end
+	end
+end

data/lib/proclaim.rb

@@ -0,0 +1,22 @@
+require "proclaim/engine"
+
+module Proclaim
+	mattr_accessor :author_class
+	@@author_class = "User"
+
+	mattr_accessor :current_author_method
+	@@current_author_method = "current_#{@@author_class.underscore}".to_sym
+
+	mattr_accessor :author_name_method
+	@@author_name_method = :name
+
+	mattr_accessor :authentication_method
+	@@authentication_method = "authenticate_#{@@author_class.underscore}!".to_sym
+
+	mattr_accessor :excerpt_length
+	@@excerpt_length = 500 # 500 characters (won't interrupt words)
+
+	def self.setup
+		yield self
+	end
+end