proclaim 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a4fb217ab74d5f76f8c5b04aafe1bb4d328e41e
-  data.tar.gz: 164386ed38ec2c67e27e1b0565cf4bef4353b04b
+  metadata.gz: 3097ffe58a4ddda60a5dea886f2ee9397bb39acb
+  data.tar.gz: f80505cac5a11b356e077aa93191d31928fba9d2
 SHA512:
-  metadata.gz: 13f1c62fa387363bca3c295c5f28f15360f98ab553bb3cad58a535334098082635adce8d72f5767226e469dff2454129d627e0e754e4e06c92698a3398b72682
-  data.tar.gz: e1235a462a4f29c74a9ac912480513d04f06858ebea23a1a0b92438d7cf7f34c404d1237887590eefaae55fb9e6679ec95b46f9f5bd73cdf2c6beab76b64b12f
+  metadata.gz: 1c61057de07fd97a72401a70f8bfd034066d4417e654b9864ae43943140fb190c18bb11400c806e7615484457f4f8ba14739ccd4ca6756bf89f6a5d7c0a04d43
+  data.tar.gz: d6700afa0c73bf5e8c4fe07e1d08c6726f56f849fdeebf24565a499b741941913d9c014833e028aeecb52b4ede9a80fda3c9fa4c641b2dd4cd1ae38d4612f2ef

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.5.0
+  - Fixed bug causing possible blank excerpt
+  - Make post URLs more friendly (backward-compatible)
+
 0.4.0
   - Added media query to emails for better display on mobile devices
   - Added callbacks as a way for main app to be notified of new posts,

data/README.md

@@ -25,11 +25,11 @@ scheme is given below.
 
 ### Get Proclaim
 
-Proclaim 0.4 works with Rails 4.2 and on, with Ruby 1.9.3 and on. Add it to your
+Proclaim 0.5 works with Rails 4.2 and on, with Ruby 1.9.3 and on. Add it to your
 Gemfile with:
 
 ```ruby
-gem 'proclaim', "~> 0.4.0"
+gem 'proclaim', "~> 0.5.0"
 ```
 
 Run `bundle install` to install it.

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/app/controllers/proclaim/posts_controller.rb

@@ -17,6 +17,13 @@ module Proclaim
 		def show
 			begin
 				authorize @post
+
+				# If an old id or a numeric id was used to find the record, then
+				# the request path will not match the post_path, and we should do
+				# a 301 redirect that uses the current friendly id.
+				if request.path != post_path(@post)
+					return redirect_to @post, status: :moved_permanently
+				end
 			rescue Pundit::NotAuthorizedError
 				# Don't leak that this resource actually exists. Turn the
 				# "permission denied" into a "not found"
@@ -97,7 +104,7 @@ module Proclaim
 
 		# Use callbacks to share common setup or constraints between actions.
 		def set_post
-			@post = Post.find(params[:id])
+			@post = Post.friendly.find(params[:id])
 		end
 
 		# Only allow a trusted parameter "white list" through.

data/app/helpers/proclaim/posts_helper.rb

@@ -1,4 +1,11 @@
 module Proclaim
 	module PostsHelper
+		def fake_form_field(post, attribute, &block)
+			if post.errors.any? and not post.errors[attribute].blank?
+				content_tag :div, block.call, class: "field_with_errors"
+			else
+				block.call
+			end
+		end
 	end
 end

data/app/models/proclaim/post.rb

@@ -20,8 +20,10 @@ module Proclaim
 		has_many :images, inverse_of: :post, dependent: :destroy
 		accepts_nested_attributes_for :images, allow_destroy: true
 
-		include AASM
+		extend FriendlyId
+		friendly_id :slug_candidates, use: :history
 
+		include AASM
 		aasm column: :state, no_direct_assignment: true do
 			state :draft, initial: true
 			state :published
@@ -41,9 +43,21 @@ module Proclaim
 		validates_presence_of :title, :body, :author
 		validate :verifyBodyHtml
 
+		after_validation :move_friendly_id_error_to_title
+
 		before_save :sanitizeBody
 		after_save :notifyBlogSubscribersIfPublished
 
+		# Only save the slug history if the post is published
+		def create_slug
+			# No real reason to keep a slug history unless it's been published
+			unless published?
+				slugs.destroy_all
+			end
+
+			super
+		end
+
 		attr_writer :excerpt_length
 		def excerpt_length
 			@excerpt_length || Proclaim.excerpt_length
@@ -71,6 +85,23 @@ module Proclaim
 
 		private
 
