ratable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b93c3b37659d970ebf0628b36e43682f8a6815a
+  data.tar.gz: 1415a6249b324eca32d99f3d157e4d4c45927cde
+SHA512:
+  metadata.gz: bee68586328cc062ab45a56a66cbd0e7f1233c777e8f122bc207b0a1e0d9ba5e87928ec81d3bb8799a7dd998afd367cecfa0b640eaf1848198c1bd40fc82d5b1
+  data.tar.gz: 8ee44788991793129d91e9cecd549ea0d1fe52576b6217d58a06e160c90214339b98a4941332fa2924ce474b3993f0f432179779a81ee7b5b58cfb9ea70c2a84

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 =
+
+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,3 @@
+= Ratable
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,48 @@
+# begin
+#   require 'bundler/setup'
+# rescue LoadError
+#   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+# end
+#
+# require 'rdoc/task'
+#
+# RDoc::Task.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title    = 'Ratable'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('README.rdoc')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+#
+# APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+# load 'rails/tasks/engine.rake'
+#
+#
+# load 'rails/tasks/statistics.rake'
+#
+#
+#
+# Bundler::GemHelper.install_tasks
+
+
+#!/usr/bin/env rake
+begin
+ require 'bundler/setup'
+rescue LoadError
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/ratable.js.erb

@@ -0,0 +1,9 @@
+//= require jquery
+//= require_tree ../../../vendor/assets/javascripts
+(function($){
+  $.fn.raty.defaults.starHalf = '<%= image_path('star-half.png') %>';
+  $.fn.raty.defaults.starOn = '<%= image_path('star-on.png') %>';
+  $.fn.raty.defaults.starOff = '<%= image_path('star-off.png') %>';
+  $.fn.raty.defaults.cancelOff = '<%= image_path('cancel-off.png') %>';
+  $.fn.raty.defaults.cancelOn = '<%= image_path('cancel-on.png') %>';
+}(jQuery));

data/app/assets/javascripts/ratings.js

@@ -0,0 +1,10 @@
+$(function() {
+  $('.rating').each(function() {
+    $this = $(this);
+    $this.raty({
+      score: $this.data('rating'),
+      scoreName: 'star',
+      space: true
+    });
+  });
+});

data/app/models/ratable/rating.rb

@@ -0,0 +1,14 @@
+module Ratable
+  class Rating < ActiveRecord::Base
+    belongs_to :ratee, polymorphic: true
+    belongs_to :rater, polymorphic: true
+
+    validates_presence_of :ratee, :value
+
+    scope :by_ratee, -> (ratee) { where(ratee: ratee) }
+    scope :by_rater, -> (rater) { where(rater: rater) }
+
+    def average
+    end
+  end
+end

data/app/views/ratable/ratings/_rating.html.erb

@@ -0,0 +1 @@
+<div class="rating" data-rating="<%= rating.value %>"></div>

data/db/migrate/20160418175804_create_ratable_ratings.rb

@@ -0,0 +1,12 @@
+class CreateRatableRatings < ActiveRecord::Migration
+  def change
+    create_table :ratable_ratings do |t|
+      t.references :ratee, polymorphic: true
+      t.references :rater, polymorphic: true
+      t.integer :value
+      t.text :comment
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/ratable/install_generator.rb

@@ -0,0 +1,26 @@
+class Ratable::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  require 'rails/generators/migration'
+
+  def self.next_migration_number path
+    unless @prev_migration
+      @prev_migration = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+    else
+      @prev_migration += 1
+    end
+    @prev_migration.to_s
+  end
+
+  def create_initializer_file
+    template 'initializer.rb', 'config/initializers/ratable.rb'
+  end
+
+  def copy_migrations
+    require 'rake'
+    Rails.application.load_tasks
+    Rake::Task['railties:install:migrations'].reenable
+    Rake::Task['ratable:install:migrations'].invoke
+  end
+
+end

data/lib/generators/ratable/templates/initializer.rb

@@ -0,0 +1,2 @@
+module Ratable
+end

data/lib/generators/ratable/views_generator.rb

@@ -0,0 +1,7 @@
+class Ratable::ViewsGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../app/views/ratable", __FILE__)
+
+  def copy_views
+    directory('ratings', 'app/views/ratable/ratings')
+  end
+end

data/lib/ratable.rb

@@ -0,0 +1,9 @@
+require 'ratable/engine'
+
+module Ratable
+  module Models
+    autoload :Ratable, 'ratable/models/ratable'
+    autoload :Ratee, 'ratable/models/ratee'
+    autoload :Rater, 'ratable/models/rater'
+  end
+end

