proclaim 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0f15c61f1b99a6e97b251a74c3233913721399a
-  data.tar.gz: 751fd7ef30e2f38397609d1b3756d3978474f6af
+  metadata.gz: c1e6549a58e1a47ce579008b2d534d4094dfe7fe
+  data.tar.gz: b4b007bbaffb2eb80fca51e5768900ba24bd3d3d
 SHA512:
-  metadata.gz: 43a8addf7c33f5df9468f13ac60659bacb16350c8faa48ea962111d3b74700fe99cacc0135722b29fc6f37401be93479c75b90d0403f912eec4aa381ef531fbe
-  data.tar.gz: 290d84b31deede29569534d5b49f176b3d7b10c2e55438d6f68233e8ed2c8f5480e27c9b3fdd7f7f57d327e827641ac64927d329161309902e11bd44f1cf83f5
+  metadata.gz: 1c79facd228f95e64482ddfb9b0e425059b459f98d239971f03a3608865ba06e198d0dfd09903c3d3bc8481114eed977fe2fda6a70e11e4e7fdd13c6e90ccbdf
+  data.tar.gz: 1189d9a314ebe3a711bc98b1dd297ae57e25feaadba6722dd8fa1790a479ab8c46f93addc6b5061d33e2323b4dc941a29638af3393a4d864bcccd220ee6f9dc7

data/CHANGELOG

@@ -1,3 +1,10 @@
+v 0.2.0
+  - Added ability to alter the buttons shown on editor toolbar
+  - Upgraded to Medium Editor 2.0.0
+  - Fix image toolbar's missing icons in production
+  - Edit/Delete buttons on post show page
+  - Posts ordered by publication date
+
 v 0.1.3
   - Fixed incorrect foreign keys
 

data/README.md

@@ -8,19 +8,15 @@ where you want it, configure it, and you have a blog. It otherwise stays out of
 your way.
 
 Proclaim stays minimal by making use of HTML5's contenteditable attribute. It
