paul_revere 0.2.1 → 1.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.swp
+.swo
+*~
+log/
+pkg
+rdoc
+gemfiles/*.lock
+*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - gemfiles/3.0.12.gemfile
+  - gemfiles/3.1.4.gemfile
+  - gemfiles/3.2.3.gemfile

data/Appraisals

@@ -0,0 +1,5 @@
+['3.2.3', '3.1.4', '3.0.12'].each do |rails_version|
+  appraise "rails-#{rails_version}" do
+    gem "rails", rails_version
+  end
+end

data/Gemfile

@@ -1,5 +1,3 @@
 source "http://rubygems.org"
-gemspec
 
-gem "appraisal"
-gem "rspec-rails"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    paul_revere (1.0)
+      rails (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    appraisal (0.3.8)
+      bundler
+      rake
+    arel (2.2.3)
+    bcrypt-ruby (3.0.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    mail (2.3.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    mocha (0.9.12)
+    multi_json (1.0.3)
+    polyglot (0.3.3)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rdoc (3.9.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  mocha
+  paul_revere!
+  rspec
+  rspec-rails
+  sqlite3

data/NEWS.md

@@ -0,0 +1,5 @@
+New in 1.0:
+
+* Support for Rails 3.2.3, 3.1.4, and 3.0.12.
+* Fix the JavaScript that hides the announcements to work out of the box.
+* The announcement hiding cookie expires after a year.

data/README.md

@@ -31,6 +31,7 @@ Paul Revere provides...
 So the flow would be...
 
 * Install the gem
+* Add `helper :announcements` either to application_controller.rb or to the specific controllers where you want to make the announcement helpers available
 * Use those partials in the correct places in your view code and mailer view code where you want announcements to show up
 * When you want to make an announcement, use the rails console to create a new Announcement record
 

data/Rakefile

@@ -1,31 +1,18 @@
-# encoding: UTF-8
-require 'rubygems'
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rake'
-require 'rdoc/task'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 require 'appraisal'
 
-require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Default: run the unit tests."
-task :default => [:all]
-
-desc 'Test the plugin under all supported Rails versions.'
-task :all => ["appraisal:install"] do |t|
-  exec('rake appraisal spec')
+task :default do |t|
+  if ENV['BUNDLE_GEMFILE'] =~ /gemfiles/
+    exec 'rake spec'
+  else
+    Rake::Task['appraise'].execute
+  end
 end
 
-desc 'Generate documentation for the paul revere plugin.'
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'PaulRevere'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :appraise => ['appraisal:install'] do |t|
+  exec 'rake appraisal'
 end

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

@@ -1,9 +1 @@
-<% if current_user and current_announcement.exists? and not announcement_hidden?(current_announcement) %>
-  <div id="flash-border" class="announcement">
-    <span><%= current_announcement.body.html_safe %></span>
-    <span class="hide">
-      <%= link_to_function "hide", "hideAnnouncement('announcement_#{current_announcement.created_at}');" %>
-    </span>
-  </div>
-<% end %>
-
+<%= render 'announcements/announcement_for_all' if current_user %>

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

@@ -1,11 +1,8 @@
-<% if current_announcement.exists? and not announcement_hidden?(current_announcement) %>
-  <div id="flash-border">
-    <div id="announcement">
-      <span><%= current_announcement.body.html_safe %></span>
-      <span class="hide">
-        <%= link_to_function "hide", "hideAnnouncement('announcement_#{current_announcement.created_at}');" %>
-      </span>
-    </div>
+<% if current_announcement.exists? && !announcement_hidden?(current_announcement) %>
+  <div id="announcement">
+    <span><%= current_announcement.body.html_safe %></span>
+    <span class="hide">
+      <%= link_to_function "hide", "hideAnnouncement('announcement_#{current_announcement.created_at}')" %>
+    </span>
   </div>
 <% end %>
-

data/gemfiles/3.0.12.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "3.0.12"
+
+gemspec :path=>"../"

data/gemfiles/3.1.4.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "3.1.4"
+gem "sass-rails"
+gem "coffee-script"
+gem "uglifier"
+gem "jquery-rails"
+
+gemspec :path=>"../"

data/gemfiles/3.2.3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "3.2.3"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.0.12.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "3.0.12"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.1.4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "3.1.4"
+
+gemspec :path=>"../"

data/gemfiles/rails-3.2.3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "3.2.3"
+
+gemspec :path=>"../"

data/lib/generators/paul_revere/templates/announcements.js

@@ -1,6 +1,6 @@
 function hideAnnouncement(announcement_created_at) {
-  createCookie(announcement_created_at, 'hidden', 1);
-  $("#announcement").parent().slideUp();
+  createCookie(announcement_created_at, 'hidden', 365);
+  $("#announcement").slideUp();
 }
 
 // http://www.quirksmode.org/js/cookies.html

data/lib/paul_revere/version.rb

@@ -0,0 +1,3 @@
+module PaulRevere
+  VERSION = '1.0'.freeze
+end

data/lib/paul_revere.rb

@@ -1,3 +1,5 @@
+require 'paul_revere/version'
+
 module PaulRevere
   class Engine < Rails::Engine
   end

data/paul_revere.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "paul_revere/version"
+
+Gem::Specification.new do |s|
+  s.name        = "paul_revere"
+  s.version     = PaulRevere::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nick Quaranto', 'Matt Jankowski', 'Joe Ferris', 'Christopher Meiklejohn', 'Tammer Saleh', 'Jason Morrison', 'Gabe Berke-Williams']
+  s.email       = "support@thoughtbot.com"
+  s.homepage    = "https://github.com/thoughtbot/paul_revere"
+  s.summary     = "Simple announcement plugin to include 'one off' style announcements in Rails web apps."
+  s.description = "Paul Revere provides a model and helper methods to do one-off style announcements."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("rails", "~> 3.0")
+
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("rspec-rails")
+  s.add_development_dependency("sqlite3")
+  s.add_development_dependency("mocha")
+  s.add_development_dependency("appraisal")
+end

data/shoulda_macros/announcement.rb

@@ -0,0 +1,18 @@
+class ActiveSupport::TestCase
+
+  def self.with_current_announcement(&blk)
+    context "When there is a current announcement" do
+      setup do
+        Annoucement.create!(:body => 'therefore,')
+      end
+      merge_block(&blk)
+    end
+  end
+
+  def self.should_display_current_announcement
+    should "have the current announcement in it" do
+      assert_match Announcement.current.body, @email.body
+    end 
+  end
+
+end

data/spec/fake_app.rb

@@ -0,0 +1,16 @@
+# Create a rails app
+module PaulRevere
+  class Application < Rails::Application
+  end
+end
+
+# Run migrations
+project_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+require File.join project_root, 'lib', 'generators', 'paul_revere', 'templates', 'migration'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+CreateAnnouncements.suppress_messages { CreateAnnouncements.up }

data/spec/helpers/announcements_helper_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'app', 'helpers', 'announcements_helper')
+require File.join(File.dirname(__FILE__), '..', '..', 'app', 'models', 'announcement')
+
+describe AnnouncementsHelper do
+
+  it "should return the current announcement when sent current_announcement and cache doesn't exist" do
+    assign :current_announcement, nil
+    Announcement.stubs(:current).returns(:foo)
+    helper.current_announcement.should == :foo
+  end
+
+  it "should return a cached announcement when sent current_announcement and cache exists" do
+    assign :current_announcement, :foo
+    Announcement.expects(:current).never
+    helper.current_announcement.should == :foo
+  end
+
+  describe "when there is an announcement" do
+    before do
+      @announcement = Announcement.create!(:body => 'a body')
+      assign :announcement, @announcement
+    end
+
+    describe "and the user has hidden an announcement" do
+      before { helper.stubs(:cookies).returns("announcement_#{@announcement.created_at}" => "hidden") }
+
+      it "should return true when sent announcement_hidden? with announcement" do
+        helper.announcement_hidden?(@announcement).should be_true
+      end
+    end
+
+    describe "and the user has not hidden an announcement" do
+      before { helper.stubs(:cookies).returns("announcement_#{@announcement.created_at}" => "not hidden") }
+
+      it "should return false when sent announcement_hidden? with announcement" do
+        helper.announcement_hidden?(@announcement).should be_false
+      end
+    end
+  end
+end

data/spec/models/announcement_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'app', 'models', 'announcement')
+
+describe Announcement do
+  it "should return the latest announcement when there are several" do
+    old = Announcement.create!(:body => 'no fun', :created_at => 2.days.ago)
+    latest = Announcement.create!(:body => 'fun', :created_at => 1.day.ago)
+    older = Announcement.create!(:body => 'less fun', :created_at => 3.days.ago)
+
+    Announcement.current.should == latest
+  end
+
+  it "should return an existent announcement where there is no announcement" do
+    Announcement.create!(:body => 'body')
+    Announcement.current.exists?.should == true
+  end
+
+  it "should return a non-existent announcement where there is no announcement" do
+    Announcement.current.exists?.should be_false
+  end
+end

data/spec/paul_revere_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe PaulRevere do
+  it "should be valid" do
+    PaulRevere.should be_a(Module)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require "rails/all"
+require "rspec/rails"
+
+# Pull in the fake rails app
+require 'fake_app'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :mocha
+
+  # Remove announcements before each example
+  config.before(:each) do
+    Announcement.delete_all
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paul_revere
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '1.0'
   prerelease: 
 platform: ruby
 authors:
@@ -15,11 +15,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-18 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152105720 !ruby/object:Gem::Requirement
+  requirement: &22372400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -27,10 +27,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152105720
+  version_requirements: *22372400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152105180 !ruby/object:Gem::Requirement
+  requirement: &22371980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -38,10 +38,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152105180
+  version_requirements: *22371980
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &22371520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22371520
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152104700 !ruby/object:Gem::Requirement
+  requirement: &22371100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -49,10 +60,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152104700
+  version_requirements: *22371100
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152104240 !ruby/object:Gem::Requirement
+  requirement: &22370680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22370680
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: &22370260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -60,28 +82,47 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152104240
+  version_requirements: *22370260
 description: Paul Revere provides a model and helper methods to do one-off style announcements.
 email: support@thoughtbot.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- NEWS.md
+- README.md
+- Rakefile
 - app/helpers/announcements_helper.rb
 - app/models/announcement.rb
 - app/views/announcements/_announcement.html.erb
 - app/views/announcements/_announcement_for_all.html.erb
 - app/views/announcements/_email_announcement.erb
+- gemfiles/3.0.12.gemfile
+- gemfiles/3.1.4.gemfile
+- gemfiles/3.2.3.gemfile
+- gemfiles/rails-3.0.12.gemfile
+- gemfiles/rails-3.1.4.gemfile
+- gemfiles/rails-3.2.3.gemfile
+- init.rb
+- lib/generators/paul_revere/USAGE
 - lib/generators/paul_revere/paul_revere_generator.rb
 - lib/generators/paul_revere/templates/announcements.js
 - lib/generators/paul_revere/templates/migration.rb
-- lib/generators/paul_revere/USAGE
 - lib/paul_revere.rb
-- MIT-LICENSE
-- Rakefile
-- Gemfile
-- README.md
-- init.rb
+- lib/paul_revere/version.rb
+- paul_revere.gemspec
+- shoulda_macros/announcement.rb
+- spec/fake_app.rb
+- spec/helpers/announcements_helper_spec.rb
+- spec/models/announcement_spec.rb
+- spec/paul_revere_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/thoughtbot/paul_revere
 licenses: []
 post_install_message: 
@@ -94,15 +135,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3043656868834385100
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3043656868834385100
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Simple announcement plugin to include 'one off' style announcements in Rails