harbinger 0.0.1.pre → 0.1.0

data/spec/models/harbinger/database_channel_message_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_active_record_helper'
+require 'harbinger/database_channel_message'
+require 'harbinger/message'
+
+module Harbinger
+  describe DatabaseChannelMessage do
+    subject { described_class.new }
+    let(:message) do
+      Message.new do |message|
+        message.append('exception', 'name', 'hello')
+        message.append('exception', 'name', 'world')
+        message.append('user', 'name', 'tim')
+        message.append('user', 'id', '123')
+      end
+    end
+
+    it 'should have many elements' do
+      subject.save!
+      expect(subject.elements).to be_a_kind_of(ActiveRecord::Associations::CollectionProxy)
+    end
+
+    context '.ordered' do
+      it 'should evaluate to sql' do
+        expect(described_class.ordered.to_sql).to be_a(String)
+      end
+    end
+
+    context '.search_state' do
+      it 'should evaluate to sql' do
+        expect(described_class.search_state('new').to_sql).to be_a(String)
+      end
+    end
+
+    context '.search_text' do
+      it 'should evaluate to sql' do
+        expect(described_class.search_text('my-text').to_sql).to be_a(String)
+      end
+    end
+
+    context '.search' do
+      it 'handles a query parameter' do
+        expect(described_class.search(q: 'Hello', state: 'new').to_sql).to be_a(String)
+      end
+    end
+
+    context '.store_message' do
+      it 'creates a new instance' do
+        expect { described_class.store_message(message) }.
+          to change { described_class.count }.
+          by(1)
+      end
+
+      it 'creates elements' do
+        storage = described_class.new
+        expect { described_class.store_message(message, storage) }.
+          to change { storage.elements.count }.
+          by(3)
+      end
+
+      it 'assigns :contexts' do
+        storage = described_class.new
+        expect { described_class.store_message(message, storage) }.
+          to change { storage.attributes.values_at('contexts', 'state') }.
+          from([nil, nil]).to(['exception,user', 'new'])
+      end
+    end
+  end
+end

data/spec/routing/harbinger/messages_routing_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_slow_helper'
+
+module Harbinger
+  describe 'routes for Messages', type: :routing do
+    routes { Harbinger::Engine.routes }
+
+    it 'generates a resourceful URL for :index' do
+      expect(messages_path).to eq('/harbinger/messages')
+    end
+
+    it 'generates a resourceful URL for :show' do
+      expect(message_path('1')).to eq('/harbinger/messages/1')
+    end
+
+  end
+end

data/spec/spec_active_record_helper.rb

@@ -0,0 +1,41 @@
+# This helper provides at least a x2 speed increase over the 'spec_slow_helper'.
+#
+# To validate this assumption, find a spec for an ActiveRecord object, and run
+# with `rspec -r spec/spec_active_record_helper.rb ./path/to/spec.rb`
+#
+# Example:
+# $ time rspec -r spec/spec_active_record_helper.rb spec/features/new_user_input_to_in_memory_spec.rb
+#
+#     real  0m1.576s
+#     user  0m1.093s
+#     sys   0m0.295s
+#
+# Compared to `rspec -r spec/spec_slow_helper.rb ./path/to/spec.rb`
+#
+# Example:
+# $ time rspec -r spec/spec_slow_helper.rb spec/features/new_user_input_to_in_memory_spec.rb
+#
+#     real  0m3.546s
+#     user  0m2.417s
+#     sys   0m0.702s
+require 'active_record'
+require 'spec_fast_helper'
+
+if !defined?(Rails)
+  # Sometimes this will be invoked when Rails is defined. In that case the relative
+  # path is ../internal. When Rails is not defined the relative path is different.
+  # By providing an absolute path, I avoid either of those silly things.
+  database = File.expand_path('../internal/db/development.sqlite3', __FILE__)
+
+  connection_info = { adapter: 'sqlite3', database: database, pool: 5, timeout: 5000 }
+  ActiveRecord::Base.establish_connection(connection_info)
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      fail ActiveRecord::Rollback
+    end
+  end
+end

data/spec/spec_fast_helper.rb

