commenteux 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfdd40532498372caf8dfdee9783ebea2413ffe9
+  data.tar.gz: c02f5d0f734bc82860da0082c2ca6a7e9cb2be5b
+SHA512:
+  metadata.gz: eced13cb7a48a25157c18831c422e30ef426178e22e77c5948ceb07cdefe7a537c55e008a77e2a1692680d258a4e1568a074f1aa79c5dbdbd35cae8033fd4cd1
+  data.tar.gz: 12a6cf53d04707222abe0253d93591bd5f52a033f3a6bb0482f5c56caedae8f3fe098b591b8694d9edab17b3e06a2e2af8436e8959ec29721c8d6216095ca4df

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Groupe Fungo inc.
+
+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,49 @@
+= Commenteux
+
+This is a mountable gem that add a presentation layer to act_as_commentable.
+
+Mount this gem into your app to automatically have access to screens that list and create comments on any of your resources.
+Those screen will be inserted in your current app layout. You can call the routes of the gem with ajax passing a parent
+div where you want the response to ben inserted.
+
+Note that the presentation layer is based on bootstrap.
+
+Note that you must have act_as_commentable installed and ready in your desired resource.
+
+== Installation :
+
+Add the following line to your Gemfile
+
+=== Rails 4
+
+  gem 'commenteux'
+
+== Usage
+
+Make your ActiveRecord model act as commentable:
+
+  class Post < ActiveRecord::Base
+    acts_as_commentable
+  end
+
+Mount the commenteux gem in your routes:
+
+  mount Commenteux::Engine => "/"
+
+Call url of commenteux screens, for exemple, like that:
+
+  <%= link_to "<i class='icon-file-text text-blue'></i> Notes".html_safe, "/commenteux/client::contract/#{@contract.id}?parent_div=ajax_target", :id => "notes_tab", :data => {:remote => true} %>
+
+== Credits
+
+jackdempsey - The creator of act_as_commentable.
+
+== Contributors
+
+seurdge, rgagnon
+
+== More
+
+http://www.groupefungo.ca
+
+

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    = 'Commenteux'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/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/commenteux/application.js.coffee

@@ -0,0 +1,72 @@
+
+$ () ->
+
+  $(document).delegate '#new_notes_link', 'click', (e) ->
+    console.log('new_notes_link click')
+    event.stopPropagation()
+    event.preventDefault()
+    parent= $(@).data('parent')
+    resource =  $(@).data('resource')
+    id = $(@).data('id')
+    console.log('parent_div = ' + parent)
+    console.log('resource = ' + resource)
+    console.log('resource_id = ' + id)
+    $.ajax
+      url: "/commenteux/" + resource + "/" + id + "/new"
+      type: "get"
+      dataType: "html"
+      data:
+        "parent_div": parent
+      success: (returnData) ->
+        console.log('success')
+        console.log("#" + parent)
+        console.log(returnData)
+        if parent
+          $("#" + parent ).html(returnData)
+        else
+          console.log('no parent')
+          $('body').html(returnData)
+        @
+      error: (e) ->
+        alert(e)
+        @
+    @
+
+  $(document).delegate '#new_comments', 'ajax:success', (e, data, status, xhr) ->
+    console.log('new_comments ajax success')
+    parent = $('#new_comments').attr('data-parent')
+    if parent
+      $('#' + parent).html(xhr.responseText)
+    else
+      $('body').html(xhr.responseText)
+
+  $(document).delegate '#new_notes_cancelled', 'click', (e) ->
+    console.log('new_notes_cancelled click')
+    event.stopPropagation()
+    event.preventDefault()
+    parent= $(@).data('parent')
+    resource =  $(@).data('resource')
+    id = $(@).data('id')
+    console.log('parent_div = ' + parent)
+    console.log('resource = ' + resource)
+    console.log('resource_id = ' + id)
+    $.ajax
+      url: "/commenteux/" + resource + "/" + id + "?parent_div=" + parent
+      type: "get"
+      dataType: "html"
+      data:
+        "parent_div": parent
+      success: (returnData) ->
+        console.log('success')
+        console.log("#" + parent)
+        console.log(returnData)
+        if parent
+          $("#" + parent ).html(returnData)
+        else
+          console.log('no parent')
+          $('body').html(returnData)
+        @
+      error: (e) ->
+        alert(e)
+        @
+    @