+		def should_generate_new_friendly_id?
+			title_changed?
+		end
+
+		def move_friendly_id_error_to_title
+			errors.add :title, *errors.delete(:friendly_id) if errors[:friendly_id].present?
+		end
+
+		# Try building a slug based on the following fields in
+		# increasing order of specificity.
+		def slug_candidates
+			[
+				:title,
+				[:title, :id]
+			]
+		end
+
 		def verifyBodyHtml
 			if not errors.messages.include?(:body) and
 			   body_plaintext.strip.empty? and
@@ -107,7 +138,9 @@ module Proclaim
 
 		def first_block_element_text(nokogiri_node)
 			if nokogiri_node.text?
-				return block_element_text(nokogiri_node.parent)
+				text = block_element_text(nokogiri_node.parent).strip
+
+				return text unless text.empty?
 			end
 
 			nokogiri_node.children.each do |child|

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

@@ -33,11 +33,27 @@
 	<% end %>
 
 	<div class = "post">
-		<h1 class = "post_title editable" data-disable-return="true" data-disable-toolbar="true" data-placeholder="Post Title"><%= @post.title %></h1>
+		<%=
+			fake_form_field @post, :title do
+				content_tag :h1, @post.title, class: "post_title editable",
+				            data: {
+				            	placeholder: "Post Title",
+				            	disable_return: "true",
+				            	disable_toolbar: "true",
+				            }
+			end
+		%>
 
-		<div class = "post_body editable" data-placeholder = "Post Body" data-image-upload-path="<%= cache_image_path %>" data-image-delete-path="<%= discard_image_path %>">
-			<%= @post.body.html_safe %>
-		</div>
+		<%=
+			fake_form_field @post, :body do
+				content_tag :div, @post.body.html_safe, class: "post_body editable",
+				            data: {
+				            	placeholder: "Post Body",
+				            	image_upload_path: cache_image_path,
+				            	image_delete_path: discard_image_path,
+				            }
+			end
+		%>
 
 		<div class = "post_information" style = "margin-bottom: 30px;">
 			<% if @post.published? %>

data/config/initializers/friendly_id.rb

@@ -0,0 +1,88 @@
+# FriendlyId Global Configuration
+#
+# Use this to set up shared configuration options for your entire application.
+# Any of the configuration options shown here can also be applied to single
+# models by passing arguments to the `friendly_id` class method or defining
+# methods in your model.
+#
+# To learn more, check out the guide:
+#
+# http://norman.github.io/friendly_id/file.Guide.html
+
+FriendlyId.defaults do |config|
+  # ## Reserved Words
+  #
+  # Some words could conflict with Rails's routes when used as slugs, or are
+  # undesirable to allow as slugs. Edit this list as needed for your app.
+  config.use :reserved
+
+  config.reserved_words = %w(new edit index session login logout users admin
+    stylesheets assets javascripts images)
+
+  #  ## Friendly Finders
+  #
+  # Uncomment this to use friendly finders in all models. By default, if
+  # you wish to find a record by its friendly id, you must do:
+  #
+  #    MyModel.friendly.find('foo')
+  #
+  # If you uncomment this, you can do:
+  #
+  #    MyModel.find('foo')
+  #
+  # This is significantly more convenient but may not be appropriate for
+  # all applications, so you must explicity opt-in to this behavior. You can
+  # always also configure it on a per-model basis if you prefer.
+  #
+  # Something else to consider is that using the :finders addon boosts
+  # performance because it will avoid Rails-internal code that makes runtime
+  # calls to `Module.extend`.
+  #
+  # config.use :finders
+  #
+  # ## Slugs
+  #
+  # Most applications will use the :slugged module everywhere. If you wish
+  # to do so, uncomment the following line.
+  #
+  # config.use :slugged
+  #
+  # By default, FriendlyId's :slugged addon expects the slug column to be named
+  # 'slug', but you can change it if you wish.
+  #
+  # config.slug_column = 'slug'
+  #
+  # When FriendlyId can not generate a unique ID from your base method, it appends
+  # a UUID, separated by a single dash. You can configure the character used as the
+  # separator. If you're upgrading from FriendlyId 4, you may wish to replace this
+  # with two dashes.
+  #
+  # config.sequence_separator = '-'
+  #
+  #  ## Tips and Tricks
+  #
+  #  ### Controlling when slugs are generated
+  #
+  # As of FriendlyId 5.0, new slugs are generated only when the slug field is
+  # nil, but if you're using a column as your base method can change this
+  # behavior by overriding the `should_generate_new_friendly_id` method that
+  # FriendlyId adds to your model. The change below makes FriendlyId 5.0 behave
+  # more like 4.0.
+  #
+  # config.use Module.new {
+  #   def should_generate_new_friendly_id?
+  #     slug.blank? || <your_column_name_here>_changed?
+  #   end
+  # }
+  #
+  # FriendlyId uses Rails's `parameterize` method to generate slugs, but for
+  # languages that don't use the Roman alphabet, that's not usually sufficient.
+  # Here we use the Babosa library to transliterate Russian Cyrillic slugs to
+  # ASCII. If you use this, don't forget to add "babosa" to your Gemfile.
+  #
+  # config.use Module.new {
+  #   def normalize_friendly_id(text)
+  #     text.to_slug.normalize! :transliterations => [:russian, :latin]
+  #   end
+  # }
+end

