message_train 0.1.0

data/spec/models/message_train/message_spec.rb

@@ -0,0 +1,83 @@
+require 'rails_helper'
+
+module MessageTrain
+  RSpec.describe Message do
+    include_context 'loaded site'
+    describe 'Model' do
+      # Relationships
+      it { should belong_to :conversation }
+      it { should belong_to :sender }
+      it { should have_many :attachments }
+      it { should have_many :receipts }
+
+      # Validations
+      it { should validate_presence_of :sender }
+      it { should validate_presence_of :subject }
+    end
+    describe 'Callbacks' do
+      context 'sets draft to true on a message to no one' do
+        subject { draft_conversation.messages.drafts.first }
+        its(:sender) { should eq first_user }
+        its(:receipts) { should have_exactly(1).item } # i.e. sender
+        its(:recipients) { should be_empty }
+        its(:draft) { should be true }
+      end
+      context 'generates receipts when present' do
+        subject { sent_conversation.messages.first }
+        its(:sender) { should eq first_user }
+        its(:receipts) { should have_exactly(2).items } # i.e. sender and recipient
+        its(:recipients) { should include second_user }
+        its(:draft) { should be false }
+      end
+    end
+    describe 'Scopes and Methods' do
+      context '.drafts' do
+        subject { MessageTrain::Message.drafts.first.conversation }
+        it { should eq draft_conversation }
+      end
+      context '.by' do
+        subject { MessageTrain::Message.by(first_user) }
+        it { should include sent_conversation.messages.first }
+        it { should include draft_conversation.messages.first }
+      end
+      context '.drafts_by' do
+        subject { MessageTrain::Message.drafts_by(first_user).first.conversation }
+        it { should eq draft_conversation }
+      end
+      context '.with_receipts_by' do
+        subject { MessageTrain::Message.with_receipts_by(first_user).last.conversation }
+        it { should eq sent_conversation }
+      end
+      context '.with_receipts_to' do
+        subject { MessageTrain::Message.with_receipts_to(first_user).last.conversation }
+        it { should eq unread_conversation }
+      end
+      context '.with_trashed_to and #is_trashed_to?' do
+        subject { trashed_conversation.messages.with_trashed_to(first_user).first.is_trashed_to?(first_user) }
+        it { should be true }
+      end
+      context '.with_deleted_to and #is_deleted_to?' do
+        subject { deleted_conversation.messages.with_deleted_to(first_user).first.is_deleted_to?(first_user) }
+        it { should be true }
+      end
+      context '.with_read_to and #is_read_to?' do
+        subject { read_conversation.messages.with_read_to(first_user).first.is_read_to?(first_user) }
+        it { should be true }
+      end
+      context '.mark' do
+        before do
+          read_conversation.messages.mark(:trash, first_user)
+        end
+        subject { read_conversation.messages.first.is_trashed_to?(first_user) }
+        it { should be true }
+      end
+      context '#mark' do
+        before do
+          read_conversation.messages.first.mark(:unread, first_user)
+        end
+        subject { read_conversation.messages.first.is_read_to?(first_user) }
+        it { should be false }
+      end
+    end
+  end
+end

data/spec/models/message_train/receipt_spec.rb

