peanut_gallery 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a93345b0d1dad83b29b6d1dfa7d1f6cc93fcae24
-  data.tar.gz: 34303919819f201c163e3518db77e4bc10c17749
+  metadata.gz: 949795aa2df5a636b51139bb19efb2152842c876
+  data.tar.gz: eb9d7a8b4dd9dbbd285b34b97c57f829dd0f558d
 SHA512:
-  metadata.gz: af8024053600cb2ec09fb6ca1af5ed1018c242e0eb2f7d498c9d1278fed5ada374ef74e88beaa74a2c999c4730f41ac667b2e23699f1a0cfa0dd08f4e4c6009f
-  data.tar.gz: e999e8c7cef9286df8276cdece4a0940edca23b44c6547048ff85e1c139b68009338304aab9ff2d5af348f10274171ae0d4c4da3f1aac73b334100b02f42823b
+  metadata.gz: 3e05af60a7d21977e460cb47334370a353422c42d532d22307cc3fc2c2234493e84bab88dc6bb17f9a575c26f5f53608ded505b44deefe306c052b7f28c6198d
+  data.tar.gz: 9ef2e06176cb5c5b177f395a37b26838c22f94fe32e71f9f95f43dcbac3c3f54aebdfee0ebb90930c314ce1f2ca0bd68f981a48b438933ce005ee8f9bb130ace

data/README.md

@@ -1,8 +1,13 @@
-# PeanutGallery
+PeanutGallery
+==========
 
-TODO: Write a gem description
+PeanutGallery adds a simple commenting feature to your Ruby on Rails
+application.
 
-## Installation
+Installation
+----------
+
+### Add Gem To Project
 
 Add this line to your application's Gemfile:
 
@@ -12,17 +17,128 @@ gem 'peanut_gallery'
 
 And then execute:
 
