notifiable 0.0.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://gemcutter.org"
+
+gem "rails", "3.0.0.beta4"
+gem "mysql"
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Notifiable
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require File.join(File.dirname(__FILE__), 'lib', 'notifiable', 'version')
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Notifiable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = "notifiable"
+  s.summary = "Insert Notifiable summary."
+  s.description = "Insert Notifiable description."
+  s.files =  FileList["[A-Z]*", "{app,config,lib}/**/*"]
+  s.version = Notifiable::VERSION.dup
+  s.email = "sbertel@mobithought.com"
+  s.homepage = "http://github.com/shenoudab/notifiable"
+  s.author = 'Shenouda Bertel'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+desc "Install the gem #{spec.name}-#{spec.version}.gem"
+task :install do
+  system("gem install pkg/#{spec.name}-#{spec.version}.gem --no-ri --no-rdoc")
+end

data/app/controllers/notifiable/notifications_controller.rb

@@ -0,0 +1,29 @@
+module Notifiable
+  class NotificationsController < ApplicationController
+    
+    unloadable
+    
+    def new
+      @notification = Notification.new
+    end
+
+    def create
+      @notification = Notification.new(params[:notifiable_notification])
+      if @notification.valid?
+        @subscriber.save
+      end
+    end
+
+    def dismiss
+      notification = Notification.find(params[:id])
+      notification.update_attribute('dismissed', true)
+      respond_to do |format|
+        format.js {
+          render :update do |page|
+            page.remove "system_message_#{notification.id}"
+          end
+        }
+      end
+    end
+  end
+end

data/app/models/notifiable/notification.rb

@@ -0,0 +1,23 @@
+module Notifiable
+  class Notification < ActiveRecord::Base
+
+    validates :level, :presence => true
+    validates :header, :presence => true
+    validates :message, :presence => true
+    validates :expires, :presence => true
+  
+    named_scope :global,   :conditions => {:notifiable_id => nil}
+    named_scope :viewable, lambda { {:conditions => ["dismissed = ? AND expires > ?", false, Time.now]} }
+
+    belongs_to :notifiable, :polymorphic => true
+
+    def viewable?
+      !dismissed? && !expired?
+    end
+
+    def expired?
+      Time.now > expires
+    end
+    
+  end
+end

data/app/views/notifiable/notifications/new.html.erb

@@ -0,0 +1,16 @@
+<div id="notifiable_notification">
+  <%= form_for @notification, :url => notifications_path, :remote => true do |f| %>
+    <%= f.label :level %>
+    <%= f.text_field :level %>
+    <br/>
+    <%= f.label :header %>
+    <%= f.text_field :header %>
+    <br />
+    <%= f.label :message %>
+    <%= f.text_field :message %>
+    <br/>
+    <%= f.label :expires %>
+    <%= f.text_field :expires %>
+    <%= f.submit "Send Notification" %>
+  <% end %>
+</div>

data/lib/generators/notifiable_install/notifiable_install_generator.rb

@@ -0,0 +1,42 @@
+class NotifiableInstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc "Creates a Notifibale Messages initializer and migration to your application."
+
+  def self.source_root
+    @_sooner_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.orm_has_migration?
+    Rails::Generators.options[:rails][:orm] == :active_record
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  class_option :orm
+  class_option :migration, :type => :boolean, :default => orm_has_migration?
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/notifiable_create_notifications.rb'
+  end
+
+  #def copy_initializer
+  #  template "sooner.rb", "config/initializers/sooner.rb"
+  #end
+
+  def show_readme
+    readme "README"
+  end
+
+  protected
+  
+  def readme(path)
+    say File.read(File.expand_path(path, self.class.source_root))
+  end
+end

data/lib/generators/notifiable_install/templates/README

@@ -0,0 +1,23 @@
+
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have defined root_url to *something* in your config/routes.rb.
+
+       root :to => "sooner/subscribers#new"
+
+  2. Ensure you have defined javascript in app/views/layouts/application.html.erb
+
+        <%= javascript_include_tag :defaults %>
+            <!-- or -->
+        <%= javascript_include_tag "http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js", "jquery.rails.js" %>
+
+        <%= csrf_meta_tag %>
+
+  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+     For example:
+
+       <p class="notice"><%= notice %></p>
+
+===============================================================================

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

