uservoice 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+rdoc/
+coverage/
+pkg/uservoice-0.1.0.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 il tempo - Alexander Greim
+
+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,61 @@
+= Uservoice feedback for Ruby on Rails
+
+This adds {Uservoice}[http://www.uservoice.com] feedback to your
+Rails application. You can set Uservoice properties in a central configuration
+file and override settings like forum id (for payed accounts) in your layout or
+view.
+
+== Installation
+
+=== As a gem
+  gem install uservoice --source http://gemcutter.org
+
+=== As a Rails dependency
+  config.gem 'uservoice', :source => 'http://gemcutter.org'
+
+=== As a Rails plugin
+  ./script/plugin install http://github.com/iltempo/uservoice.git
+
+
+== Configuration
+
+Generate files for your app:
+  ./script/generate uservoice <key> <forum>
+Where <key> is the Uservoice account name and <forum> the id of your main forum.
+Find both settings in widgets section of the admin interface of Uservoice.
+
+Default properties are stored in a file named uservoice.yml in the config directory
+of your Rails application. Make it fit to your needs.
+
+Enable Uservoice in controllers of your choice. Add to ApplicationController
+directly to enable uservoice for every controller.
+
+  class MyController < ApplicationController
+    enable_uservoice
+    ...
+  end
+
+Link Uservoice javascript file and add configuration to HTML HEAD section of
+your template file:
+  <%= javascript_include_tag 'uservoice' %>
+  <%= uservoice_config_javascript %>
+
+You can even override default uservoice settings in your view:
+  <%= uservoice_config_javascript(:alignment => 'right', :forum => 12983) %>
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 {il tempo}[http://github.com/iltempo] -
+{Alexander Greim}[http://github.com/iltempo], released under the MIT license

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "uservoice"
+    gem.summary = %Q{Uservoice for your Rails application}
+    gem.description = %Q{This adds Uservoice user feedback to your Rails application.
+      You can set Uservoice properties in a central configuration file and override
+      settings like forum id (for payed accounts) in your layout or view.}
+    gem.email = 'alexxx@iltempo.de'
+    gem.homepage = 'http://github.com/iltempo/uservoice'
+    gem.authors = ['Alexander Greim']
+    gem.version = '0.1.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "uservoice #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/uservoice/USAGE

@@ -0,0 +1,14 @@
+Name
+    uservoice - creates uservoice files
+
+Description:
+    This generator creates all files needed for uservoice integration.
+
+    ./script/generate uservoice <uservoice_key> <main_forum_id>
+
+    Please add to head section of your layout file:
+      <%= javascript_include_tag 'uservoice' %>
+      <%= uservoice_config_javascript %>
+
+Example:
+    ./script/generate uservoice mypage 12345

data/generators/uservoice/templates/uservoice.js

@@ -0,0 +1,8 @@
+function _loadUserVoice() {
+  var s = document.createElement('script');
+  s.setAttribute('type', 'text/javascript');
+  s.setAttribute('src', ("https:" == document.location.protocol ? "https://" : "http://") + "cdn.uservoice.com/javascripts/widgets/tab.js");
+  document.getElementsByTagName('head')[0].appendChild(s);
+}
+_loadSuper = window.onload;
+window.onload = (typeof window.onload != 'function') ? _loadUserVoice : function() { _loadSuper(); _loadUserVoice(); };

data/generators/uservoice/templates/uservoice_template.yml

@@ -0,0 +1,12 @@
+uservoice_options:
+  # required
+  key: <%= args.first %>
+  host: <%= args.first %>.uservoice.com
+  forum: <%= args.second %>
+  showTab: true
+  # optional
+  alignment: left
+  background_color: "#f00"
+  text_color: white
+  hover_color: "#06C"
+  lang: en

data/generators/uservoice/uservoice_generator.rb

@@ -0,0 +1,16 @@
+class UservoiceGenerator < Rails::Generator::Base
+  def manifest
+    unless args.length == 2
+      puts usage_message
+      exit 1
+    end
+
+    record do |m|
+      m.directory('config')
+      m.template 'uservoice_template.yml', 'config/uservoice.yml'
+
+      m.directory('public/javascripts')
+      m.file 'uservoice.js', 'public/javascripts/uservoice.js'
+    end
+  end
+end

data/init.rb

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

data/lib/uservoice/class_methods.rb

@@ -0,0 +1,26 @@
+# This module holds all class methods to be
+# included into ActionController::Base class
+# for enabling uservoice in a Rails app.
+#
+# Author::    Alexander Greim  (mailto:alexxx@iltempo.de)
+# Copyright:: Copyright (c) 2010 il tempo
+# License::   Distributes under the same terms as Ruby
+
+module Uservoice
+  module ClassMethods
+
+    # Loads uservoice configuration from yaml file.
+    #
+    def enable_uservoice
+      self.uservoice_configuration ||= begin
+        configuration = YAML::load(IO.read(self.uservoice_configuration_file))
+        HashWithIndifferentAccess.new(configuration['uservoice_options'])
+      end
+    end
+
+    def uservoice_configuration_file #:nodoc:
+      "#{RAILS_ROOT}/config/uservoice.yml"
+    end
+
+  end
+end

data/lib/uservoice/instance_methods.rb

@@ -0,0 +1,20 @@
+# This module holds all instance methods to be
+# included into ActionController::Base class
+# for enabling uservoice in a Rails app.
+#
+# Author::    Alexander Greim  (mailto:alexxx@iltempo.de)
+# Copyright:: Copyright (c) 2010 il tempo
+# License::   Distributes under the same terms as Ruby
+
+module Uservoice
+  module InstanceMethods
+
+    # Enables uservoice configuration as controller
+    # instance variable
+    #
+    def uservoice_init
+      @uservoice_configuration ||= self.class.uservoice_configuration
+    end
+
+  end
+end

data/lib/uservoice/uservoice_helper.rb

@@ -0,0 +1,20 @@
+# This module holds all frontend helper methods
+# for uservoice in a Rails app.
+#
+# Author::    Alexander Greim  (mailto:alexxx@iltempo.de)
+# Copyright:: Copyright (c) 2010 il tempo
+# License::   Distributes under the same terms as Ruby
+
+module UservoiceHelper
+
+  # Renders javascript configuration to be integrated
+  # into layout file.
+  # Takes a forum id if different from default one.
+  #
+  def uservoice_config_javascript(options={})
+    config = @uservoice_configuration.dup
+    config.merge!(options)
+    "<script type=\"text/javascript\"> var uservoiceOptions = #{config.to_json}; </script>"
+  end
+
+end

data/lib/uservoice.rb

@@ -0,0 +1,21 @@
+path = File.join(File.dirname(__FILE__), 'uservoice')
+$LOAD_PATH << path
+ActiveSupport::Dependencies.load_paths << path
+ActiveSupport::Dependencies.load_once_paths.delete(path)
+
+module Uservoice
+end
+
+require 'class_methods'
+require 'instance_methods'
+
+module ActionController #:nodoc:
+  class Base #:nodoc:
+    cattr_accessor :uservoice_configuration
+    before_filter :uservoice_init
+    helper :uservoice
+
+    include Uservoice::InstanceMethods
+    extend Uservoice::ClassMethods
+  end
+end

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'test/unit'
+
+require 'active_support'
+require 'active_support/test_case'
+
+require 'action_controller'
+require 'action_controller/test_process'
+
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+generator_source = Rails::Generator::PathSource.new(:uservoice, File.dirname(__FILE__) + '/../generators')
+Rails::Generator::Base.append_sources(generator_source)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'uservoice'
+
+class Test::Unit::TestCase
+end
+
+begin
+  require 'redgreen' unless ENV['TM_FILENAME']
+rescue LoadError
+end

data/test/test_uservoice.rb

@@ -0,0 +1,89 @@
+require 'helper'
+
+class MyUservoiceController < ActionController::Base
+  def self.uservoice_configuration_file
+    File.dirname(__FILE__) + '/uservoice_test.yml'
+  end
+  enable_uservoice
+
+  def assignment
+    render :text => nil
+  end
+
+  def config_js_default
+    render :inline => "<%= uservoice_config_javascript %>"
+  end
+
+  def config_js_custom_forum
+    render :inline => "<%= uservoice_config_javascript(:forum => 815) %>"
+  end
+
+  def config_js_custom_alignment
+    render :inline => "<%= uservoice_config_javascript(:alignment => 'right') %>"
+  end
+end
+
+class UservoiceTest < ActiveSupport::TestCase
+
+  def setup
+    @my_controller = MyUservoiceController.new
+  end
+
+  ['uservoice_configuration_file'].each do |method|
+    test "should add class method '#{method}' to controller classes" do
+      assert MyUservoiceController.methods.include?(method)
+    end
+  end
+
+  ['uservoice_init'].each do |method|
+    test "should add instance method '#{method}' to controller classes" do
+      assert @my_controller.methods.include?(method)
+    end
+  end
+end
+
+class MyUservoiceControllerTest < ActionController::TestCase
+  tests MyUservoiceController
+
+  def setup
+    @my_controller = MyUservoiceController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+
+    ActionController::Routing::Routes.draw do |map|
+      map.connect 'assignment', :controller => 'my_uservoice', :action => :assignment
+      map.connect 'config_js_default', :controller => 'my_uservoice', :action => :config_js_default
+      map.connect 'config_js_custom_forum', :controller => 'my_uservoice', :action => :config_js_custom_forum
+      map.connect 'config_js_custom_alignment', :controller => 'my_uservoice', :action => :config_js_custom_alignment
+    end
+  end
+
+  def test_controller
+    get :assignment
+    config = assigns('uservoice_configuration')
+    assert config.is_a?(Hash)
+    assert_equal 'test', config['key']
+  end
+
+  def test_config_javascript_default
+    get :config_js_default
+    assert_match Regexp.new('<script type="text/javascript"> var uservoiceOptions = .*</script>'), @response.body
+    assert_match Regexp.new('"host":"test.uservoice.com"'), @response.body
+    assert_match Regexp.new('"forum":12345'), @response.body
+  end
+
+  def test_config_custom_forum
+    get :config_js_custom_forum
+    assert_match Regexp.new('<script type="text/javascript"> var uservoiceOptions = .*</script>'), @response.body
+    assert_match Regexp.new('"forum":815'), @response.body
+    assert_no_match Regexp.new('"forum":12345'), @response.body
+  end
+
+  def test_config_custom_alignment
+    get :config_js_custom_alignment
+    assert_match Regexp.new('<script type="text/javascript"> var uservoiceOptions = .*</script>'), @response.body
+    assert_match Regexp.new('"forum":12345'), @response.body
+    assert_match Regexp.new('"alignment":"right"'), @response.body
+  end
+end
+

data/test/test_uservoice_generator.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class UservoiceGeneratorTest < Test::Unit::TestCase
+
+  def setup
+    FileUtils.mkdir_p(fake_rails_root)
+    @original_files = file_list
+  end
+
+  def teardown
+    FileUtils.rm_r(fake_rails_root)
+  end
+
+  def test_generates_correct_files
+    run_generator('uservoice', 'test', '12345')
+    new_files = file_list - @original_files
+    expected_files = ['config',
+                      'config/uservoice.yml',
+                      'public',
+                      'public/javascripts',
+                      'public/javascripts/uservoice.js']
+
+    assert_equal expected_files, new_files
+  end
+
+  def test_config_file_contains_settings
+    run_generator('uservoice', 'my_name', '98765')
+    config = read_config_file
+    assert_equal 'my_name', config['key']
+    assert_equal 'my_name.uservoice.com', config['host']
+    assert_equal 98765, config['forum']
+  end
+
+  private
+
+    def fake_rails_root
+      File.join(File.dirname(__FILE__), 'rails_root')
+    end
+
+    def file_list
+      Dir.chdir(fake_rails_root) do
+        Dir.glob('**/*')
+      end
+    end
+
+    def read_config_file
+      YAML::load(IO.read(File.join(fake_rails_root, 'config/uservoice.yml')))['uservoice_options']
+    end
+
+    def run_generator(*options)
+      Rails::Generator::Scripts::Generate.new.run(options, :destination => fake_rails_root, :quiet => true)
+    end
+
+end

data/test/uservoice_test.yml

@@ -0,0 +1,12 @@
+uservoice_options:
+  # required
+  key: test
+  host: test.uservoice.com
+  forum: 12345
+  showTab: true
+  # optional
+  alignment: left
+  background_color: "#f00"
+  text_color: white
+  hover_color: "#06C"
+  lang: en

data/uservoice.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{uservoice}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexander Greim"]
+  s.date = %q{2010-01-01}
+  s.description = %q{This adds Uservoice user feedback to your Rails application.
+      You can set Uservoice properties in a central configuration file and override
+      settings like forum id (for payed accounts) in your layout or view.}
+  s.email = %q{alexxx@iltempo.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "generators/uservoice/USAGE",
+     "generators/uservoice/templates/uservoice.js",
+     "generators/uservoice/templates/uservoice_template.yml",
+     "generators/uservoice/uservoice_generator.rb",
+     "init.rb",
+     "lib/uservoice.rb",
+     "lib/uservoice/class_methods.rb",
+     "lib/uservoice/instance_methods.rb",
+     "lib/uservoice/uservoice_helper.rb",
+     "test/helper.rb",
+     "test/test_uservoice.rb",
+     "test/test_uservoice_generator.rb",
+     "test/uservoice_test.yml",
+     "uservoice.gemspec"
+  ]
+  s.homepage = %q{http://github.com/iltempo/uservoice}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Uservoice for your Rails application}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_uservoice.rb",
+     "test/test_uservoice_generator.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: uservoice
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alexander Greim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-01 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: |-
+  This adds Uservoice user feedback to your Rails application.
+        You can set Uservoice properties in a central configuration file and override
+        settings like forum id (for payed accounts) in your layout or view.
+email: alexxx@iltempo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- generators/uservoice/USAGE
+- generators/uservoice/templates/uservoice.js
+- generators/uservoice/templates/uservoice_template.yml
+- generators/uservoice/uservoice_generator.rb
+- init.rb
+- lib/uservoice.rb
+- lib/uservoice/class_methods.rb
+- lib/uservoice/instance_methods.rb
+- lib/uservoice/uservoice_helper.rb
+- test/helper.rb
+- test/test_uservoice.rb
+- test/test_uservoice_generator.rb
+- test/uservoice_test.yml
+- uservoice.gemspec
+has_rdoc: true
+homepage: http://github.com/iltempo/uservoice
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Uservoice for your Rails application
+test_files: 
+- test/helper.rb
+- test/test_uservoice.rb
+- test/test_uservoice_generator.rb