rails_page_comment 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa94be8d319a8caa4d8f6c65637473b0c5cc601
+  data.tar.gz: 97f909835fa5786c4b6a5013130f5fa9a29c5765
+SHA512:
+  metadata.gz: 567e00422086e310d9114ded43d4b4f1e2bfb45b02916aa6accf13bf4de5d34945cc870fd5f7fb5e42a110e1aa01c48c08e66d7fa8e549c1c506b76e3dcb3d69
+  data.tar.gz: 012955440e9107f065a3082071c2ba36055411ec3ee904f8b881d3e9b7a77b67dec9cc9af5333beb8e94b0f230ef412f5918a3159c90f8b66ae4f465af4d381a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,45 @@
+# Rails Page Comment
+
+
+
+## Features
+
+Write comment on the page.
+
+## Installation
+
+For basic usage just include ckeditor gem:
+
+```
+gem 'rails_page_comment'
+```
+
+
+### How generate config files
+
+
+```
+rails generate rails_page_comment:install
+```
+
+
+To use set it show on the page or not, add this to an initializer.
+
+```ruby
+# in config/initializers/rails_page_comment.rb
+
+Ckeditor.setup do |config|
+  config.show_on_page = true/false
+end
+```
+##Usage
+
+```ruby
+class ApplicationController < ActionController::Base
+
+  page_comment_resource
+
+end
+```
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'RailsPageComment'
+  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.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/rails_page_comment/application.js

@@ -0,0 +1,13 @@
+// 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_tree .

data/app/assets/javascripts/rails_page_comment/page_comments.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/rails_page_comment/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/rails_page_comment/page_comments.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/rails_page_comment/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsPageComment
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/rails_page_comment/page_comments_controller.rb

@@ -0,0 +1,62 @@
+require_dependency "rails_page_comment/application_controller"
+
+module RailsPageComment
+  class PageCommentsController < ApplicationController
+    before_action :set_page_comment, only: [:show, :edit, :update, :destroy]
+
+    # GET /page_comments
+    def index
+      @page_comments = PageComment.all
+    end
+
+    # GET /page_comments/1
+    def show
+    end
+
+    # GET /page_comments/new
+    def new
+      @page_comment = PageComment.new
+    end
+
+    # GET /page_comments/1/edit
+    def edit
+    end
+
+    # POST /page_comments
+    def create
+      @page_comment = PageComment.new(create_page_comment_params)
+      if @page_comment.save
+        render :edit
+      else
+        render :nothing  => true
+      end
+    end
+
+    # PATCH/PUT /page_comments/1
+    def update
+      if @page_comment.update(update_page_comment_params)
+        render :edit
+      else
+        render :edit
+      end
+    end
+
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_page_comment
+        @page_comment = PageComment.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def create_page_comment_params
+        params.require(:page_comment).permit(:content, :page_uri)
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def update_page_comment_params
+        params.require(:page_comment).permit(:content)
+      end
+
+  end
+end

data/app/helpers/rails_page_comment/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsPageComment
+  module ApplicationHelper
+  end
+end

data/app/helpers/rails_page_comment/page_comments_helper.rb

@@ -0,0 +1,4 @@
+module RailsPageComment
+  module PageCommentsHelper
+  end
+end

data/app/models/rails_page_comment/page_comment.rb

@@ -0,0 +1,4 @@
+module RailsPageComment
+  class PageComment < ActiveRecord::Base
+  end
+end

data/app/views/layouts/rails_page_comment/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsPageComment</title>
+  <%= stylesheet_link_tag    "rails_page_comment/application", media: "all" %>
+  <%= javascript_include_tag "rails_page_comment/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/rails_page_comment/page_comments/_form.html.erb

@@ -0,0 +1,13 @@
+<div style="text-align: center" id="page_comment">
+  <h1>本画面／機能の詳細仕様説明:</h1><br/>
+<%= form_for(@page_comment, :remote => true) do |f| %>
+   <%= hidden_field_tag :authenticity_token, @_csrf_token%>
+  <div class="field">
+    <%= f.hidden_field :page_uri%>
+    <%= f.text_area :content, cols: 90, rows: 20%>
+  </div>
+  <div class="actions">
+    <%= f.submit "保存"%>
+  </div>
+<% end %>
+</div>

data/app/views/rails_page_comment/page_comments/edit.html.erb

@@ -0,0 +1 @@
+<%= render 'form' %>

data/app/views/rails_page_comment/page_comments/edit.js.erb

@@ -0,0 +1 @@
+$('#page_comment').html("<%= j render :partial => 'form'%>");alert('保存しました。');