@@ -0,0 +1,73 @@
+require 'rails_helper'
+
+module MessageTrain
+  RSpec.describe Receipt do
+    describe 'Model' do
+      # Relationships
+      it { should belong_to :message }
+      it { should belong_to :recipient }
+      # Validations
+      it { should validate_presence_of :message }
+      it { should validate_presence_of :recipient }
+    end
+    describe 'Scopes and Methods' do
+      include_context 'loaded site'
+      describe '.sender_receipt' do
+        subject { MessageTrain::Receipt.sender_receipt.first }
+        its(:sender) { should be true }
+      end
+      describe '.recipient_receipt' do
+        subject { MessageTrain::Receipt.recipient_receipt.first }
+        its(:sender) { should be false }
+      end
+      describe '.for' do
+        subject { MessageTrain::Receipt.for(first_user).conversations }
+        it { should include sent_conversation }
+        it { should include unread_conversation }
+        it { should include ignored_conversation }
+        it { should include trashed_conversation }
+        it { should include read_conversation }
+      end
+      describe '.receipts_to' do
+        subject { MessageTrain::Receipt.receipts_to(first_user) }
+        its(:first) { should be_a MessageTrain::Receipt }
+        its(:count) { should be > 5 }
+      end
+      describe '.trashed_to' do
+        subject { MessageTrain::Receipt.trashed_to(first_user).first.message.conversation }
+        its(:subject) { should eq 'Trashed Conversation' }
+      end
+      describe '.untrashed_to' do
+        subject { MessageTrain::Receipt.untrashed_to(first_user).first }
+        its(:marked_trash) { should be false }
+      end
+      describe '.read_to' do
+        subject { MessageTrain::Receipt.read_to(first_user).first.message.conversation }
+        its(:subject) { should eq 'Read Conversation' }
+      end
+      describe '.deleted_to' do
+        subject { MessageTrain::Receipt.deleted_to(first_user).first.message.conversation }
+        its(:subject) { should eq 'Deleted Conversation' }
+      end
+      describe '.undeleted_to' do
+        subject { MessageTrain::Receipt.undeleted_to(first_user).first }
+        its(:marked_deleted) { should be false }
+      end
+      describe '.message_ids' do
+        subject { MessageTrain::Receipt.receipts_by(first_user).message_ids }
+        it { should include sent_conversation.messages.first.id }
+      end
+      describe '.messages' do
+        subject { MessageTrain::Receipt.receipts_by(first_user).messages }
+        it { should include sent_conversation.messages.first }
+      end
+      describe '#mark' do
+        before do
+          unread_conversation.messages.first.receipts.for(first_user).first.mark(:read)
+        end
+        subject { unread_conversation.messages.first.is_read_to?(first_user) }
+        it { should be true }
+      end
+    end
+  end
+end

data/spec/models/user_spec.rb

@@ -0,0 +1,68 @@
+require 'rails_helper'
+
+RSpec.describe User do
+
+  describe 'Model' do
+    # Rolify Gem by extension
+    it { should have_and_belong_to_many(:roles) }
+
+    # MessageTrain Gem
+    it { should have_many(:messages) }
+    it { should have_many(:receipts) }
+  end
+
+  describe 'Scopes and Methods' do
+    include_context 'loaded site'
+
+    describe '#conversations' do
+      context 'with division as :in' do
+        subject { first_user.conversations(:in).first.includes_receipts_to?(first_user) }
+        it { should be true }
+      end
+      context 'with division as :sent' do
+        subject { first_user.conversations(:sent).first.includes_receipts_by?(first_user) }
+        it { should be true }
+      end
+      context 'with division as :trash' do
+        subject { first_user.conversations(:trash).first.includes_trashed_for?(first_user) }
+        it { should be true}
+      end
+    end
+
+    describe '#all_boxes' do
+      context 'returns all boxes for the given user' do
+        subject { first_user.all_boxes }
+        its(:first) { should be_a MessageTrain::Box }
+        its(:count) { should be 6 }
+      end
+    end
+
+    describe '#all_conversations' do
+      context 'returns all conversations with any receipt' do
+        subject { first_user.all_conversations }
+        it { should include sent_conversation }
+        it { should include unread_conversation }
+        it { should include read_conversation }
+        it { should include ignored_conversation }
+        it { should include trashed_conversation }
+        it { should include deleted_conversation }
+        it { should_not include someone_elses_conversation }
+      end
+    end
+
+    describe '#all_messages' do
+      context 'returns all messages with any receipt' do
+        subject { first_user.all_messages }
+        it { should include sent_conversation.messages.first }
+        it { should include unread_conversation.messages.first }
+        it { should include read_conversation.messages.first }
+        it { should include ignored_conversation.messages.first }
+        it { should include trashed_conversation.messages.first }
+        it { should include deleted_conversation.messages.first }
+        it { should_not include someone_elses_conversation.messages.first }
+      end
+    end
+
+  end
+
+end

data/spec/rails_helper.rb

@@ -0,0 +1,83 @@
+require 'coveralls'
+Coveralls.wear!
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../dummy/config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+require 'shoulda/matchers'
+require 'factory_girl_rails'
+require 'capybara/rspec'
+require 'database_cleaner'
+require 'rake'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migrator.migrations_paths = 'spec/dummy/db/migrate'
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = false
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+    Dummy::Application.load_tasks
+    Rake::Task['db:seed'].invoke # loading seeds
+  end
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+
+  config.before(:each)    { @routes = MessageTrain::Engine.routes }
+  config.include MessageTrain::Engine.routes.url_helpers
+
+  config.include Warden::Test::Helpers
+  config.include Devise::TestHelpers, type: :controller
+  config.include Devise::TestHelpers, type: :helper
+  config.include Devise::TestHelpers, type: :routing
+  config.include RSpecHtmlMatchers
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/controller_behaviors.rb

