seems_rateable 1.0.13 → 2.0.0

data/lib/seems_rateable/builder.rb

@@ -0,0 +1,35 @@
+require_relative 'builder/html_options'
+
+module SeemsRateable
+  class Builder
+    include ActionView::Helpers::TagHelper
+
+    attr_reader :rateable, :options
+
+    def self.build(rateable, options)
+      new(rateable, options).build
+    end
+
+    def initialize(rateable, options)
+      @rateable, @options = rateable, options
+    end
+
+    def build
+      content_tag :div, nil, html_options
+    end
+
+    private
+
+    def html_options
+      HtmlOptions.new(rating, options).to_h
+    end
+
+    def rating
+      rateable.rating dimension
+    end
+
+    def dimension
+      options.delete(:dimension)
+    end
+  end
+end

data/lib/seems_rateable/builder/html_options.rb

@@ -0,0 +1,37 @@
+module SeemsRateable
+  class Builder
+    class HtmlOptions
+      attr_reader :rating, :options
+
+      def initialize(rating, options)
+        @rating, @options = rating, options
+      end
+
+      def to_h
+        options[:class] = "#{klass} #{disabled}".strip
+        options[:data] = options.fetch(:data, {}).merge(rating_attributes)
+        options
+      end
+
+      private
+
+      def rating_attributes
+        rate_params.merge average: rating.average
+      end
+
+      # Avoids passing nil dimension to the data html attrbitutes
+      # because it gets processed as data-dimension="null"
+      def rate_params
+        rating.rates.where_values_hash.keep_if { |k, v| v }
+      end
+
+      def klass
+        options[:class] || SeemsRateable.config.default_selector_class
+      end
+
+      def disabled
+        'jDisabled' if options[:disabled]
+      end
+    end
+  end
+end

data/lib/seems_rateable/configuration.rb

@@ -0,0 +1,23 @@
+module SeemsRateable
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield config if block_given?
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :rate_owner_class
+    config_accessor :current_rater_method
+    config_accessor :default_selector_class
+  end
+
+  configure do |config|
+    config.rate_owner_class = 'User'
+    config.current_rater_method = :current_user
+    config.default_selector_class = 'rateable'
+  end
+end

data/lib/seems_rateable/engine.rb

@@ -2,15 +2,20 @@ module SeemsRateable
   class Engine < ::Rails::Engine
     isolate_namespace SeemsRateable
 
-    config.generators do |g|
-      g.test_framework :rspec, :fixture => false
-      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
-    end
-
     initializer :seems_rateable do
-      ActiveRecord::Base.send :include, SeemsRateable::Model
-      ActionView::Base.send :include, SeemsRateable::Helpers
+      ::ActiveSupport.on_load(:active_record) { extend SeemsRateable::Models::ActiveRecordExtension }
+      ::ActiveSupport.on_load(:action_view) { include SeemsRateable::Helpers::ActionViewExtension }
+      ::ActiveSupport.on_load(:action_controller) { include SeemsRateable::Helpers::CurrentRater }
       ActionDispatch::Routing::Mapper.send :include, SeemsRateable::Routes
     end
+
+    config.after_initialize do
+      require 'seems_rateable/application_controller'
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
   end
 end

data/lib/seems_rateable/errors.rb

@@ -1,21 +1,7 @@
 module SeemsRateable
   module Errors
-    class InvalidRateableObjectError < StandardError
-      def to_s
-        "Stated object is not rateable. Add 'seems_rateable' to your object's class model."
-      end
-    end
-    
-    class NoCurrentUserInstanceError < StandardError
-      def to_s
-        "User instance current_user is not available."
-      end
-    end
-    
-    class AlreadyRatedError < StandardError
-      def to_s
-        "User has already rated an object."
-      end
-    end 
+    class InvalidRateableError < StandardError;end
+    class NonExistentDimension < StandardError;end
+    class NoCurrentRaterError < StandardError;end
   end
 end

data/lib/seems_rateable/helpers/action_view_extension.rb

