neutral 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27678637183996203a37b3887be25f347be8a784
+  data.tar.gz: a76fd757d8c8e389a38fb89f94c912baf592deb3
+SHA512:
+  metadata.gz: 6dfdec73927a16494db5b9dc5ecf8097d301c5aa995b7282e7035d0851cc0c0882a521ab4ae56bda9e8fae9c3f08427546669edcf5db73a895db84d086091652
+  data.tar.gz: aabe39f28693e565acaace9c7c897c32f7a698c878f0a1063ca69225037e1354da49804005763f7b9bbb416a9a83be9296709461188a5f0c9bfd95ce1432197e

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+coverage/**/*
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,194 @@
+PATH
+  remote: .
+  specs:
+    neutral (0.0.1)
+      font-awesome-rails (~> 4.0.3.1)
+      jquery-rails
+      rails (~> 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    bcrypt-ruby (3.0.1)
+    builder (3.1.4)
+    capybara (2.2.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    coderay (1.1.0)
+    columnize (0.3.6)
+    database_cleaner (1.2.0)
+    debugger (1.6.5)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.1)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.2.1)
+      factory_girl (~> 4.2.0)
+      railties (>= 3.0.0)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    ffaker (1.22.1)
+    font-awesome-rails (4.0.3.1)
+      railties (>= 3.2, < 5.0)
+    hike (1.2.3)
+    httpauth (0.2.0)
+    i18n (0.6.9)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    libv8 (3.16.14.3)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth (0.4.7)
+    oauth2 (0.8.1)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    polyglot (0.3.3)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-rails (0.3.2)
+      pry (>= 0.9.10)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.1)
+    ref (1.0.5)
+    remarkable (3.1.13)
+      rspec (>= 1.2.0)
+    remarkable_activerecord (3.1.13)
+      remarkable (~> 3.1.13)
+      rspec (>= 1.2.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-rails (2.14.1)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    sorcery (0.8.2)
+      bcrypt-ruby (~> 3.0.0)
+      oauth (~> 0.4.4)
+      oauth2 (~> 0.8.0)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    therubyracer (0.12.0)
+      libv8 (~> 3.16.14.0)
+      ref
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  database_cleaner
+  debugger
+  factory_girl_rails (~> 4.2.1)
+  ffaker
+  neutral!
+  pry-rails
+  remarkable_activerecord
+  rspec-rails
+  shoulda-matchers
+  simplecov
+  sorcery
+  sqlite3
+  therubyracer

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,143 @@
+# Neutral
+
+Neutral is a rails engine providing ajaxful positive/negative voting solution for your ActiveRecord objects along with couple of additional features.
+
+![Preview](images/neutral.png)
+
+## Installation
+
+Add following into your Gemfile
+
+    gem 'neutral'
+
+Run
+
+    $ bundle
+ 
+Or install it yourself as
+
+    $ gem install neutral
+
+### Generation
+
+Generate required files using
+
+    $ rails g neutral:install
+
+And proceed to migrate newly created migration files
+
+    $ rake db:migrate
+
+## Usage
+
+Make your ActiveRecord model voteable
+
+    class Post < ActiveRecord::Base
+      neutral
+    end
+
+And select your voter model
+
+    class User < ActiveRecord::Base
+      neutral_voter
+    end
+
+*Note: If your voter model is not User configure this setting inside neutral.rb [intializer](https://github.com/petertoth/neutral#configuring-neutral)*
+
+To display voting use `voting_for` helper in your view : 
+
+    <%= voting_for post %>
+
+## Customization
+
+### View
+
+You can also pass two additional options to `voting_for` helper
+
+* **[icons](https://github.com/petertoth/neutral#font-awesome)** : Icons used for positive/negative/remove
+* **difference** : Display difference count instead of positive/negative counts
+<br>*If the difference is positive i.e positive votes - negative votes > 0 then the color of the span is green, red otherwise*
+
+Example : 
+
+    <%= voting_for article, icons: :myfabulousicons, difference: true %>
+
+### Configuring Neutral
+
+In *config/initializers/neutral.rb* you can configure these options :
+
+* **can_change** : Determine wheter a voter can change(update,delete) his vote
+* **current_voter_method** : This is most typically `current_user` but if not, change this to your own representation of a voter instance e.g `current_client` or `current_customer`. Also make sure it accessible from your ApplicationController.
+* **require_login** : Voter is/is not required to be authenticated in order to vote. Setting to false is not recommended
+* **vote_owner_class** : Configure an owner of a vote. Pass string of class name of the model you added `neutral_voter` into. For example `'User'`, `'Client'` or `'Customer'`
+* **default_icon_set** : This icon set is used when no explicit icon set is passed to `voting_for` helper
+
+### Font Awesome
+
+This engine enables you to define your own icon sets using FontAwesome icons that provide representation of voting related actions such as like, dislike, remove, plus, minus, whatever ...
+
+You can use any [FontAwesome icon class](http://fontawesome.io/icons/) available
+
+Define an icon set in your *neutral.rb* initializer
+
+```
+#config/initializers/neutral.rb
+
+Neutral.define do
+  set :myicons do
+    positive "fa-thumbs-up"
+    negative "fa-thumbs-down"
+    remove "fa-times"
+  end
+
+  set :fabulous do
+    positive "fa-plus"
+    # If any of action is omitted, definition from your default icon set is used.
+    # In this case "fa-thumbs-down-o" would be used for negative and "fa-times" 
+    # for remove action because because :thumbs(default set) contains these definitions.
+  end
+end
+```
+
+Finally use it as follows :
+
+    <%= voting_for voteable, icons: :myicons %>
+
+If you ever need to access a definition of a given icon set proceed analogically as follows : `Neutral.icons.thumbs.positive`
+
+## i18n
+
+Define your custom error messages for each of your locale in *config/locales/neutral.yml*
+
+    en:
+      errors:
+        duplication: "You have already selected this option!"
+        cannot_change: "You are not permitted to change the vote!"
+        require_login : "You must be logged in to vote!"
+
+## Uninstallation
+
+Run : 
+
+    $ rails g neutral:uninstall
+
+It :
+
+* comments `neutral` in your *routes.rb*
+
+* removes `require neutral` from your stylesheet manifest
+
+* removes *neutral.rb* initializer
+* removes *neutral.yml* locale file
+* removes database entities(engine's tables) and migration files - **optional**
+
+## 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
+
+## License
+MIT License. Copyright (c) 2014

data/Rakefile

@@ -0,0 +1,21 @@
+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    = 'Neutral'
+  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'
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/stylesheets/neutral/index.css

@@ -0,0 +1,43 @@
+/*
+ *= require font-awesome
+ *= require_self
+ *= require_tree .
+ */
+
+div.neutral a {
+  display: inline;
+  margin: 0 4px;
+  color: inherit;
+  outline: none;
+}
+
+div.neutral a:hover {
+  border: none;
+  opacity: .8;
+  text-decoration: none;
+}
+
+div.neutral a.remove {
+  opacity: .4;
+}
+
+div.neutral i {
+  font-size: 1.2em;
+}
+
+div.neutral span {
+  display: inline;  
+}
+
+div.neutral span#positive, div.neutral span.positive {
+  color: green;
+}
+
+div.neutral span#negative, div.neutral span.negative {
+  color: red;
+}
+
+div.neutral span.error {
+  margin-left: 5px;
+  color: red;
+}

data/app/controllers/neutral/application_controller.rb

@@ -0,0 +1,22 @@
+module Neutral
+  class ApplicationController < ::ApplicationController
+    protect_from_forgery
+
+    rescue_from Errors::RequireLogin, with: :require_login
+    rescue_from Errors::CannotChange, with: :cannot_change
+    rescue_from Errors::DuplicateVote, with: :duplicate
+
+    private
+    def require_login
+      render 'neutral/votes/errors/require_login'
+    end
+
+    def cannot_change
+      render 'neutral/votes/errors/cannot_change'
+    end
+
+    def duplicate
+      render 'neutral/votes/errors/duplicate'
+    end
+  end
+end

data/app/controllers/neutral/votes_controller.rb

@@ -0,0 +1,48 @@
+require_dependency 'application_controller'
+
+module Neutral
+  class VotesController < ApplicationController
+    layout false
+
+    before_filter :require_login?, only: :create
+    before_filter :can_change?, except: :create
+
+    def create
+      @vote = Vote.create(vote_params)
+    end
+
+    def update
+      vote.update_attributes(value: params[:value])
+    end
+
+    def destroy
+      vote.destroy
+    end
+
+    helper_method :vote, :voting
+    def vote
+      @vote ||= Vote.find_by(id: params[:id]) || Vote.new(vote_params)
+    end
+
+    def voting
+      @voting ||= vote.voting || Voting.new
+    end
+
+    private
+    def require_login?
+      raise Errors::RequireLogin if Neutral.config.require_login && !current_voter
+    end
+
+    def can_change?
+      raise Errors::CannotChange unless Neutral.config.can_change && authorized?
+    end
+
+    def vote_params
+      params.require(:vote).permit(:voteable_type, :voteable_id, :value).merge voter_id: current_voter.try(:id)
+    end
+
+    def authorized?
+      current_voter == vote.voter
+    end
+  end
+end

data/app/helpers/neutral/votes_helper.rb

@@ -0,0 +1,16 @@
+module Neutral
+  module VotesHelper
+    def by_url
+      return raw "a[href*='#{request.post? ? votes_path : vote_path}']"
+    end
+
+    def vote_path(value=[1,0].sample)
+      raw neutral.vote_path(vote, value: value)
+    end
+
+    def votes_path(value=[1,0].sample)
+      raw neutral.votes_path(vote: vote.main_attributes.update(value: value))
+    end
+  end
+end
+

data/app/models/neutral/vote.rb

@@ -0,0 +1,26 @@
+module Neutral
+  class Vote < ActiveRecord::Base
+    before_update :avoid_duplication
+
+    validates_inclusion_of :value, in: [0,1]
+    validates_presence_of :voteable_type, :voteable_id, :value
+
+    belongs_to :voteable, polymorphic: true
+    belongs_to :voter, class_name: Neutral.config.vote_owner_class.classify
+
+    include Neutral::Model::VoteCached
+
+    def nature
+      value == 1 ? :positive : :negative
+    end
+
+    def main_attributes
+      attributes.symbolize_keys.except(:id, :voter_id, :created_at, :updated_at)
+    end
+
+    private
+    def avoid_duplication
+      raise Errors::DuplicateVote unless self.changed?
+    end
+  end
+end

data/app/models/neutral/voting.rb

@@ -0,0 +1,39 @@
+module Neutral
+  class Voting < ActiveRecord::Base
+    before_destroy :delete_votes
+
+    belongs_to :votingable, polymorphic: true
+
+    delegate :votes, to: :votingable
+
+    def difference
+      positive - negative
+    end
+
+    def self.init(vote)
+      create(votingable_type: vote.voteable_type, votingable_id: vote.voteable_id) do |voting|
+        voting.increment(vote.nature)
+      end
+    end
+
+    def add_to_existing(nature)
+      increment!(nature)
+    end
+
+    def edit(nature)
+      increment(nature)
+      decrement(nature==:positive ? :negative : :positive)
+      save
+    end
+
+    def remove(nature)
+      decrement!(nature)
+    end
+
+    private
+
+    def delete_votes
+      votes.delete_all
+    end
+  end
+end

data/app/views/neutral/votes/create.js.erb

@@ -0,0 +1,27 @@
+$(document).ready(function() {
+
+  neutral = $("div.neutral").find("<%= by_url %>").parent();
+
+  neutral.find("span#positive").html("<%= voting.positive.nonzero? %>");
+  neutral.find("span#negative").html("<%= voting.negative.nonzero? %>");
+  neutral.find("span#difference").html("<%= voting.difference.nonzero?.try(:abs) %>");
+
+  neutral.find("span#difference").attr("class", "<%= voting.difference > 0 ? 'positive' : 'negative' %>");
+
+  <% if vote.voter_id && Neutral.config.can_change %>
+
+  neutral.find("a[class!='remove']").data('method', 'patch');
+  neutral.find("a[class!='remove']").attr('data-method', 'patch');
+  neutral.find("a.positive").attr('href', '<%= vote_path(1) %>');
+  neutral.find("a.negative").attr('href', '<%= vote_path(0) %>');
+
+  neutral.append('<%= escape_javascript(
+    Neutral::VotingBuilder::Elements::Link::Remove.new(
+      Neutral::VotingBuilder::Router.new(vote)[:remove],
+      Neutral.icons.send(Neutral.config.default_icon_set).send(:remove)).to_s
+    )
+  %>');
+
+  <% end %>
+
+});

data/app/views/neutral/votes/destroy.js.erb

@@ -0,0 +1,18 @@
+$(document).ready(function() {
+
+  neutral = $("div.neutral").find("<%= by_url %>").parent();
+
+  neutral.find("a[class!='remove']").data('method', 'post');
+  neutral.find("a[class!='remove']").attr('data-method', 'post');
+  neutral.find("a.positive").attr('href', '<%= votes_path(1) %>');
+  neutral.find("a.negative").attr('href', '<%= votes_path(0) %>');
+
+  neutral.find("span#positive").html("<%= voting.positive.nonzero? %>");
+  neutral.find("span#negative").html("<%= voting.negative.nonzero? %>");
+  neutral.find("span#difference").html("<%= voting.difference.nonzero?.try(:abs) %>");
+
+  neutral.find("span#difference").attr("class", "<%= voting.difference > 0 ? 'positive' : 'negative' %>");
+
+  neutral.find("a.remove").remove();
+
+});

data/app/views/neutral/votes/errors/cannot_change.js.erb

@@ -0,0 +1,9 @@
+$(document).ready(function() {
+
+  neutral = $("div.neutral").find("<%= by_url %>").parent();
+
+  neutral.find("span.error").remove();
+
+  $("<span class='error'><%= t('errors.cannot_change') %></span>").appendTo(neutral).delay(4000).hide(0);
+
+});

data/app/views/neutral/votes/errors/duplicate.js.erb

@@ -0,0 +1,9 @@
+$(document).ready(function() {
+
+  neutral = $("div.neutral").find("<%= by_url %>").parent();
+
+  neutral.find("span.error").remove();
+
+  $("<span class='error'><%= t('errors.duplication') %></span>").appendTo(neutral).delay(4000).hide(0);
+
+});

data/app/views/neutral/votes/errors/require_login.js.erb

@@ -0,0 +1,10 @@
+$(document).ready(function() {
+
+  neutral = $("div.neutral").find("<%= by_url %>").parent();
+
+  neutral.find("span.error").remove();
+
+  $("<span class='error'><%= t('errors.require_login') %></span>").appendTo(neutral).delay(4000).hide(0);
+
+});
+