announcements 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in announcements.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Svilen Gospodinov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+
+## Quick start
+
+1. Requirements: rails >= 3.1.0 and jquery
+2. Add `gem 'announcements'` to your Gemfile and run `bundle`
+3. Run `rails g announcements:install`
+4. Use `<%= announce Announcement.newest %>` in your views to display the latest announcement
+5. Create your first announcement in `rails c` by simply creating a new Announcement record, like `Announcement.create(:body => 'This is my first announcement!')`
+6. Next, add some CSS (find an example below; the default output is quite plain and ugly) and customise it.
+
+## Styling
+
+## Customisation
+
+## How it works
+
+## How to uninstall
+
+There is no uninstaller at this point, but you can simply remove the following files manually:
+
+1. app/models/announcement.rb
+2. vendor/assets/javascripts/announcements.js
+
+You also have to remove the `//= require announcements` line in your app/assets/javascripts/application.js file, and rollback the `create_announcements` migration.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/announcements.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "announcements/version"
+
+Gem::Specification.new do |s|
+  s.name        = "announcements"
+  s.version     = Announcements::VERSION
+  s.authors     = ["Svilen Gospodinov"]
+  s.email       = ["svilen@gospodinov.co.uk"]
+  s.homepage    = ""
+  s.summary     = "Announcements for Rails >= 3.1.0"
+  s.description = "The Announcements gem makes it easier to display short announcement messages in your views"
+
+  s.rubyforge_project = "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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "jquery-rails"
+  s.add_runtime_dependency "rails", ">= 3.1.0"
+end

data/lib/announcements.rb

@@ -0,0 +1,9 @@
+require "announcements/version"
+require "announcements/announcements_helper.rb"
+
+ActionView::Base.send :include, AnnouncementsHelper
+
+module Announcements
+  # Your code goes here...
+end
+

data/lib/announcements/announcements_helper.rb

@@ -0,0 +1,22 @@
+module AnnouncementsHelper
+
+	# Outputs given announcement in HTML.
+	# 
+	# Basic usage: <%= announce Announcement.newest %>
+	#
+	# Options:
+	# div_class -- name for a custom div class, which wraps the announcement text and hide message, default is "info"
+	# hide_message -- clickable text which hides the announcement, default is "hide message"
+	def announce announcement, options = {}
+		text = options[:hide_message] || "hide message"
+		div_class = options[:div_class] || "info"
+		if announcement != nil && cookies["announcement_" + announcement.id.to_s] != "hidden"
+			content_tag :div, :class => div_class do
+				result = announcement.body.html_safe
+				result << content_tag(:span, text, :class => "hide_announcement", :data => { :announcementid => announcement.id })
+				result
+			end
+		end
+	end
+
+end

data/lib/announcements/version.rb

@@ -0,0 +1,3 @@
+module Announcements
+  VERSION = "0.0.1"
+end

data/lib/generators/announcements/install/install_generator.rb

@@ -0,0 +1,25 @@
+module Announcements
+	class InstallGenerator <  Rails::Generators::Base
+		
+		desc "Installs the Announcement gem"
+		source_root File.expand_path('../templates', __FILE__)
+		
+		def create_model
+			say "--- Creating model in app/models..."
+			template "announcement.rb", "app/models/announcement.rb"
+			say "--- Creating the migration ..."
+			generate("model", "announcement body:text type:string --skip")
+			say "--- Running the migration..."
+			rake("db:migrate")	
+		end
+		
+		def create_js_files
+			say "--- Copying js to vendor/assets/javascripts..."
+			template "announcements.js", "vendor/assets/javascripts/announcements.js"
+			say "--- Adding require in app/assets/javascripts/application.js..."
+			insert_into_file "app/assets/javascripts/application.js", "//= require announcements\n", :after => "jquery_ujs\n"
+			say "--- IMPORTANT: New asset was added in the vendor folder; you have to precompile assets for production!"
+		end
+				
+	end
+end

data/lib/generators/announcements/install/templates/announcement.rb

@@ -0,0 +1,17 @@
+class Announcement < ActiveRecord::Base
+
+  validates_presence_of :body
+  
+  def self.newest
+	Announcement.last
+  end
+  
+  def self.newest_private
+    Announcement.where("type is null").order("id desc").first
+  end
+
+  def self.newest_public
+    Announcement.where("type = 'public'").order("id desc").first
+  end
+  
+end

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

@@ -0,0 +1,21 @@
+$(function() {
+
+    $('.hide_announcement').click(function() {
+        var a_id = $(this).data("announcementid");
+        createCookie("announcement_" + a_id, "hidden", 45);
+        $(this).parent().slideUp();
+    });
+
+    function createCookie(name, value, days) {
+        var expires = "";
+        if (days) {
+            var date = new Date();
+            date.setTime(date.getTime() + (days*24*60*60*1000));
+            expires = "; expires=" + date.toGMTString();
+        } else {
+            expires = "";
+        }
+
+        document.cookie = name + "=" + value + expires + "; path=/";
+    }
+});

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: announcements
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Svilen Gospodinov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: &26346180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *26346180
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &26345736 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *26345736
+description: The Announcements gem makes it easier to display short announcement messages
+  in your views
+email:
+- svilen@gospodinov.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- announcements.gemspec
+- lib/announcements.rb
+- lib/announcements/announcements_helper.rb
+- lib/announcements/version.rb
+- lib/generators/announcements/install/install_generator.rb
+- lib/generators/announcements/install/templates/announcement.rb
+- lib/generators/announcements/install/templates/announcements.js
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: announcements
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Announcements for Rails >= 3.1.0
+test_files: []