feedbackable 0.0.4

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 feedbackable.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+Installation:
+
+1) Add gem to your Gemfile, as:
+   gem 'feedbackable'
+   then run
+   bundle install
+
+2) Your email settings must be preconfigured before using feedbackable gem
+
+3) Run generators:
+    rails g feedbackable:install
+    rake db:migrate
+    rails g feedbackable:views
+
+4) Add admin_email configuration parameter to your application.rb:
+    config.feedbackable.admin_email = 'your@admin_email.com'
+5) Add to your application.js
+    //= require jqmodal
+    //= require init
+   To your application.css
+    *= require jqmodal
+6) Add to your model:
+        has_feedback
+   And to your view:
+       <a href="#" class="jqModal">Add feedback</a>
+       <div class="jqmWindow" id="dialog">
+        <a href="#" class="jqmClose">X</a>
+        <%= render :partial => 'feedbacks/form', :locals => { :feedbackable => @your_model_instance }  %>
+       </div>

data/Rakefile

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

data/app/controllers/feedbacks_controller.rb

@@ -0,0 +1,24 @@
+class FeedbacksController < ApplicationController
+
+  def create
+    pf = params[:feedback]
+    @feedback = Feedback.new(
+        :subject => pf[:subject],
+        :feed_text => pf[:feed_text],
+        :contact_email => pf[:contact_email]
+    )
+    @feedback.feedbackable_type = pf[:feedbackable_type]
+    @feedback.feedbackable_id = pf[:feedbackable_id]
+
+    respond_to do |format|
+      if @feedback.save
+        format.js
+        # Need some load mask in the future
+        UserMailer.feedback_send(pf[:subject], pf[:feed_text], pf[:contact_email]).deliver
+      else
+        format.js { render :partial => 'errors' }
+      end
+    end
+  end
+
+end

data/app/mailers/user_mailer.rb

@@ -0,0 +1,8 @@
+class UserMailer < ActionMailer::Base
+  def feedback_send(subject, body, from)
+    @subject = subject
+    @body = body
+    @from = from
+    mail(:to => Feedbackable::config.admin_email, :from => from, :subject => "You've got new feedback!")
+  end
+end

data/app/models/feedback.rb

@@ -0,0 +1,10 @@
+class Feedback < ActiveRecord::Base
+        
+	belongs_to :feedbackable, :polymorphic => true
+	
+	attr_accessible :subject, :feed_text, :contact_email
+  validates_presence_of :subject, :feed_text, :feedbackable, :presence => true
+  validates :contact_email, :presence => true,
+            :length => {:minimum => 3, :maximum => 254},
+            :format => {:with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i}
+end

data/app/views/feedbacks/_errors.js.erb

@@ -0,0 +1 @@
+$("#new_feedback-notice").html('<div><%= escape_javascript(@feedback.errors.map {|k,v| "#{k.to_s.titleize} #{v}"}.join('<br/>')).html_safe %></div>');

data/app/views/feedbacks/_form.html.erb

@@ -0,0 +1,26 @@
+<%= form_for Feedback.new, :remote => true do |f| %>
+    <div id='new_feedback-notice'></div>
+
+    <div class="field">
+      <%= f.label :subject %>:<br />
+      <%= f.text_field :subject %>
+    </div>
+
+    <div class="field">
+      <%= f.label :contact_email %>:<br />
+      <%= f.text_field :contact_email %>
+    </div>
+
+    <div class="field">
+      <%= f.label :feed_text %>:<br />
+      <%= f.text_area:feed_text %>
+    </div>
+
+    <%= f.hidden_field :feedbackable_type, :value => feedbackable.class.name %><br />
+    <%= f.hidden_field :feedbackable_id , :value => feedbackable.id %><br />
+
+    <div class="actions">
+      <%= f.submit "Send feedback" %>
+    </div>
+
+<% end %>

data/app/views/feedbacks/create.js.erb

@@ -0,0 +1,3 @@
+$("#new_feedback")[0].reset();
+$('#dialog').jqmHide();
+alert("Thanks, your feedback has been sent");

data/app/views/user_mailer/feedback_send.html.erb

@@ -0,0 +1,8 @@
+<h3>Hi!</h3>
+<p><i>New feedback:</i></p>
+<b>From:</b>
+<%= @from %><br/>
+<b>Subject:</b>
+<%= @subject %><br/>
+<b>Feedback text:</b>
+<%= @body %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+
+  resources :feedbacks
+
+end