data/db/migrate/20150213015321_create_friendly_id_slugs.rb

@@ -0,0 +1,16 @@
+class CreateFriendlyIdSlugs < ActiveRecord::Migration
+	def change
+		create_table :friendly_id_slugs do |t|
+			t.string   :slug,           :null => false
+			t.integer  :sluggable_id,   :null => false
+			t.string   :sluggable_type, :limit => 50
+			t.string   :scope
+			t.datetime :created_at
+		end
+
+		add_index :friendly_id_slugs, :sluggable_id
+		add_index :friendly_id_slugs, [:slug, :sluggable_type]
+		add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], :unique => true
+		add_index :friendly_id_slugs, :sluggable_type
+	end
+end

data/db/migrate/20150213015850_add_slug_to_posts.rb

@@ -0,0 +1,20 @@
+class AddSlugToPosts < ActiveRecord::Migration
+	def change
+		change_table :proclaim_posts do |t|
+			t.string :slug, null: false
+		end
+
+		# This ensures that even if two clients try to create the same
+		# post slug at exactly the same time, the database won't accept
+		# one of them (Rails would have)
+		add_index :proclaim_posts, :slug, unique: true
+
+		reversible do |direction|
+			direction.up do
+				print "Generating slugs for existing posts... "
+				Proclaim::Post.find_each(&:save)
+				puts "done."
+			end
+		end
+	end
+end

data/lib/proclaim/engine.rb

@@ -3,6 +3,7 @@ require 'coffee-rails'
 require 'sass-rails'
 require 'jquery-rails'
 require 'htmlentities'
+require 'friendly_id'
 require 'closure_tree'
 require 'font-awesome-rails'
 require 'medium-editor-rails'

data/lib/proclaim/version.rb

@@ -1,3 +1,3 @@
 module Proclaim
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/proclaim.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
 	s.add_dependency "sass-rails", "~> 5.0"
 	s.add_dependency "jquery-rails", "~> 4.0"
 	s.add_dependency "htmlentities", "~> 4.3"
+	s.add_dependency "friendly_id", "~> 5.1"
 	s.add_dependency "nokogiri", "~> 1.6"
 	s.add_dependency "premailer", "~> 1.8"
 	s.add_dependency "closure_tree", "~> 5.2"

data/test/controllers/proclaim/posts_controller_test.rb

@@ -173,34 +173,32 @@ module Proclaim
 			assert_match /not authorized/, flash[:error]
 		end
 
-		test "should show post if logged in" do
+		test "should show draft post if logged in" do
 			user = FactoryGirl.create(:user)
 			sign_in user
 
-			# Should show published post
-			newPost = FactoryGirl.create(:published_post)
-
-			get :show, id: newPost
-			assert_response :success
-			assert_equal assigns(:post), newPost
-
-			# Should also show unpublished post
+			# Should show draft post
 			newPost = FactoryGirl.create(:post)
 
 			get :show, id: newPost
 			assert_response :success
-			assert_equal assigns(:post), newPost
+			assert_equal newPost, assigns(:post)
 		end
 
-		test "should show post if not logged in" do
+		test "should show published post if logged in" do
+			user = FactoryGirl.create(:user)
+			sign_in user
+
 			# Should show published post
 			newPost = FactoryGirl.create(:published_post)
 
 			get :show, id: newPost
 			assert_response :success
-			assert_equal assigns(:post), newPost
+			assert_equal newPost, assigns(:post)
+		end
 
-			# Should not show unpublished post
+		test "should not show draft post if not logged in" do
+			# Should not show draft post
 			newPost = FactoryGirl.create(:post)
 
 			# Controller should hide the "permission denied" in a "not-found"
