ddr-alerts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 908efd90fdfcfc3ae4ae2f35774bf721acc9654a
+  data.tar.gz: b6267ac4a425081b58e299b401917ac65a08e144
+SHA512:
+  metadata.gz: 98305bdb8e237f04a12e915eae6331978461d1e5c32a7bf4ee421f6d2ac0f39be82aac644fe040618c93dba875724c22f1d1c3bd7a841e029f7ca149bebafc10
+  data.tar.gz: 2c52a7ed31113ce4f7477f9000cf19b7e7dc6ed7de2930cceb527b57a7e4af5c6e780b45dbed7dd7c88207c798114b3e22347dcac3ddd60b2b3cf6a97b33fcf5

data/.gitignore

@@ -0,0 +1,6 @@
+coverage
+Gemfile.lock
+pkg
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1
+script: "bundle exec rake ci"
+cache: 
+  - bundler
+  - apt
+notifications:
+  email:
+    - lib-drs@duke.edu

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "coveralls", require: false

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2014, Duke University
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,60 @@
+# Ddr::Alerts
+
+Alerts for the Duke Digital Repository
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ddr-alerts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ddr-alerts
+
+## Usage
+
+#### Migrations
+
+Install the ddr-alerts migrations:
+
+    rake ddr_alerts:install:migrations
+
+then
+
+    rake db:migrate
+
+    rake db:test:prepare
+
+#### View Partial
+
+Ddr::Alerts contains a view partial (ddr/alerts/message/_alert_message.html.erb) that displays the alert messages.  This partial depends on
+the local 'alert_messages' to contain an array of Ddr::Alert::Message which are to be displayed.  Render this partial in the desired
+view / layout of your application, passing in the appropriate value for the 'alert_messages' local.  For example, override Blacklight's
+shared/_flash_messages.html.erb as shown below to include all active alert messages in the 'repository' context above the application's
+flash messages on each page:
+
+```
+<div class="row">
+  <div class="col-md-12">
+    <div id="main-flashes">
+	  <%= render partial: '/ddr/alerts/message/alert_message', locals: { alert_messages: Ddr::Alerts::Message.active.repository } %>
+      <%= yield %>
+    </div>
+  </div>
+</div>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ddr-alerts/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+APP_ROOT = File.dirname(__FILE__)
+
+require 'rspec/core/rake_task'
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec => ["app:db:migrate", "app:db:test:prepare"])
+
+desc "Run the CI build"
+task :ci do
+  Rake::Task['spec'].invoke
+end
+
+task :default => :spec

data/app/views/ddr/alerts/message/_alert_message.html.erb

@@ -0,0 +1,7 @@
+<% unless alert_messages.empty? %>
+	<div class="alert alert-danger"><ul class="<%= "list-unstyled" if alert_messages.size == 1 %>">
+		<% alert_messages.each do |msg| %>
+			<li><%= msg.message.html_safe %></li>
+		<% end %>
+	</ul></div>
+<% end %>

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/ddr/alerts/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/20141215160128_create_ddr_alerts_messages.rb

@@ -0,0 +1,16 @@
+class CreateDdrAlertsMessages < ActiveRecord::Migration
+  def up
+    unless table_exists?("ddr_alerts_messages")
+      create_table "ddr_alerts_messages" do |t|
+        t.text    "message"
+        t.boolean "active", default: false
+        t.timestamps
+      end
+    end
+  end
+
+  def down
+    # raise ActiveRecord::IrreversibleMigration
+    drop_table "ddr_alerts_messages"
+  end
+end

data/db/migrate/20141215161516_create_ddr_alerts_message_contexts.rb

@@ -0,0 +1,16 @@
+class CreateDdrAlertsMessageContexts < ActiveRecord::Migration
+  def up
+    unless table_exists?("ddr_alerts_message_contexts")
+      create_table "ddr_alerts_message_contexts" do |t|
+        t.belongs_to "message", index: true
+        t.string     "context"
+        t.timestamps
+      end
+    end
+  end
+
+  def down
+    # raise ActiveRecord::IrreversibleMigration
+    drop_table "ddr_alerts_message_contexts"
+  end
+end

data/ddr-alerts.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ddr/alerts/version'
+
+Gem::Specification.new do |s|
+  s.name          = "ddr-alerts"
+  s.version       = Ddr::Alerts::VERSION
+  s.authors       = ["Jim Coble"]
+  s.email         = ["lib-drs@duke.edu"]
+  s.summary       = %q{Alerts for the Duke Digital Repository}
+  s.description   = %q{Alerts for the Duke Digital Repository}
+  s.homepage      = "https://github.com/duke-libraries/ddr-alerts"
+  s.license       = "BSD-3-Clause"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 4.1.6"
+
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec-rails", "~> 3.1"
+  s.add_development_dependency "factory_girl_rails", "~> 4.4"
+  s.add_development_dependency "database_cleaner"
+end

data/lib/ddr-alerts.rb

@@ -0,0 +1 @@
+require 'ddr/alerts'

data/lib/ddr/alerts.rb

@@ -0,0 +1,18 @@
+require "ddr/alerts/engine"
+require "ddr/alerts/version"
+
+require "active_record"
+
+module Ddr
+  module Alerts
+    extend ActiveSupport::Autoload
+
+    autoload :Message
+    autoload :MessageContext
+
+    def self.table_name_prefix
+      'ddr_alerts_'
+    end
+
+  end
+end

data/lib/ddr/alerts/engine.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module Ddr
+  module Alerts
+    class Engine < ::Rails::Engine
+
+      engine_name "ddr_alerts"
+
+    end
+  end
+end

data/lib/ddr/alerts/message.rb

@@ -0,0 +1,14 @@
+module Ddr
+  module Alerts
+    class Message < ActiveRecord::Base
+
+      has_many :contexts, class_name: "Ddr::Alerts::MessageContext", inverse_of: :message, dependent: :destroy
+
+      scope :active, -> { where(active: true) }
+
+      scope :ddr, -> { joins(:contexts).where(ddr_alerts_message_contexts: { context: Ddr::Alerts::MessageContext::CONTEXT_DDR }) }
+      scope :repository, -> { joins(:contexts).where(ddr_alerts_message_contexts: { context: Ddr::Alerts::MessageContext::CONTEXT_REPOSITORY }) }
+
+    end
+  end
+end

data/lib/ddr/alerts/message_context.rb

@@ -0,0 +1,15 @@
+module Ddr
+  module Alerts
+    class MessageContext < ActiveRecord::Base
+
+      CONTEXT_REPOSITORY = 'repository'.freeze
+      CONTEXT_DDR = 'ddr'.freeze
+      CONTEXTS = [ CONTEXT_REPOSITORY, CONTEXT_DDR ].freeze
+
+      validates :context, inclusion: { in: CONTEXTS }
+
+      belongs_to :message, inverse_of: :contexts
+
+    end
+  end
+end

data/lib/ddr/alerts/version.rb

@@ -0,0 +1,5 @@
+module Ddr
+  module Alerts
+    VERSION = "0.1.0"
+  end
+end

data/spec/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/spec/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/spec/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/spec/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/spec/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/spec/dummy/app/helpers/application_helper.rb

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

data/spec/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/spec/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')