data/lib/ratable/engine.rb

@@ -0,0 +1,29 @@
+require 'rails'
+
+module Ratable
+  class Engine < ::Rails::Engine
+    isolate_namespace Ratable
+    initializer "ratable.models.ratee" do
+      ActiveSupport.on_load(:active_record) do
+        extend Ratable::Models::Ratable::ActiveRecordExtension
+        include Ratable::Models::Ratable::ActiveRecordInclusion
+      end
+    end
+    initializer "ratable.models.ratee" do
+      ActiveSupport.on_load(:active_record) do
+        extend Ratable::Models::Ratee::ActiveRecordExtension
+      end
+    end
+    initializer "ratable.models.rater" do
+      ActiveSupport.on_load(:active_record) do
+        extend Ratable::Models::Rater::ActiveRecordExtension
+      end
+    end
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/ratable/models/ratable.rb

@@ -0,0 +1,37 @@
+module Ratable
+  module Models
+    module Ratable
+
+      module ActiveRecordExtension
+        def acts_like_ratable?
+          classes = ancestors
+          classes.include?(Ratee) || classes.include?(Rater)
+        end
+
+        def acts_like_ratee?
+          ancestors.include?(Ratee)
+        end
+
+        def acts_like_rater?
+          ancestors.include?(Rater)
+        end
+      end
+
+      module ActiveRecordInclusion
+        def acts_like_ratable?
+          classes = self.class.ancestors
+          classes.include?(Ratee) || classes.include?(Rater)
+        end
+
+        def acts_like_ratee?
+          self.class.ancestors.include?(Ratee)
+        end
+
+        def acts_like_rater?
+          self.class.ancestors.include?(Rater)
+        end
+      end
+
+    end
+  end
+end

data/lib/ratable/models/ratee.rb

@@ -0,0 +1,43 @@
+module Ratable
+  module Models
+    module Ratee
+      extend ActiveSupport::Concern
+
+      attr_reader :has_one
+
+      module ActiveRecordExtension
+        def acts_as_ratee(options={has_one: false})
+          @has_one = options[:has_one]
+          include Ratee
+        end
+      end
+
+      included do
+        if @has_one
+          has_one :rating, class_name: 'Ratable::Rating', dependent: :destroy, as: :ratee
+        else
+          has_many :ratings, class_name: 'Ratable::Rating', dependent: :destroy, as: :ratee
+        end
+        has_one :rating_summary, class_name: 'Ratable::RatingSummary', as: :ratee
+      end
+
+      def raters
+        if @has_one
+          rating.rater
+        else
+          ratings.includes(:rater).collect { |rating| rating.rater }
+        end
+      end
+
+      def rate(options={})
+        options.reject! { |k| k == :ratee }
+        if @has_one
+          self.rating.create(options)
+        else
+          self.ratings.create(options)
+        end
+      end
+
+    end
+  end
+end

data/lib/ratable/models/rater.rb

@@ -0,0 +1,43 @@
+module Ratable
+  module Models
+    module Rater
+      extend ActiveSupport::Concern
+
+      attr_reader :has_one
+
+      module ActiveRecordExtension
+        def acts_as_rater(options={has_one: false})
+          @has_one = options[:has_one]
+          include Rater
+        end
+      end
+
+      included do
+        if @has_one
+          has_one :rating, class_name: 'Ratable::Rating', dependent: :destroy, as: :rater
+        else
+          has_many :ratings, class_name: 'Ratable::Rating', dependent: :destroy, as: :rater
+        end
+        has_one :rating_summary, class_name: 'Ratable::RatingSummary', as: :rater
+      end
+
+      def ratees
+        if @has_one
+          rating.ratee
+        else
+          ratings.includes(:ratee).collect { |rating| rating.ratee }
+        end
+      end
+
+      def rate(options={})
+        options.reject! { |k| k == :rater }
+        if @has_one
+          self.rating.create(options)
+        else
+          self.ratings.create(options)
+        end
+      end
+
+    end
+  end
+end

data/lib/ratable/version.rb

@@ -0,0 +1,3 @@
+module Ratable
+  VERSION = '0.0.1'
+end

data/lib/tasks/ratable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ratable do
+#   # Task goes here
+# 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>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require ratable
+//= require ratings
+//= require_tree .

data/spec/dummy/app/assets/javascripts/posts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/assets/stylesheets/posts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}