rails_private_messages 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjlmMTljMDRlZWFhZTQyYWEzYzQyMTYyNTQxMjYzOTRiYjQ3YjU4NA==
+  data.tar.gz: !binary |-
+    NmEyNTZhMGNiYjlmZjMwOGZlMTE2NDE3YjJiNWEwYWRmNTVkMmU4ZA==
+SHA512:
+  metadata.gz: !binary |-
+    OGI3ODZhMTdlZWViODU5OTM2OTg0NGIwMTcwNjI1NGJhYWJlZjM5MWUxMTYw
+    MWRlMjgxMTQ3NzY1N2JkZTBkZmE1MGU4MDZiY2Q3MWRiZWM5NGQ2YzJmYWVm
+    ZjFjNTFlOGIzNDhmNzA1OGEzZTc3MTE0ODZhNzQ4MTBhYzkwN2I=
+  data.tar.gz: !binary |-
+    MWE1Zjc4Y2U3ZTViMTI4NmU0NWQ4Mzg2OTQ2ZGNiN2M3MTg0NTUxMzYwNzk4
+    MDc5MGRjNDZjYTI0NjViMmQ0MDZlZTgxYTg2NjI0MTcxZWE5YjBiZmM0NDRj
+    MTdmNDQ4OTZhMjM5YTJiYjJhNTQ2MTI2NzI3YmI5MDk2NDdjNTg=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Arturo Hernandez
+
+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,3 @@
+= PrivateMessages
+
+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    = 'PrivateMessages'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+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/lib/generators/private_messages/model/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Creates the private message model and migration for use with 
+    the simple_private_messages plugin.
+
+    Run the migration, passing the name of the model to be created.
+
+Example:
+  
+    ./script/generate private_message_model Message
+
+Further steps are involved after this, see the README for full details.

data/lib/generators/private_messages/model/model_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module PrivateMessages
+	module Generators
+		class ModelGenerator < Rails::Generators::Base
+			include Rails::Generators::Migration
+
+			desc "Creates the private message model."
+
+			argument :user_model_name, :required => false, :default => "User", :desc => "The user model name"
+			argument :message_model_name, :required => false, :default => "Message", :desc => "The message model name"
+
+			attr_reader :singular_camel_case_name, :plural_camel_case_name, :singular_lower_case_name, :plural_lower_case_name
+			attr_reader :singular_camel_case_parent, :plural_camel_case_parent, :singular_lower_case_parent, :plural_lower_case_parent
+
+			def self.source_root
+				File.join(File.dirname(__FILE__), 'templates')
+			end
+
+			# Implement the required interface for Rails::Generators::Migration.
+			# taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+			def self.next_migration_number(dirname) #:nodoc:
+				if ActiveRecord::Base.timestamped_migrations
+					Time.now.utc.strftime("%Y%m%d%H%M%S")
+				else
+					"%.3d" % (current_migration_number(dirname) + 1)
+				end
+			end
+
+			def go
+				@singular_camel_case_name = message_model_name.singularize.camelize
+				@plural_camel_case_name = message_model_name.pluralize.camelize
+				@singular_lower_case_name = message_model_name.singularize.underscore
+				@plural_lower_case_name = message_model_name.pluralize.underscore
+
+				@singular_camel_case_parent = user_model_name.singularize.camelize
+				@plural_camel_case_parent = user_model_name.pluralize.camelize
+				@singular_lower_case_parent = user_model_name.singularize.underscore
+				@plural_lower_case_parent = user_model_name.pluralize.underscore    
+
+				#directory "app/models"
+				template "model.rb", "app/models/#{singular_lower_case_name}.rb"
+					
+				migration_template "migration.rb", "db/migrate/create_#{plural_lower_case_name}.rb", :assigns => {
+					:migration_name => "Create#{plural_camel_case_name}"
+				}
+			end
+		end
+	end
+end

data/lib/generators/private_messages/model/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= "Create#{plural_camel_case_name}" %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= plural_lower_case_name %> do |t|
+      t.integer :sender_id, :recipient_id
+      t.boolean :sender_deleted, :recipient_deleted, :default => false
+      t.string :subject
+      t.text :body
+      t.datetime :read_at
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= plural_lower_case_name %>
+  end
+end

data/lib/generators/private_messages/model/templates/model.rb

@@ -0,0 +1,9 @@
+class <%= singular_camel_case_name %> < ActiveRecord::Base
+
+  is_private_message<% unless singular_camel_case_parent == "User" %> :class_name => "<%= "#{singular_camel_case_parent}" %>"<% end %>
+  
+  # The :to accessor is used by the scaffolding,
+  # uncomment it if using it or you can remove it if not
+  #attr_accessor :to
+  
+end

data/lib/private_messages/has_private_message.rb