@@ -0,0 +1,18 @@
+module SeemsRateable
+  module Helpers
+    module ActionViewExtension
+      def rating_for(rateable, options={})
+        unless rateable.kind_of? Models::ActiveRecordExtension::Rateable
+          raise Errors::InvalidRateableError, "#{rateable.inspect} is not a rateable" +
+            " object, try adding 'seems_rateable' into your object's model"
+        end
+
+        if !current_rater || rateable.rated_by?(current_rater, options[:dimension])
+          options[:disabled] = true
+        end
+
+        SeemsRateable::Builder.build(rateable, options)
+      end
+    end
+  end
+end

data/lib/seems_rateable/helpers/current_rater.rb

@@ -0,0 +1,15 @@
+module SeemsRateable
+  module Helpers
+    module CurrentRater
+      extend ActiveSupport::Concern
+
+      def current_rater
+        send SeemsRateable.config.current_rater_method
+      end
+
+      included do
+        helper_method :current_rater
+      end
+    end
+  end
+end

data/lib/seems_rateable/models/active_record_extension.rb

@@ -0,0 +1,23 @@
+module SeemsRateable
+  module Models
+    module ActiveRecordExtension
+      def seems_rateable(*dimensions)
+        has_many :_rates, -> { where dimension: nil }, as: :rateable, class_name: SeemsRateable::Rate, dependent: :destroy
+        has_many :_raters, through: :_rates, source: :rater, dependent: :destroy
+
+        dimensions.each do |dimension|
+          has_many :"#{dimension}_rates", -> { where dimension: dimension }, as: :rateable, class_name: SeemsRateable::Rate, dependent: :destroy
+          has_many :"#{dimension}_raters", through: :"#{dimension}_rates", source: :rater, dependent: :destroy
+        end
+
+        include Rateable
+      end
+
+      def seems_rateable_rater
+        has_many :rates_given, class_name: SeemsRateable::Rate, foreign_key: :rater_id
+
+        include Rater
+      end
+    end
+  end
+end

data/lib/seems_rateable/models/active_record_extension/rateable.rb

@@ -0,0 +1,26 @@
+module SeemsRateable
+  module Models
+    module ActiveRecordExtension
+      module Rateable
+        %w[rates raters].each do |m|
+          define_method m do |dimension=nil|
+            if respond_to? "#{dimension}_#{m}"
+              send "#{dimension}_#{m}"
+            else
+              raise Errors::NonExistentDimension, "Dimension '#{dimension.inspect}' does not exist for #{self.class}"
+            end
+          end
+        end
+
+        def rating(dimension=nil)
+          SeemsRateable::Rating.new rates(dimension)
+        end
+
+        def rated_by?(rater, dimension=nil)
+          return unless rater
+          raters(dimension).include? rater
+        end
+      end
+    end
+  end
+end

data/lib/seems_rateable/models/active_record_extension/rater.rb

@@ -0,0 +1,11 @@
+module SeemsRateable
+  module Models
+    module ActiveRecordExtension
+      module Rater
+        def rates_given(dimension=nil)
+          super.where(dimension: dimension)
+        end
+      end
+    end
+  end
+end

data/lib/seems_rateable/rating.rb

@@ -0,0 +1,19 @@
+module SeemsRateable
+  class Rating < Struct.new(:rates)
+    def average
+      sum/(count.nonzero? || 1)
+    end
+
+    def sum
+      stars.inject(:+).to_f
+    end
+
+    def count
+      stars.length
+    end
+
+    def stars
+      @stars ||= rates.pluck(:stars)
+    end
+  end
+end

data/lib/seems_rateable/routes.rb

@@ -1,7 +1,7 @@
 module SeemsRateable
   module Routes
     def seems_rateable
-      mount SeemsRateable::Engine => '/rateable', :as => :rateable
+      mount SeemsRateable::Engine => '/rateable', as: 'seems_rateable'
     end
   end
 end

data/lib/seems_rateable/version.rb

@@ -1,3 +1,3 @@
 module SeemsRateable
