acts_as_nps_rateable 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDE0YTQ5NWUwNjdkMjFmM2YyYzM3ZjdjYzU5MTk5OTQ0ODM5ODM4Mg==
+  data.tar.gz: !binary |-
+    Yjk5MmEyMjE1ODVmZDJmMDk3YTYxM2VmNTM3MTAxNzA5NzdkNTNlMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGI3YmVlNmNmM2I2Mzc1NDczMjJmYmYwMTUwMGRkM2E0ZjMxNTRkY2MxMGI5
+    NmI5YmYzN2NhYmQ2OGQwZmIzY2U3ODgxNGZkMjk0MjhiYTc3YmNmODkxYTcz
+    MTg0NDBhN2ExNzQ4ZGZjZjA3OWVkZmUxZjJkMDMyZmIyNDNkN2Y=
+  data.tar.gz: !binary |-
+    ZTU4YzNmY2M2ZmJjODY4NmNhYWUyYWUxNjUxOTM1OGFjMWI3OTFlOGZhYTY2
+    OGExY2I2ZTkyZDlmNTkwMDRkMmE4MjFjOTZiNDhkMWMwZWIyMWIzMzQ3N2Y2
+    NjljOGY3MTU5YzVjMmE5ZWE0MTU4YzBkYjkyYjU2ODUyYTM4MTE=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/.ruby-gemset

@@ -0,0 +1 @@
+acts_as_nps_rateable

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_nps_rateable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shahbaz Javeed
+
+MIT License
+
+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,29 @@
+# ActsAsNpsRateable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_nps_rateable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_nps_rateable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/acts_as_nps_rateable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_nps_rateable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'acts_as_nps_rateable'
+  gem.version       = ActsAsNpsRateable::VERSION
+  gem.authors       = ['Shahbaz Javeed']
+  gem.email         = ['sjaveed@gmail.com']
+  gem.description   = %q{Rails gem that provides Net Promoter Score (NPS) ratings and analysis for ActiveRecord models.  It can be used as a regular 0 to 10 rating scale and you can just ignore the NPS analysis methods.}
+  gem.summary       = %q{Net Promoter Score ratings and analysis for ActiveRecord models}
+  gem.homepage      = 'https://github.com/sjaveed/acts_as_nps_rateable'
+
+  gem.add_dependency 'activerecord', '~> 3.0'
+  gem.add_dependency 'rails', '~> 3.0'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/lib/acts_as_nps_rateable.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), "acts_as_nps_rateable/railtie")
+
+module ActsAsNpsRateable
+  autoload :Hook, File.join(File.dirname(__FILE__), "acts_as_nps_rateable/hook")
+  autoload :InstanceMethods, File.join(File.dirname(__FILE__), "acts_as_nps_rateable/instance_methods")
+end
+
+require 'nps_rating'

data/lib/acts_as_nps_rateable/hook.rb

@@ -0,0 +1,10 @@
+# This is the hook that implements the acts_as_nps_rateable method
+# and includes all acts_as_nps_rateable instance methods as needed
+
+module ActsAsNpsRateable::Hook
+  def acts_as_nps_rateable
+    has_many :nps_ratings, :as => :nps_rateable, class_name: 'ActsAsNpsRateable::NpsRating', :dependent => :destroy
+
+    include ActsAsNpsRateable::InstanceMethods
+  end
+end

data/lib/acts_as_nps_rateable/instance_methods.rb

@@ -0,0 +1,63 @@
+# These are all the instance methods that acts_as_nps_rateable includes into an ActiveModel
+
+module ActsAsNpsRateable::InstanceMethods
+  # rate this rateable ensuring there's at most only one rating per user per rateable
+  def rate(score, user)
+    ActiveRecord::Base.transaction do
+      nps_ratings.where(user_id: user.id).delete_all if user.present?
+      nps_ratings.create(score: score.to_i, user_id: user.id)
+    end
+  end
+
+  # the average of all ratings for this rateable
+  def average_rating
+    nps_ratings.average(:score)
+  end
+
+  # a check to see if the specified user has already rated this rateable
+  def rated_by?(user)
+    return unless user.present?
+
+    nps_ratings.where(user_id: user.id).size > 0
+  end
+
+  #
+  # Net Promoter Score Calculations: http://www.checkmarket.com/2011/06/net-promoter-score/
+  #
+
+  def promoters ratings = nil
+    if ratings.nil?
+      nps_ratings.promoters.size
+    else
+      ratings.promoters.size
+    end
+  end
+
+  def passives ratings = nil
+    if ratings.nil?
+      nps_ratings.passives.size
+    else
+      ratings.passives.size
+    end
+  end
+
+  def detractors ratings = nil
+    if ratings.nil?
+      nps_ratings.detractors.size
+    else
+      ratings.detractors.size
+    end
+  end
+
+  def net_promoter_score ratings = nil
+    total_ratings = ratings.nil? ? nps_ratings.size : ratings.size
+    return 0 if total_ratings == 0
+
+    if ratings.nil?
+      (promoters - detractors) * 100 / total_ratings
+    else
+      (promoters(ratings) - detractors(ratings)) * 100 / total_ratings
+    end
+  end
+
+end