@@ -0,0 +1,88 @@
+shared_examples_for 'a successful page' do |options = {}|
+  context 'responds successfully' do
+    subject { response }
+    it { should be_success }
+  end
+  if options[:which_renders].present?
+    it_behaves_like 'a page rendering a template', options[:which_renders]
+  end
+end
+shared_examples_for 'a page rendering a template' do |template|
+  context "renders the #{template} template" do
+    subject { response }
+    it { should render_template(template) }
+  end
+end
+shared_examples_for 'an error response' do |http_status|
+  context "issues error response code #{http_status}" do
+    subject { response }
+    it { should have_http_status(http_status) }
+  end
+end
+shared_examples_for 'a redirect to' do |path|
+  context "redirects to #{path}" do
+    subject { response }
+    it { should redirect_to path_to_url(path) }
+  end
+end
+shared_examples_for 'a redirect matching' do |path_expression|
+  context "redirects matching #{path_expression}" do
+    subject { response.location }
+    it { should match path_expression }
+  end
+end
+shared_examples_for 'a redirect to sign in' do
+  it_behaves_like 'a redirect to', '/users/sign_in'
+end
+shared_examples_for 'an error response with message' do |message|
+  it_behaves_like 'an error response', :forbidden
+  context 'sets failure message' do
+    subject { flash[:error] }
+    it { should eq message }
+  end
+end
+shared_examples_for 'a 404 Not Found error' do
+  it_behaves_like 'an error response', :not_found
+  it_behaves_like 'a page rendering a template', '404'
+end
+shared_examples_for 'a page with a message' do |options|
+  it_behaves_like 'a successful page'
+  options.each do |key, value|
+    context "sets #{key.to_s} message" do
+      subject { flash[key] }
+      it { should eq value }
+    end
+  end
+end
+shared_examples_for 'a page with an error message' do |message|
+  it_behaves_like 'a page with a message', error: message
+end
+shared_examples_for 'a page with an alert message' do |message|
+  it_behaves_like 'a page with a message', alert: message
+end
+shared_examples_for 'a page with a notice message' do |message|
+  it_behaves_like 'a page with a message', notice: message
+end
+shared_examples_for 'a 403 Forbidden error' do
+  it_should_behave_like 'an error response with message', 'You are not authorized to access this page.'
+end
+shared_examples_for 'a redirect with notice' do |path, message|
+  it_behaves_like 'a redirect to', path
+  context 'sets notice' do
+    subject { flash[:notice] }
+    it { should eq message }
+  end
+end
+shared_examples_for 'a redirect with alert' do |path, message|
+  it_behaves_like 'a redirect to', path
+  context 'sets alert' do
+    subject { flash[:alert] }
+    it { should eq message }
+  end
+end
+shared_examples_for 'a response without error' do
+  context 'sets no errors' do
+    subject { flash[:error] }
+    it { should be nil }
+  end
+end

data/spec/support/controller_macros.rb

@@ -0,0 +1,13 @@
+module ControllerMacros
+  def access_anonymous
+    sign_out :user
+    User.new
+  end
+
+  def login_user(user)
+    @request ||= controller.request
+    @request.env["devise.mapping"] = Devise.mappings[:user]
+    sign_in user
+    user
+  end
+end

data/spec/support/conversations.rb

@@ -0,0 +1,10 @@
+shared_context 'conversations' do
+  let(:sent_conversation) { MessageTrain::Conversation.find_by_subject('Sent Conversation') }
+  let(:unread_conversation) { MessageTrain::Conversation.find_by_subject('Unread Conversation') }
+  let(:ignored_conversation) { MessageTrain::Conversation.find_by_subject('Ignored Conversation') }
+  let(:trashed_conversation) { MessageTrain::Conversation.find_by_subject('Trashed Conversation') }
+  let(:read_conversation) { MessageTrain::Conversation.find_by_subject('Read Conversation') }
+  let(:deleted_conversation) { MessageTrain::Conversation.find_by_subject('Deleted Conversation') }
+  let(:someone_elses_conversation) { MessageTrain::Conversation.find_by_subject("Someone Else's Conversation") }
+  let(:draft_conversation) { MessageTrain::Conversation.find_by_subject('This should turn into a draft')}
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/feature_behaviors.rb