@@ -0,0 +1,24 @@
+class SoonerCreateSubscribers < ActiveRecord::Migration
+  def self.up
+    create_table :notifications do |t|
+      t.string        :header
+      t.string        :level
+      t.text          :message
+      t.boolean       :dismissed, :default => false
+      t.boolean       :dismissable, :default => false
+      t.datetime      :expires
+      t.references    :notifiable, :polymorphic => true
+      #Any additional fields here  
+      t.timestamps   
+    end
+
+    add_index :notifications, [:dismissed, :expires], :name => 'viewable_index'
+    add_index :notifications, [:notifiable_type, :notifiable_id], :name => 'notifiable'
+
+  end
+  
+  def self.down
+    drop_table :notifications 
+  end
+  
+end

data/lib/generators/notifiable_install/templates/sooner.rb

@@ -0,0 +1,13 @@
+Sooner.setup do |config|
+  # Configure the e-mail address which will be shown in SoonerMailer.
+  config.mailer_sender = "info@sooner.com"
+
+  config.db_store = true
+  config.csv_store = true
+  config.csv_file = "subscribers.csv"
+
+  # Messages.
+  config.subscribed = 'Subscribed Successfully.'
+  config.already_subscribed = 'Already Subscribed.'
+  config.error_subscribed = 'Please Try to subscribe again.'
+end

data/lib/notifiable/helpers/notifiable_helper.rb

@@ -0,0 +1,41 @@
+module Notifiable
+  module Helpers
+    module NotificationHelper
+      def notify_msg(message, options={})
+        header = header_div(message.header, message.level)
+        body = message.message
+        base_options = {:class => "notify #{message.level}", :id => "notification_#{message.id}"}.merge(options)
+        
+        if message.dismissable?
+          body += content_tag(:p, link_to_remote("Dismiss", :url => {:controller => 'notifiable/notifications', :action => 'dismiss',
+                :id => message.id}))
+        end
+        content_tag(:div, header + body, base_options)
+      end
+  
+      def notify_for(obj, options={})
+        messages = obj.notificaions.select(&:viewable?).
+          map {|msg| notify_msg(msg, options)}
+        messages.join("\n")
+      end
+  
+      def notifications(options={})
+        Notification.global.viewable.map {|msg| notify_msg(msg, options)}.join("\n")
+      end
+  
+      def static_notification(level, header, options={}, &block)
+        header = header_div(header, level)
+        body   = capture(&block)
+        
+        concat(content_tag(:div, header + body, {:class => "notify #{level}"}.merge(options)), block.binding)
+      end
+      
+      private
+      
+      def header_div(text, level)
+        content_tag(:div, content_tag(:span, text, :class => level), :class => "notify-header #{level}")
+      end
+      
+    end
+  end
+end

data/lib/notifiable/rails.rb

@@ -0,0 +1,5 @@
+module Notifiable
+  class Engine < ::Rails::Engine
+    
+  end
+end

data/lib/notifiable/version.rb

@@ -0,0 +1,3 @@
+module Notifiable
+  VERSION = "0.0.1".freeze
+end

data/lib/notifiable.rb

@@ -0,0 +1,5 @@
+module Notifiable
+  ActionView::Base.send(:include, Notifiable::Helpers::NotificationHelper)
+end
+
+require 'notifiable/rails'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: notifiable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Shenouda Bertel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-13 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Insert Notifiable description.
+email: sbertel@mobithought.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Gemfile
+- README.rdoc
+- Rakefile
+- app/controllers/notifiable/notifications_controller.rb
+- app/models/notifiable/notification.rb
+- app/views/notifiable/notifications/new.html.erb
+- lib/notifiable/helpers/notifiable_helper.rb
+- lib/notifiable/version.rb
+- lib/notifiable/rails.rb
+- lib/notifiable.rb
+- lib/generators/notifiable_install/templates/sooner.rb
+- lib/generators/notifiable_install/templates/migration.rb
+- lib/generators/notifiable_install/templates/README
+- lib/generators/notifiable_install/notifiable_install_generator.rb
+has_rdoc: true
+homepage: http://github.com/shenoudab/notifiable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Insert Notifiable summary.
+test_files: []
+