data/feedbackable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "feedbackable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "feedbackable"
+  s.version     = Feedbackable::VERSION
+  s.authors     = ["Marat Galiev"]
+  s.email       = ["kazanlug@gmail.com"]
+  s.homepage    = "http://www.smartapps.ru"
+  s.summary     = %q{Add feedback to your models}
+  s.description = %q{Adding feedback action to model}
+
+  s.rubyforge_project = "feedbackable"
+
+  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"
+end

data/lib/feedbackable.rb

@@ -0,0 +1,26 @@
+require "feedbackable/version"
+require "feedbackable/railtie"
+require "feedbackable/engine"
+require "feedbackable/active_record_extension"
+
+module Feedbackable
+
+	  def self.configure(&block)
+    	yield @config ||= Feedbackable::Configuration.new
+  	end
+
+  	def self.config
+    	@config
+    end
+
+    class Configuration #:nodoc:
+	    include ActiveSupport::Configurable
+      config_accessor :admin_email
+	    def param_name
+	      config.param_name.respond_to?(:call) ? config.param_name.call() : config.param_name
+	    end
+	  end
+	  
+  	ActiveRecord::Base.extend(Feedbackable::ActiveRecordExtension)
+
+end

data/lib/feedbackable/active_record_extension.rb

@@ -0,0 +1,7 @@
+module Feedbackable
+  module ActiveRecordExtension
+    def has_feedback(options = {})
+      # some options must be here, like feedbacks table name etc
+    end
+  end
+end

data/lib/feedbackable/engine.rb

@@ -0,0 +1,4 @@
+module Feedbackable
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/feedbackable/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module Feedbackable
+  class Railtie < ::Rails::Railtie
+    config.feedbackable = ActiveSupport::OrderedOptions.new
+
+    initializer "feedbackable.configure" do |app|
+      Feedbackable.configure do |config|
+        config.admin_email = app.config.feedbackable[:admin_email] || 'admin@example.com'
+      end
+
+    end
+  end
+end

data/lib/feedbackable/version.rb

@@ -0,0 +1,3 @@
+module Feedbackable
+  VERSION = "0.0.4"
+end

data/lib/generators/feedbackable/install_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Feedbackable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates migration for Feebacker"
+
+      def self.orm
+        Rails::Generators.options[:rails][:orm]
+      end
+
+      def self.orm_has_migration?
+        [:active_record].include? orm
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+          migration_number += 1
+          migration_number.to_s
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_migration
+        migration_template 'install.rb', 'db/migrate/install_feedbackable.rb'
+      end
+
+      def add_assets
+        ad = File.expand_path("../../../../vendor/assets", __FILE__)
+        directory ad, "vendor/assets"
+      end
+
+    end
+  end
+end

data/lib/generators/feedbackable/templates/install.rb

@@ -0,0 +1,18 @@
+class InstallFeedbackable < ActiveRecord::Migration
+  def self.up
+    create_table :feedbacks do |t|
+      t.string :subject, :limit => 20 
+      t.text :feed_text
+      t.references :feedbackable, :polymorphic => true
+      t.string :contact_email
+      t.timestamps
+    end
+
+    add_index :feedbacks, :feedbackable_type
+    add_index :feedbacks, :feedbackable_id
+  end
+
+  def self.down
+    drop_table :feedbacks
+  end
+end

data/lib/generators/feedbackable/views_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Feedbackable
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views', __FILE__)
+
+      def copy_or_fetch
+        filename_pattern = File.join self.class.source_root, "*"
+        Dir.glob(filename_pattern).map {|f| File.basename f}.each do |f|
+          directory f.to_s, "app/views/#{f}"
+        end
+      end      
+
+    end
+  end
+end

data/lib/init.rb

@@ -0,0 +1 @@
+require 'feedbackable'

data/spec/fake_app.rb

@@ -0,0 +1,38 @@
+require 'active_record'
+require 'action_controller/railtie'
+
+# database
+ActiveRecord::Base.configurations = {'test' => {:adapter => 'mysql2', :database => 'marat_development', :username => "root", :password => "777777"}}
+# ActiveRecord::Base.configurations = {'test' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('test')
+
+# config
+app = Class.new(Rails::Application)
+app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+app.config.session_store :cookie_store, :key => "_myapp_session"
+app.config.active_support.deprecation = :log
+app.initialize!
+
+# models
+class Order < ActiveRecord::Base
+  has_feedback
+end
+
+# routes
+app.routes.draw do
+  resources :feedbacks
+end
+
+#migrations
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define :version => 0 do
+    create_table "feedbacks", :force => true do |t|
+      t.string :subject, :limit => 20
+      t.text :feed_text
+      t.references :feedbackable, :polymorphic => true
+      t.string :contact_email
+      t.timestamps
+    end
+  end
+end