-    $ bundle
+```text
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install peanut_gallery
+```text
+$ gem install peanut_gallery
+```
+
+### Add the Comment Model
+
+Next, you'll want to add a `Comment` model to your application. You can do this
+by running the install generator:
+
+```text
+$ bundle exec rails g peanut_gallery:install
+```
+
+This will add a migration, so you'll want to migrate your database.
+
+```text
+$ bundle exec rake db:migrate
+```
+
+> The install generator adds a `Comment` model to your application. You'll
+> notice the model file has no content, but still works. That's because it is
+> inheriting from the `PeanutGallery::Comment` model. This is so we can hide
+> the abstracted (repeated) logic. But, you're welcome to override any default
+> logic in your project's `Comment` model.
+>
+> *Note: PeanutGallery never accesses the base model by default. It will always
+> look for the `Comment` model in your project.*
+
+Usage
+----------
+
+There are three items to be concerned with to get PeanutGallery working
+properly:
+
+1. Routes
+2. Associations
+3. Forms
+
+### Routes
+
+Running the install generator should add the following to your
+`config/routes.rb` file:
+
+```ruby
+namespace :peanut_gallery do
+  resources :comments, :only => [:create, :update, :destroy]
+end
+```
+
+If something went wrong and you don't see this, go ahead and add it manually.
+
+### Associations
+
+For any model that you want to have comments, all you have to do is all
+`has_comments` to the model. For example, if a `Post` model has comments, your
+model might look like this:
+
+```ruby
+class Post < ActiveRecord::Base
+  has_comments
+end
+```
+
+This means you can call `comments` on any single object within this model.
+
+### Forms
+
+There is a helper made available to you for rendering a form:
+
+```erb
+<%= new_comment_form(object, author) %>
+```
+
+Here the `object` is the item to which you want to attach the comment. The
+`author` is the object of the user who is adding the comment.
+
+> *Note: PeanutGallery assumes (but does not require) you're using a `User`
+> model, and that the logged in user is `current_user`. Therefore, you can
+> leave off the `author` parameter if you have your current user wrapped up in
+> a `current_user` method.
+
+Helpers
+----------
+
+### Deleting Comments
+
+In addition to the forms helper, there is also a helper to delete a comment.
+
+```erb
+<%= delete_comment_link(comment_object) %>
+```
+
+Of course, you can write this manually (or add your own helper) if you'd like
+to.
+
+Customization
+----------
+
+### Overriding A User Model
+
+PeanutGallery assumes the use of a user model. If you want to override that, you'll need to add the association into your `Comment` model:
+
+```ruby
+class Comment < ActiveRecord::Base
+  belongs_to :author, :class_name => 'YourUserClassName'
+end
+```
 
-## Usage
+### Controller Actions
 
-TODO: Write usage instructions here
+The controller doing all the work for PeanutGallery is the
+`PeanutGallery::CommentsController`. If you want to override it, you can create
+a controller at `app/controllers/peanut_gallery/comments_controller.rb`.
 
-## Contributing
+Contributing
+----------
 
 1. Fork it ( https://github.com/[my-github-username]/peanut_gallery/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/app/controllers/peanut_gallery/comments_controller.rb

@@ -0,0 +1,45 @@
+class PeanutGallery::CommentsController < ApplicationController
+
+  def create
+    @comment = Comment.new(comment_params)
+    if @comment.save
+      redirect_to params[:peanut_gallery_comment][:redirect_route],
+                  :notice => 'Comment created!'
+    else
+      redirect_to params[:peanut_gallery_comment][:redirect_route],
+                  :notice => 'Comment could not be saved.'
+    end
+  end
+
+  def update
+    @comment = Comment.find_by_id(params[:id])
+    if @comment.nil?
+      raise "Could not find comment."
+    else
+      if @comment.save
+        redirect_to request.referrer, :notice => 'Comment saved!'
+      else
+        redirect_to request.referrer, :notice => 'Comment could not be saved.'
+      end
+    end
+  end
+
+  def destroy
+    @comment = Comment.find_by_id(params[:id])
+    if @comment.nil?
+      raise "Could not find comment."
+    else
+      @comment.destroy
+      redirect_to request.referrer, :notice => 'Comment deleted!'
+    end
+  end
+
+  private
+
+    def comment_params
+      params
+        .require(:peanut_gallery_comment)
+        .permit(:markdown, :item_id, :item_type, :author_id)
+    end
+
+end

data/app/helpers/peanut_gallery/comments_helper.rb

@@ -0,0 +1,27 @@
+module PeanutGallery
+  module CommentsHelper
+
+    def new_comment_form(obj, author = current_user)
+      @comment = Comment.new if @comment.nil?
+      simple_form_for @comment do |f|
+        o  = f.input :markdown, :label => false,
+                     :placeholder => 'Add a comment ...'
+        o += f.input :item_id, :as => :hidden,
+                     :input_html => { :value => obj.id }
+        o += f.input :item_type, :as => :hidden,
+                     :input_html => { :value => obj.class.to_s }
+        o += f.input :author_id, :as => :hidden,
+                     :input_html => { :value => author.id }
+        o += f.input :redirect_route, :as => :hidden,
+                     :input_html => { :value => request.path }
+        o += f.submit "Add Comment"
+      end
+    end
+
+    def delete_comment_link(comment)
+      link_to 'Delete Comment', peanut_gallery_comment_path(comment),
+              :method => :delete, :data => { :confirm => 'Are you sure?' }
+    end
+
+  end
+end

data/app/models/peanut_gallery/comment.rb

@@ -0,0 +1,15 @@
+module PeanutGallery
+  class Comment < ActiveRecord::Base
+
+    converts_markdown :markdown, :html
+
+    belongs_to :item, :polymorphic => true
+    belongs_to :author, :class_name => 'User'
+
+    default_scope { includes(:item, :author) }
+
+    scope :newest_first, -> { order('created_at desc') }
+    scope :oldest_first, -> { order('created_at asc') }
+
+  end
+end

data/app/views/comments/_comment.html.erb

@@ -0,0 +1,6 @@
+<article class="comment">
+  <%= comment.html.html_safe %>
+  <%= content_tag :span, "by #{comment.author.name}", :class => 'author' %>
+  <%= content_tag :span, "#{time_ago_in_words(comment.created_at)} ago",
+                  :class => 'date' %>
+</article>

data/lib/generators/peanut_gallery/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rails/generators'
+
+module PeanutGallery
+  class InstallGenerator < Rails::Generators::Base
+    desc "Add comment model migration to your project"
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_comment_model
+      cols  = "item_id:integer item_type:string author_id:integer "
+      cols += "markdown:text html:text"
+      generate "model comment #{cols}"
+    end
+
+    def change_model_inheritance
+      gsub_file 'app/models/comment.rb', /ActiveRecord\:\:Base/,
+                'PeanutGallery::Comment'
+    end
+
+    def add_routes
+      routes  = "\n  namespace :peanut_gallery do\n"
+      routes += "    resources :comments, :only => [:create, :update, :destroy]\n"
+      routes += "  end\n"
+      inject_into_file 'config/routes.rb', routes,
+                       :after => /Rails\.application\.routes\.draw\ do\n/
+    end
+  end
+end

data/lib/peanut_gallery.rb

@@ -1,5 +1,9 @@
+require 'peanut_gallery/engine'
+require "peanut_gallery/has_comments"
 require "peanut_gallery/version"
 
+require 'mark_it_zero'
+require 'simple_form'
+
 module PeanutGallery
-  # Your code goes here...
 end

data/lib/peanut_gallery/engine.rb

@@ -0,0 +1,4 @@
+module PeanutGallery
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/peanut_gallery/has_comments.rb

@@ -0,0 +1,7 @@
+class << ActiveRecord::Base
+
+  def has_comments
+    has_many :comments, :as => :item
+  end
+
+end

data/lib/peanut_gallery/version.rb

@@ -1,3 +1,3 @@
 module PeanutGallery
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/peanut_gallery.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'mark_it_zero', "~> 0.3.1"
+  spec.add_dependency 'simple_form'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peanut_gallery
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean C Davis
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mark_it_zero
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - scdavis41@gmail.com
@@ -50,7 +78,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/peanut_gallery/comments_controller.rb
+- app/helpers/peanut_gallery/comments_helper.rb
+- app/models/peanut_gallery/comment.rb
+- app/views/comments/_comment.html.erb
+- lib/generators/peanut_gallery/install_generator.rb
 - lib/peanut_gallery.rb
+- lib/peanut_gallery/engine.rb
+- lib/peanut_gallery/has_comments.rb
 - lib/peanut_gallery/version.rb
 - peanut_gallery.gemspec
 homepage: ''