@@ -0,0 +1,70 @@
+# This helper provides at least a ~x3 speed increase over the 'spec_slow_helper'.
+#
+# The idea being that some tests have very few dependencies.
+#
+# Example:
+# $ time rspec -r spec/spec_fast_helper.rb spec/lib/hydramata-work_spec.rb
+#
+#     real  0m1.188s
+#     user  0m0.979s
+#     sys   0m0.204s
+#
+# Compared to `rspec -r spec/spec_slow_helper.rb ./path/to/spec.rb`
+#
+# Example:
+# $ time rspec -r spec/spec_slow_helper.rb spec/lib/hydramata-work_spec.rb
+#
+#     real  0m3.491s
+#     user  0m2.800s
+#     sys   0m0.667s
+
+require 'rspec/given'
+unless defined?(Rails)
+  Dir[File.expand_path("../../app/*", __FILE__)].each do |dir|
+    $LOAD_PATH << dir
+  end
+  $LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+  unless defined?(require_dependency)
+    def require_dependency(*files)
+      require *files
+    end
+  end
+end
+
+class AttributeBucket
+  def initialize(attributes = {})
+    attributes.each do |key, value|
+      send("#{key}=", value) if respond_to?("#{key}=")
+    end
+  end
+end
+
+class Request < AttributeBucket
+  attr_accessor :path, :params, :user_agent
+end
+
+unless defined?(User)
+  class User < AttributeBucket
+    attr_accessor :username
+  end
+end
+
+shared_examples 'a harbinger reporter' do
+  Given(:reporter) { described_class.new(double) }
+  context 'interface' do
+    Then { expect(reporter).to respond_to(:accept) }
+    And { expect(reporter.method(:accept).arity).to eq(1) }
+  end
+  context 'is fault tolerant' do
+    Given(:message) { double(append: false) }
+    When { reporter.accept(message) }
+  end
+end
+
+
+shared_examples "a harbinger channel" do
+  Given(:channel) { described_class }
+  Then { expect(channel).to respond_to(:deliver) }
+  And { expect(channel.method(:deliver).arity).to eq(-2) }
+end

data/spec/spec_slow_helper.rb