data/app/controllers/commenteux/application_controller.rb

@@ -0,0 +1,3 @@
+class Commenteux::ApplicationController < ApplicationController
+  #Nécessaire pour hériter de La,pplication controller de l'application hôte
+end

data/app/controllers/commenteux/notes_controller.rb

@@ -0,0 +1,63 @@
+require_dependency "commenteux/application_controller"
+
+module Commenteux
+  class NotesController < ApplicationController
+
+    def comments_params
+      comments_permit_fields = [:title, :comment, :user_id]
+      params.require(:comments).permit(
+          comments_permit_fields)
+    end
+
+    def index
+      resource = fetch_resource
+      @comments = resource.comments.all
+      @parent_div = params[:parent_div]
+
+      if request.xhr?
+        render :layout => false
+      end
+
+    end
+
+    def fetch_resource
+      @resource = params[:resource]
+      @class_name = classify_namespace(params[:resource])
+      @resourceKlass = eval(@class_name)
+      @resource_id = params[:resource_id]
+      @resourceKlass.find(@resource_id)
+    end
+
+    def classify_namespace(const)
+      const = const.classify
+      if const.include?('::')
+        new_const = ''
+        splitted = const.split('::')
+        for str in splitted do
+          new_const = new_const + str.classify + '::'
+        end
+        const = new_const[0..(new_const.length - 3)]
+      end
+      const
+    end
+
+    def new
+      resource = fetch_resource
+      @comments = resource.comments.new
+      @parent_div = params[:parent_div]
+
+      if request.xhr?
+        render :layout => false
+      end
+
+    end
+
+    def create
+      resource = fetch_resource
+      resource.comments.create(comments_params)
+      @parent_div = params[:parent_div]
+      redirect_to "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=" + @parent_div
+    end
+
+  end
+end

data/app/helpers/commenteux/application_helper.rb

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

data/app/helpers/commenteux/notes_helper.rb

@@ -0,0 +1,11 @@
+module Commenteux
+  module NotesHelper
+
+    def user_lookup(user_id)
+      if user_id
+        User.find(user_id).name
+      end
+    end
+
+  end
+end

data/app/views/commenteux/notes/index.html.erb

@@ -0,0 +1,31 @@
+<%= javascript_include_tag 'commenteux/application' %>
+
+<table class="table">
+  <thead>
+  <tr>
+    <th>Commentaire</th>
+    <th>Fait par</th>
+    <th>Date</th>
+  </tr>
+  </thead>
+
+  <% @comments.each do |comment| %>
+      <tr>
+        <td>
+          <%= comment.comment %>
+        </td>
+        <td>
+          <%= user_lookup(comment.user_id) %>
+        </td>
+        <td>
+          <%= comment.created_at %>
+        </td>
+      </tr>
+  <% end %>
+</table>
+<br/>
+
+<%= link_to "Nouveau", "#", :id => "new_notes_link", :class => 'btn btn-primary',
+            :data => {:parent => @parent_div,
+                      :resource => @resource.downcase,
+                      :id => @resource_id } %>

data/app/views/commenteux/notes/new.html.erb

@@ -0,0 +1,31 @@
+<%= simple_form_for @comments, as: 'comments', url: "/commenteux/#{@resource.downcase}/#{@resource_id}?parent_div=#{@parent_div}",
+                    :remote => true, :data => {:parent => @parent_div}, wrapper: :bootstrap do |c| %>
+
+    <div style="display:none">
+      <%= c.input :title %>
+    </div>
+    <%= c.input :comment, :label => 'Commentaire' %>
+    <% if defined? current_user %>
+        <div style="display:none">
+          <%= c.input :user_id, input_html: {value: current_user.id} %>
+        </div>
+    <% end %>
+
+    <div class="form-actions form-actions-padding-sm">
+      <div class="row">
+        <div class="col-md-10 col-md-offset-5">
+
+          <button class="btn btn-primary" type="submit" id='save'>
+            Enregistrer
+          </button>
+
+          <%= link_to "Annuler", "#", :id => "new_notes_cancelled", :class => 'btn',
+                      :data => {:parent => @parent_div,
+                                :resource => @resource.downcase,
+                                :id => @resource_id } %>
+
+        </div>
+      </div>
+    </div>
+
+<% end %>

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/initializers/simple_form.rb