data/app/views/rails_page_comment/page_comments/index.html.erb

@@ -0,0 +1,27 @@
+<h1>Listing page_comments</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Requst uri</th>
+      <th>Content</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @page_comments.each do |page_comment| %>
+      <tr>
+        <td><%= page_comment.requst_uri %></td>
+        <td><%= page_comment.content %></td>
+        <td><%= link_to 'Show', page_comment %></td>
+        <td><%= link_to 'Edit', edit_page_comment_path(page_comment) %></td>
+        <td><%= link_to 'Destroy', page_comment, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Page comment', new_page_comment_path %>

data/app/views/rails_page_comment/page_comments/new.html.erb

@@ -0,0 +1 @@
+<%= render :partial => '/form' %>

data/app/views/rails_page_comment/page_comments/show.html.erb

@@ -0,0 +1,14 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Requst uri:</strong>
+  <%= @page_comment.requst_uri %>
+</p>
+
+<p>
+  <strong>Content:</strong>
+  <%= @page_comment.content %>
+</p>
+
+<%= link_to 'Edit', edit_page_comment_path(@page_comment) %> |
+<%= link_to 'Back', page_comments_path %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+RailsPageComment::Engine.routes.draw do
+
+  resources :page_comments
+
+end

data/db/migrate/20141105030748_create_rails_page_comment_page_comments.rb

@@ -0,0 +1,10 @@
+class CreateRailsPageCommentPageComments < ActiveRecord::Migration
+  def change
+    create_table :rails_page_comment_page_comments do |t|
+      t.string :page_uri
+      t.text :content
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/rails_page_comment/install_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module RailsPageComment
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Generates migration for Page Comment (RailsPageComment) models"
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      # copy configuration
+      def copy_initializer
+        template "rails_page_comment.rb", "config/initializers/rails_page_comment.rb"
+      end
+
+      def mount_engine
+        route "mount RailsPageComment::Engine => '/rails_page_comment'"
+      end
+
+      # def create_models
+      #   [:page_comment].each do |filename|
+      #     template "#{generator_dir}/rails_page_comment/#{filename}.rb",
+      #              File.join('app/models', rails_page_comment_dir, "#{filename}.rb")
+      #   end
+      # end
+      #
+      def create_migrations
+          migration_template "#{generator_dir}/migration.rb", File.join('db/migrate', "create_rails_page_comment_page_comments.rb")
+      end
+
+      protected
+
+        def rails_page_comment_dir
+          'rails_page_comment'
+        end
+
+        def generator_dir
+          @generator_dir ||= 'active_record'
+        end
+
+    end
+  end
+end

data/lib/generators/rails_page_comment/templates/active_record/migration.rb

@@ -0,0 +1,16 @@
+class CreateRailsPageCommentPageComments < ActiveRecord::Migration
+  def self.up
+    create_table :rails_page_comment_page_comments do |t|
+      t.string  :page_uri, :null => false
+
+      t.text :content
+      t.timestamps
+    end
+
+    add_index "rails_page_comment_page_comments", ["page_uri"], :name => "idx_rails_page_comment_page_comments_page_uri"
+  end
+
+  def self.down
+    drop_table :rails_page_comment_page_comments
+  end
+end

data/lib/generators/rails_page_comment/templates/active_record/rails_page_comment/page_comment.rb

@@ -0,0 +1,3 @@
+class RailsPageComment::PageComment < ActiveRecord::Base
+
+end

data/lib/generators/rails_page_comment/templates/rails_page_comment.rb

@@ -0,0 +1,7 @@
+# Use this hook to configure RailsPageComment
+RailsPageComment.setup do |config|
+  # show comment on page or not
+
+  config.show_on_page = true
+
+end

data/lib/rails_page_comment/controller_additions.rb

@@ -0,0 +1,34 @@
+module RailsPageComment
+
+  # This module is automatically included into all controllers.
+  module ControllerAdditions
+    module ClassMethods
+      # Sets up a before filter which loads and authorizes the current resource. This performs both
+      #
+      #   class BooksController < ApplicationController
+      #     page_comment_resource
+      #   end
+      #
+      def page_comment_resource(*args)
+        page_comment_resource_class.add_after_filter(self, :page_comment_resource, *args)
+      end
+
+      def page_comment_resource_class
+        ControllerResource
+      end
+
+
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include RailsPageComment::ControllerAdditions
+  end
+end

data/lib/rails_page_comment/controller_resource.rb