-  VERSION = "1.0.13"
+  VERSION = "2.0.0"
 end

data/seems_rateable.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "seems_rateable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "seems_rateable"
+  s.version     = SeemsRateable::VERSION
+  s.authors     = ["Peter Toth"]
+  s.email       = ["peter@petertoth.me"]
+  s.homepage    = "http://rateable.herokuapp.com"
+  s.summary     = "Star Rating Engine"
+  s.description = "Star rating engine using jQuery plugin jRating for Rails applications"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/**/*`.split("\n")
+
+  s.add_dependency "rails", ">= 4.0.0"
+  s.add_dependency "jquery-rails"
+
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "devise"
+
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "factory_girl_rails"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "selenium-webdriver"
+  s.add_development_dependency "shoulda-matchers"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "generator_spec"
+end

data/spec/builder_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+feature SeemsRateable::Builder do
+  let(:rateable) { DummyModel.seems_rateable.create }
+  let(:options) { {} }
+
+  describe ".build" do
+    it "initializes a new builder object and builds it" do
+      SeemsRateable::Builder.should_receive(:new).with(rateable, kind_of(Hash)).and_call_original
+      SeemsRateable::Builder.any_instance.should_receive(:build)
+      SeemsRateable::Builder.build(rateable, options)
+    end
+  end
+
+  describe "#build" do
+    def rating(rateable, options)
+      Capybara.string(SeemsRateable::Builder.new(rateable, options).build).first('div')
+    end
+
+    subject { rating(rateable, options) }
+
+    describe "attributes" do
+      its(['class']) { should include(SeemsRateable.config.default_selector_class) }
+      its(['data-rateable-type']) { should eq(rateable.class.name) }
+      its(['data-rateable-id']) { should eq(rateable.id.to_s) }
+      its(['data-average']) { should_not be_nil }
+      its(['data-dimension']) { should be_nil }
+
+      context "with explicit class passed" do
+        let(:klass) { 'stuff' }
+
+        subject { rating(rateable, class: klass) }
+
+        its(['class']) { should include(klass) }
+      end
+
+      context "with dimension" do
+        let(:dimension) { 'quality' }
+        let(:rateable) { DummyModel.seems_rateable(dimension).create }
+
+        subject { rating(rateable, dimension: dimension) }
+
+        its(['data-dimension']) { should eq(dimension) }
+      end
+
+      context "when disabled" do
+        subject { rating(rateable, disabled: true) }
+
+        its(['class']) { should include('jDisabled') }
+      end
+    end
+  end
+end

data/spec/controllers/rates_controller_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe SeemsRateable::RatesController do
+  routes { SeemsRateable::Engine.routes }
+
+  let(:user) { FactoryGirl.create(:user) }
+  let(:article) { FactoryGirl.create(:post) }
+
+  describe "POST #create" do
+    def create_rate
+      xhr :post, :create, valid_attributes(article)
+    end
+
+    def valid_attributes(rateable)
+      {
+        rate: {
+          rateable_type: rateable.class.name,
+          rateable_id: rateable.id,
+          stars: rand(1..5),
+          dimension: ['speed', 'quality', nil].sample
+        }
+      }
+    end
+
+    context "when valid" do
+      before do
+        controller.stub(:current_user).and_return(user)
+      end
+
+      it "creates a new rate" do
+        expect { create_rate }.to change(SeemsRateable::Rate, :count).by(1)
+      end
+
+      it "assigns a newly created rate as @rate" do
+        create_rate
+        assigns(:rate).should be_a(SeemsRateable::Rate)
+        assigns(:rate).should be_persisted
+      end
+
+      it "renders average rating as json" do
+        create_rate
+        expect(response.content_type).to eq('application/json')
+        expect(response.status).to eq(200)
+        expect(JSON.parse(response.body)).to have_key("average")
+      end
+    end
+
+    context "when invalid" do
+      context "when user is not signed in" do
+        it "raises a NoCurrentRaterError error" do
+          expect { create_rate }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.