feedbacker 0.1.5 → 0.1.6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    feedbacker (0.1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    i18n (0.6.1)
+    json (1.6.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  feedbacker!
+  rake (>= 0.9.2)
+  rdoc (>= 3.12)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Worldwide IDEA, Inc  http://www.wwidea.org
+Copyright 2009-2013 Worldwide IDEA, Inc  http://www.wwidea.org
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/feedbacker.png)](http://badge.fury.io/rb/feedbacker)
+[![Code Climate](https://codeclimate.com/github/wwidea/feedbacker.png)](https://codeclimate.com/github/wwidea/feedbacker)
+
 Feedbacker
 ==========
 
@@ -11,47 +14,52 @@ Feedbacker assumes that you're using...
 *  At least Rails 3.1.3
 *  The Rails Asset Pipeline
 *  Jquery
+*  That you have a User class with email and name methods (name can be configured to something else)
 *  and probably some other things that we've failed to mention.
 
 Installation
 ------------
 1. Add the following to your Gemfile.
 
-    gem :feedbacker
+        gem :feedbacker
 
 2. Run `bundle install`
 
 3. Add the following line to your application layout.
 
-    <%= javascript_include_tag :feedbacker %>
+        <%= javascript_include_tag :feedbacker %>
 
 4. Add the following line to your application layout before you call application.css. Override default settings in application.css.
 
-    <%= stylesheet_link_tag :feedbacker %>
+        <%= stylesheet_link_tag :feedbacker %>
 
 5. Add the following line at at appropriate position in your application layout.
 
-    <%= render(:partial => 'feedbacker/tab') unless current_user.is_guest? %>
+        <%= render(:partial => 'feedbacker/tab') unless current_user.is_guest? %>
 
 6. Add the folllowing line to config/application.rb.
 
-    config.paths['db/migrate'] = Feedbacker::Engine.paths['db/migrate'].existent
-
+        config.paths['db/migrate'] += Feedbacker::Engine.paths['db/migrate'].existent
+    
 7. Run `rake db:migrate` to add remarks table.
 
 8. Create feedbacker.rb in config/initializers and add the following line.
 
-    Feedbacker::EMAIL_TO = 'support@yourdomain.com'
-
-9. (Optional) You may also add either or both of the following lines and edit to taste. Defaults are shown.
+        Feedbacker::SETTINGS.email_to = 'support@yourdomain.com'
+    
+  OR
+  
+        Feedbacker::SETTINGS.update do |settings|
+          settings.email_to = 'support@yourdomain.com'
+          settings.user_name_method = :name             # default value
+          settings.email_prefix = '[FEEDBACKER]'        # default value
+        end
 
-    Feedbacker::RemarkMethods::USER_NAME_METHOD = :first_last
-    Feedbacker::EMAIL_PREFIX = '[FEEDBACKER]'
-
-Copyright (c) 2009 WWIDEA, Inc. released under the MIT license
 
 
 Contributions
 -------------
 
 If have improvements to contribute to this gem, please feel free to fork, commit with tests (if applicable), and then send a pull request. Thank You!
+
+Copyright (c) 2009-2013 WWIDEA, Inc. released under the MIT license

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task :default => :test

data/app/mailers/feedback_mailer.rb

@@ -1,6 +1,11 @@
 class FeedbackMailer < ActionMailer::Base
   def feedback(remark)
     @remark = remark
-    mail(:to => Feedbacker::EMAIL_TO, :from => Feedbacker::EMAIL_TO, :reply_to => remark.user.email, :subject => "#{(defined? Feedbacker::EMAIL_PREFIX) ? Feedbacker::EMAIL_PREFIX : '[FEEDBACKER]'} Feedback Notification")
+    mail(
+      to:         Feedbacker::SETTINGS.email_to,
+      from:       Feedbacker::SETTINGS.email_to,
+      reply_to:   remark.user.email,
+      subject:    "#{Feedbacker::SETTINGS.email_prefix} Feedback Notification"
+    )
   end
 end

data/feedbacker.gemspec

@@ -1,15 +1,21 @@
 require File.expand_path('../lib/feedbacker/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = "feedbacker"
-  s.version = Feedbacker::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.authors = ["Jonathan S. Garvin", 'Aaron Baldwin', 'WWIDEA, Inc']
-  s.email = ["developers@wwidea.org"]
-  s.homepage = "https://github.com/wwidea/feedbacker"
-  s.summary = %q{Sitewide Feedback form pinned to sidewall as verticle tab.}
-  s.description = %q{Feedbacker provides a pull out tab on the side of every page on a site for users to send feedback to the site.}
+  s.name          = "feedbacker"
+  s.version       = Feedbacker::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Jonathan S. Garvin", 'Aaron Baldwin', 'WWIDEA, Inc']
+  s.email         = ["developers@wwidea.org"]
+  s.homepage      = "https://github.com/wwidea/feedbacker"
+  s.summary       = %q{Sitewide Feedback form pinned to sidewall as verticle tab.}
+  s.description   = %q{Feedbacker provides a pull out tab on the side of every page on a site for users to send feedback to the site.}
+  s.license     = 'MIT'
+
+  s.add_development_dependency('rake','>= 0.9.2')
+  s.add_development_dependency('rdoc','>= 3.12')
+  s.add_development_dependency('activesupport')
+
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- test/*`.split("\n")
   s.require_paths = ["lib"]
-end
+end

data/lib/feedbacker/remark_methods.rb

@@ -1,28 +1,13 @@
 module Feedbacker #:nodoc:
   module RemarkMethods
     def self.included(base)
-      base.extend ClassMethods
       base.class_eval do
-        include InstanceMethods
-        
         belongs_to :user
       end
     end
     
-    module ClassMethods
-
-    end
-    
-    module InstanceMethods
-      
-      def user_name
-        if defined? Feedbacker::RemarkMethods::USER_NAME_METHOD
-          return user.send(Feedbacker::RemarkMethods::USER_NAME_METHOD)
-        else
-          user.name
-        end
-      end
-      
+    def user_name
+      return user.send(Feedbacker::SETTINGS.user_name_method)
     end
   end
-end
+end

data/lib/feedbacker/settings.rb

@@ -0,0 +1,17 @@
+module Feedbacker
+  class Settings
+    attr_accessor :email_to, :email_prefix, :user_name_method
+    
+    def initialize
+      self.email_to           = ''
+      self.email_prefix       = '[FEEDBACKER]'
+      self.user_name_method   = :name
+    end
+    
+    def update
+      yield self
+    end
+  end
+  
+  SETTINGS = Settings.new
+end

data/lib/feedbacker/version.rb

@@ -1,3 +1,3 @@
 module Feedbacker
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/test/jenkins.bash

@@ -0,0 +1,3 @@
+#!/bin/bash
+bundle install
+bundle exec rake test

data/test/remark_methods_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require File.expand_path('../../lib/feedbacker/remark_methods', __FILE__)
+
+class RemarkMethodsTest < ActiveSupport::TestCase
+  
+  test "should send user_name_method to user" do
+    instance = remark_methods_class.new(return_send_class.new)
+    
+    assert_equal 'name method', instance.user_name
+  end
+
+  private
+  
+  def remark_methods_class
+    @remark_methods_class ||= Class.new do
+      attr_accessor :user
+      
+      def self.belongs_to(*args)
+      end
+      
+      def initialize(user)
+        self.user = user
+      end
+      
+      include Feedbacker::RemarkMethods
+    end
+  end
+  
+  def return_send_class
+    Class.new do
+      def name
+        "name method"
+      end
+    end
+  end
+end

data/test/settings_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require File.expand_path('../../lib/feedbacker/settings', __FILE__)
+
+class SettingsTest < ActiveSupport::TestCase
+
+  test "should return default values" do
+    settings = Feedbacker::Settings.new
+    
+    assert_equal '', settings.email_to
+    assert_equal '[FEEDBACKER]', settings.email_prefix
+    assert_equal :name, settings.user_name_method
+  end
+  
+  test "should assign new value to setting" do
+    settings = Feedbacker::Settings.new
+    settings.email_to = 'testing@mail.com'
+    
+    assert_equal 'testing@mail.com', settings.email_to
+  end
+  
+  test 'should update setting' do
+    settings = Feedbacker::Settings.new
+    settings.update do |settings|
+      settings.email_to = 'me@mail.com'
+    end
+    
+    assert_equal 'me@mail.com', settings.email_to
+  end
+  
+  test 'should return default value from SETTINGS constant' do
+    assert_equal '[FEEDBACKER]', Feedbacker::SETTINGS.email_prefix
+  end
+end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
 require 'rubygems'
 require 'active_support'
-require 'active_support/test_case'
+require 'active_support/test_case'
+require 'test/unit'
+

metadata

@@ -1,32 +1,77 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: feedbacker
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.6
   prerelease: 
-  version: 0.1.5
 platform: ruby
-authors: 
+authors:
 - Jonathan S. Garvin
 - Aaron Baldwin
 - WWIDEA, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-16 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: Feedbacker provides a pull out tab on the side of every page on a site for users to send feedback to the site.
-email: 
+date: 2013-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Feedbacker provides a pull out tab on the side of every page on a site
+  for users to send feedback to the site.
+email:
 - developers@wwidea.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -40,12 +85,9 @@ files:
 - app/views/remarks/_form.html.erb
 - app/views/remarks/_greeting.html.erb
 - app/views/remarks/create.js.erb
-- config/initializers/feedbacker.rb
 - config/routes.rb
 - db/migrate/20101230191157_create_remarks_table.rb
 - feedbacker.gemspec
-- init.rb
-- install.rb
 - lib/assets/images/feedback_tab.png
 - lib/assets/images/feedback_tab_bottom.png
 - lib/assets/javascripts/feedbacker.js
@@ -53,39 +95,41 @@ files:
 - lib/feedbacker.rb
 - lib/feedbacker/remark_methods.rb
 - lib/feedbacker/remarks_controller_methods.rb
+- lib/feedbacker/settings.rb
 - lib/feedbacker/version.rb
 - lib/tasks/feedbacker_tasks.rake
-- test/feedbacker_test.rb
+- test/jenkins.bash
+- test/remark_methods_test.rb
+- test/settings_test.rb
 - test/test_helper.rb
-- uninstall.rb
-has_rdoc: true
 homepage: https://github.com/wwidea/feedbacker
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Sitewide Feedback form pinned to sidewall as verticle tab.
-test_files: 
-- test/feedbacker_test.rb
+test_files:
+- test/jenkins.bash
+- test/remark_methods_test.rb
+- test/settings_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/config/initializers/feedbacker.rb

@@ -1,3 +0,0 @@
-Feedbacker::RemarkMethods::USER_NAME_METHOD = :first_last
-Feedbacker::EMAIL_PREFIX = '[FEEDBACKER]'
-Feedbacker::EMAIL_TO = ''

data/init.rb

@@ -1 +0,0 @@
-# Include hook code here

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/test/feedbacker_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class FeedbackerTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here