data/lib/acts_as_nps_rateable/railtie.rb

@@ -0,0 +1,8 @@
+module ActsAsNpsRateable
+  class Railtie < Rails::Railtie
+    # Extend ActiveRecord::Base here and include ActsAsNpsRateable instance methods
+    config.to_prepare do
+      ActiveRecord::Base.send(:extend, ActsAsNpsRateable::Hook)
+    end
+  end
+end

data/lib/acts_as_nps_rateable/version.rb

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

data/lib/generators/acts_as_nps_rateable/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/migration'
+
+module ActsAsNpsRateable
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration
+      migration_template '01-migration.rb', 'db/migrate/acts_as_nps_rateable_migration'
+      migration_template '02-migration.rb', 'db/migrate/acts_as_nps_rateable_migration_upgrade_0_0_2'
+    end
+
+    def install_models
+      #template 'nps_rating.rb', 'app/models/nps_rating.rb'
+    end
+  end
+end

data/lib/generators/acts_as_nps_rateable/templates/01-migration.rb

@@ -0,0 +1,14 @@
+class ActsAsNpsRateableMigration < ActiveRecord::Migration
+  def change
+    create_table :nps_ratings do |t|
+      t.integer :score
+      t.integer :nps_rateable_id
+      t.string  :nps_rateable_type
+      t.integer :user_id
+
+      t.timestamps
+    end
+
+    add_index :nps_ratings, [:nps_rateable_type, :nps_rateable_id, :user_id], unique: true, name: "acts_as_nps_rateable_unique_index"
+  end
+end

data/lib/generators/acts_as_nps_rateable/templates/02-migration.rb

@@ -0,0 +1,5 @@
+class ActsAsNpsRateableMigration < ActiveRecord::Migration
+  def change
+    add_column :nps_ratings, :comments, :text
+  end
+end

data/lib/nps_rating.rb

@@ -0,0 +1,41 @@
+module ActsAsNpsRateable
+  class NpsRating < ActiveRecord::Base
+    self.table_name = 'nps_ratings'
+
+    belongs_to :nps_rateable, polymorphic: true
+    belongs_to :user
+
+    validates_presence_of :score
+    validates_numericality_of :score, only_integer: true
+    validates_inclusion_of :score, in: (0..10).to_a, message: 'must be between 0 and 10'
+
+    validates_presence_of :nps_rateable_id
+    validates_presence_of :nps_rateable_type
+
+    validates_presence_of :user_id
+    validates_uniqueness_of :user_id, scope: [:nps_rateable_type, :nps_rateable_id], message: 'has already rated'
+
+    before_save :remove_blank_comments
+
+    scope :promoters, where(score: [9, 10])
+    scope :passives, where(score: [7, 8])
+    scope :detractors, where('score <= 6')
+    scope :with_comments, where('comments IS NOT NULL')
+
+    def self.calculate_for relevant_ratings
+      total_ratings = relevant_ratings.size
+      return 0 if total_ratings == 0
+
+      promoters = relevant_ratings.promoters.size
+      detractors = relevant_ratings.detractors.size
+
+      ((promoters - detractors) * 100.0 / total_ratings).round
+    end
+
+    private
+
+    def remove_blank_comments
+      write_attribute(:comments, nil) if comments.blank?
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_nps_rateable
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Shahbaz Javeed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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'
+description: Rails gem that provides Net Promoter Score (NPS) ratings and analysis
+  for ActiveRecord models.  It can be used as a regular 0 to 10 rating scale and you
+  can just ignore the NPS analysis methods.
+email:
+- sjaveed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_nps_rateable.gemspec
+- lib/acts_as_nps_rateable.rb
+- lib/acts_as_nps_rateable/hook.rb
+- lib/acts_as_nps_rateable/instance_methods.rb
+- lib/acts_as_nps_rateable/railtie.rb
+- lib/acts_as_nps_rateable/version.rb
+- lib/generators/acts_as_nps_rateable/install_generator.rb
+- lib/generators/acts_as_nps_rateable/templates/01-migration.rb
+- lib/generators/acts_as_nps_rateable/templates/02-migration.rb
+- lib/nps_rating.rb
+homepage: https://github.com/sjaveed/acts_as_nps_rateable
+licenses: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Net Promoter Score ratings and analysis for ActiveRecord models
+test_files: []