paul_revere 1.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 355afacefa6cf9309f77b784430797fa11dcf8d3
-  data.tar.gz: 0b6bf869f4f2004f70dea0e5a708ae2f5878848f
+  metadata.gz: 4b100f2354a49122ecd4082d4b84b4599571ee5e
+  data.tar.gz: 5325d817b43a06b3f72e6991ef259148a53aebd5
 SHA512:
-  metadata.gz: 6801cbf8cecdb895ff0364d6bd82eb9a97a4c3dec237f4c6eaf8a102768c67e7f3dac968933a42c3480bceba8d757ab2aafc895f40349cff0647dff065852119
-  data.tar.gz: 71100c4a13c779ad10c0a6bffdf022a12ed6d7be502483f26857077cd7b6de1ea289f4b03d3c5ac168f1af9fe09292d17c17d4921449e394236608f506a09ef7
+  metadata.gz: c12367eb2d4cf6e17ed90bb6a4f4cbb771d71210171aed06ac4fe0463a0b583caefce76213402bafcd47745fcff9e697eced1daaa4148af90610f342dd1d991f
+  data.tar.gz: 42d2f556c6e6dd471789bc01c6db199ebf1e9e1bb2192dde54401c5f14a2a9f92d228f778fee99256f2eaafc932efc220a195d1e45ba66256f63c64d4b997542

data/Appraisals

@@ -1,4 +1,4 @@
-['4.2.0', '4.1.0', '4.0.0'].each do |rails_version|
+["4.2.0", "4.1.0", "4.0.0"].each do |rails_version|
   appraise "rails_#{rails_version}" do
     gem "rails", "~> #{rails_version}"
   end

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    paul_revere (1.4)
+    paul_revere (2.0.0)
       rails (~> 4.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionmailer (4.2.0)
       actionpack (= 4.2.0)
@@ -50,6 +50,11 @@ GEM
     builder (3.2.2)
     diff-lcs (1.2.5)
     erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
     generator_spec (0.9.3)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
@@ -57,6 +62,12 @@ GEM
       activesupport (>= 4.1.0)
     hike (1.2.3)
     i18n (0.7.0)
+    jasmine (2.2.0)
+      jasmine-core (~> 2.2)
+      phantomjs
+      rack (>= 1.2.1)
+      rake
+    jasmine-core (2.2.0)
     json (1.8.2)
     loofah (2.0.1)
       nokogiri (>= 1.5.9)
@@ -68,6 +79,7 @@ GEM
     multi_json (1.10.1)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
+    phantomjs (1.9.8.0)
     rack (1.6.0)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -133,7 +145,9 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 1.0)
+  factory_girl_rails (~> 4.5)
   generator_spec (~> 0.9)
+  jasmine (~> 2.2)
   paul_revere!
   rspec-rails (~> 3.1)
   sqlite3 (~> 1.3)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2014 thoughtbot, inc
+Copyright (c) 2009 thoughtbot, inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/NEWS.md

@@ -1,3 +1,11 @@
+New in 2.0.0:
+
+* Remove deprecated should macros
+* Switch to using `change` in generated Rails migrations
+* Clean up the README and installation instructions
+* Install the javascripts into vendor/assets
+* Rename helper methods and view partials
+
 New in 1.4:
 
 * Reference the MIT license from the gemspec

data/README.md