@@ -0,0 +1,75 @@
+
+module PrivateMessages
+  module HasPrivateMessage
+    extend ActiveSupport::Concern
+      
+      included do
+      end
+
+      module ClassMethods
+        # Sets up a model have private messages, defining the child class as specified in :class_name (typically "Messages").
+        # Provided the following instance messages:
+        # *  <tt>sent_messages</tt> - returns a collection of messages for which this object is the sender.
+        # *  <tt>received_messages</tt> - returns a collection of messages for which this object is the recipient.
+        def has_private_message(options = {})
+          options[:class_name] ||= 'Message'
+
+          unless included_modules.include? InstanceMethods
+            class_attribute :options
+            table_name = options[:class_name].constantize.table_name
+            
+            has_many :sent_messages, -> {
+                        
+                        where("#{table_name}.sender_deleted = false").order("#{table_name}.created_at DESC")
+                      },
+                      :class_name => options[:class_name], :foreign_key => 'sender_id'
+                      #:includes => :recipient,
+                       #
+                        #.order("#{table_name}.created_at DESC")
+                        
+                        #:order => "#{table_name}.created_at DESC",
+                        #:conditions => ["#{table_name}.sender_deleted = ?", false]
+                                
+
+
+            has_many :received_messages, ->{
+                        where("#{table_name}.recipient_deleted = false").order("#{table_name}.created_at DESC")
+                      },
+                     :class_name => options[:class_name],
+                     :foreign_key => 'recipient_id'
+                     #, ->
+                     #{
+                     #   :includes => :sender,
+                     #   :order => "#{table_name}.created_at DESC",
+                     #   :conditions => [, false]
+                     #}
+
+            #extend ClassMethods
+            include InstanceMethods
+          end 
+          self.options = options
+        end 
+      end 
+
+      #module ClassMethods #:nodoc:
+        # None yet...
+        
+      #end
+
+      module InstanceMethods
+        # Returns true or false based on if this user has any unread messages
+        def unread_messages?
+          unread_message_count > 0 ? true : false
+        end
+        
+        # Returns the number of unread messages for this user
+        def unread_message_count
+          eval options[:class_name] + '.count(:conditions => ["recipient_id = ? AND read_at IS NULL and recipient_deleted = ?", self, false])'
+        end
+      end 
+
+    end
+  end
+
+
+ActiveRecord::Base.send :include, PrivateMessages::HasPrivateMessage

data/lib/private_messages/is_a_private_message.rb

@@ -0,0 +1,59 @@
+ 
+module PrivateMessages
+  module IsAPrivateMessage
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      def is_private_message(options = {})
+        options[:class_name] ||= 'User'
+          
+          unless included_modules.include? InstanceMethods 
+            belongs_to :sender,
+                       :class_name => options[:class_name],
+                       :foreign_key => 'sender_id'
+            belongs_to :recipient,
+                       :class_name => options[:class_name],
+                       :foreign_key => 'recipient_id'
+
+            #extend ClassMethods 
+            include InstanceMethods 
+          end 
+
+          #scope :already_read, :conditions => "read_at IS NOT NULL"
+          #scope :unread, :conditions => "read_at IS NULL"
+           scope :already_read, -> { where("read_at IS NOT NULL") }
+           scope :unread, -> { where("read_at IS NULL") }
+      end
+      def read_message(id, reader)
+          message = where("id=? and (sender_id = ? OR recipient_id = ?)", id, reader, reader).first()
+          #message = self.find(id, :conditions => ["sender_id = ? OR recipient_id = ?", reader, reader]).first()
+          if message.read_at.nil? && reader == message.recipient
+            message.read_at = Time.now
+            message.save!
+          end
+          message
+      end
+
+     
+    end
+    module InstanceMethods
+        # Returns true or false value based on whether the a message has been read by it's recipient.
+        def message_read?
+          self.read_at.nil? ? false : true
+        end
+
+        # Marks a message as deleted by either the sender or the recipient, which ever the user that was passed is.
+        # Once both have marked it deleted, it is destroyed.
+        def mark_deleted(user)
+          self.sender_deleted = true if self.sender == user
+          self.recipient_deleted = true if self.recipient == user
+          self.sender_deleted && self.recipient_deleted ? self.destroy : save!
+        end
+      end 
+  end
+end
+ 
+ActiveRecord::Base.send :include, PrivateMessages::IsAPrivateMessage

data/lib/private_messages/version.rb

@@ -0,0 +1,3 @@
+module PrivateMessages
+  VERSION = "0.0.1"
+end

data/lib/private_messages.rb

@@ -0,0 +1,4 @@
+require "private_messages/is_a_private_message"
+require "private_messages/has_private_message"
+module PrivateMessages
+end

data/lib/tasks/private_messages_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/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/test/dummy/app/assets/stylesheets/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/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/message.rb

@@ -0,0 +1,9 @@
+class Message < ActiveRecord::Base
+
+  is_private_message
+  
+  # The :to accessor is used by the scaffolding,
+  # uncomment it if using it or you can remove it if not
+  #attr_accessor :to
+  
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+	has_private_message
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "private_messages"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end