-also uses the
-[Medium Editor clone](https://github.com/daviferreira/medium-editor) by Davi
-Ferreira, in concert with Pavel Linkesch's
-[Image Insert plugin](https://github.com/orthes/medium-editor-insert-plugin)
-tied to CarrierWave for image uploads.
+also uses the [Medium Editor clone][1] by Davi Ferreira, in concert with Pavel
+Linkesch's [Image Insert plugin][2] tied to CarrierWave for image uploads.
 
 Proclaim doesn't include any users or authentication. It was made to be able to
 work with whatever setup you're using. All that it requires is that your
-application _has_ users and authentication
-([Devise](https://github.com/plataformatec/devise) is recommended). In Proclaim
-0.1, authentication is also used as authorization. If a user is logged in, it
-can create/publish/edit/delete posts and edit/delete comments. If no user is
-logged in, it can only read posts and create comments.
+application _has_ users and authentication ([Devise][3] is recommended). In
+Proclaim 0.1, authentication is also used as authorization. If a user is logged
+in, it can create/publish/edit/delete posts and edit/delete comments. If no user
+is logged in, it can only read posts and create comments.
 
 More information about configuring Proclaim for your specific authentication
 scheme is given below.
@@ -32,7 +28,7 @@ scheme is given below.
 Proclaim 0.1 works with Rails 4.2 and on. Add it to your Gemfile with:
 
 ```ruby
-gem 'proclaim', "~> 0.1.3"
+gem 'proclaim', "~> 0.2.0"
 ```
 
 Run `bundle install` to install it.
@@ -108,6 +104,7 @@ Proclaim.author_name_method = :name
 Proclaim.current_author_method = :current_user
 Proclaim.authentication_method = :authenticate_user!
 Proclaim.excerpt_length = 500
+Proclaim.editor_toolbar_buttons = ['bold', 'italic', 'underline', 'anchor', 'header1', 'header2', 'quote']
 ```
 
 - **Proclaim.author_class**
@@ -137,6 +134,11 @@ Proclaim.excerpt_length = 500
   Maximum length for the excerpts shown on the posts index. The excerpts may be
   less than this, but will never exceed it.
 
+- **Proclaim.editor_toolbar_buttons**
+
+  The buttons to be displayed on the Medium Editor toolbar. For a full list of
+  options, see the README for [that project][1].
+
 Astute readers may note that the defaults corresponds to defaults from Devise (on
 the User class). If that's not your setup, all of these options can be changed
 in the initializer installed by `rails generate proclaim:install`.
@@ -154,3 +156,7 @@ application and alter them by using the generator:
 ```ruby
 rails generate proclaim:views
 ```
+
+[1]: https://github.com/daviferreira/medium-editor  "Medium Editor Clone"
+[2]: https://github.com/orthes/medium-editor-insert-plugin "Image Insert plugin"
+[3]: https://github.com/plataformatec/devise "Devise"

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/app/assets/javascripts/proclaim.js

@@ -13,6 +13,6 @@
 //= require jquery
 //= require jquery_ujs
 //= require medium-editor
-//= require medium-editor-insert-plugin.all.min
+//= require medium-editor-insert-plugin.all
 //= require rails-timeago
 //= require_tree .

data/app/assets/javascripts/proclaim/editor.js.coffee

@@ -1,6 +1,6 @@
 class Editor
 	constructor: (@form, @titleFormField, @titleEditableItem,
-	              @bodyFormField, @bodyEditableItem) ->
+	              @bodyFormField, @bodyEditableItem, @toolbarButtons) ->
 		if (@form.length == 1) and (@titleFormField.length == 1) and
 		   (@titleEditableItem.length == 1) and (@bodyFormField.length == 1) and
 		   (@bodyEditableItem.length == 1)
@@ -8,8 +8,10 @@ class Editor
 			imageDeletePath = @bodyEditableItem.data("image-delete-path")
 
 			if (imageUploadPath.length > 0) and (imageDeletePath.length > 0)
-				@bodyEditor = new MediumEditor(@bodyEditableItem,
-				                           {buttonLabels: 'fontawesome'})
+				@bodyEditor = new MediumEditor(@bodyEditableItem, {
+					buttonLabels: 'fontawesome',
+					buttons: @toolbarButtons
+				})
 
 				@titleEditor = new MediumEditor(@titleEditableItem)
 

data/app/assets/stylesheets/proclaim.css.scss

@@ -13,7 +13,7 @@
  *= require font-awesome
  *= require medium-editor/medium-editor
  *= require medium-editor/themes/mani
- *= require medium-editor-insert-plugin.min
+ *= require medium-editor-insert-plugin
  *= require_tree .
  *= require_self
  */

data/app/assets/stylesheets/proclaim/posts.css.scss

@@ -26,6 +26,34 @@ div.post_excerpt_information
 	margin-top: 10px;
 }
 
+td#draft_posts
+{
+	width: 40%;
+	vertical-align: top;
+
+	h2
+	{
+		margin-top: 0;
+	}
+
+	h3
+	{
+		margin-bottom: 0;
+	}
+
+	div#draft_list
+	{
+		border: solid rgba(0, 0, 0, 0.3) 1px;
+		padding: 10px;
+		margin-left: 20px;
+	}
+
+	div.post_excerpt_information
+	{
+		margin-top: 0;
+	}
+}
+
 input.datetime_picker
 {
 	cursor: pointer;

data/app/controllers/proclaim/posts_controller.rb

@@ -9,7 +9,7 @@ module Proclaim
 
 		# GET /posts
 		def index
-			@posts = policy_scope(Post)
+			@posts = policy_scope(Post).order(published_at: :desc, updated_at: :desc)
 			authorize Post
 		end
 

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

@@ -6,13 +6,15 @@
 		              $(document).find("input#post_title"),
 		              $(document).find("form.new_post h1.editable"),
 		              $(document).find("input#post_body"),
-		              $(document).find("form.new_post div.editable"));
+		              $(document).find("form.new_post div.editable"),
+		              <%= raw Proclaim.editor_toolbar_buttons.to_json %>);
 		<% else %>
 			new Editor($(document).find("form.edit_post"),
 		              $(document).find("input#post_title"),
 		              $(document).find("form.edit_post h1.editable"),
 		              $(document).find("input#post_body"),
-		              $(document).find("form.edit_post div.editable"));
+		              $(document).find("form.edit_post div.editable"),
+		              <%= raw Proclaim.editor_toolbar_buttons.to_json %>);
 		<% end %>
 	});
 </script>

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

@@ -5,26 +5,65 @@
 <% 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>
+	<table style = "width: 100%;">
+		<tr>
+			<td id = "published_posts">
+				<% @posts.published.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 %>
+					<% 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? %>
+							<% if policy(post).edit? %>
+								|
+							<% end %>
+							<%= link_to 'Delete', post, method: :delete, data: { confirm: 'Are you sure?' } %>
+						<% end %>
+					</div>
+					<%= post.author.send(Proclaim.author_name_method) %><br />
+					<%= timeago_tag post.updated_at, format: "%B %d, %Y" %>
+				</div>
 			<% 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 %>
+			</td>
+
+			<% drafts = @posts.draft %>
+			<% unless drafts.blank? %>
+				<td id = "draft_posts">
+					<div id = "draft_list">
+						<h2>Drafts</h2>
+						<% drafts.each do |post| %>
+							<h3 class = "draft_list_item">
+								<%= link_to post.title, post %>
+							</h3>
+							<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? %>
+										<% if policy(post).edit? %>
+											|
+										<% end %>
+										<%= link_to 'Delete', post, method: :delete, data: { confirm: 'Are you sure?' } %>
+									<% end %>
+								</div>
+								<%= post.author.send(Proclaim.author_name_method) %><br />
+								<%= timeago_tag post.updated_at, format: "%B %d, %Y" %>
+							</div>
+						<% end %>
+					</div>
+				</td>
+			<% end %>
+		</tr>
+	</table>
 <% end %>

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

@@ -14,6 +14,19 @@
 	});
 </script>
 
+<div style = "float: right;">
+	<% if policy(@post).edit? %>
+		<%= link_to 'Edit', edit_post_path(@post) %>
+	<% end %>
+
+	<% if policy(@post).destroy? %>
+		<% if policy(@post).edit? %>
+			|
+		<% end %>
+		<%= link_to 'Delete', @post, method: :delete, data: { confirm: 'Are you sure?' } %>
+	<% end %>
+</div>
+
 <div class = "post">
 	<h1 class = "post_title"><%= @post.title %></h1>
 

data/lib/proclaim.rb

@@ -16,6 +16,9 @@ module Proclaim
 	mattr_accessor :excerpt_length
 	@@excerpt_length = 500 # 500 characters (won't interrupt words)
 
+	mattr_accessor :editor_toolbar_buttons
+	@@editor_toolbar_buttons = ['bold', 'italic', 'underline', 'anchor', 'header1', 'header2', 'quote']
+
 	def self.setup
 		yield self
 	end

data/lib/proclaim/engine.rb

@@ -16,7 +16,21 @@ module Proclaim
 		isolate_namespace Proclaim
 
 		initializer :assets do
-			Rails.application.config.assets.precompile += %w{ link.png remove.png resize-bigger.png resize-smaller.png unlink.png }
+			Rails.application.config.assets.precompile += %w{
+				link.png
+				remove.png
+				resize-bigger.png
+				resize-smaller.png
+				unlink.png
+				medium-editor-insert-plugin.css.scss
+				medium-editor-insert-plugin-frontend.css.scss
+				medium-editor-insert-plugin.all.js
+				addons/medium-editor-insert-embeds.js
+				addons/medium-editor-insert-maps.js
+				addons/medium-editor-insert-tables.js
+				addons/medium-editor-insert-images.js
+				addons/medium-editor-insert-plugin.js
+			}
 		end
 
 		initializer :append_migrations do |app|

data/lib/proclaim/version.rb

@@ -1,3 +1,3 @@
 module Proclaim
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/proclaim.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
 	s.add_dependency "premailer", "~> 1.8"
 	s.add_dependency "closure_tree", "~> 5.2"
 	s.add_dependency "font-awesome-rails", "~> 4.2"
-	s.add_dependency "medium-editor-rails", "~> 0.13"
+	s.add_dependency "medium-editor-rails", "~> 1.0"
 	s.add_dependency "carrierwave", "~> 0.10"
 	s.add_dependency "aasm", "~> 4.0"
 	s.add_dependency "rails-timeago", "~> 2.11"

data/test/controllers/proclaim/posts_controller_test.rb

@@ -40,6 +40,39 @@ module Proclaim
 			assert_includes assigns(:posts), post2
 		end
 
+		test "posts should be ordered by publication date" do
+			post1 = FactoryGirl.create(:published_post)
+			post2 = FactoryGirl.create(:published_post)
+
+			get :index
+			assert_response :success
+			assert_not_nil assigns(:posts)
+			assert_equal 2, assigns(:posts).count
+			assert_equal post2, assigns(:posts).first
+			assert_equal post1, assigns(:posts).last
+		end
+
+		test "drafts should be ordered by updated date" do
+			user = FactoryGirl.create(:user)
+			sign_in user
+
+			post1 = FactoryGirl.create(:post)
+			post2 = FactoryGirl.create(:post)
+			post3 = FactoryGirl.create(:post)
+
+			# Update post1 so its updated_at is newest
+			post2.body = "Updated Body"
+			post2.save
+
+			get :index
+			assert_response :success
+			assert_not_nil assigns(:posts)
+			assert_equal 3, assigns(:posts).count
+			assert_equal post2, assigns(:posts).first
+			assert_equal post3, assigns(:posts).second
+			assert_equal post1, assigns(:posts).last
+		end
+
 		test "should get new if logged in" do
 			user = FactoryGirl.create(:user)
 			sign_in user

data/test/integration/without_javascript/post_test.rb

@@ -115,6 +115,36 @@ class PostTest < ActionDispatch::IntegrationTest
 		       "Post 2 should not contain a link to see more"
 	end
 
+	test "index should show posts ordered by publication date" do
+		post1 = FactoryGirl.create(:published_post)
+		post2 = FactoryGirl.create(:published_post)
+
+		visit proclaim.posts_path
+
+		assert page.body.index(post2.title) < page.body.index(post1.title),
+		       "Post 2 should be shown before post 1!"
+	end
+
+	test "index should show drafts ordered by modification date" do
+		user = FactoryGirl.create(:user)
+		sign_in user
+
+		post1 = FactoryGirl.create(:post)
+		post2 = FactoryGirl.create(:post)
+		post3 = FactoryGirl.create(:post)
+
+		# Update post1 so its updated_at is newest
+		post2.body = "Updated Body"
+		post2.save
+
+		visit proclaim.posts_path
+
+		assert page.body.index(post2.title) < page.body.index(post3.title),
+		       "Post 2 draft should be shown before post 3 draft!"
+		assert page.body.index(post3.title) < page.body.index(post1.title),
+		       "Post 3 draft should be shown before post 1 draft!"
+	end
+
 	test "show should show author name" do
 		post = FactoryGirl.create(:published_post)
 

data/vendor/assets/stylesheets/{medium-editor-insert-plugin.css → medium-editor-insert-plugin.css.scss}

@@ -178,17 +178,17 @@
     cursor: pointer; }
   .mediumInsert .mediumInsert-imageRemove {
     right: 0;
-    background-image: url(/assets/remove.png); }
+    background-image: image_url('remove.png'); }
   .mediumInsert .mediumInsert-imageResizeSmaller, .mediumInsert .mediumInsert-imageResizeBigger, .mediumInsert .mediumInsert-imageResizeBigger {
     right: 31px;
-    background-image: url(/assets/resize-smaller.png); }
+    background-image: image_url('resize-smaller.png'); }
   .mediumInsert .mediumInsert-imageResizeBigger {
-    background-image: url(/assets/resize-bigger.png); }
+    background-image: image_url('resize-bigger.png'); }
   .mediumInsert .mediumInsert-imageLink, .mediumInsert .mediumInsert-imageUnlink {
     right: 62px;
-    background-image: url(/assets/link.png); }
+    background-image: image_url('link.png'); }
   .mediumInsert .mediumInsert-imageUnlink {
-    background-image: url(/assets/unlink.png); }
+    background-image: image_url('unlink.png'); }
   .mediumInsert .mediumInsert-error {
     background-color: #f2dede;
     border: 1px solid #ebccd1;