message_train 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32aa42123688961b79c63b6f69518b5b02bdb3ce
-  data.tar.gz: 373cd78a85d7659dd200644c5b5c69395e6b3f38
+  metadata.gz: 279f6b86182280de36d875bc58b839cffefbb5bd
+  data.tar.gz: 24ad6a58c91cf45ddc80f645c642a12e480ef106
 SHA512:
-  metadata.gz: 84e2ed92d284aa5c83202fc669397bdd35a668915abb5143fed67e084eac219fd534cffc8ee16fbdae85db8042f2feb0569e83c02715738a245734ea33dd8575
-  data.tar.gz: 8bb83b97014008b1e35f03da47f0fceecc17fd2db283356ec16135b32699c3229119cac878fe19ba2a555176a47c88df1680450bf296c505276ad51588469b87
+  metadata.gz: 20e06ae5d8f27c9760a5bc05ee3b46a59df822824ef8929b92eb93905006b5d6a670ce6a7c34c8cf9fdc94eecbad77f987b6ccdb4df75bc0f8b8b4a3d1fe35c0
+  data.tar.gz: 396db8fa546546fa128a7bdeea851bc377e8340bbffbe16f7f4d0db302ecef3d6cb72d10445ecefaf6b69119cd398dc447197b6b9e09f5022e33984c5dc3b2c2

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - message_train.gemspec
+    - db/migrate/*
+    - spec/dummy/db/schema.rb
+    - spec/dummy/db/migrate/*
+Style/ClassVars:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.ruby-gemset

@@ -1 +1 @@
-message_train
+message_train

data/.scss-lint.yml

@@ -0,0 +1,7 @@
+linters:
+  PlaceholderInExtend:
+    enabled: false
+  QualifyingElement:
+    enabled: false
+  VendorPrefix:
+    enabled: false

data/.simplecov

@@ -5,4 +5,4 @@ SimpleCov.formatter = Coveralls::SimpleCov::Formatter
 SimpleCov.start do
    add_filter 'lib/message_train/localization.rb'
    add_filter 'spec'
-end
+end

data/.travis.yml

@@ -9,4 +9,4 @@ before_script:
   - sh -e /etc/init.d/xvfb start
 script: bundle exec rspec
 notifications:
-  email: false
+  email: false

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 # Add dependencies required to use your gem here.
 # Example:
 #   gem 'activesupport', '>= 2.3.5'
@@ -32,6 +32,10 @@ group :development do
   gem 'sdoc', '~> 0.4.1'
   gem 'bundler', '~> 1.0'
   gem 'jeweler', '~> 2.0'
+  gem 'pre-commit', '~> 0.27'
+  gem 'rubocop', '~> 0.37'
+  gem 'coffeelint', '~> 1.14'
+  gem 'scss_lint', '~> 0.47.0', require: false
 end
 
 group :development, :test do
@@ -57,4 +61,4 @@ group :test do
   gem 'coveralls', '~> 0.8', require: false
   gem 'rspec-html-matchers', '~> 0.7'
   gem 'selenium-webdriver', '~> 2'
-end
+end

data/LICENSE.txt

@@ -2,7 +2,7 @@ Copyright (c) 2015 Gem Vein
 
 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
+'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
@@ -11,7 +11,7 @@ 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,
+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

data/README.rdoc

@@ -1,12 +1,12 @@
 = MessageTrain
-{<img src="https://travis-ci.org/gemvein/message_train.svg" alt="Build Status" />}[https://travis-ci.org/gemvein/message_train]
-{<img src="https://coveralls.io/repos/gemvein/message_train/badge.svg?branch=master&service=github" alt="Coverage Status" />}[https://coveralls.io/github/gemvein/message_train?branch=master]
-{<img src="https://badge.fury.io/rb/message_train.svg" alt="Gem Version" />}[http://badge.fury.io/rb/message_train]
+{<img src='https://travis-ci.org/gemvein/message_train.svg' alt='Build Status' />}[https://travis-ci.org/gemvein/message_train]
+{<img src='https://coveralls.io/repos/gemvein/message_train/badge.svg?branch=master&service=github' alt='Coverage Status' />}[https://coveralls.io/github/gemvein/message_train?branch=master]
+{<img src='https://badge.fury.io/rb/message_train.svg' alt='Gem Version' />}[http://badge.fury.io/rb/message_train]
 
 
 MessageTrain is a Rails 4 Private Messaging Gem that uses bootstrap to send and display private messages from one user to another. It can also be configured to send messages to a user collective (such as a certain Role or Group of users).
 
-Messages can be saved as drafts instead of sending. Message composition features type-ahead completion for recipients, wysiwyg html bodies, and an arbitrary number of attachments. Messages are grouped together into conversations, and allow valid senders to reply to a given message. Any given conversation can be ignored if it is no longer of interest to the user, at which point no further messages will be received in that conversation. The "read" or "unread" status of messages is tracked automatically, and can also be changed manually by the user.
+Messages can be saved as drafts instead of sending. Message composition features type-ahead completion for recipients, wysiwyg html bodies, and an arbitrary number of attachments. Messages are grouped together into conversations, and allow valid senders to reply to a given message. Any given conversation can be ignored if it is no longer of interest to the user, at which point no further messages will be received in that conversation. The 'read' or 'unread' status of messages is tracked automatically, and can also be changed manually by the user.
 
 Conversations are grouped into various boxes, depending on their status for that user: in, sent, all, drafts, trash, ignored. Any message can be trashed by the user, at which point the user has the option to permanently delete it.
 
@@ -39,7 +39,7 @@ To include Message Train variables and helpers in your controllers, add this con
 
 Add to your application.css.scss:
 
-    @import "message_train";
+    @import 'message_train';
 
 And in your application.js:
 

data/Rakefile

@@ -1,26 +1,27 @@
 # encoding: utf-8
-
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "message_train"
-  gem.homepage = "http://www.gemvein.com/museum/cases/message_train"
-  gem.license = "MIT"
-  gem.summary = %Q{Rails 4 Engine providing messaging for any object}
-  gem.description = %Q{Rails 4 Engine providing private/public messaging for any object, such as Users or Groups}
-  gem.email = "karen.e.lundgren@gmail.com"
-  gem.authors = ["Karen Lundgren"]
+  # gem is a Gem::Specification...
+  # see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'message_train'
+  gem.homepage = 'http://www.gemvein.com/museum/cases/message_train'
+  gem.license = 'MIT'
+  gem.summary = 'Rails 4 Engine providing messaging for any object'
+  gem.description = 'Rails 4 Engine providing private/public messaging for '\
+    'any object, such as Users or Groups'
+  gem.email = 'karen.e.lundgren@gmail.com'
+  gem.authors = ['Karen Lundgren']
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -31,17 +32,17 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-desc "Code coverage detail"
+desc 'Code coverage detail'
 task :simplecov do
-  ENV['COVERAGE'] = "true"
+  ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
 end
 
-task :default => :spec
+task default: :spec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "message_train #{version}"
@@ -49,22 +50,22 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
-
 # load 'rails/tasks/statistics.rake'
 
 namespace :message_train do
-  desc "Clean out development system files"
+  desc 'Clean out development system files'
   task files: :environment do
     FileUtils.rm_rf(Dir["#{Rails.root}/public/system/development/*/*"])
   end