@@ -0,0 +1,62 @@
+shared_examples_for 'a bootstrap page' do |options = {}|
+  include ERB::Util
+  context 'displays a page with bootstrap elements' do
+    subject { page }
+    if options[:title].present?
+      it { should have_title html_escape(options[:title]) }
+      it { should have_xpath '//h1', text: options[:title] }
+    end
+    it { should have_selector '.navbar .navbar-header .navbar-brand', text: BootstrapLeather.configuration.application_title }
+  end
+end
+
+shared_examples_for 'a bootstrap page with a dropdown navigation list' do |options|
+  if options[:text]
+    it { should have_selector 'li.dropdown a.dropdown-toggle', text: options[:text]}
+  else
+    it { should have_selector 'li.dropdown a.dropdown-toggle'}
+  end
+end
+
+shared_examples_for 'a bootstrap page with an alert' do |type, text|
+  subject { page }
+  it { should have_selector ".alert.alert-#{type}", text: text }
+end
+
+shared_examples_for 'a bootstrap page without an alert' do |type|
+  subject { page }
+  it { should_not have_selector ".alert.alert-#{type}" }
+end
+
+shared_examples_for 'a bootstrap page listing a collection of items' do |object, options={}|
+  options[:minimum] ||= 1
+  options[:plural_title] ||= object.model_name.human.pluralize(2)
+  options[:plural_name] ||= object.table_name
+  collection_css_id = options[:plural_name]
+  member_css_class = options[:plural_name].singularize
+  it_behaves_like 'a bootstrap page', title: options[:plural_title].titlecase
+  context "displays a list of ##{collection_css_id} in .#{member_css_class}" do
+    subject { page }
+    it { should have_css("##{collection_css_id} .#{member_css_class}", minimum: options[:minimum]) }
+  end
+end
+
+shared_examples_for 'a bootstrap page showing an item' do |object, title, options={}|
+  options[:css_id] ||= object.table_name.singularize
+  it_behaves_like 'a bootstrap page', title: title
+  context "displays an item at ##{options[:css_id]}" do
+    subject { page }
+    it { should have_css("##{options[:css_id]}") }
+  end
+end
+
+shared_examples_for 'a bootstrap form with errors' do |error_fields|
+  subject { page }
+  for field in error_fields
+    it_behaves_like 'a bootstrap page with an alert', 'danger', "#{field.to_s.humanize} can't be blank"
+    context 'shows which field has errors' do
+      subject { page }
+      it { should have_css('.form-group.has-error', text: field.to_s.humanize)}
+    end
+  end
+end

data/spec/support/groups.rb

@@ -0,0 +1,3 @@
+shared_context 'groups' do
+  let(:first_group) { Group.find_by_title('First Group') }
+end

data/spec/support/loaded_site.rb

@@ -0,0 +1,5 @@
+shared_context 'loaded site' do
+  include_context 'users'
+  include_context 'groups'
+  include_context 'conversations'
+end

data/spec/support/shared_connection.rb

@@ -0,0 +1,13 @@
+# In your test_helper.rb
+class ActiveRecord::Base
+  mattr_accessor :shared_connection
+  @@shared_connection = nil
+
+  def self.connection
+    @@shared_connection || retrieve_connection
+  end
+end
+
+# Forces all threads to share the same connection. This works on
+# Capybara because it starts the web server in a thread.
+ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection

data/spec/support/users.rb

@@ -0,0 +1,6 @@
+shared_context 'users' do
+  let(:first_user) { User.friendly.find('first-user') }
+  let(:second_user) { User.friendly.find('second-user') }
+  let(:third_user) { User.friendly.find('third-user') }
+  let(:last_user) { User.order('id').last }
+end

data/spec/support/utilities.rb

@@ -0,0 +1,8 @@
+def path_to_url(path)
+  "#{request.protocol}#{request.host_with_port.sub(/:80$/,"")}/#{path.sub(/^\//,"")}"
+end
+
+def show_page
+  save_page Rails.root.join( 'public', 'capybara.html' )
+  %x(launchy http://localhost:3000/capybara.html)
+end