@@ -0,0 +1,145 @@
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, class: :input,
+    hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input placeholder: "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable the lookup for any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    b.optional :maxlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    b.use :label_input
+    b.use :hint,  wrap_with: { tag: :span, class: :hint }
+    b.use :error, wrap_with: { tag: :span, class: :error }
+  end
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   inline: input + label
+  #   nested: label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'alert alert-error'
+
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a label.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  config.label_class = 'control-label'
+
+  # You can define the class to use on all forms. Default is simple_form.
+  # config.form_class = :simple_form
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
+  # These validations are enabled in SimpleForm's internal config but disabled by default
+  # in this configuration, which is recommended due to some quirks from different browsers.
+  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
+  # change this configuration to true.
+  config.browser_validations = false
+
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Custom wrappers for input types. This should be a hash containing an input
+  # type as key and the wrapper that will be used for all inputs with specified type.
+  # config.wrapper_mappings = { string: :prepend }
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+
+  # Default class for inputs
+  # config.input_class = nil
+end

data/config/initializers/simple_form_bootstrap.rb

@@ -0,0 +1,45 @@
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  config.wrappers :bootstrap, tag: 'div', class: 'control-group', error_class: 'error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label
+    b.wrapper tag: 'div', class: 'controls' do |ba|
+      ba.use :input
+      ba.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+    end
+  end
+
+  config.wrappers :prepend, tag: 'div', class: "control-group", error_class: 'error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label
+    b.wrapper tag: 'div', class: 'controls' do |input|
+      input.wrapper tag: 'div', class: 'input-prepend' do |prepend|
+        prepend.use :input
+      end
+      input.use :hint,  wrap_with: { tag: 'span', class: 'help-block' }
+      input.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+    end
+  end
+
+  config.wrappers :append, tag: 'div', class: "control-group", error_class: 'error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label
+    b.wrapper tag: 'div', class: 'controls' do |input|
+      input.wrapper tag: 'div', class: 'input-append' do |append|
+        append.use :input
+      end
+      input.use :hint,  wrap_with: { tag: 'span', class: 'help-block' }
+      input.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+    end
+  end
+
+  # Wrappers for forms and inputs using the Twitter Bootstrap toolkit.
+  # Check the Bootstrap docs (http://twitter.github.com/bootstrap)
+  # to learn about the different styles for forms and inputs,
+  # buttons and other elements.
+  config.default_wrapper = :bootstrap
+end

data/config/locales/simple_form.en.yml

@@ -0,0 +1,26 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Labels and hints examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+

data/config/routes.rb

@@ -0,0 +1,7 @@
+Commenteux::Engine.routes.draw do
+
+  get '/commenteux/:resource/:resource_id', to: 'notes#index'
+  get '/commenteux/:resource/:resource_id/new', to: 'notes#new'
+  post '/commenteux/:resource/:resource_id', to: 'notes#create'
+
+end

data/lib/commenteux/engine.rb

@@ -0,0 +1,5 @@
+module Commenteux
+  class Engine < ::Rails::Engine
+    isolate_namespace Commenteux
+  end
+end

data/lib/commenteux/version.rb

@@ -0,0 +1,3 @@
+module Commenteux
+  VERSION = "1.0.0"
+end

data/lib/commenteux.rb

@@ -0,0 +1,4 @@
+require "commenteux/engine"
+
+module Commenteux
+end

data/lib/tasks/cucumber.rake

@@ -0,0 +1,65 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
+  task 'test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/tasks/notes_tasks.rake

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

data/lib/templates/erb/scaffold/_form.html.erb

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>