@@ -209,6 +207,66 @@ module Proclaim
 			end
 		end
 
+		test "should show published post if not logged in" do
+			# Should show published post
+			newPost = FactoryGirl.create(:published_post)
+
+			get :show, id: newPost
+			assert_response :success
+			assert_equal newPost, assigns(:post)
+		end
+
+		test "should show post via id" do
+			post = FactoryGirl.create(:published_post, title: "New Post")
+
+			# Test with ID
+			get :show, id: post.id
+			assert_response :redirect,
+			                "Visiting a post by ID should redirect to slug"
+			assert_equal post, assigns(:post)
+		end
+
+		test "should show post via slug" do
+			post = FactoryGirl.create(:published_post, title: "New Post")
+
+			# Test with slug
+			get :show, id: post.friendly_id
+			assert_response :success
+			assert_equal post, assigns(:post)
+		end
+
+		test "should not show draft post via old slugs" do
+			user = FactoryGirl.create(:user)
+			sign_in user
+
+			post = FactoryGirl.create(:post, title: "New Post")
+			old_slug = post.friendly_id
+
+			# Now change slug
+			post.title = "New Post Modified"
+			post.save
+
+			# Verify that old slug doesn't work
+			assert_raises ActiveRecord::RecordNotFound,
+			              "Draft posts should not maintain slug history" do
+				get :show, id: old_slug
+			end
+		end
+
+		test "should show published post via old slugs" do
+			post = FactoryGirl.create(:published_post, title: "New Post")
+			old_slug = post.friendly_id
+
+			# Now change slug
+			post.title = "New Post Modified"
+			post.save
+
+			# Verify that old slug still works
+			get :show, id: old_slug
+			assert_response :redirect, "This should redirect to the current slug"
+			assert_equal assigns(:post), post
+		end
+
 		test "should get edit if logged in" do
 			user = FactoryGirl.create(:user)
 			sign_in user

data/test/dummy/db/schema.rb

@@ -11,7 +11,20 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150123115226) do
+ActiveRecord::Schema.define(version: 20150213015850) do
+
+  create_table "friendly_id_slugs", force: :cascade do |t|
+    t.string   "slug",                      null: false
+    t.integer  "sluggable_id",              null: false
+    t.string   "sluggable_type", limit: 50
+    t.string   "scope"
+    t.datetime "created_at"
+  end
+
+  add_index "friendly_id_slugs", ["slug", "sluggable_type", "scope"], name: "index_friendly_id_slugs_on_slug_and_sluggable_type_and_scope", unique: true
+  add_index "friendly_id_slugs", ["slug", "sluggable_type"], name: "index_friendly_id_slugs_on_slug_and_sluggable_type"
+  add_index "friendly_id_slugs", ["sluggable_id"], name: "index_friendly_id_slugs_on_sluggable_id"
+  add_index "friendly_id_slugs", ["sluggable_type"], name: "index_friendly_id_slugs_on_sluggable_type"
 
   create_table "proclaim_comment_hierarchies", id: false, force: :cascade do |t|
     t.integer "ancestor_id",   null: false
@@ -50,9 +63,11 @@ ActiveRecord::Schema.define(version: 20150123115226) do
     t.datetime "published_at"
     t.datetime "created_at",                     null: false
     t.datetime "updated_at",                     null: false
+    t.string   "slug"
   end
 
   add_index "proclaim_posts", ["author_id"], name: "index_proclaim_posts_on_author_id"
+  add_index "proclaim_posts", ["slug"], name: "index_proclaim_posts_on_slug", unique: true
   add_index "proclaim_posts", ["state"], name: "index_proclaim_posts_on_state"
 
   create_table "proclaim_subscriptions", force: :cascade do |t|

data/test/integration/without_javascript/post_test.rb

@@ -145,7 +145,7 @@ class PostTest < ActionDispatch::IntegrationTest
 		       "Post 3 draft should be shown before post 1 draft!"
 	end
 
-	test "show should show author name" do
+	test "show should include author name" do
 		post = FactoryGirl.create(:published_post)
 
 		visit proclaim.post_path(post)
@@ -153,6 +153,36 @@ class PostTest < ActionDispatch::IntegrationTest
 		assert page.has_text? post.author.send(Proclaim.author_name_method)
 	end
 