data/spec/fake_gem.rb

@@ -0,0 +1,6 @@
+# Simulate a gem providing a subclass of ActiveRecord::Base before the Railtie is loaded.
+
+require 'active_record'
+
+class GemDefinedModel < ActiveRecord::Base
+end

data/spec/feedbackable/feedback_test.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Feedback do
+
+  it "should create valid feedback object" do
+    order = Order.new
+    order.save
+    feedback = Feedback.new
+    feedback.subject = "Test subject"
+    feedback.feed_text = "Cool order!"
+    feedback.contact_email = 'from@test.com'
+    feedback.feedbackable = order
+    feedback.save.should be true
+  end
+
+  it "should not create feedback without data" do
+    feedback = Feedback.new
+    feedback.save.should be false
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+
+require 'rails'
+require 'active_record'
+require 'feedbackable'
+require File.dirname(__FILE__) << '/../app/models/feedback'
+
+require 'fake_app'

data/vendor/assets/javascripts/init.js

@@ -0,0 +1,6 @@
+$().ready(function() {
+    $('#dialog').jqm();
+    $('.jqmClose').on('click',function() {
+        $("#new_feedback-notice").html('');
+    });
+});

data/vendor/assets/javascripts/jqmodal.js

@@ -0,0 +1,69 @@
+/*
+ * jqModal - Minimalist Modaling with jQuery
+ *   (http://dev.iceburg.net/jquery/jqModal/)
+ *
+ * Copyright (c) 2007,2008 Brice Burgess <bhb@iceburg.net>
+ * Dual licensed under the MIT and GPL licenses:
+ *   http://www.opensource.org/licenses/mit-license.php
+ *   http://www.gnu.org/licenses/gpl.html
+ * 
+ * $Version: 03/01/2009 +r14
+ */
+(function($) {
+$.fn.jqm=function(o){
+var p={
+overlay: 50,
+overlayClass: 'jqmOverlay',
+closeClass: 'jqmClose',
+trigger: '.jqModal',
+ajax: F,
+ajaxText: '',
+target: F,
+modal: F,
+toTop: F,
+onShow: F,
+onHide: F,
+onLoad: F
+};
+return this.each(function(){if(this._jqm)return H[this._jqm].c=$.extend({},H[this._jqm].c,o);s++;this._jqm=s;
+H[s]={c:$.extend(p,$.jqm.params,o),a:F,w:$(this).addClass('jqmID'+s),s:s};
+if(p.trigger)$(this).jqmAddTrigger(p.trigger);
+});};
+
+$.fn.jqmAddClose=function(e){return hs(this,e,'jqmHide');};
+$.fn.jqmAddTrigger=function(e){return hs(this,e,'jqmShow');};
+$.fn.jqmShow=function(t){return this.each(function(){t=t||window.event;$.jqm.open(this._jqm,t);});};
+$.fn.jqmHide=function(t){return this.each(function(){t=t||window.event;$.jqm.close(this._jqm,t)});};
+
+$.jqm = {
+hash:{},
+open:function(s,t){var h=H[s],c=h.c,cc='.'+c.closeClass,z=(parseInt(h.w.css('z-index'))),z=(z>0)?z:3000,o=$('<div></div>').css({height:'100%',width:'100%',position:'fixed',left:0,top:0,'z-index':z-1,opacity:c.overlay/100});if(h.a)return F;h.t=t;h.a=true;h.w.css('z-index',z);
+ if(c.modal) {if(!A[0])L('bind');A.push(s);}
+ else if(c.overlay > 0)h.w.jqmAddClose(o);
+ else o=F;
+
+ h.o=(o)?o.addClass(c.overlayClass).prependTo('body'):F;
+ if(ie6){$('html,body').css({height:'100%',width:'100%'});if(o){o=o.css({position:'absolute'})[0];for(var y in {Top:1,Left:1})o.style.setExpression(y.toLowerCase(),"(_=(document.documentElement.scroll"+y+" || document.body.scroll"+y+"))+'px'");}}
+
+ if(c.ajax) {var r=c.target||h.w,u=c.ajax,r=(typeof r == 'string')?$(r,h.w):$(r),u=(u.substr(0,1) == '@')?$(t).attr(u.substring(1)):u;
+  r.html(c.ajaxText).load(u,function(){if(c.onLoad)c.onLoad.call(this,h);if(cc)h.w.jqmAddClose($(cc,h.w));e(h);});}
+ else if(cc)h.w.jqmAddClose($(cc,h.w));
+
+ if(c.toTop&&h.o)h.w.before('<span id="jqmP'+h.w[0]._jqm+'"></span>').insertAfter(h.o);	
+ (c.onShow)?c.onShow(h):h.w.show();e(h);return F;
+},
+close:function(s){var h=H[s];if(!h.a)return F;h.a=F;
+ if(A[0]){A.pop();if(!A[0])L('unbind');}
+ if(h.c.toTop&&h.o)$('#jqmP'+h.w[0]._jqm).after(h.w).remove();
+ if(h.c.onHide)h.c.onHide(h);else{h.w.hide();if(h.o)h.o.remove();} return F;
+},
+params:{}};
+var s=0,H=$.jqm.hash,A=[],ie6=$.browser.msie&&($.browser.version == "6.0"),F=false,
+i=$('<iframe src="javascript:false;document.write(\'\');" class="jqm"></iframe>').css({opacity:0}),
+e=function(h){if(ie6)if(h.o)h.o.html('<p style="width:100%;height:100%"/>').prepend(i);else if(!$('iframe.jqm',h.w)[0])h.w.prepend(i); f(h);},
+f=function(h){try{$(':input:visible',h.w)[0].focus();}catch(_){}},
+L=function(t){$()[t]("keypress",m)[t]("keydown",m)[t]("mousedown",m);},
+m=function(e){var h=H[A[A.length-1]],r=(!$(e.target).parents('.jqmID'+h.s)[0]);if(r)f(h);return !r;},
+hs=function(w,t,c){return w.each(function(){var s=this._jqm;$(t).each(function() {
+ if(!this[c]){this[c]=[];$(this).click(function(){for(var i in {jqmShow:1,jqmHide:1})for(var s in this[i])if(H[this[i][s]])H[this[i][s]].w[i](this);return F;});}this[c].push(s);});});};
+})(jQuery);

