noodnik 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 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.md

@@ -0,0 +1,52 @@
+#noodnik
+
+This gem is a simple solution that allows you to remind your users to do things such as update their profiles, complete surveys or try a new feature. You can easily add links for postponing these reminders.
+
+## Installation
+
+## Examples
+
+### A Quick Nagging Example
+
+    <%= nag_user_to :update_profile do %>
+      You still need to <%= link_to 'update your profile', update_profile_path %>!
+    <% end %>
+
+This will render the following HTML:
+   
+    <div class="noodnik-nag"> 
+      You still need to <a href="/profiles/update" class="noodnik-complete" data-noodnik-complete-path="/noodnik/complete?topic=update_profile">update your profile</a>!
+    </div>
+
+- Clicking on "**update your profile**" will stop the message from appearing the next time the user views the page.
+
+### Postponing Nags
+
+Inside ```nag_user_to``` blocks, you can use the ```postpone_for``` helper to create links for temporarily postponing nags:
+
+    <%= nag_user_to :complete_survey do %>
+      Don't forget to <%= link_to 'complete our survey', complete_survey_path %> 
+      (<%= postpone_for 5.days %>)      
+    <% end %>
+
+Will output something that looks like:
+
+Don't forget to [complete our survey] [1] ([Remind me in 5 days] [1])
+
+- Clicking on "**complete our survey**" will take the user to ```complete_survey_path```, but will also mark this nag as *complete* (which means that this entire div block won't be displayed ever again in the future)
+- Click on "**Remind me in 5 days**" will hide the div block and prevent it from being displayed in the next 5 days. The user will stay in the same page and won't be redirected anywhere.
+
+### Manually Completing Nags
+
+Any ```link_to``` under a ```nag_user_to``` block will automatically mark the nag as *complete* when clicked. You might choose to mark nags as complete at a different time (for example, only after the user actually finishes a survey).
+To achieve this, you need to specify ```complete: false``` for links inside ```nag_user_to``` blocks.
+
+    <%= nag_user_to :complete_survey do %>
+      <%= link_to 'complete our survey', complete_survey_path, complete: false %>
+    <% end %>
+
+Then, you can mark this as complete by calling:
+
+    TODO
+
+  [1]: http://www.example.com/complete_survey

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Noodnik'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+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/app/assets/javascripts/noodnik/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/noodnik/nags.erb.coffee

@@ -0,0 +1,12 @@
+$ ->
+  $('a.noodnik-postpone').click (event) -> 
+    event.preventDefault()
+    url = $(this).attr 'href'
+    $box = $(this).parent()
+    $box = $(this).parentsUntil('div.noodnik-nag').parent() unless $box.hasClass 'noodnik-nag'
+    $.get url, ->
+      $box.hide()
+
+  $('a.noodnik-complete').click (event) ->
+    url = $(this).data 'noodnik-complete-path'
+    $.get url

data/app/assets/stylesheets/noodnik/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/app/assets/stylesheets/noodnik/nags.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/noodnik/application_controller.rb

@@ -0,0 +1,4 @@
+module Noodnik
+	class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/noodnik/nags_controller.rb

@@ -0,0 +1,47 @@
+module Noodnik
+	class NagsController < ApplicationController
+		def postpone
+			next_nag = params[:period].to_i.from_now
+			topic = params[:topic]
+
+			if user_id.present?
+				nag = find_or_create_nag(topic)
+				nag.next_nag = next_nag
+				nag.save
+			else
+				cookies[topic] = next_nag.to_s
+			end
+
+			render :nothing => true
+		end
+
+		def complete
+			topic = params[:topic]
+
+      if user_id.present?
+				nag = find_or_create_nag(topic)
+				nag.completed = true
+				nag.save
+			else
+				cookies.delete topic
+			end
+
+			render :nothing => true
+		end
+
+		private
+
+		def user_id
+			Noodnik.current_user_id.call
+		end
+
+		def find_or_create_nag(topic)
+			attr = { user_id: user_id, topic: topic }
+			if Nag.exists? attr
+				Nag.find :first, conditions: attr
+			else
+				Nag.new attr	
+			end
+		end
+	end
+end

data/app/helpers/noodnik/application_helper.rb

@@ -0,0 +1,4 @@
+module Noodnik
+  module ApplicationHelper
+  end
+end

data/app/helpers/noodnik/nags_helper.rb

@@ -0,0 +1,51 @@
+module Noodnik
+	module NagsHelper
+		def nag_user_to(topic, &block)
+			nag = find_nag(topic)
+			return if nag && (nag.next_nag > Time.now || nag.completed?)
+
+			begin
+	 		  class_eval('alias :original_link_to :link_to')
+		    class_eval('alias :link_to :my_custom_link_to')
+				Context.new.local_eval do
+					@noodnik_topic = topic
+					content_tag :div, class: 'noodnik-nag' do
+						capture(&block)
+					end
+				end
+		  ensure
+				@noodnik_topic = nil
+		    class_eval('alias :link_to :original_link_to')
+		  end
+		end
+
+		private
+
+		def find_nag(topic)
+			attr = { user_id: Noodnik.current_user_id.call, topic: topic }
+			Nag.find :first, conditions: attr
+		end
+
+		def my_custom_link_to(*args)
+			has_options = args.last.is_a? Hash
+			html_options = has_options ? args.last : {}
+			html_options["data-noodnik-complete-path"] = noodnik.routes.url_helpers.complete_path(topic: @noodnik_topic)
+			
+			if html_options.include? :class
+				html_options[:class] += " noodnik-complete"
+			else
+				html_options[:class] = "noodnik-complete"
+			end
+
+			args << html_options unless has_options
+			original_link_to *args
+		end
+
+		class Context
+			include Rails.application.routes.mounted_helpers
+		  def postpone_for(period)
+				original_link_to "Remind me in #{period.inspect}", noodnik.routes.url_helpers.postpone_path(period: period, topic: @noodnik_topic), class: 'noodnik-postpone'
+			end
+		end
+	end
+end

data/app/models/noodnik/nag.rb

@@ -0,0 +1,4 @@
+module Noodnik
+  class Nag < ActiveRecord::Base
+  end
+end

data/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html> 
+<html>
+<head>
+  <title>Noodnik</title>
+  <%= stylesheet_link_tag    "noodnik/application" %>
+  <%= javascript_include_tag "noodnik/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/layouts/noodnik/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Noodnik</title>
+  <%= stylesheet_link_tag    "noodnik/application" %>
+  <%= javascript_include_tag "noodnik/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Noodnik::Engine.routes.draw do
+  get "postpone" => "nags#postpone"
+
+  get "complete" => "nags#complete"
+
+end

data/db/migrate/20110813042447_create_noodnik_nags.rb

@@ -0,0 +1,11 @@
+class CreateNoodnikNags < ActiveRecord::Migration
+  def change
+    create_table :noodnik_nags do |t|
+      t.integer :id
+      t.datetime :next_nag
+      t.boolean :completed
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20110813065655_add_user_id_to_nags.rb

@@ -0,0 +1,5 @@
+class AddUserIdToNags < ActiveRecord::Migration
+  def change
+		add_column :noodnik_nags, :user_id, :integer
+  end
+end

data/db/migrate/20110813072011_add_topic_to_nags.rb

@@ -0,0 +1,5 @@
+class AddTopicToNags < ActiveRecord::Migration
+  def change
+    add_column :noodnik_nags, :topic, :string
+  end
+end

data/lib/noodnik.rb

@@ -0,0 +1,10 @@
+require "noodnik/engine"
+require "noodnik/railtie"
+
+module Noodnik
+	mattr_accessor :current_user_id
+
+	def self.setup
+		yield self
+	end	 
+end

data/lib/noodnik/engine.rb

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

data/lib/noodnik/railtie.rb

@@ -0,0 +1,7 @@
+module Noodnik
+	class Railtie < Rails::Railtie
+		initializer "noodnik.view_helpers" do
+			ActionView::Base.send :include, NagsHelper
+		end
+	end
+end

data/lib/tasks/noodnik_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :noodnik do
+#   # Task goes here
+# end

data/test/dummy/Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^engine.+[^swp]$}) { "spec/" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec/" }
+  watch('spec/spec_helper.rb')                        { "spec/" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+guard 'spork', :cucumber_env => { 'RAILS_ENV' => 'test' }, :rspec_env => { 'RAILS_ENV' => 'test' } do
+  watch('config/application.rb')
+  watch('config/environment.rb')
+  watch(%r{^config/environments/.+\.rb$})
+  watch(%r{^config/initializers/.+\.rb$})
+  watch('spec/spec_helper.rb')
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/home.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/assets/stylesheets/home.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end