+	test "show should work via id" do
+		post = FactoryGirl.create(:published_post)
+
+		visit proclaim.post_path(post.id)
+		assert page.has_text? post.title
+		assert_equal proclaim.post_path(post.friendly_id), current_path,
+		             "Post show via ID should redirect to more friendly URL"
+	end
+
+	test "show should work via slug" do
+		post = FactoryGirl.create(:published_post)
+
+		visit proclaim.post_path(post.friendly_id)
+		assert page.has_text? post.title
+	end
+
+	test "show should work via old slugs for published posts" do
+		post = FactoryGirl.create(:published_post, title: "New Post")
+		old_slug = post.friendly_id
+
+		# Change slug
+		post.title = "New Post Modified"
+		post.save
+
+		visit proclaim.post_path(old_slug)
+		assert page.has_text? post.title
+		assert_equal proclaim.post_path(post.friendly_id), current_path,
+		             "Post show via ID should redirect to more friendly URL"
+	end
+
 	test "image should have relative source path" do
 		user = FactoryGirl.create(:user)
 		sign_in user

data/test/models/proclaim/post_test.rb

@@ -122,6 +122,10 @@ module Proclaim
 			post = FactoryGirl.build(:post,
 			                         body: "This is outside.<p>This is inside.</p>")
 			assert_equal "This is outside.", post.excerpt
+
+			post = FactoryGirl.build(:post,
+			                         body: "<p>\r\n</p><p>foo</p>")
+			assert_equal "foo", post.excerpt
 		end
 
 		test "verify body sanitization" do
@@ -130,5 +134,60 @@ module Proclaim
 
 			assert_equal "foo alert('bar');", post.body
 		end
+
+		test "verify slug presence" do
+			post = FactoryGirl.build(:post, title: "New Post")
+			assert_nil post.slug
+
+			post.save
+			assert_equal "new-post", post.slug
+
+			assert_equal post, Post.friendly.find(post.slug)
+			assert_equal post, Post.friendly.find(post.id),
+			             "Should also be able to use regular-old ID"
+		end
+
+		test "verify slug uniqueness" do
+			post = FactoryGirl.create(:post, title: "New Post")
+			assert_equal "new-post", post.slug
+
+			post = FactoryGirl.build(:post, title: "New Post") # Same title
+			post.valid?
+
+			assert post.save, "Title should not be required to be unique"
+			assert_not_equal "new-post", post.slug, "Slugs should be unique"
+		end
+
+		test "verify unpublished post slug changes but does not keep history" do
+			post = FactoryGirl.create(:post, title: "New Post")
+			assert_equal "new-post", post.slug
+			assert_equal post, Post.friendly.find(post.slug)
+
+			post.title = "New Post Modified"
+			post.save
+			assert_equal "new-post-modified", post.slug,
+			             "The slug should change if the post title changes"
+			assert_equal post, Post.friendly.find(post.slug)
+
+			# Assert that we cannot use the old slug
+			refute Post.friendly.exists_by_friendly_id?("new-post"),
+				    "Should not be able to use old slug on an unpublished post"
+		end
+
+		test "verify published post slug changes and keeps history" do
+			post = FactoryGirl.create(:published_post, title: "New Post")
+			assert_equal "new-post", post.slug
+			assert_equal post, Post.friendly.find(post.slug)
+
+			post.title = "New Post Modified"
+			post.save
+			assert_equal "new-post-modified", post.slug,
+			             "The slug should change if the post title changes"
+			assert_equal post, Post.friendly.find(post.slug)
+
+			# Also assert that we can use the old slug (i.e. published links
+			# can't be broken)
+			assert_equal post, Post.friendly.find("new-post")
+		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proclaim
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kyle Fazzari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: friendly_id
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -395,6 +409,7 @@ files:
 - app/views/proclaim/subscriptions/index.html.erb
 - app/views/proclaim/subscriptions/new.html.erb
 - app/views/proclaim/subscriptions/show.html.erb
+- config/initializers/friendly_id.rb
 - config/routes.rb
 - db/migrate/20141108222616_create_proclaim_posts.rb
 - db/migrate/20141114235359_create_proclaim_comments.rb
@@ -402,6 +417,8 @@ files:
 - db/migrate/20141210234057_create_proclaim_subscriptions.rb
 - db/migrate/20141222224905_create_proclaim_images.rb
 - db/migrate/20150123115226_add_name_to_subscriptions.rb
+- db/migrate/20150213015321_create_friendly_id_slugs.rb
+- db/migrate/20150213015850_add_slug_to_posts.rb
 - lib/generators/proclaim/install_generator.rb
 - lib/generators/proclaim/templates/README
 - lib/generators/proclaim/templates/initialize_proclaim.rb