flyer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0beb30f7cd48acf09067ba968ee6c437c554794
+  data.tar.gz: a66326cd122f1deedfcc9284e76c968bc0b7d9e1
+SHA512:
+  metadata.gz: 0d4115bffda8d7e1291e0bf28612d1e7daaa6c278233d0f1eee132254626564487fb18f0d4efe50d642bff70eb77b71ae1179f1a641fa8ff1472be3528fe0e09
+  data.tar.gz: 06d7c279e20ac755338c396c1ae0abc007425ee54a1f5ecf7263bf5c8d901c97a89ed4da8bf926f3bfb52dfe98988f38f797fe00b6bf2ab30981229f120cdcb7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Linus Oleander
+
+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,46 @@
+# Flyer
+
+Display user notifications in Rails programmatically.
+
+## Install
+
+`gem install flyer`
+
+## Usage
+
+``` ruby
+# config/initializers/flyer.rb
+Flyer::Notification.init do |config|
+  # Unique id. Used to uniquely identify a notification.
+  config.id = "new-user"
+
+  # Message to be passed to view. Is evaluated in the view context.
+  config.message { "Your nickname is #{current_user.nickname}" + icon "flash" }
+
+  # Optional. Path to be pssed to view. Is evaluated in the controller context.
+  config.path { challenge_path }
+
+  # Optional. Only display notification if this blocks evaluates to true
+  # The block is evaluated in the controller context.
+  config.on { current_user.admin? and not first_visit? }
+
+  # Optional. Number of times to display the notification 
+  # for each user. Default is 1.
+  config.limit = 1
+
+  # Optional. When should the notification be visible?
+  config.valid = { from: "2015-04-01", to: "2016-04-01" }
+
+  # Optional. Arbitrary data to be passed to view. 
+  config.params = { timeout: 10 }
+end
+```
+
+``` erb
+-- app/views/_notifications.html.erb (any view)
+<% notifications.each do |notification| %>
+  <%= notification.path %>
+  <%= notification.message %>
+  <%= notification.params %>
+<% end %>
+```

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Flyer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/flyer.rb

@@ -0,0 +1,10 @@
+module Flyer
+end
+
+require "flyer/errors"
+require "flyer/controller_additions"
+require "flyer/notification"
+
+ActionController::Base.class_eval do
+  include Flyer::ControllerAdditions
+end

data/lib/flyer/controller_additions.rb

@@ -0,0 +1,30 @@
+module Flyer::ControllerAdditions
+  #
+  # @return Array<Flyer::ViewObject>
+  #
+  def notifications
+    @notifications ||= begin
+      found_notifications = []
+      Flyer::Notification.notifications.each do |n|
+        notification = Flyer::Notification.new(self)
+        n.call(notification)
+        notification.validate!
+        if notification.visible?
+          notification.used!
+          found_notifications << notification.view
+        end
+      end
+
+      ids = found_notifications.map(&:id)
+      unless ids.uniq.count == ids.count
+        raise Flyer::FoundNonUniqueIds.new
+      end
+
+      found_notifications
+    end
+  end
+
+  def self.included(base)
+    base.helper_method :notifications
+  end
+end

data/lib/flyer/errors.rb

@@ -0,0 +1,13 @@
+module Flyer
+  class PathNotGivenError < StandardError
+  end
+
+  class MessageMissingError < StandardError
+  end
+
+  class IdMissingError < StandardError
+  end
+
+  class FoundNonUniqueIds < StandardError
+  end
+end

data/lib/flyer/notification.rb

@@ -0,0 +1,121 @@
+require_relative "view_object"
+
+class Flyer::Notification
+  attr_accessor :valid, :params, :id, :limit
+
+  @@notifications = []
+
+  def self.init(&block)
+    @@notifications << block
+  end
+
+  def self.reset!
+    @@notifications = []
+  end
+
+  #
+  # @return Array<Flyer::Notification>
+  #
+  def self.notifications
+    @@notifications
+  end
+
+  #
+  # @controller ActionController::Base
+  #
+  def initialize(controller)
+    @on = []
+    @limit = 1
+    @controller = controller
+  end
+
+  #
+  # Raise an error if @id or @message is missing
+  #
+  def validate!
+    raise Flyer::IdMissingError.new unless @id
+    raise Flyer::MessageMissingError.new unless @message
+  end
+
+  #
+  # Mark current notification has used
+  #
+  def used!
+    cookies.permanent[token] = current_count + 1
+  end
+
+  #
+  # @return Boolean Has the notification expired?
+  #
+  def expired?
+    return false unless @valid
+
+    if @valid[:to]
+      if Date.parse(@valid.fetch(:to)) < Date.today
+        return true
+      end
+    end
+
+    if @valid[:from]
+      if Date.parse(@valid.fetch(:from)) > Date.today
+        return true
+      end
+    end
+  end
+
+  #
+  # @return Boolean Should the notification be visible?
+  #
+  def visible?
+    return false if hit_limit?
+    return false if expired?
+    return true if @on.empty?
+    @on.any?{ |blk| @controller.instance_eval(&blk) }
+  end
+
+  #
+  # @return Flyer::ViewObject Object to be passed to view
+  #
+  def view
+    Flyer::ViewObject.new(@controller, @path, @message, @params, @id)
+  end
+
+  #
+  # @block Proc The evaluation if @block should yield a path
+  #
+  def path(&block)
+    @path = block
+  end
+
+  #
+  # @block Proc The evaluation if @block should yield a string
+  #
+  def message(&block)
+    @message = block
+  end
+
+  #
+  # @block Proc The evaluation if @block should yield a boolean
+  #
+  def on(&block)
+    @on << block
+  end
+
+  private
+
+  def token
+    "flyer.#{id}".parameterize
+  end
+
+  def hit_limit?
+    limit and current_count >= limit
+  end
+
+  def current_count
+    cookies[token].to_i
+  end
+
+  def cookies
+    @controller.send(:cookies)
+  end
+end

data/lib/flyer/version.rb

@@ -0,0 +1,3 @@
+module Flyer
+  VERSION = "1.0.0"
+end

data/lib/flyer/view_object.rb

@@ -0,0 +1,34 @@
+class Flyer::ViewObject
+  attr_reader :params, :id
+
+  #
+  # @controller ActionController::Base
+  # @path Proc
+  # @message Proc
+  # @params Hash
+  # @id Object
+  #
+  def initialize(controller, path, message, params, id)
+    @controller = controller
+    @path       = path
+    @message    = message
+    @params     = params
+    @id         = id
+  end
+
+  #
+  # @return String
+  #
+  def message
+    @controller.view_context.
+      instance_eval(&@message).to_s.html_safe
+  end
+
+  #
+  # @return Path / String
+  #
+  def path
+    raise Flyer::PathNotGivenError.new unless @path
+    @controller.instance_eval(&@path)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: flyer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Linus Oleander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Display user notifications in Rails programmatically
+email:
+- linus@oleander.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/flyer.rb
+- lib/flyer/controller_additions.rb
+- lib/flyer/errors.rb
+- lib/flyer/notification.rb
+- lib/flyer/version.rb
+- lib/flyer/view_object.rb
+homepage: https://github.com/oleander/flyer-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Display user notifications in Rails programmatically
+test_files: []