proclaim 0.1.0

data/README.md

@@ -0,0 +1,137 @@
+# Proclaim
+
+Most Rails blogging tools include everything you could ever want, including
+things you don't. Proclaim tries to provide the simplest (yet beautiful)
+implementation of a blog you could want-- posts, comments, and subscriptions.
+It's not meant to *be* your entire website-- it's a mountable engine. Mount it
+where you want it, configure it, and you have a blog. It otherwise stays out of
+your way.
+
+## Getting Started
+
+### Get Proclaim
+
+Proclaim 0.1 works with Rails 4.2 and on. Add it to your Gemfile with:
+
+```ruby
+gem 'proclaim', "~> 0.1.0"
+```
+
+Run `bundle install` to install it.
+
+
+### Install Proclaim
+
+After you've added Proclaim to your gemfile, you can install it with:
+
+```ruby
+rails generate proclaim:install
+```
+
+The generator will install an initializer which describes all of Proclaim's
+configuration options. You should check those out, and change them if necessary.
+It will also mount Proclaim in your `config/routes.rb` at the path `/blog`.
+
+Now run `rake db:migrate`
+
+
+### Setup Assets
+
+Include Proclaim in Javascript manifest file:
+
+```javascript
+//= require proclaim
+```
+
+Include Proclaim in Stylesheet manifest file:
+
+```scss
+*= require proclaim
+```
+
+
+### Setup Mailer and Root Route
+
+Proclaim sends emails when:
+
+- A new subscription is added (A welcome email)
+- A new comment is made on a post to which subscriptions exist
+- A new post is made and subscriptions exist on the blog itself
+
+Because of this, ensure that the mailer has default URL options in each
+environment. Here is a possible configuration for
+`config/environments/development.rb`:
+
+```ruby
+config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+```
+
+A default root path must also be defined in the application's routes:
+
+```ruby
+root to: "home#index"
+```
+
+
+### Engine Configuration Options
+
+The Proclaim engine has a number of configurable parameters that mostly relate
+to tying the engine in with the rest of the site. Proclaim tries to be as
+unobtrusive as possible-- it doesn't provide users or authentication. It does,
+however, require some concept of authors, expecting that they authenticate
+somehow, and posts will belong to whichever author publishes them.
+
+All configuration items (and their defaults) follow:
+
+```ruby
+Proclaim.author_class = "User"
+Proclaim.author_name_method = :name
+Proclaim.current_author_method = :current_user
+Proclaim.authentication_method = :authenticate_user!
+Proclaim.excerpt_length = 500
+```
+
+- **Proclaim.author_class**
+
+  The class to which posts belong. Changing this also changes the default
+  `Proclaim.current_author_method` and `Proclaim.authentication_method`. For
+  example, setting `author_class = "Admin"` changes the default
+  `current_author_method` to be `:current_admin`, etc.
+
+- **Proclaim.author_name_method**
+
+  Method to obtain the name of the author. This should be a method on the author
+  class.
+
+- **Proclaim.current_author_method**
+
+  Method to obtain the currently-authenticated user. Should return nil if no
+  user is currently authenticated.
+
+- **Proclaim.authentication_method**
+
+  Method to verify that a user is authenticated, and if not, will redirect to
+  some sort of authentication page.
+
+- **Proclaim.excerpt_length**
+
+  Maximum length for the excerpts shown on the posts index. The excerpts may be
+  less than this, but will never exceed it.
+
+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`.
+
+
+## Customizations
+
+Proclaim was built to help you quickly develop an application that includes a
+blog. However, it shouldn't be in your way when you need to customize it. Since
+Proclaim is an engine, all of its views are packaged inside the gem. These views
+will get you started, and you can always implement new styles via CSS, but you
+may wish to change them completely. You can simply copy them into your
+application and alter them by using the generator:
+
+```ruby
+rails generate proclaim:views
+```

data/Rakefile

@@ -0,0 +1,65 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Proclaim'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.verbose = false
+  if ENV["TEST"].nil?
+    t.pattern = 'test/**/*_test.rb'
+  else
+    t.pattern = ENV["TEST"]
+  end
+end
+
+namespace :test do
+  Rails::TestTask.new(:generators) do |t|
+    t.pattern = "test/lib/generators/**/*_test.rb"
+  end
+
+  Rails::TestTask.new(:units) do |t|
+    t.pattern = 'test/{models,helpers,unit}/**/*_test.rb'
+  end
+
+  Rails::TestTask.new(:functionals) do |t|
+    t.pattern = 'test/{controllers,mailers,functional}/**/*_test.rb'
+  end
+
+  Rails::TestTask.new(:integration) do |t|
+    t.pattern = 'test/integration/**/*_test.rb'
+  end
+
+  namespace :integration do
+    Rails::TestTask.new(:js) do |t|
+      t.pattern = 'test/integration/with_javascript/**/*_test.rb'
+    end
+
+    Rails::TestTask.new(:no_js) do |t|
+      t.pattern = 'test/integration/without_javascript/**/*_test.rb'
+    end
+  end
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/assets/javascripts/proclaim.js

@@ -0,0 +1,18 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require medium-editor
+//= require medium-editor-insert-plugin.all.min
+//= require rails-timeago
+//= require_tree .

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

@@ -0,0 +1,192 @@
+class CommentsHandler
+	constructor: (@discussionClass, @commentClass, @commentFormClass,
+	              @mainCommentFormClass, @cancelCommentButtonClass,
+	              @replyLinkClass, @updateLinkClass, @deleteLinkClass,
+	              @subscribeCheckboxClass, @subscribeEmailClass) ->
+		if (@discussionClass.length > 0) and
+		   (@commentClass.length > 0) and
+		   (@commentFormClass.length > 0) and
+		   (@mainCommentFormClass.length > 0) and
+		   (@cancelCommentButtonClass.length > 0) and
+		   (@replyLinkClass.length > 0) and
+		   (@updateLinkClass.length > 0) and
+		   (@deleteLinkClass.length > 0) and
+		   (@subscribeCheckboxClass.length > 0) and
+		   (@subscribeEmailClass.length > 0)
+			@cleanBindings()
+			@addBindings()
+		else
+			console.error("Invalid length for comment classes!")
+
+	addBindings: ->
+		$(document).on "click", @replyLinkClass, @showNewCommentForm
+		$(document).on "click", @updateLinkClass, @showUpdateCommentForm
+		$(document).on "click", @cancelCommentButtonClass, @cancelComment
+
+		$(document).on "ajax:beforeSend", @commentFormClass, @handleCommentStarted
+		$(document).on "ajax:complete", @commentFormClass, @handleCommentFinished
+
+		$(document).on "ajax:success", @commentFormClass, @handleCommentSuccess
+		$(document).on "ajax:error", @commentFormClass, @handleCommentFailure
+
+		$(document).on "ajax:success", @deleteLinkClass, @handleDeleteCommentSuccess
+		$(document).on "ajax:error", @deleteLinkClass, @handleDeleteCommentFailure
+
+		$(document).on "change", @subscribeCheckboxClass, @handleSubscribeCheckbox
+
+	cleanBindings: ->
+		$(document).off "click", @replyLinkClass
+		$(document).off "click", @updateLinkClass
+		$(document).off "click", @cancelCommentButtonClass
+
+		$(document).off "ajax:beforeSend", @commentFormClass
+		$(document).off "ajax:complete", @commentFormClass
+
+		$(document).off "ajax:success", @commentFormClass
+		$(document).off "ajax:error", @commentFormClass
+
+		$(document).off "ajax:success", @deleteLinkClass
+		$(document).off "ajax:error", @deleteLinkClass
+
+		$(document).off "change", @subscribeCheckboxClass
+
+	# Disable the form until the new comment has been processed
+	handleCommentStarted: (event, xhr, settings) =>
+		form = $(event.target)
+		form.find(":input").prop("disabled", true);
+		form.before('<div class = "loading" style = "width: 100px;"></div>')
+
+	handleCommentFinished: (event, xhr, status) =>
+		form = $(event.target)
+		target = $(form.data("target"))
+		form.find(":input").prop("disabled", false);
+		form.siblings('div.loading').remove()
+
+		if status == "success"
+			@removeForm form
+
+	handleCommentSuccess: (event, data, status, xhr) =>
+		if data.html.length == 0
+			console.error("Invalid comment HTML!")
+			return
+
+		form = $(event.target)
+
+		if form.hasClass("edit_comment")
+			form.closest(@discussionClass).replaceWith(data.html)
+		else
+			target = $(form.data("target"))
+			if target.length == 1
+				target.append(data.html)
+			else
+				console.error("Invalid comment target!")
+				return
+
+			# Hide form, but don't remove so events can still be emitted
+			@removeForm form, true
+
+	handleCommentFailure: (event, xhr, status, error) =>
+		$(event.target).siblings("div.error").remove()
+		errorMessage = "<div class='error'>"
+		errorMessage += "<strong>The following errors have prevented this comment from being saved:</strong>"
+		errorMessage += "<ul>"
+		for error in $.parseJSON(xhr.responseText)
+			errorMessage += "<li>" + error + "</li>"
+		errorMessage += "</ul>"
+		errorMessage += "</div>"
+		$(event.target).before(errorMessage)
+
+	handleDeleteCommentSuccess: (event, data, status, xhr) =>
+		commentContainer = $(event.target).closest(@discussionClass)
+		if commentContainer.length == 1
+			commentContainer.fadeOut ->
+				commentContainer.remove()
+		else
+			console.error("No comment container for removal!")
+
+	handleDeleteCommentFailure: (event, xhr, status, error) =>
+		console.error("Unable to delete comment!")
+
+	showNewCommentForm: (event) =>
+		event.preventDefault()
+
+		target = $($(event.target).data("target"))
+		if target.length != 1
+			console.error("Invalid comment target data!")
+			return
+
+		# Ensure form isn't already shown. If it is, don't show it again
+		if target.children(@commentFormClass).length == 0
+			form = $(event.target).data("form")
+			if form.length == 0
+				console.error("Invalid comment form data!")
+				return
+
+			# Remove all other non-main forms-- make this form exclusive
+			other_forms = $(document).find(@commentFormClass).not(@mainCommentFormClass)
+			if other_forms.length > 0
+				@removeForm other_forms
+
+			target.append(form)
+			form = target.children(@commentFormClass)
+			form.addClass("new_comment")
+
+			form.children(@cancelCommentButtonClass).focus();
+			form.children("input:text:visible:first").focus();
+
+	showUpdateCommentForm: (event) =>
+		event.preventDefault()
+
+		target = $(event.target)
+
+		form = target.data("form")
+		if form.length == 0
+			console.error("Invalid comment form data!")
+			return
+
+		discussion = target.closest(@discussionClass)
+		target.closest(@commentClass).hide()
+		discussion.prepend(form)
+		form = discussion.children(@commentFormClass)
+		form.addClass("edit_comment")
+		form.children(@cancelCommentButtonClass).focus();
+		form.children("input:text:visible:first").focus();
+
+	cancelComment: (event) =>
+		event.preventDefault()
+
+		form = $(event.target).closest(@commentFormClass)
+		if form.hasClass("edit_comment")
+			form.siblings(@commentClass).show()
+
+		$(event.target).siblings(@subscribeEmailClass).hide()
+		@removeForm form
+
+	handleSubscribeCheckbox: (event) =>
+		if event.target.checked
+			$(event.target).siblings(@subscribeEmailClass).show()
+		else
+			$(event.target).siblings(@subscribeEmailClass).val("")
+			$(event.target).siblings(@subscribeEmailClass).hide()
+
+	removeForm: (form, hideInsteadOfRemove = false) ->
+		if form.length == 0
+			console.error("Invalid comment form length for removal!")
+			return
+
+		form.siblings("div.error").remove() # If any
+
+		form.each (index, element) =>
+			thisForm = $(element)
+
+			# Don't remove the main comment form-- just clear it
+			if thisForm.is(@mainCommentFormClass)
+				element.reset()
+			else
+				if (hideInsteadOfRemove)
+					thisForm.hide()
+				else
+					thisForm.remove()
+
+# Make available to other scripts
+@CommentsHandler = CommentsHandler

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

@@ -0,0 +1,50 @@
+class Editor
+	constructor: (@form, @titleFormField, @titleEditableItem,
+	              @bodyFormField, @bodyEditableItem) ->
+		if (@form.length == 1) and (@titleFormField.length == 1) and
+		   (@titleEditableItem.length == 1) and (@bodyFormField.length == 1) and
+		   (@bodyEditableItem.length == 1)
+			imageUploadPath = @bodyEditableItem.data("image-upload-path")
+			imageDeletePath = @bodyEditableItem.data("image-delete-path")
+
+			if (imageUploadPath.length > 0) and (imageDeletePath.length > 0)
+				@bodyEditor = new MediumEditor(@bodyEditableItem,
+				                           {buttonLabels: 'fontawesome'})
+
+				@titleEditor = new MediumEditor(@titleEditableItem)
+
+				@bodyEditableItem.mediumInsert({
+					editor: @bodyEditor,
+					addons: {
+						images: {
+							imagesUploadScript: imageUploadPath,
+							imagesDeleteScript: imageDeletePath,
+							deleteFile: (file, that) =>
+								$.post that.options.imagesDeleteScript, {file: file}, (data, status, jqxhr) =>
+									if data.id
+										@form.append('<input type="hidden" name="post[images_attributes][' + data.id + '][id]" value="' + data.id + '" />')
+										@form.append('<input type="hidden" name="post[images_attributes][' + data.id + '][_destroy]" value="true" />')
+								, "json"
+						}
+					}
+				})
+
+				@cleanBindings()
+				@addBindings()
+			else
+				console.error("Missing image upload and/or image delete paths for body editor!")
+		else
+			console.error("Invalid length for editable items or form fields!")
+
+	addBindings: ->
+		@form.on "submit", @updateFormFields
+
+	cleanBindings: ->
+		@form.off "submit"
+
+	updateFormFields: (event) =>
+		@titleFormField.val(@titleEditor.serialize()["element-0"].value)
+		@bodyFormField.val(@bodyEditor.serialize()["element-0"].value)
+
+# Make available to other scripts
+@Editor = Editor