-  desc "Recreate database from seeds and clean out all system files"
+  desc 'Recreate database from seeds and clean out all system files'
   task clean: :environment do
     import 'spec/dummy/Rakefile'
-    Rake::Task["message_train:files"].invoke
+    Rake::Task['message_train:files'].invoke
     dummy_app_path = MessageTrain::Engine.root.join('spec', 'dummy')
-    system "bundle exec rake -f #{dummy_app_path.join('Rakefile')} db:drop db:create db:migrate db:seed db:test:prepare"
+    system "bundle exec rake -f #{dummy_app_path.join('Rakefile')} db:drop "\
+      'db:create db:migrate db:seed db:test:prepare'
   end
-end
+end

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.3

data/app/assets/javascripts/message_train.js

@@ -8,7 +8,7 @@ function create_alert(level, message) {
 }
 
 function set_and_change(selector, value) {
-    $(selector).prop('checked', value).trigger("change");
+    $(selector).prop('checked', value).trigger('change');
 }
 
 function flicker(selector, count) {

data/app/assets/stylesheets/message_train.scss

@@ -14,7 +14,9 @@ img {
 }
 
 .message-train-conversations {
-  a, a:link, a:visited {
+  a,
+  a:link,
+  a:visited {
     color: $text-color;
   }
 
@@ -25,57 +27,65 @@ img {
   input[type='checkbox'] {
     margin-right: 1em;
   }
+
   .unread {
     font-weight: bold;
   }
 
   .read {
-    background-color: rgba($list-group-disabled-bg, 0.75);
+    background-color: rgba($list-group-disabled-bg, .75);
+
+    .flicker.flicker-out {
+      background-color: $list-group-disabled-bg;
+      transition: background-color 1s ease-out;
+    }
   }
 
   .draft {
     font-style: italic;
   }
 
-  .selected, .read.selected {
+  .selected,
+  .read.selected {
+    background-color: $state-warning-bg;
+
     a {
       color: $state-warning-text;
     }
-    background-color: $state-warning-bg;
   }
 
-  .flicker, .read.flicker, .selected.flicker {
+  .flicker,
+  .read.flicker,
+  .selected.flicker {
     background-color: $state-info-bg;
-    transition: background-color 0.1s ease-in;
+    transition: background-color .1s ease-in;
   }
 
-  .flicker.flicker-out, .unread.flicker.flicker-out {
+  .flicker.flicker-out,
+  .unread.flicker.flicker-out {
     background-color: $list-group-bg;
     transition: background-color 1s ease-out;
   }
-
-  .read.flicker.flicker-out {
-     background-color: $list-group-disabled-bg;
-     transition: background-color 1s ease-out;
-   }
 }
 
 .box-actions {
-  margin: 2em 0 1em 0;
+  margin: 2em 0 1em;
+
   .check-all button {
     min-height: 2.5em;
   }
 }
 
 div.conversation-actions {
-  margin: 1em 0 1em 0;
+  margin: 1em 0;
 }
 
 td.conversation-actions {
+  white-space: nowrap;
+
   a {
     visibility: hidden;
   }
-  white-space: nowrap;
 }
 
 .date-column {
@@ -91,8 +101,8 @@ tr:hover .conversation-actions a {
 }
 
 .glyphicon.spinning {
-  animation: spin 1s infinite linear;
   -webkit-animation: spin2 1s infinite linear;
+  animation: spin 1s infinite linear;
 }
 
 @keyframes spin {
@@ -118,9 +128,9 @@ tr:hover .conversation-actions a {
 }
 
 .btn-compose {
-  margin: 0 auto 10px auto;
-  width: 100%;
+  margin: 0 auto 10px;
   white-space: inherit;
+  width: 100%;
 }
 
 .tt-menu {
@@ -131,4 +141,4 @@ tr:hover .conversation-actions a {
 
 .dropdown-menu {
   width: 240px;
-}
+}

data/app/controllers/concerns/message_train_support.rb

@@ -1,8 +1,7 @@
+# MessageTrain support
 module MessageTrainSupport
   extend ActiveSupport::Concern
-
   included do
-
     # Last in first out
     prepend_before_filter :load_collective_boxes,
                           :load_box,
@@ -23,14 +22,9 @@ module MessageTrainSupport
     rescue_from ActiveRecord::RecordNotFound do
       render '404', status: :not_found
     end
-
   end
 
-protected
-
-  # def require_authentication
-  #   redirect_to url_for(MessageTrain.configuration.user_sign_in_path), flash: { error: :you_must_sign_in_or_sign_up_to_continue.l }
-  # end
+  protected
 
   def anonymous
     @anonymous = true
@@ -42,9 +36,9 @@ protected
   end
 
   def load_box_user
-    # # What we used to do
-    # @box_user = send(MessageTrain.configuration.current_user_method) || require_authentication
-    @box_user = send(MessageTrain.configuration.current_user_method) || anonymous
+    @box_user = send(
+      MessageTrain.configuration.current_user_method
+    ) || anonymous
   end
 
   def load_division
@@ -54,40 +48,51 @@ protected
   def load_collective
     if params[:collective_id].present?
       collective_table, collective_id = params[:collective_id].split(':')
-      collective_class_name = MessageTrain.configuration.recipient_tables[collective_table.to_sym]
+      collective_class_name = MessageTrain.configuration.recipient_tables[
+        collective_table.to_sym
+      ]
       collective_model = collective_class_name.constantize
-      slug_column = MessageTrain.configuration.slug_columns[collective_table.to_sym] || :slug
+      slug_column = MessageTrain.configuration
+                                .slug_columns[collective_table.to_sym] || :slug
       @collective = collective_model.find_by!(slug_column => collective_id)
 
-      unless @collective.allows_receiving_by?(@box_user) || @collective.allows_sending_by?(@box_user)
+      unless @collective.allows_receiving_by?(
+        @box_user
+      ) || @collective.allows_sending_by?(
+        @box_user
+      )
         flash[:error] = :access_to_that_box_denied.l
         redirect_to main_app.root_url
         return
       end
 
       case @division
-        when :in, :ignored
-          unless @collective.allows_receiving_by? @box_user
-            flash[:error] = :access_to_that_box_denied.l
-            redirect_to message_train.collective_box_url(@collective.path_part, :sent)
-          end
-        when :sent, :drafts
-          unless @collective.allows_sending_by? @box_user
-            flash[:error] = :access_to_that_box_denied.l
-            redirect_to message_train.collective_box_url(@collective.path_part, :in)
-          end
-        else
-          # do nothing
+      when :in, :ignored
+        unless @collective.allows_receiving_by? @box_user
+          flash[:error] = :access_to_that_box_denied.l
+          redirect_to message_train.collective_box_url(
+            @collective.path_part,
+            :sent
+          )
+        end
+      when :sent, :drafts
+        unless @collective.allows_sending_by? @box_user
+          flash[:error] = :access_to_that_box_denied.l
+          redirect_to message_train.collective_box_url(
+            @collective.path_part,
+            :in
+          )
+        end
       end
     end
   end
 
   def load_box
-    if !@collective.nil?
-      @box = @collective.box(@division, @box_user)
-    else
-      @box = @box_user.box(@division)
-    end
+    @box = if !@collective.nil?
+             @collective.box(@division, @box_user)
+           else
+             @box_user.box(@division)
+           end
   end
 
   def load_collective_boxes
@@ -110,25 +115,24 @@ protected
   def respond_to_marking
     if !@box.errors.all.empty?
       respond_to do |format|
-        format.html {
+        format.html do
           flash[:error] = @box.message
           show
-        }
+        end
         format.json { render :results, status: :unprocessable_entity }
       end
     else
       respond_to do |format|
-        format.html {
+        format.html do
           if @box.results.all.empty?
             flash[:alert] = @box.message
           else
             flash[:notice] = @box.message
           end
           show
-        }
+        end
         format.json { render :results, status: :accepted }
       end
     end
   end
-
-end
+end

data/app/controllers/message_train/application_controller.rb

@@ -1,4 +1,5 @@
 module MessageTrain
+  # Application controller
   class ApplicationController < ::ApplicationController
     include MessageTrainSupport
   end

data/app/controllers/message_train/boxes_controller.rb

@@ -1,4 +1,5 @@
 module MessageTrain
+  # Boxes controller
   class BoxesController < MessageTrain::ApplicationController
     before_filter :load_conversations
 
@@ -18,7 +19,7 @@ module MessageTrain
 
     # DELETE /box/:division
     def destroy
-      if ['ignore', 'unignore'].include? params[:mark_to_set]
+      if %w( ignore unignore ).include? params[:mark_to_set]
         @box.send(params[:mark_to_set], @objects)
       end
       respond_to_marking
@@ -26,8 +27,8 @@ module MessageTrain
 
     private
 
-      def load_conversations
-        @conversations = @box.conversations
-      end
+    def load_conversations
+      @conversations = @box.conversations
+    end
   end
 end

data/app/controllers/message_train/conversations_controller.rb

@@ -1,4 +1,5 @@
 module MessageTrain
+  # Conversations controller
   class ConversationsController < MessageTrain::ApplicationController
     before_filter :load_conversation
     after_filter :mark_as_read
@@ -20,7 +21,7 @@ module MessageTrain
 
     # DELETE /box/:division/conversations/:id
     def destroy
-      if ['ignore', 'unignore'].include? params[:mark_to_set]
+      if %w( ignore unignore ).include? params[:mark_to_set]
         @box.send(params[:mark_to_set], @conversation)
       end
       respond_to_marking
@@ -28,12 +29,12 @@ module MessageTrain
 
     private
 
-      def load_conversation
-        @conversation = @box.find_conversation(params[:id])
-      end
+    def load_conversation
+      @conversation = @box.find_conversation(params[:id])
+    end
 
-      def mark_as_read
-        @box.mark :read, conversations: @conversation
-      end
+    def mark_as_read
+      @box.mark :read, conversations: @conversation
+    end
   end
 end

data/app/controllers/message_train/messages_controller.rb

@@ -1,4 +1,5 @@
 module MessageTrain
+  # Messages controller
   class MessagesController < MessageTrain::ApplicationController
     before_filter :load_message, only: [:show, :edit, :update]
 
@@ -11,14 +12,14 @@ module MessageTrain
 
     # GET /box/:division/messages/new
     def new
-      @message = @box.new_message(message_train_conversation_id: params[:conversation_id])
+      @message = @box.new_message(
+        message_train_conversation_id: params[:conversation_id]
+      )
     end
 
     # GET /box/:division/messages/:id/edit
     def edit
-      unless @message.draft
-        raise ActiveRecord::RecordNotFound
-      end
+      !@message.draft && raise(ActiveRecord::RecordNotFound)
     end
 
     # POST /box/:division/messages
@@ -38,15 +39,19 @@ module MessageTrain
 
     # PATCH/PUT /box/:division/messages/:id
     def update
-      unless @message.draft
-        raise ActiveRecord::RecordNotFound
-      end
+      !@message.draft && raise(ActiveRecord::RecordNotFound)
       @box.update_message(@message, message_params)
       if @box.errors.all.empty?
         if @message.draft
-          redirect_to message_train.box_conversation_url(@box, @message.conversation), alert: @box.message
+          redirect_to(
+            message_train.box_conversation_url(@box, @message.conversation),
+            alert: @box.message
+          )
         else
-          redirect_to message_train.box_path(:sent), notice: @box.message
+          redirect_to(
+            message_train.box_path(:sent),
+            notice: @box.message
+          )
         end
       else
         flash[:error] = @box.message
@@ -54,26 +59,24 @@ module MessageTrain
       end
     end
 
-  private
+    private
+
     def load_message
       @message = @box.find_message(params[:id])
     end
 
-    # Never trust parameters from the scary internet, only allow the white list through.
+    # Never trust parameters from the scary internet, only allow the white list
+    # through.
     def message_params
       permitted = params.require(:message).permit(
-          :conversation_id,
-          :subject,
-          :body,
-          :draft,
-          attachments_attributes: [:id, :attachment, :_destroy],
-          recipients_to_save: MessageTrain.configuration.recipient_tables.keys
+        :conversation_id,
+        :subject,
+        :body,
+        :draft,
+        attachments_attributes: [:id, :attachment, :_destroy],
+        recipients_to_save: MessageTrain.configuration.recipient_tables.keys
       )
-      if permitted['draft'] == :save_as_draft.l
-        permitted['draft'] = true
-      else
-        permitted['draft'] = false
-      end
+      permitted['draft'] = (permitted['draft'] == :save_as_draft.l)
       permitted
     end
   end