camaleon_cms_rating 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3a0c3fbcbbdf63e5820be68221622a77ae2ea71
+  data.tar.gz: 68d1ae70ad03ff567ad780c6a4c1a92f91cdd492
+SHA512:
+  metadata.gz: b814077798bef9d0e1a8b63876cfb482fc2d88ead276db4afe727743c7ca0d268a82cb0c9798eac238a5ef075a67cd7286ab3f0c8232c99fa9b0a72d1da7d563
+  data.tar.gz: aaf9c71a4743c9ec92b45eaca3e60c26826ff487c8d154688426ff5d7a506d7e9c3725afeed13077edfe6adfa82bb00aacd1458362e598f12303458283cca961

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Richard Li
+
+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,38 @@
+# Camaleon CMS Rating
+A star rating plugin for the Camaleon CMS.
+
+## Preview
+![](art/preview.png)
+
+## Usage
+```erb
+<!-- including scripts into the layout file -->
+<%= javascript_include_tag plugin_asset_path('main', 'camaleon_cms_rating') %>
+
+<!-- including partials into the post template file -->
+<%= render partial: plugin_view('front/index', 'camaleon_cms_rating'), locals: { post: @post } %>
+<%= render partial: plugin_view('front/new', 'camaleon_cms_rating'), locals: { post: @post } %>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'camaleon_cms_rating'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install camaleon_cms_rating
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/aspirewit/camaleon_cms_rating. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'CamaleonCmsRating'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/plugins/camaleon_cms_rating/jquery.raty.js

@@ -0,0 +1,762 @@
+/*!
+ * jQuery Raty - A Star Rating Plugin
+ *
+ * The MIT License
+ *
+ * @author  : Washington Botelho
+ * @doc     : http://wbotelhos.com/raty
+ * @version : 2.7.1
+ *
+ */
+
+;
+(function($) {
+  'use strict';
+
+  var methods = {
+    init: function(options) {
+      return this.each(function() {
+        this.self = $(this);
+
+        methods.destroy.call(this.self);
+
+        this.opt = $.extend(true, {}, $.fn.raty.defaults, options);
+
+        methods._adjustCallback.call(this);
+        methods._adjustNumber.call(this);
+        methods._adjustHints.call(this);
+
+        this.opt.score = methods._adjustedScore.call(this, this.opt.score);
+
+        if (this.opt.starType !== 'img') {
+          methods._adjustStarType.call(this);
+        }
+
+        methods._adjustPath.call(this);
+        methods._createStars.call(this);
+
+        if (this.opt.cancel) {
+          methods._createCancel.call(this);
+        }
+
+        if (this.opt.precision) {
+          methods._adjustPrecision.call(this);
+        }
+
+        methods._createScore.call(this);
+        methods._apply.call(this, this.opt.score);
+        methods._setTitle.call(this, this.opt.score);
+        methods._target.call(this, this.opt.score);
+
+        if (this.opt.readOnly) {
+          methods._lock.call(this);
+        } else {
+          this.style.cursor = 'pointer';
+
+          methods._binds.call(this);
+        }
+      });
+    },
+
+    _adjustCallback: function() {
+      var options = ['number', 'readOnly', 'score', 'scoreName', 'target', 'path'];
+
+      for (var i = 0; i < options.length; i++) {
+        if (typeof this.opt[options[i]] === 'function') {
+          this.opt[options[i]] = this.opt[options[i]].call(this);
+        }
+      }
+    },
+
+    _adjustedScore: function(score) {
+      if (!score) {
+        return score;
+      }
+
+      return methods._between(score, 0, this.opt.number);
+    },
+
+    _adjustHints: function() {
+      if (!this.opt.hints) {
+        this.opt.hints = [];
+      }
+
+      if (!this.opt.halfShow && !this.opt.half) {
+        return;
+      }
+
+      var steps = this.opt.precision ? 10 : 2;
+
+      for (var i = 0; i < this.opt.number; i++) {
+        var group = this.opt.hints[i];
+
+        if (Object.prototype.toString.call(group) !== '[object Array]') {
+          group = [group];
+        }
+
+        this.opt.hints[i] = [];
+
+        for (var j = 0; j < steps; j++) {
+          var
+            hint = group[j],
+            last = group[group.length - 1];
+
+          if (last === undefined) {
+            last = null;
+          }
+
+          this.opt.hints[i][j] = hint === undefined ? last : hint;
+        }
+      }
+    },
+
+    _adjustNumber: function() {
+      this.opt.number = methods._between(this.opt.number, 1, this.opt.numberMax);
+    },
+
+    _adjustPath: function() {
+      this.opt.path = this.opt.path || '';
+
+      if (this.opt.path && this.opt.path.charAt(this.opt.path.length - 1) !== '/') {
+        this.opt.path += '/';
+      }
+    },
+
+    _adjustPrecision: function() {
+      this.opt.half = true;
+    },
+
+    _adjustStarType: function() {
+      var replaces = ['cancelOff', 'cancelOn', 'starHalf', 'starOff', 'starOn'];
+
+      this.opt.path = '';
+
+      for (var i = 0; i < replaces.length; i++) {
+        this.opt[replaces[i]] = this.opt[replaces[i]].replace('.', '-');
+      }
+    },
+
+    _apply: function(score) {
+      methods._fill.call(this, score);
+
+      if (score) {
+        if (score > 0) {
+          this.score.val(score);
+        }
+
+        methods._roundStars.call(this, score);
+      }
+    },
+
+    _between: function(value, min, max) {
+      return Math.min(Math.max(parseFloat(value), min), max);
+    },
+
+    _binds: function() {
+      if (this.cancel) {
+        methods._bindOverCancel.call(this);
+        methods._bindClickCancel.call(this);
+        methods._bindOutCancel.call(this);
+      }
+
+      methods._bindOver.call(this);
+      methods._bindClick.call(this);
+      methods._bindOut.call(this);
+    },
+
+    _bindClick: function() {
+      var that = this;
+
+      that.stars.on('click.raty', function(evt) {
+        var
+          execute = true,
+          score   = (that.opt.half || that.opt.precision) ? that.self.data('score') : (this.alt || $(this).data('alt'));
+
+        if (that.opt.click) {
+          execute = that.opt.click.call(that, +score, evt);
+        }
+
+        if (execute || execute === undefined) {
+          if (that.opt.half && !that.opt.precision) {
+            score = methods._roundHalfScore.call(that, score);
+          }
+
+          methods._apply.call(that, score);
+        }
+      });
+    },
+
+    _bindClickCancel: function() {
+      var that = this;
+
+      that.cancel.on('click.raty', function(evt) {
+        that.score.removeAttr('value');
+
+        if (that.opt.click) {
+          that.opt.click.call(that, null, evt);
+        }
+      });
+    },
+
+    _bindOut: function() {
+      var that = this;
+
+      that.self.on('mouseleave.raty', function(evt) {
+        var score = +that.score.val() || undefined;
+
+        methods._apply.call(that, score);
+        methods._target.call(that, score, evt);
+        methods._resetTitle.call(that);
+
+        if (that.opt.mouseout) {
+          that.opt.mouseout.call(that, score, evt);
+        }
+      });
+    },
+
+    _bindOutCancel: function() {
+      var that = this;
+
+      that.cancel.on('mouseleave.raty', function(evt) {
+        var icon = that.opt.cancelOff;
+
+        if (that.opt.starType !== 'img') {
+          icon = that.opt.cancelClass + ' ' + icon;
+        }
+
+        methods._setIcon.call(that, this, icon);
+
+        if (that.opt.mouseout) {
+          var score = +that.score.val() || undefined;
+
+          that.opt.mouseout.call(that, score, evt);
+        }
+      });
+    },
+
+    _bindOver: function() {
+      var
+        that   = this,
+        action = that.opt.half ? 'mousemove.raty' : 'mouseover.raty';
+
+      that.stars.on(action, function(evt) {
+        var score = methods._getScoreByPosition.call(that, evt, this);
+
+        methods._fill.call(that, score);
+
+        if (that.opt.half) {
+          methods._roundStars.call(that, score, evt);
+          methods._setTitle.call(that, score, evt);
+
+          that.self.data('score', score);
+        }
+
+        methods._target.call(that, score, evt);
+
+        if (that.opt.mouseover) {
+          that.opt.mouseover.call(that, score, evt);
+        }
+      });
+    },
+
+    _bindOverCancel: function() {
+      var that = this;
+
+      that.cancel.on('mouseover.raty', function(evt) {
+        var
+          starOff = that.opt.path + that.opt.starOff,
+          icon    = that.opt.cancelOn;
+
+        if (that.opt.starType === 'img') {
+          that.stars.attr('src', starOff);
+        } else {
+          icon = that.opt.cancelClass + ' ' + icon;
+
+          that.stars.attr('class', starOff);
+        }
+
+        methods._setIcon.call(that, this, icon);
+        methods._target.call(that, null, evt);
+
+        if (that.opt.mouseover) {
+          that.opt.mouseover.call(that, null);
+        }
+      });
+    },
+
+    _buildScoreField: function() {
+      return $('<input />', { name: this.opt.scoreName, type: 'hidden' }).appendTo(this);
+    },
+
+    _createCancel: function() {
+      var
+        icon   = this.opt.path + this.opt.cancelOff,
+        cancel = $('<' + this.opt.starType + ' />', { title: this.opt.cancelHint, 'class': this.opt.cancelClass });
+
+      if (this.opt.starType === 'img') {
+        cancel.attr({ src: icon, alt: 'x' });
+      } else {
+        // TODO: use $.data
+        cancel.attr('data-alt', 'x').addClass(icon);
+      }
+
+      if (this.opt.cancelPlace === 'left') {
+        this.self.prepend('&#160;').prepend(cancel);
+      } else {
+        this.self.append('&#160;').append(cancel);
+      }
+
+      this.cancel = cancel;
+    },
+
+    _createScore: function() {
+      var score = $(this.opt.targetScore);
+
+      this.score = score.length ? score : methods._buildScoreField.call(this);
+    },
+
+    _createStars: function() {
+      for (var i = 1; i <= this.opt.number; i++) {
+        var
+          name  = methods._nameForIndex.call(this, i),
+          attrs = { alt: i, src: this.opt.path + this.opt[name] };
+
+        if (this.opt.starType !== 'img') {
+          attrs = { 'data-alt': i, 'class': attrs.src }; // TODO: use $.data.
+        }
+
+        attrs.title = methods._getHint.call(this, i);
+
+        $('<' + this.opt.starType + ' />', attrs).appendTo(this);
+
+        if (this.opt.space) {
+          this.self.append(i < this.opt.number ? '&#160;' : '');
+        }
+      }
+
+      this.stars = this.self.children(this.opt.starType);
+    },
+
+    _error: function(message) {
+      $(this).text(message);
+
+      $.error(message);
+    },
+
+    _fill: function(score) {
+      var hash = 0;
+
+      for (var i = 1; i <= this.stars.length; i++) {
+        var
+          icon,
+          star   = this.stars[i - 1],
+          turnOn = methods._turnOn.call(this, i, score);
+
+        if (this.opt.iconRange && this.opt.iconRange.length > hash) {
+          var irange = this.opt.iconRange[hash];
+
+          icon = methods._getRangeIcon.call(this, irange, turnOn);
+
+          if (i <= irange.range) {
+            methods._setIcon.call(this, star, icon);
+          }
+
+          if (i === irange.range) {
+            hash++;
+          }
+        } else {
+          icon = this.opt[turnOn ? 'starOn' : 'starOff'];
+
+          methods._setIcon.call(this, star, icon);
+        }
+      }
+    },
+
+    _getFirstDecimal: function(number) {
+      var
+        decimal = number.toString().split('.')[1],
+        result  = 0;
+
+      if (decimal) {
+        result = parseInt(decimal.charAt(0), 10);
+
+        if (decimal.slice(1, 5) === '9999') {
+          result++;
+        }
+      }
+
+      return result;
+    },
+
+    _getRangeIcon: function(irange, turnOn) {
+      return turnOn ? irange.on || this.opt.starOn : irange.off || this.opt.starOff;
+    },
+
+    _getScoreByPosition: function(evt, icon) {
+      var score = parseInt(icon.alt || icon.getAttribute('data-alt'), 10);
+
+      if (this.opt.half) {
+        var
+          size    = methods._getWidth.call(this),
+          percent = parseFloat((evt.pageX - $(icon).offset().left) / size);
+
+        score = score - 1 + percent;
+      }
+
+      return score;
+    },
+
+    _getHint: function(score, evt) {
+      if (score !== 0 && !score) {
+        return this.opt.noRatedMsg;
+      }
+
+      var
+        decimal = methods._getFirstDecimal.call(this, score),
+        integer = Math.ceil(score),
+        group   = this.opt.hints[(integer || 1) - 1],
+        hint    = group,
+        set     = !evt || this.move;
+
+      if (this.opt.precision) {
+        if (set) {
+          decimal = decimal === 0 ? 9 : decimal - 1;
+        }
+
+        hint = group[decimal];
+      } else if (this.opt.halfShow || this.opt.half) {
+        decimal = set && decimal === 0 ? 1 : decimal > 5 ? 1 : 0;
+
+        hint = group[decimal];
+      }
+
+      return hint === '' ? '' : hint || score;
+    },
+
+    _getWidth: function() {
+      var width = this.stars[0].width || parseFloat(this.stars.eq(0).css('font-size'));
+
+      if (!width) {
+        methods._error.call(this, 'Could not get the icon width!');
+      }
+
+      return width;
+    },
+
+    _lock: function() {
+      var hint = methods._getHint.call(this, this.score.val());
+
+      this.style.cursor = '';
+      this.title        = hint;
+
+      this.score.prop('readonly', true);
+      this.stars.prop('title', hint);
+
+      if (this.cancel) {
+        this.cancel.hide();
+      }
+
+      this.self.data('readonly', true);
+    },
+
+    _nameForIndex: function(i) {
+      return this.opt.score && this.opt.score >= i ? 'starOn' : 'starOff';
+    },
+
+    _resetTitle: function(star) {
+      for (var i = 0; i < this.opt.number; i++) {
+        this.stars[i].title = methods._getHint.call(this, i + 1);
+      }
+    },
+
+     _roundHalfScore: function(score) {
+      var integer = parseInt(score, 10),
+          decimal = methods._getFirstDecimal.call(this, score);
+
+      if (decimal !== 0) {
+        decimal = decimal > 5 ? 1 : 0.5;
+      }
+
+      return integer + decimal;
+    },
+
+    _roundStars: function(score, evt) {
+      var
+        decimal = (score % 1).toFixed(2),
+        name    ;
+
+      if (evt || this.move) {
+        name = decimal > 0.5 ? 'starOn' : 'starHalf';
+      } else if (decimal > this.opt.round.down) {               // Up:   [x.76 .. x.99]
+        name = 'starOn';
+
+        if (this.opt.halfShow && decimal < this.opt.round.up) { // Half: [x.26 .. x.75]
+          name = 'starHalf';
+        } else if (decimal < this.opt.round.full) {             // Down: [x.00 .. x.5]
+          name = 'starOff';
+        }
+      }
+
+      if (name) {
+        var
+          icon = this.opt[name],
+          star = this.stars[Math.ceil(score) - 1];
+
+        methods._setIcon.call(this, star, icon);
+      }                                                         // Full down: [x.00 .. x.25]
+    },
+
+    _setIcon: function(star, icon) {
+      star[this.opt.starType === 'img' ? 'src' : 'className'] = this.opt.path + icon;
+    },
+
+    _setTarget: function(target, score) {
+      if (score) {
+        score = this.opt.targetFormat.toString().replace('{score}', score);
+      }
+
+      if (target.is(':input')) {
+        target.val(score);
+      } else {
+        target.html(score);
+      }
+    },
+
+    _setTitle: function(score, evt) {
+      if (score) {
+        var
+          integer = parseInt(Math.ceil(score), 10),
+          star    = this.stars[integer - 1];
+
+        star.title = methods._getHint.call(this, score, evt);
+      }
+    },
+
+    _target: function(score, evt) {
+      if (this.opt.target) {
+        var target = $(this.opt.target);
+
+        if (!target.length) {
+          methods._error.call(this, 'Target selector invalid or missing!');
+        }
+
+        var mouseover = evt && evt.type === 'mouseover';
+
+        if (score === undefined) {
+          score = this.opt.targetText;
+        } else if (score === null) {
+          score = mouseover ? this.opt.cancelHint : this.opt.targetText;
+        } else {
+          if (this.opt.targetType === 'hint') {
+            score = methods._getHint.call(this, score, evt);
+          } else if (this.opt.precision) {
+            score = parseFloat(score).toFixed(1);
+          }
+
+          var mousemove = evt && evt.type === 'mousemove';
+
+          if (!mouseover && !mousemove && !this.opt.targetKeep) {
+            score = this.opt.targetText;
+          }
+        }
+
+        methods._setTarget.call(this, target, score);
+      }
+    },
+
+    _turnOn: function(i, score) {
+      return this.opt.single ? (i === score) : (i <= score);
+    },
+
+    _unlock: function() {
+      this.style.cursor = 'pointer';
+      this.removeAttribute('title');
+
+      this.score.removeAttr('readonly');
+
+      this.self.data('readonly', false);
+
+      for (var i = 0; i < this.opt.number; i++) {
+        this.stars[i].title = methods._getHint.call(this, i + 1);
+      }
+
+      if (this.cancel) {
+        this.cancel.css('display', '');
+      }
+    },
+
+    cancel: function(click) {
+      return this.each(function() {
+        var self = $(this);
+
+        if (self.data('readonly') !== true) {
+          methods[click ? 'click' : 'score'].call(self, null);
+
+          this.score.removeAttr('value');
+        }
+      });
+    },
+
+    click: function(score) {
+      return this.each(function() {
+        if ($(this).data('readonly') !== true) {
+          score = methods._adjustedScore.call(this, score);
+
+          methods._apply.call(this, score);
+
+          if (this.opt.click) {
+            this.opt.click.call(this, score, $.Event('click'));
+          }
+
+          methods._target.call(this, score);
+        }
+      });
+    },
+
+    destroy: function() {
+      return this.each(function() {
+        var self = $(this),
+            raw  = self.data('raw');
+
+        if (raw) {
+          self.off('.raty').empty().css({ cursor: raw.style.cursor }).removeData('readonly');
+        } else {
+          self.data('raw', self.clone()[0]);
+        }
+      });
+    },
+
+    getScore: function() {
+      var score = [],
+          value ;
+
+      this.each(function() {
+        value = this.score.val();
+
+        score.push(value ? +value : undefined);
+      });
+
+      return (score.length > 1) ? score : score[0];
+    },
+
+    move: function(score) {
+      return this.each(function() {
+        var
+          integer  = parseInt(score, 10),
+          decimal  = methods._getFirstDecimal.call(this, score);
+
+        if (integer >= this.opt.number) {
+          integer = this.opt.number - 1;
+          decimal = 10;
+        }
+
+        var
+          width   = methods._getWidth.call(this),
+          steps   = width / 10,
+          star    = $(this.stars[integer]),
+          percent = star.offset().left + steps * decimal,
+          evt     = $.Event('mousemove', { pageX: percent });
+
+        this.move = true;
+
+        star.trigger(evt);
+
+        this.move = false;
+      });
+    },
+
+    readOnly: function(readonly) {
+      return this.each(function() {
+        var self = $(this);
+
+        if (self.data('readonly') !== readonly) {
+          if (readonly) {
+            self.off('.raty').children(this.opt.starType).off('.raty');
+
+            methods._lock.call(this);
+          } else {
+            methods._binds.call(this);
+            methods._unlock.call(this);
+          }
+
+          self.data('readonly', readonly);
+        }
+      });
+    },
+
+    reload: function() {
+      return methods.set.call(this, {});
+    },
+
+    score: function() {
+      var self = $(this);
+
+      return arguments.length ? methods.setScore.apply(self, arguments) : methods.getScore.call(self);
+    },
+
+    set: function(options) {
+      return this.each(function() {
+        $(this).raty($.extend({}, this.opt, options));
+      });
+    },
+
+    setScore: function(score) {
+      return this.each(function() {
+        if ($(this).data('readonly') !== true) {
+          score = methods._adjustedScore.call(this, score);
+
+          methods._apply.call(this, score);
+          methods._target.call(this, score);
+        }
+      });
+    }
+  };
+
+  $.fn.raty = function(method) {
+    if (methods[method]) {
+      return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
+    } else if (typeof method === 'object' || !method) {
+      return methods.init.apply(this, arguments);
+    } else {
+      $.error('Method ' + method + ' does not exist!');
+    }
+  };
+
+  $.fn.raty.defaults = {
+    cancel       : false,
+    cancelClass  : 'raty-cancel',
+    cancelHint   : 'Cancel this rating!',
+    cancelOff    : 'cancel-off.png',
+    cancelOn     : 'cancel-on.png',
+    cancelPlace  : 'left',
+    click        : undefined,
+    half         : false,
+    halfShow     : true,
+    hints        : ['bad', 'poor', 'regular', 'good', 'gorgeous'],
+    iconRange    : undefined,
+    mouseout     : undefined,
+    mouseover    : undefined,
+    noRatedMsg   : 'Not rated yet!',
+    number       : 5,
+    numberMax    : 20,
+    path         : undefined,
+    precision    : false,
+    readOnly     : false,
+    round        : { down: 0.25, full: 0.6, up: 0.76 },
+    score        : undefined,
+    scoreName    : 'score',
+    single       : false,
+    space        : true,
+    starHalf     : 'star-half.png',
+    starOff      : 'star-off.png',
+    starOn       : 'star-on.png',
+    starType     : 'img',
+    target       : undefined,
+    targetFormat : '{score}',
+    targetKeep   : false,
+    targetScore  : undefined,
+    targetText   : '',
+    targetType   : 'hint'
+  };
+
+})(jQuery);

data/app/assets/javascripts/plugins/camaleon_cms_rating/main.js

@@ -0,0 +1,31 @@
+//= require ./jquery.raty
+//
+jQuery(function(){
+  $.ajaxSetup({
+    beforeSend: function(xhr) {
+      xhr.setRequestHeader('X-CSRF-Token', $('meta[name="csrf-token"]').attr('content'));
+    }
+  });
+
+  $('.read-only-rating').raty({
+    path: '/assets/plugins/camaleon_cms_rating',
+    readOnly: true,
+    score: function() {
+      return $(this).data('score');
+    }
+  });
+
+  $('.editable-rating').raty({
+    path: '/assets/plugins/camaleon_cms_rating',
+    click: function(score, event) {
+      $this = $(this);
+      $this.raty({
+        path: '/assets/plugins/camaleon_cms_rating',
+        readOnly: true
+      });
+
+      data = { post_id: $this.data('post-id'), score: score };
+      $.post("/plugins/camaleon_cms_rating/create", data);
+    }
+  });
+});

data/app/controllers/plugins/camaleon_cms_rating/admin_controller.rb

@@ -0,0 +1,19 @@
+class Plugins::CamaleonCmsRating::AdminController < CamaleonCms::Apps::PluginsAdminController
+  include Plugins::CamaleonCmsRating::MainHelper
+
+  def index
+  end
+
+  # show settings form
+  def settings
+  end
+
+  # save values from settings form
+  def save_settings
+    @plugin.set_options(params[:options]) if params[:options].present? # save option values
+    @plugin.set_metas(params[:metas]) if params[:metas].present? # save meta values
+    @plugin.set_field_values(params[:field_options]) if params[:field_options].present? # save custom field values
+    redirect_to url_for(action: :settings), notice: 'Settings Saved Successfully'
+  end
+  # add custom methods below ....
+end

data/app/controllers/plugins/camaleon_cms_rating/front_controller.rb

@@ -0,0 +1,18 @@
+class Plugins::CamaleonCmsRating::FrontController < CamaleonCms::Apps::PluginsFrontController
+  include Plugins::CamaleonCmsRating::MainHelper
+
+  def index
+    # actions for frontend module
+  end
+
+  # add custom methods below
+  def create
+    @rating = Plugins::CamaleonCmsRating::Rating.new(
+      score: params[:score],
+      post_id: params[:post_id],
+      rater_id: cama_current_user.try(:id)
+    )
+
+    head @rating.save ? :ok : :bad_request
+  end
+end

data/app/helpers/plugins/camaleon_cms_rating/main_helper.rb

@@ -0,0 +1,29 @@
+module Plugins::CamaleonCmsRating::MainHelper
+  def self.included(klass)
+    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+  end
+
+  # here all actions on going to active
+  # you can run sql commands like this:
+  # results = ActiveRecord::Base.connection.execute(query);
+  # plugin: plugin model
+  def camaleon_cms_rating_on_active(plugin)
+  end
+
+  # here all actions on going to inactive
+  # plugin: plugin model
+  def camaleon_cms_rating_on_inactive(plugin)
+  end
+
+  # here all actions to upgrade for a new version
+  # plugin: plugin model
+  def camaleon_cms_rating_on_upgrade(plugin)
+  end
+
+  # hook listener to add settings link below the title of current plugin (if it is installed)
+  # args: {plugin (Hash), links (Array)}
+  # permit to add unlimmited of links...
+  def camaleon_cms_rating_on_plugin_options(args)
+    args[:links] << link_to('Settings', admin_plugins_camaleon_cms_rating_settings_path)
+  end
+end

data/app/models/plugins/camaleon_cms_rating/rating.rb

@@ -0,0 +1,8 @@
+class Plugins::CamaleonCmsRating::Rating < ActiveRecord::Base
+  self.table_name = 'camaleon_cms_rating_ratings'
+
+  belongs_to :post, class_name: 'CamaleonCms::Post'
+  belongs_to :rater, class_name: PluginRoutes.static_system_info['user_model'].presence || 'CamaleonCms::User'
+
+  validates_inclusion_of :score, in: (1..5).to_a
+end

data/app/views/plugins/camaleon_cms_rating/admin/index.html.erb

@@ -0,0 +1,9 @@
+<%#= javascript_include_tag plugin_asset("my_file.js") %>
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4>My Title</h4>
+  </div>
+  <div class="panel-body">
+    <p>Plugin ready to use in admin panel!.</p>
+  </div>
+</div>

data/app/views/plugins/camaleon_cms_rating/admin/settings.html.erb

@@ -0,0 +1,21 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4>My Plugin Settings</h4>
+  </div>
+  <div class="panel-body">
+    <%= form_tag(url_for(action: :save_settings), class: 'validate') do %>
+      <div class="form-group">
+        <label>My Option Setting</label>
+        <%= text_field_tag 'options[my_setting]', @plugin.get_option('my_setting'), class: 'form-control required' %>
+      </div>
+      <div class="form-group">
+        <label>My Meta Setting</label>
+        <%= text_field_tag 'metas[my_setting]', @plugin.get_meta('my_setting'), class: 'form-control required' %>
+      </div>
+      <%= render partial: "camaleon_cms/admin/settings/custom_fields/render", locals: {record: @plugin, field_groups: @plugin.get_field_groups} %>
+      <div class="form-group text-right">
+        <%= submit_tag 'Save Settings', class: 'btn btn-primary' %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/plugins/camaleon_cms_rating/front/_index.html.erb

@@ -0,0 +1,19 @@
+<div>
+  <% ratings = post.ratings %>
+  <% count = ratings.count %>
+  <% average = ratings.average(:score).to_f.round(2) %>
+
+  <div class="read-only-rating" data-score="<%== average %>"></div>
+
+  <p><%= "#{average} average based on #{count} ratings." %></p>
+
+  <% groups = ratings.order(:score).group(:score).count %>
+  <% 5.downto(1) do |score| %>
+    <div>
+      <span><%= "#{score} Star" %></span>
+      <span class="read-only-rating" data-score="<%== score %>"></span>
+      <% percentage = count.nonzero? ? Array(groups.assoc(score)).second.to_i.fdiv(count) * 100 : 0 %>
+      <%= number_to_percentage(percentage, precision: 0) %>
+    </div>
+  <% end %>
+</div>

data/app/views/plugins/camaleon_cms_rating/front/_new.html.erb

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

data/app/views/plugins/camaleon_cms_rating/front/index.html.erb

@@ -0,0 +1,2 @@
+<%#= javascript_include_tag plugin_gem_asset("js/my_file.js") %>
+Plugin ready to use! in frontend.

data/app/views/plugins/camaleon_cms_rating/layouts/readme.txt

@@ -0,0 +1,2 @@
+You can create your layouts here.
+To load your custom layout you can use: layout: plugin_layout(<layout_name>) in your controller

data/config/camaleon_plugin.json

@@ -0,0 +1,14 @@
+{
+  "title": "Camaleon CMS Rating",
+  "descr": "A star rating plugin for the Camaleon CMS.",
+  "key": "camaleon_cms_rating", // must be the name of the folder of your plugin, sample: app/views/plugins/<my_plugin> ==> 'my_plugin'
+  "helpers": [
+    "Plugins::CamaleonCmsRating::MainHelper"
+  ],
+  "hooks": {
+    "on_active": ["camaleon_cms_rating_on_active"],
+    "on_inactive": ["camaleon_cms_rating_on_inactive"],
+    "plugin_options": ["camaleon_cms_rating_on_plugin_options"]
+    //here you can add all your hooks (read documentation)
+  }
+}

data/config/initializers/custom_models.rb

@@ -0,0 +1,5 @@
+Rails.application.config.to_prepare do
+  CamaleonCms::Post.class_eval do
+    has_many :ratings, class_name: 'Plugins::CamaleonCmsRating::Rating'
+  end
+end

data/config/routes.rb

@@ -0,0 +1,31 @@
+Rails.application.routes.draw do
+  scope PluginRoutes.system_info["relative_url_root"] do
+    scope '(:locale)', locale: /#{PluginRoutes.all_locales}/, :defaults => {  } do
+      # frontend
+      namespace :plugins do
+        namespace 'camaleon_cms_rating' do
+          get 'index' => 'front#index'
+          post 'create' => 'front#create'
+        end
+      end
+    end
+
+    #Admin Panel
+    scope :admin, as: 'admin', path: PluginRoutes.system_info['admin_path_name'] do
+      namespace 'plugins' do
+        namespace 'camaleon_cms_rating' do
+          controller :admin do
+            get :index
+            get :settings
+            post :save_settings
+          end
+        end
+      end
+    end
+
+    # main routes
+    #scope 'camaleon_cms_rating', module: 'plugins/camaleon_cms_rating/', as: 'camaleon_cms_rating' do
+    #  Here my routes for main routes
+    #end
+  end
+end

data/db/migrate/20170812143133_create_camaleon_cms_rating_ratings.rb

@@ -0,0 +1,9 @@
+class CreateCamaleonCmsRatingRatings < ActiveRecord::Migration[5.0]
+  def change
+    create_table :camaleon_cms_rating_ratings do |t|
+      t.integer :score
+      t.belongs_to :post
+      t.belongs_to :rater
+    end
+  end
+end

data/lib/camaleon_cms_rating.rb

@@ -0,0 +1,5 @@
+require "camaleon_cms_rating/engine"
+
+module CamaleonCmsRating
+  # Your code goes here...
+end

data/lib/camaleon_cms_rating/engine.rb

@@ -0,0 +1,4 @@
+module CamaleonCmsRating
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/camaleon_cms_rating/version.rb

@@ -0,0 +1,3 @@
+module CamaleonCmsRating
+  VERSION = '0.1.0'
+end

data/lib/tasks/camaleon_cms_rating_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :camaleon_cms_rating do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: camaleon_cms_rating
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A star rating plugin for the Camaleon CMS.
+email:
+- aspirewit@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/camaleon_cms_rating_manifest.js
+- app/assets/images/plugins/camaleon_cms_rating/star-half.png
+- app/assets/images/plugins/camaleon_cms_rating/star-off.png
+- app/assets/images/plugins/camaleon_cms_rating/star-on.png
+- app/assets/javascripts/plugins/camaleon_cms_rating/jquery.raty.js
+- app/assets/javascripts/plugins/camaleon_cms_rating/main.js
+- app/controllers/plugins/camaleon_cms_rating/admin_controller.rb
+- app/controllers/plugins/camaleon_cms_rating/front_controller.rb
+- app/helpers/plugins/camaleon_cms_rating/main_helper.rb
+- app/models/plugins/camaleon_cms_rating/rating.rb
+- app/views/plugins/camaleon_cms_rating/admin/index.html.erb
+- app/views/plugins/camaleon_cms_rating/admin/settings.html.erb
+- app/views/plugins/camaleon_cms_rating/front/_index.html.erb
+- app/views/plugins/camaleon_cms_rating/front/_new.html.erb
+- app/views/plugins/camaleon_cms_rating/front/index.html.erb
+- app/views/plugins/camaleon_cms_rating/layouts/readme.txt
+- config/camaleon_plugin.json
+- config/initializers/custom_models.rb
+- config/routes.rb
+- db/migrate/20170812143133_create_camaleon_cms_rating_ratings.rb
+- lib/camaleon_cms_rating.rb
+- lib/camaleon_cms_rating/engine.rb
+- lib/camaleon_cms_rating/version.rb
+- lib/tasks/camaleon_cms_rating_tasks.rake
+homepage: https://github.com/aspirewit/camaleon_cms_rating
+licenses:
+- MIT
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A star rating plugin for the Camaleon CMS.
+test_files: []