@@ -1,75 +1,73 @@
-Paul Revere
-===========
+# Paul Revere
 
 [![Build Status](https://travis-ci.org/thoughtbot/paul_revere.svg?branch=master)](https://travis-ci.org/thoughtbot/paul_revere)
 
-Simple announcement plugin to include "one off" style announcements in Rails web apps.
+This gem enables the inclusion of "one off" announcements in Rails applications.
 
-[![Paul Revere's
-Ride](http://f.cl.ly/items/2u260D0Y2j2T3O3o4017/Screen%20Shot%202013-01-23%20at%2010.46.06%20AM.png)](http://poetry.eserver.org/paul-revere.html)
+## Installation
 
-Install with the asset pipeline (Rails 3.1+, asset pipeline enabled)
---------------------------------------------------------------------
+First, include the gem as normal in your Gemfile:
 
-Install as normal in your Gemfile:
+    gem "paul_revere"
 
-    gem 'paul_revere'
-
-Run the generator to create the migration:
+Then, run the generator to create the migration and copy the javascript.
 
     rails generate paul_revere
 
-Add the announcement JS to `app/assets/javascripts/application.js`:
+The announcements JS will be installed into vendor/assets/javascripts.
+You can add the announcement JS to `app/assets/javascripts/application.js`:
 
     //= require announcements
 
-Run the migration:
-
-    rake db:migrate && rake db:migrate:redo
-
-Install without the asset pipeline (Rails 3.0 or asset pipeline disabled)
----------------------------------------------------------------------------
-
-Install as normal in your Gemfile:
-
-    gem 'paul_revere'
+This will include the javascript into the `application.js` for the entire site.
 
-Run the generator to create the migration and copy the JavaScript file into public:
+Finally, create the announcements table by running the migration:
 
-    rails generate paul_revere
-
-Add the announcement JS to your layout, such as `app/views/layouts/application.html.erb`:
-
-    <%= javascript_include_tag 'announcements' %>
+    rake db:migrate
 
-Run the migration:
+## Background
 
-    rake db:migrate && rake db:migrate:redo
+Paul Revere provides...
 
-Usage
------
+* A model called `Announcement`, which has timestamps and a "body" text column.
+* A `current` class method on `Announcement` which returns the latest
+  `Announcement`, or a new unsaved instance.
+* A view helper called `#current_announcement`, which will return that latest
+  `Announcement` record.
+* A view partial called `_public_announcement`, which is intended to be shown to
+  all site users.
+* A view partial called `_private_announcement`, which is intended to be shown
+  only to logged in users.  Note that this merely wraps the rendering of the
+  public announcement with a call to a helper which checks that a user is signed
+  in. There is only one type of Announcement.
+* A view partial called `_email_announcement`, which is intended to be used in
+  site emails which are sent out and need to include announcements.
 
-Paul Revere provides...
+## Usage
 
-* A model called `Announcement`, which has nothing more than timestamps and a "body" column (text column).  We view the most recent `Announcement` as the "current" announcement, and will select that to show on the site.
-* A helper called `#current_announcement`, which will return that latest `Announcement` record.
-* A view partial called `_announcement_for_all`, which is intended to be shown to all site users.
-* A view partial called `_announcement`, which is intended to be shown only to logged in users.
-* A view partial called `_email_announcement`, which is intended to be used in site emails which are sent out.
+* Install the gem, run the migration, ensure the javascript can be accessed.
+* Use those partials in the correct places in your view code and mailer view
+  code where you want announcements to show up.
 
-So the flow would be...
+For example, to include the latest announcement for all site users:
 
-* Install the gem
-* Use those partials in the correct places in your view code and mailer view code where you want announcements to show up:
+```
+<%= render "announcements/public_announcement" %>
+```
 
-        <%= render 'announcements/announcement_for_all' %>
+To make an announcement, use the Rails console to create a new record:
 
-* When you want to make an announcement, use the Rails console to create a new `Announcement` record:
+```
+Announcement.create!(body: "Free ice cream on Monday!")
+```
 
-        Announcement.create!(body: 'This Web site is shutting down because you refuse to pay')
+There is a helper method called `announcement_visibility_allowed?`, which is
+what the `private_announcement` partial calls to determine whether to allow the
+current session to view announcements.  The built-in implementation just checks
+that `current_user` is truth-y. Override that helper method if you want to do
+something more interesting as a check here.
 
-Credits
--------
+## Credits
 
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
 
@@ -79,7 +77,7 @@ Thank you to all [the contributors](https://github.com/thoughtbot/paul_revere/co
 
 The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
-License
--------
+## License
 
-Paul Revere is Copyright © 2009-2014 thoughtbot. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Paul Revere is Copyright © 2009 thoughtbot, inc. It is free software, and may be
+redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -1,18 +1,21 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'appraisal'
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "appraisal"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
+require "jasmine"
+load "jasmine/tasks/jasmine.rake"
+
 task :default do |t|
-  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
-    exec 'rake spec'
+  if ENV["BUNDLE_GEMFILE"] =~ /gemfiles/
+    exec "rake spec jasmine:ci"
   else
-    Rake::Task['appraise'].execute
+    Rake::Task["appraise"].execute
   end
 end
 
-task :appraise => ['appraisal:install'] do |t|
-  exec 'rake appraisal'
+task :appraise => ["appraisal:install"] do |t|
+  exec "rake appraisal"
 end

data/app/assets/javascripts/announcements.js

@@ -1,15 +1,29 @@
-function hideAnnouncement(announcement_created_at) {
-  createCookie(announcement_created_at, 'hidden', 365);
+function hideAnnouncement(announcement_key) {
+  createCookie(announcement_key, "hidden", 365);
   $("#announcement").slideUp();
 }
 
-// http://www.quirksmode.org/js/cookies.html
-function createCookie(name,value,days) {
+// Utility scripts from http://www.quirksmode.org/js/cookies.html
+function createCookie(name, value, days) {
   if (days) {
     var date = new Date();
-    date.setTime(date.getTime()+(days*24*60*60*1000));
-    var expires = "; expires="+date.toGMTString();
+    date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
+    var expires = "; expires=" + date.toGMTString();
+  } else var expires = "";
+  document.cookie = name + "=" + value + expires + "; path=/";
+}
+
+function readCookie(name) {
+  var nameEQ = name + "=";
+  var ca = document.cookie.split(';');
+  for (var i = 0; i < ca.length; i++) {
+    var c = ca[i];
+    while (c.charAt(0) == ' ') c = c.substring(1, c.length);
+    if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length, c.length);
   }
-  else var expires = "";
-  document.cookie = name+"="+value+expires+"; path=/";
+  return null;
+}
+
+function eraseCookie(name) {
+  createCookie(name, "", -1);
 }

data/app/helpers/announcements_helper.rb

@@ -1,9 +1,17 @@
 module AnnouncementsHelper
-  def announcement_hidden?(announcement)
-    cookies["announcement_#{announcement.created_at}"] == "hidden"
+  def announcement_visible?(announcement)
+    announcement.exists? && announcement_unread?(announcement)
+  end
+
+  def announcement_unread?(announcement)
+    cookies[announcement.to_cookie_key] != "hidden"
   end
 
   def current_announcement
     @current_announcement ||= Announcement.current
   end
+
+  def announcement_visibility_allowed?
+    !! current_user
+  end
 end

data/app/models/announcement.rb

@@ -1,9 +1,13 @@
 class Announcement < ActiveRecord::Base
   def self.current
-    order('created_at desc').first || new
+    order("created_at desc").first || new
   end
 
   def exists?
     !new_record?
   end
+
+  def to_cookie_key
+    "#{self.class.name.downcase}_#{created_at.iso8601}"
+  end
 end

data/app/views/announcements/_private_announcement.html.erb

@@ -0,0 +1,3 @@
+<% if announcement_visibility_allowed? -%>
+  <%= render "announcements/public_announcement" %>
+<% end -%>

data/app/views/announcements/_public_announcement.html.erb

@@ -0,0 +1,8 @@
+<% if announcement_visible?(current_announcement) %>
+  <div id="announcement">
+    <span><%= current_announcement.body.html_safe %></span>
+    <span class="hide">
+      <%= link_to "hide", "#", onclick: "hideAnnouncement('#{current_announcement.to_cookie_key}')" %>
+    </span>
+  </div>
+<% end %>

data/gemfiles/rails_4.0.0.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", "~> 4.0.0"
 

data/gemfiles/rails_4.1.0.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", "~> 4.1.0"
 

data/gemfiles/rails_4.2.0.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
 

data/lib/generators/paul_revere/paul_revere_generator.rb

@@ -1,32 +1,28 @@
-require 'rails/generators/active_record'
+require "rails/generators/active_record"
 
 class PaulRevereGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
-  desc "Put the JavaScript and migration in place"
+  desc "Copy the PaulRevere JavaScript and announcements migration"
   source_root File.join(File.dirname(__FILE__), "templates")
 
   def install
-    copy_javascript if needs_js_copied?
+    copy_javascript
     migration_template "migration.rb", "db/migrate/create_announcements.rb"
   end
 
   private
 
   def copy_javascript
-    copy_file File.join(javascript_path, 'announcements.js'), js_destination
+    copy_file File.join(javascript_path, "announcements.js"), javascript_destination
   end
 
   def javascript_path
     File.join(%w(.. .. .. .. app assets javascripts))
   end
 
-  def needs_js_copied?
-    !::Rails.application.config.assets.enabled
-  end
-
-  def js_destination
-    'public/javascripts/announcements.js'
+  def javascript_destination
+    "vendor/assets/javascripts/announcements.js"
   end
 
   def self.next_migration_number(dirname)

data/lib/generators/paul_revere/templates/migration.rb

@@ -1,12 +1,8 @@
 class CreateAnnouncements < ActiveRecord::Migration
-  def self.up
+  def change
     create_table :announcements do |t|
       t.text :body
-      t.timestamps :null => false
+      t.timestamps null: false
     end
   end
-
-  def self.down
-    drop_table :announcements
-  end
 end

data/lib/paul_revere.rb

@@ -1,4 +1,4 @@
-require 'paul_revere/version'
+require "paul_revere/version"
 
 module PaulRevere
   class Engine < Rails::Engine

data/lib/paul_revere/version.rb

@@ -1,3 +1,3 @@
 module PaulRevere
-  VERSION = '1.4'.freeze
+  VERSION = "2.0.0".freeze
 end