@@ -0,0 +1,52 @@
+module RailsPageComment
+  # Handle the load and authorization controller logic so we don't clutter up all controllers with non-interface methods.
+  # This class is used internally, so you do not need to call methods directly on it.
+  class ControllerResource # :nodoc:
+
+    ActionView::Base.send(:include, RailsPageComment::Engine.routes.url_helpers) # brings ActionDispatch::Routing::UrlFor
+    ActionView::Base.send(:include, ActionView::Helpers::TagHelper)
+    ActionView::Base.send(:include, ActiveSupport::Configurable)
+    ActionView::Base.send(:include, ActionController::RequestForgeryProtection)
+
+    def self.add_after_filter(controller_class, method, *args)
+      if  RailsPageComment.show_on_page
+        options = args.extract_options!
+        resource_name = args.first
+        before_filter_method = options.delete(:prepend) ? :prepend_after_filter : :after_filter
+        controller_class.send(before_filter_method, options.slice(:only, :except, :if, :unless)) do |controller|
+          controller.class.page_comment_resource_class.new(controller, resource_name, options.except(:only, :except, :if, :unless)).send(method)
+        end
+      end
+    end
+
+    def initialize(controller, *args)
+      @controller = controller
+      @params = controller.params
+      @options = args.extract_options!
+      @name = args.first
+    end
+
+    def page_comment_resource
+      if !@controller.request.xhr?
+        page_controller = RailsPageComment::PageCommentsController.new
+        page_controller.request = @controller.request
+        av = ActionView::Base.new(File.join(Gem.loaded_specs['rails_page_comment'].full_gem_path, 'app', 'views', 'rails_page_comment', 'page_comments'), {}, )
+        page_uri = [@controller.params[:controller], @controller.params[:action]].join("/")
+        page_comment = RailsPageComment::PageComment.find_by(:page_uri => page_uri) || RailsPageComment::PageComment.new(:page_uri => page_uri)
+        av.assign({
+                      :page_comment => page_comment,
+                      :_csrf_token => @controller.session[:_csrf_token]
+                  })
+        if page_comment.new_record?
+          html = av.render(:template => "new")
+        else
+          html = av.render(:template => "edit")
+        end
+
+        @controller.response.body = @controller.response.body.gsub('</body>',"#{html}</body>")
+      end
+    end
+
+
+  end
+end

data/lib/rails_page_comment/engine.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'rails_page_comment'
+
+module RailsPageComment
+  class Engine < ::Rails::Engine
+
+    isolate_namespace RailsPageComment
+
+  end
+end

data/lib/rails_page_comment/version.rb

@@ -0,0 +1,3 @@
+module RailsPageComment
+  VERSION = "0.0.3"
+end

data/lib/rails_page_comment.rb

@@ -0,0 +1,20 @@
+require "rails_page_comment/version"
+require 'rails_page_comment/engine'
+require 'rails_page_comment/controller_resource'
+require 'rails_page_comment/controller_additions'
+
+module RailsPageComment
+  # Your code goes here...
+  mattr_accessor :show_on_page
+  @@show_on_page = true
+
+  module Helpers
+
+  end
+
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/tasks/rails_page_comment_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_page_comment do
+#   # Task goes here
+# end

data/test/controllers/rails_page_comment/page_comments_controller_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+module RailsPageComment
+  class PageCommentsControllerTest < ActionController::TestCase
+    setup do
+      @page_comment = page_comments(:one)
+    end
+
+    test "should get index" do
+      get :index
+      assert_response :success
+      assert_not_nil assigns(:page_comments)
+    end
+
+    test "should get new" do
+      get :new
+      assert_response :success
+    end
+
+    test "should create page_comment" do
+      assert_difference('PageComment.count') do
+        post :create, page_comment: { content: @page_comment.content, requst_uri: @page_comment.requst_uri }
+      end
+
+      assert_redirected_to page_comment_path(assigns(:page_comment))
+    end
+
+    test "should show page_comment" do
+      get :show, id: @page_comment
+      assert_response :success
+    end
+
+    test "should get edit" do
+      get :edit, id: @page_comment
+      assert_response :success
+    end
+
+    test "should update page_comment" do
+      patch :update, id: @page_comment, page_comment: { content: @page_comment.content, requst_uri: @page_comment.requst_uri }
+      assert_redirected_to page_comment_path(assigns(:page_comment))
+    end
+
+    test "should destroy page_comment" do
+      assert_difference('PageComment.count', -1) do
+        delete :destroy, id: @page_comment
+      end
+
+      assert_redirected_to page_comments_path
+    end
+  end
+end