spree_comments 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+spec/test_app

data/Gemfile

@@ -0,0 +1,32 @@
+source 'http://rubygems.org'
+
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+group :test do
+  gem 'rspec-rails', '= 2.4.1'
+  gem 'factory_girl_rails'
+  gem 'rcov'
+  gem 'shoulda'
+  gem 'faker'
+  if RUBY_VERSION < "1.9"
+    gem "ruby-debug"
+  else
+    gem "ruby-debug19"
+  end
+end
+
+group :cucumber do
+  gem 'cucumber-rails'
+  gem 'database_cleaner', '~> 0.5.2'
+  gem 'nokogiri'
+  gem 'capybara'
+  gem 'factory_girl_rails'
+  gem 'faker'
+  gem 'launchy'
+
+  if RUBY_VERSION < "1.9"
+    gem "ruby-debug"
+  else
+    gem "ruby-debug19"
+  end
+end

data/README.markdown

@@ -0,0 +1,38 @@
+# Spree Comments
+
+Spree Comments is an extension for Spree to allow commenting on different models via the
+admin ui and currently supports Orders & Shipments.
+
+Spree Comments also supports optional comment Types which can be defined per comment-able
+object (i.e. Order, Shipment, etc) via the admin Configuration tab.
+
+This is based on a fork / rename of jderrett/spree-order-comments and is now an officially
+supported extension.
+
+Requirements:
+
+* [acts\_as\_commentable](http://github.com/jackdempsey/acts_as_commentable) installed
+
+Notes:
+
+* Comments are read-only.  You cannot edit or remove them from the Admin UI.
+
+* Comment model and migration are included in the gem.  You do NOT need to follow the
+acts\_as\_commentable instructions for script/generate comment
+
+## Installation
+
+1. Add the following to your Gemfile
+  gem "spree_comments"
+  gem "acts_as_commentable"
+
+2. Run `bundle install`
+
+3. Copy over migrations via the rake task:
+  rake spree_comments:install
+
+4. Run the migrations: `rake db:migrate`
+
+5. Start your server: `script/rails s`
+
+

data/Rakefile

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc "Default Task"
+task :default => [ :spec ]
+
+gemfile = File.expand_path('../spec/test_app/Gemfile', __FILE__)
+if File.exists?(gemfile) && %w(rcov spec cucumber).include?(ARGV.first.to_s)
+  require 'bundler'
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  Bundler.setup
+
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new do |t|
+    t.cucumber_opts = %w{--format pretty}
+  end
+
+  desc "Run specs with RCov"
+  RSpec::Core::RakeTask.new(:rcov) do |t|
+    t.rcov = true
+    t.rcov_opts = %w{ --exclude gems\/,spec\/,features\/}
+    t.verbose = true
+  end
+
+end
+
+desc "Regenerates a rails 3 app for testing"
+task :test_app do
+  SPREE_PATH = ENV['SPREE_PATH']
+  raise "SPREE_PATH should be specified" unless SPREE_PATH
+  require File.join(SPREE_PATH, 'lib/generators/spree/test_app_generator')
+  class AuthTestAppGenerator < Spree::Generators::TestAppGenerator
+    def tweak_gemfile
+      append_file 'Gemfile' do
+<<-gems
+gem 'spree_core', :path => '#{File.join(SPREE_PATH, 'core')}'
+gem 'spree_auth', :path => '#{File.join(SPREE_PATH, 'auth')}'
+gem 'spree_comments', :path => '#{File.dirname(__FILE__)}'
+gems
+      end
+    end
+
+    def install_gems
+      inside "test_app" do
+        run 'rake spree_core:install'
+        run 'rake spree_auth:install'
+        run 'rake spree_comments:install'
+      end
+    end
+
+    def migrate_db
+      run_migrations
+    end
+  end
+  AuthTestAppGenerator.start
+end
+
+namespace :test_app do
+  desc 'Rebuild test and cucumber databases'
+  task :rebuild_dbs do
+    system("cd spec/test_app && rake db:drop db:migrate RAILS_ENV=test && rake db:drop db:migrate RAILS_ENV=cucumber")
+  end
+end
+

data/app/controllers/admin/comment_types_controller.rb

@@ -0,0 +1,7 @@
+class Admin::CommentTypesController < Admin::BaseController
+  resource_controller
+
+  update.wants.html { redirect_to collection_url }
+  create.wants.html { redirect_to collection_url }
+  destroy.success.wants.js { render_js_for_destroy }
+end

data/app/controllers/admin/comments_controller.rb

@@ -0,0 +1,9 @@
+class Admin::CommentsController < Admin::BaseController
+  resource_controller
+
+  create.response do |wants|
+    # go to edit form after creating as new product
+    wants.html {redirect_to :back}
+  end
+
+end

data/app/models/comment.rb

@@ -0,0 +1,16 @@
+class Comment < ActiveRecord::Base
+  include ActsAsCommentable::Comment
+
+  belongs_to :commentable, :polymorphic => true
+  belongs_to :comment_type
+
+  default_scope :order => 'created_at ASC'
+
+  # NOTE: install the acts_as_votable plugin if you
+  # want user to vote on the quality of comments.
+  #acts_as_voteable
+
+  # NOTE: Comments belong to a user
+  belongs_to :user
+
+end

data/app/models/comment_type.rb

@@ -0,0 +1,3 @@
+class CommentType < ActiveRecord::Base
+  has_many :comments
+end

data/app/views/admin/comment_types/_form.html.erb

@@ -0,0 +1,16 @@
+<%- locals = {:f => f} -%>
+<%= hook :admin_comment_type_form_fields, locals do %>
+  <%= f.field_container :name do %>
+    <%= f.label :name, t("name") %><br />
+    <%= f.text_field :name, :class => 'fullwidth title' %>
+    <%= error_message_on :comment_type, :name %>
+  <% end %>
+
+  <%= f.field_container :applies_to do %>
+    <%= f.label :applies_to, t("applies_to") %><br />
+    <%= f.text_field :applies_to, :value => f.object.nil? ? "Order" : f.object.applies_to, :class => 'fullwidth title' %>
+    <%= error_message_on :comment_type, :applies_to%>
+  <% end %>
+
+<% end %>
+

data/app/views/admin/comment_types/edit.html.erb

@@ -0,0 +1,16 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<%= hook :admin_comment_type_edit_form_header do %>
+  <h1><%= t("editing_comment_type") %></h1>
+  <%= render "shared/error_messages", :target => @comment_type %>
+<% end %>
+
+<%= hook :admin_comment_type_edit_form do %>
+  <%= form_for(@comment_type, :url => object_url, :html => { :method => :put }) do |f| %>
+    <%= render :partial => "form", :locals => { :f => f } %>
+
+    <%= hook :admin_comment_type_edit_form_buttons do %>
+      <%= render :partial => "admin/shared/edit_resource_links" %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/admin/comment_types/index.html.erb

@@ -0,0 +1,44 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<div class='toolbar'>
+  <ul class='actions'>
+    <li>
+      <%= button_link_to t("new_comment_type"), new_object_url, :icon => 'add'  %>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<h1><%= t("comment_types") %></h1>
+
+<table class="index">
+  <thead>
+    <tr>
+    <%= hook :admin_comment_types_index_headers do %>
+      <th><%= t("name") %></th>
+      <th><%= t("applies_to") %></th>
+    <% end %>
+      <th>
+        <% hook :admin_comment_types_index_header_actions %>
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @comment_types.each do |comment_type| %>
+      <tr id="<%= dom_id comment_type %>">
+        <%- locals = {:comment_type => comment_type} -%>
+        <%= hook :admin_comment_types_index_rows, locals do %>
+          <td><%= comment_type.name %></td>
+          <td><%= comment_type.applies_to %></td>
+        <% end %>
+        <td width="140px">
+          <%= hook :admin_comment_types_index_row_actions, locals do %>
+            <%= link_to_edit comment_type %> &nbsp;
+            <%= link_to_delete comment_type %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+

data/app/views/admin/comment_types/new.html.erb

@@ -0,0 +1,17 @@
+<%= render :partial => 'admin/shared/configuration_menu' %>
+
+<%= hook :admin_comment_type_new_form_header do %>
+  <h1><%= t("new_comment_type") %></h1>
+
+  <%= render "shared/error_messages", :target => @comment_type %>
+<% end %>
+
+<%= hook :admin_comment_type_new_form do %>
+  <%= form_for(:comment_type, :url => collection_url) do |f| %>
+    <%= render :partial => "form", :locals => { :f => f } %>
+
+    <%= hook :admin_comment_type_new_form_buttons do %>
+      <%= render :partial => "admin/shared/new_resource_links" %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/admin/orders/_tab.html.erb

@@ -0,0 +1,3 @@
+<li <%= raw ' class="active"' if current == "Comments" %>>
+   <%= link_to t("comments"), comments_admin_order_url(@order) %>
+</li>

data/app/views/admin/orders/comments.html.erb

@@ -0,0 +1,2 @@
+<%= render "admin/shared/order_tabs", :current => "Comments" %>
+<%= render "admin/shared/comments", :commentable => @order %>

data/app/views/admin/shared/_comments.html.erb

@@ -0,0 +1,62 @@
+<h1><%= "#{t("comments")} #{(t('for') + " " + comments_for unless (comments_for rescue nil).nil?)}"%></h1>
+
+<table class="index">
+  <tr>
+    <th style="width:140px;"><%= "#{t('spree.date')}/#{t('spree.time')}" %></th>
+    <% unless @comment_types.empty? %>
+      <th><%= t("type") %></th>
+    <% end %>
+    <th><%= t("comment") %></th>
+  </tr>
+  <% commentable.comments.reverse.each_with_index do |comment, index| %>
+    <tr id="<%= dom_id(comment) %>">
+      <td><%= comment.created_at.to_formatted_s(:long) %></td>
+      <% unless @comment_types.empty? %>
+        <td><%= comment.comment_type.name if comment.comment_type %></td>
+      <% end %>
+      <td>
+        <div id="order-comment-header-<%= index %>" class="order-comment-header">
+          <strong><%= comment.user.email%> said:</strong>
+        </div>
+        <div id="order-comment-body-<%= index %>" class="order-comment-body">
+          <%= comment.comment %>
+        </div>
+      </td>
+     </tr>
+  <% end %>
+</table>
+
+
+<div class="order-add-comment">
+  <% form_for(:comment, :url => admin_comments_url) do |f| %>
+    <%= hidden_field_tag 'comment[commentable_id]', commentable.id %>
+    <%= hidden_field_tag 'comment[commentable_type]', commentable.class %>
+    <%= hidden_field_tag 'comment[user_id]', current_user.id %>
+
+    <table class="index">
+      <thead>
+        <th colspan="2"><%= t('add_comment') %></th>
+      </thead>
+      <tbody>
+         <% unless @comment_types.empty? %>
+          <tr>
+            <td><%= f.label :comment_type_id, t("type") %><br /></td>
+            <td><%= f.select :comment_type_id, @comment_types.map{|ct| [ct.name, ct.id]},{} ,:class => 'title' %></td>
+          </tr>
+        <% end %>
+        <tr>
+          <td style="width:140px;"><%= f.label :comment, t("comment") %></td>
+          <td><%= f.text_area :comment,  {:style => 'height:150px;', :class => 'fullwidth'} %></td>
+        </tr>
+        <tr>
+          <td>&nbsp;</td>
+          <td>      <%= button t('add_comment') %></td>
+        </tr>
+      </tbody>
+    </table>
+
+    <p class="form-buttons">
+
+    </p>
+  <% end %>
+</div>

data/app/views/admin/shipments/_button.html.erb

@@ -0,0 +1,4 @@
+<li>
+  <%= button_link_to(t("comments"), comments_admin_order_shipment_url(@order, @shipment)) %>
+</li>
+

data/app/views/admin/shipments/comments.html.erb

@@ -0,0 +1,2 @@
+<%= render "admin/shared/order_tabs", :current => "Shipments" %>
+<%= render "admin/shared/comments", {:commentable => @shipment, :comments_for => "Shipment ##{@shipment.number}"} %>

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+---
+en:
+  for: for
+  comments: Comments
+  comment: Comment
+  add_comment: Add Comment
+  add_comment_type: Add Comment Type
+  comment_types: Comment Types
+  manage_comment_types: Manage comment types
+  applies_to: Applies To
+  new_comment_type: New Comment Type
+  editing_comment_type: Editing Comment Type

data/config/routes.rb

@@ -0,0 +1,33 @@
+
+#map.namespace :admin do |admin|
+#  admin.resources :comments
+#  admin.resources :comment_types
+#
+#  admin.resources :orders, :member => {:comments => :get} do |order|
+#    order.resources :shipments, :member => {:comments => :get}
+#  end
+#end
+#
+
+Rails.application.routes.draw do
+  namespace :admin do
+    resources :comments
+    resources :comment_types
+
+    resources :orders do
+      member do
+        get :comments
+      end
+
+      resources :shipments do
+        member do
+         get :comments
+       end
+      end
+    end
+  end
+
+#match '/admin/comments' => 'admin/comments', :via => [:get, :post]
+#  match '/admin/comment_types' => 'admin/comment_types', :via => [:get, :post]
+end
+

data/db/migrate/20091021182639_create_comments.rb

@@ -0,0 +1,19 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.string :title, :limit => 50, :default => "" 
+      t.text :comment, :default => "" 
+      t.references :commentable, :polymorphic => true
+      t.references :user
+      t.timestamps
+    end
+
+    add_index :comments, :commentable_type
+    add_index :comments, :commentable_id
+    add_index :comments, :user_id
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/db/migrate/20100406085611_create_comment_types.rb

@@ -0,0 +1,13 @@
+class CreateCommentTypes < ActiveRecord::Migration
+  def self.up
+    create_table :comment_types do |t|
+      t.string :name
+      t.string :applies_to
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comment_types
+  end
+end

data/db/migrate/20100406100728_add_type_to_comments.rb

@@ -0,0 +1,9 @@
+class AddTypeToComments < ActiveRecord::Migration
+  def self.up
+    add_column :comments, :comment_type_id, :integer
+  end
+
+  def self.down
+    remove_column :comments, :comment_type_id
+  end
+end

data/lib/spree_comments.rb

@@ -0,0 +1,37 @@
+require 'spree_core'
+require 'acts_as_commentable'
+require 'spree_comments_hooks'
+
+module SpreeComments
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+	  def self.activate
+	    Order.class_eval do
+	      acts_as_commentable
+	    end
+	
+	    Shipment.class_eval do
+	      acts_as_commentable
+	    end
+	
+	    Admin::OrdersController.class_eval do
+	      def comments
+	        load_object
+	        @comment_types = CommentType.find(:all, :conditions => {:applies_to => "Order"} )
+	      end
+	    end
+	
+	    Admin::ShipmentsController.class_eval do
+	      def comments
+	        load_object
+	        @comment_types = CommentType.find(:all, :conditions => {:applies_to => "Shipment"} )
+	      end
+	    end
+	
+	  end
+
+    config.to_prepare  &method(:activate).to_proc
+	end
+end

data/lib/spree_comments_hooks.rb

@@ -0,0 +1,10 @@
+class SpreeCommentsHooks < Spree::ThemeSupport::HookListener
+  insert_after :admin_order_tabs, :partial => "admin/orders/tab"
+
+  insert_after :admin_shipment_edit_buttons, :partial => "admin/shipments/button"
+
+  insert_after :admin_configurations_menu do
+    "<%= configurations_menu_item(I18n.t('comment_types'), admin_comment_types_url, I18n.t('manage_comment_types')) %>"
+  end
+
+end

data/lib/tasks/install.rake

@@ -0,0 +1,15 @@
+namespace :spree_comments do
+  desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['spree_comments:install:migrations'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+end

data/spree_comments.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.platform  = Gem::Platform::RUBY
+  s.name      = 'spree_comments'
+  s.version   = '1.0.0'
+  s.summary   = 'Comments for orders and shipments'
+  s.homepage  = 'http://www.spreecommerce.com'
+  s.author    = 'Rails Dog'
+  s.email     = 'gems@railsdog.com'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]  
+  s.has_rdoc      = false
+
+  s.add_dependency('spree_core', '>=0.30.0')
+  s.add_dependency('acts_as_commentable', '3.0.0')
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: spree_comments
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rails Dog
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-21 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 103
+        segments: 
+        - 0
+        - 30
+        - 0
+        version: 0.30.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: acts_as_commentable
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: gems@railsdog.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- app/controllers/admin/comment_types_controller.rb
+- app/controllers/admin/comments_controller.rb
+- app/models/comment.rb
+- app/models/comment_type.rb
+- app/views/admin/comment_types/_form.html.erb
+- app/views/admin/comment_types/edit.html.erb
+- app/views/admin/comment_types/index.html.erb
+- app/views/admin/comment_types/new.html.erb
+- app/views/admin/orders/_tab.html.erb
+- app/views/admin/orders/comments.html.erb
+- app/views/admin/shared/_comments.html.erb
+- app/views/admin/shipments/_button.html.erb
+- app/views/admin/shipments/comments.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20091021182639_create_comments.rb
+- db/migrate/20100406085611_create_comment_types.rb
+- db/migrate/20100406100728_add_type_to_comments.rb
+- lib/spree_comments.rb
+- lib/spree_comments_hooks.rb
+- lib/tasks/install.rake
+- spree_comments.gemspec
+has_rdoc: true
+homepage: http://www.spreecommerce.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Comments for orders and shipments
+test_files: []
+