data/vendor/assets/stylesheets/jqmodal.css

@@ -0,0 +1,37 @@
+/* jqModal base Styling courtesy of;
+	Brice Burgess <bhb@iceburg.net> */
+
+/* The Window's CSS z-index value is respected (takes priority). If none is supplied,
+	the Window's z-index value will be set to 3000 by default (via jqModal.js). */
+	
+.jqmWindow {
+    display: none;
+    
+    position: fixed;
+    top: 17%;
+    left: 50%;
+    
+    margin-left: -300px;
+    width: 600px;
+    
+    background-color: #EEE;
+    color: #333;
+    border: 1px solid black;
+    padding: 12px;
+}
+
+.jqmOverlay { background-color: #000; }
+
+/* Background iframe styling for IE6. Prevents ActiveX bleed-through (<select> form elements, etc.) */
+* iframe.jqm {position:absolute;top:0;left:0;z-index:-1;
+	width: expression(this.parentNode.offsetWidth+'px');
+	height: expression(this.parentNode.offsetHeight+'px');
+}
+
+/* Fixed posistioning emulation for IE6
+     Star selector used to hide definition from browsers other than IE6
+     For valid CSS, use a conditional include instead */
+* html .jqmWindow {
+     position: absolute;
+     top: expression((document.documentElement.scrollTop || document.body.scrollTop) + Math.round(17 * (document.documentElement.offsetHeight || document.body.clientHeight) / 100) + 'px');
+}

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: feedbackable
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Marat Galiev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &80727290 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *80727290
+description: Adding feedback action to model
+email:
+- kazanlug@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/feedbacks_controller.rb
+- app/mailers/.gitkeep
+- app/mailers/user_mailer.rb
+- app/models/feedback.rb
+- app/views/feedbacks/_errors.js.erb
+- app/views/feedbacks/_form.html.erb
+- app/views/feedbacks/create.js.erb
+- app/views/user_mailer/feedback_send.html.erb
+- config/routes.rb
+- feedbackable.gemspec
+- lib/feedbackable.rb
+- lib/feedbackable/active_record_extension.rb
+- lib/feedbackable/engine.rb
+- lib/feedbackable/railtie.rb
+- lib/feedbackable/version.rb
+- lib/generators/feedbackable/install_generator.rb
+- lib/generators/feedbackable/templates/install.rb
+- lib/generators/feedbackable/views_generator.rb
+- lib/init.rb
+- spec/fake_app.rb
+- spec/fake_gem.rb
+- spec/feedbackable/feedback_test.rb
+- spec/spec_helper.rb
+- vendor/assets/javascripts/init.js
+- vendor/assets/javascripts/jqmodal.js
+- vendor/assets/stylesheets/jqmodal.css
+homepage: http://www.smartapps.ru
+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: feedbackable
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Add feedback to your models
+test_files: []