@@ -0,0 +1,57 @@
+# Why is this a spec_slow_helper instead of spec_helper
+# Because it is extremely slow to load all of the following dependencies:
+#
+# * SimpleCov
+# * EngineCart (and therefore the underlying internal Rails application)
+# * Rails
+#
+# But overtime the slowness grows. See the sibling helpers: ./spec/*_helper.rb
+# (i.e. spec_active_record_helper.rb, spec_fast_helper.rb, spec_view_helper.rb)
+ENV['RAILS_ENV'] ||= 'test'
+if ENV['COV'] || ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start 'rails'
+  SimpleCov.command_name 'spec'
+end
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!('rails')
+end
+
+require 'engine_cart'
+require File.expand_path('../internal/config/environment.rb',  __FILE__)
+
+EngineCart.load_application!
+
+require 'rspec/rails'
+require 'rspec-html-matchers'
+require 'database_cleaner'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require 'spec_helper'` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.raise_errors_for_deprecations!
+  # 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'
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+end

data/spec/spec_view_helper.rb

@@ -0,0 +1,38 @@
+# I'm deliberately not including this, as I was hoping to keep the views tested
+# in extreme isolation.
+
+# Example:
+# $ time rspec -r spec/spec_view_helper.rb spec/views/hydramata/works/fieldsets/_edit.html.erb_spec.rb
+#
+#     real  0m1.228s
+#     user  0m1.003s
+#     sys   0m0.205s
+#
+# Compared to `rspec -r spec/spec_slow_helper.rb ./path/to/spec.rb`
+#
+# Example:
+# $ time rspec -r spec/spec_view_helper.rb spec/views/hydramata/works/fieldsets/_edit.html.erb_spec.rb
+#
+#     real  0m3.417s
+#     user  0m2.720s
+#     sys   0m0.679s
+
+require 'active_support'
+require 'action_view'
+require 'action_controller'
+
+require 'active_support/core_ext/hash/reverse_merge'
+
+require 'rspec/core'
+require 'rails/version'
+require 'rspec/rails/extensions'
+require 'rspec/rails/view_rendering'
+require 'rspec/rails/adapters'
+require 'rspec/rails/matchers'
+require 'rspec/rails/fixture_support'
+require 'rspec/rails/example'
+require 'rspec/rails/configuration'
+
+require 'rspec-html-matchers'
+
+ActionController::Base.prepend_view_path(File.expand_path('../../app/views', __FILE__))

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root "./spec/test_app_templates"
+
+  # if you need to generate any additional configuration
+  # into the test app, this generator will be run immediately
+  # after setting up the application
+
+  def install_engine
+    generate 'harbinger:install'
+  end
+end

data/spec/views/harbinger/messages/index.html.erb_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_view_helper'
+
+# As of 3.0.x :type tags are no longer inferred.
+# This means, without the `type: :view` tag, the render method does not exist
+# in the example context
+describe 'harbinger/messages/index.html.erb', type: :view do
+  let(:created_at) { Time.now }
+  let(:message) do
+    double(
+      'Message',
+      contexts: ['Hello','World'],
+      state: 'new',
+      created_at: created_at
+    )
+  end
+  let(:harbinger) { double("Engine", message_path: true, messages_path: '/messages/') }
+  it 'renders the object and fieldsets' do
+    expect(harbinger).to receive(:message_path).with(message.to_param).and_return("/messages/#{message.to_param}")
+    render template: "harbinger/messages/index.html.erb", locals: { messages: [message], harbinger: harbinger }
+    expect(rendered).to have_tag('.search-form') do
+      with_tag('input.q.search-query', with: { type: 'search', name: 'q' } )
+    end
+
+    expect(rendered).to have_tag('.message') do
+      with_tag(".detail.message-created-at-detail a time", text: created_at.to_s)
+      with_tag('.detail.message-contexts-detail', text: 'Hello')
+      with_tag('.detail.message-contexts-detail', text: 'World')
+      with_tag('.detail.message-state-detail', text: 'new')
+    end
+  end
+end

data/spec/views/harbinger/messages/show.html.erb_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_view_helper'
+
+# As of 3.0.x :type tags are no longer inferred.
+# This means, without the `type: :view` tag, the render method does not exist
+# in the example context
+describe 'harbinger/messages/show.html.erb', type: :view do
+  let(:created_at) { Time.now }
+  let(:netid_element) { double('Element', key: 'netid', value: 'jfriesen') }
+  let(:request_referrer_element) { double('Element', key: 'request_referrer', value: 'from somewhere') }
+  let(:message) do
+    double(
+      'Message',
+      contexts: ['Hello','World'],
+      state: 'new',
+      created_at: created_at,
+      elements: [netid_element, request_referrer_element]
+    )
+  end
+  it 'renders the object and fieldsets' do
+    render template: 'harbinger/messages/show',
+      locals: { message: message }
+    expect(rendered).to have_tag('article.message') do
+      with_tag('.term.message-contexts-term')
+      with_tag('.detail.message-contexts-detail', text: 'Hello')
+      with_tag('.detail.message-contexts-detail', text: 'World')
+      with_tag('.term.message-state-term')
+      with_tag('.detail.message-state-detail', text: 'new')
+      with_tag('.term.message-created-at-term')
+      with_tag('.detail.message-created-at-detail time', text: created_at.to_s)
+      with_tag('.term.netid-term', text: netid_element.key)
+      with_tag('.detail.netid-detail', text: netid_element.value)
+      with_tag('.term.request-referrer-term', text: request_referrer_element.key)
+      with_tag('.detail.request-referrer-detail', text: request_referrer_element.value)
+    end
+  end
+end

metadata

@@ -1,71 +1,232 @@
 --- !ruby/object:Gem::Specification
 name: harbinger
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: An exception tracking Rails engine
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A Rails engine for arbitrary message creation and delivery.
 email:
 - jeremy.n.friesen@gmail.com
-executables:
-- rails
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".hound.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
-- MIT-LICENSE
 - README.md
 - Rakefile
 - app/assets/images/harbinger/.keep
 - app/assets/javascripts/harbinger/application.js
 - app/assets/stylesheets/harbinger/application.css
 - app/controllers/harbinger/application_controller.rb
+- app/controllers/harbinger/messages_controller.rb
 - app/helpers/harbinger/application_helper.rb
+- app/models/harbinger/database_channel_message.rb
+- app/models/harbinger/database_channel_message_element.rb
+- app/views/harbinger/messages/index.html.erb
+- app/views/harbinger/messages/show.html.erb
 - app/views/layouts/harbinger/application.html.erb
 - bin/rails
 - config/routes.rb
+- db/migrate/20140310185338_create_harbinger_database_channel_message.rb
+- db/migrate/20140310185339_create_harbinger_database_channel_message_elements.rb
+- gemfiles/rails4.1.gemfile
+- gemfiles/rails4.gemfile
 - harbinger.gemspec
+- lib/generators/harbinger/install/install_generator.rb
+- lib/generators/harbinger/install/templates/harbinger_initializer.rb.erb
 - lib/harbinger.rb
+- lib/harbinger/channels.rb
+- lib/harbinger/channels/database_channel.rb
+- lib/harbinger/channels/logger_channel.rb
+- lib/harbinger/channels/null_channel.rb
+- lib/harbinger/configuration.rb
 - lib/harbinger/engine.rb
+- lib/harbinger/exceptions.rb
+- lib/harbinger/message.rb
+- lib/harbinger/reporters.rb
+- lib/harbinger/reporters/exception_reporter.rb
+- lib/harbinger/reporters/null_reporter.rb
+- lib/harbinger/reporters/request_reporter.rb
+- lib/harbinger/reporters/user_reporter.rb
 - lib/harbinger/version.rb
 - lib/tasks/harbinger_tasks.rake
-homepage: ''
+- run_each_spec_in_isolation
+- script/fast_specs
+- spec/controllers/harbinger/messages_controller_spec.rb
+- spec/features/end_to_end_exception_handling_spec.rb
+- spec/lib/harbinger/channels/database_channel_spec.rb
+- spec/lib/harbinger/channels/logger_channel_spec.rb
+- spec/lib/harbinger/channels/null_channel_spec.rb
+- spec/lib/harbinger/channels_spec.rb
+- spec/lib/harbinger/configuration_spec.rb
+- spec/lib/harbinger/message_spec.rb
+- spec/lib/harbinger/reporters/exception_reporter_spec.rb
+- spec/lib/harbinger/reporters/null_reporter_spec.rb
+- spec/lib/harbinger/reporters/request_reporter_spec.rb
+- spec/lib/harbinger/reporters/user_reporter_spec.rb
+- spec/lib/harbinger/reporters_spec.rb
+- spec/lib/harbinger_spec.rb
+- spec/models/harbinger/database_channel_message_element_spec.rb
+- spec/models/harbinger/database_channel_message_spec.rb
+- spec/routing/harbinger/messages_routing_spec.rb
+- spec/spec_active_record_helper.rb
+- spec/spec_fast_helper.rb
+- spec/spec_slow_helper.rb
+- spec/spec_view_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/views/harbinger/messages/index.html.erb_spec.rb
+- spec/views/harbinger/messages/show.html.erb_spec.rb
+homepage: https://github.com/ndlib/harbinger
 licenses:
 - Apache2
 metadata: {}
@@ -75,18 +236,42 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: An exception tracking Rails engine
-test_files: []
+summary: A Rails engine for arbitrary message creation and delivery.
+test_files:
+- spec/controllers/harbinger/messages_controller_spec.rb
+- spec/features/end_to_end_exception_handling_spec.rb
+- spec/lib/harbinger/channels/database_channel_spec.rb
+- spec/lib/harbinger/channels/logger_channel_spec.rb
+- spec/lib/harbinger/channels/null_channel_spec.rb
+- spec/lib/harbinger/channels_spec.rb
+- spec/lib/harbinger/configuration_spec.rb
+- spec/lib/harbinger/message_spec.rb
+- spec/lib/harbinger/reporters/exception_reporter_spec.rb
+- spec/lib/harbinger/reporters/null_reporter_spec.rb
+- spec/lib/harbinger/reporters/request_reporter_spec.rb
+- spec/lib/harbinger/reporters/user_reporter_spec.rb
+- spec/lib/harbinger/reporters_spec.rb
+- spec/lib/harbinger_spec.rb
+- spec/models/harbinger/database_channel_message_element_spec.rb
+- spec/models/harbinger/database_channel_message_spec.rb
+- spec/routing/harbinger/messages_routing_spec.rb
+- spec/spec_active_record_helper.rb
+- spec/spec_fast_helper.rb
+- spec/spec_slow_helper.rb
+- spec/spec_view_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/views/harbinger/messages/index.html.erb_spec.rb
+- spec/views/harbinger/messages/show.html.erb_spec.rb