neutral 0.0.1

data/lib/neutral/voting_builder/router.rb

@@ -0,0 +1,45 @@
+module Neutral
+  module VotingBuilder
+    class Router
+      include Neutral::Engine.routes.url_helpers
+
+      def initialize(vote)
+        @vote = vote
+      end
+
+      def [](element)
+        send element
+      end
+
+      def positive
+        if persisted?
+          { path: vote_path(vote, value: 1), method: 'patch' }
+        else
+          { path: votes_path(vote: vote.main_attributes.merge(value: 1)), method: 'post' }
+        end
+      end
+
+      def negative
+        if persisted?
+          { path: vote_path(vote, value: 0), method: 'patch' }
+        else
+          { path: votes_path(vote: vote.main_attributes.merge(value: 0)), method: 'post' }
+        end
+      end
+
+      def remove
+        raise "Remove path for non-existent vote cannot be obtained" unless persisted?
+        { path: vote_path(vote), method: 'delete' }
+      end
+
+      private
+      def vote
+        @vote
+      end
+
+      def persisted?
+        vote.persisted?
+      end
+    end
+  end
+end

data/lib/neutral/voting_builder/structure.rb

@@ -0,0 +1,21 @@
+module Neutral
+  module VotingBuilder
+    class Structure
+      def initialize(persisted, difference)
+        @persisted = persisted
+        @difference = difference
+      end
+
+      def to_a
+        structure = %w[positive_span positive_link difference_span negative_link negative_span remove_link]
+        structure -= %w[remove_link] unless can_change?
+        structure -= @difference ? %w[positive_span negative_span] : %w[difference_span]
+      end
+
+      private
+      def can_change?
+        @persisted && Neutral.config.can_change
+      end
+    end
+  end
+end

data/lib/neutral.rb

@@ -0,0 +1,46 @@
+require "neutral/engine"
+
+require "jquery-rails"
+require "font-awesome-rails"
+
+require "neutral/engine"
+require "neutral/configuration"
+
+module Neutral
+  autoload :Engine, 'neutral/engine'
+  autoload :Errors, 'neutral/errors'
+
+  module Model
+    autoload :ActiveRecordExtension, 'neutral/model/active_record_extension'
+    autoload :VoteCached, 'neutral/model/vote_cached'
+  end
+
+  module VotingBuilder
+    autoload :Builder, 'neutral/voting_builder/builder'
+    autoload :Elements, 'neutral/voting_builder/elements'
+    autoload :Router, 'neutral/voting_builder/router'
+    autoload :Structure, 'neutral/voting_builder/structure'
+  end
+
+  module Helpers
+    autoload :Routes, 'neutral/helpers/routes'
+    autoload :ActionViewExtension, 'neutral/helpers/action_view_extension'
+  end
+
+  module Icons
+    autoload :Collection, 'neutral/icons/collection'
+    autoload :Set, 'neutral/icons/set'
+  end
+
+  def self.define(&block)
+    module_eval(&block)
+  end
+
+  def self.set(name, &block)
+    icons.add Icons::Set.new(name, &block)
+  end
+
+  def self.icons
+    @icons ||= Icons::Collection.new
+  end
+end

data/neutral.gemspec

@@ -0,0 +1,34 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "neutral/version"
+
+Gem::Specification.new do |s|
+  s.name        = "neutral"
+  s.version     = Neutral::VERSION
+  s.authors     = ["Peter Tóth"]
+  s.email       = ["proximin@gmail.com"]
+  s.homepage    = "https://github.com/petertoth/neutral"
+  s.summary     = "Rails engine providing positive/negative ajaxful voting solution with FontAwesome integration and handful of additional features."
+  s.description = "Rails engine providing positive/negative ajaxful voting solution with FontAwesome integration and handful of additional features."
+
+  s.files = `git ls-files`.split("\n") - Dir["images/*"]
+  s.test_files = `git ls-files -- spec/**/*`.split("\n")
+
+  s.add_dependency "rails", "~> 4.0.0"
+	s.add_dependency "font-awesome-rails", "~> 4.0.3.1"
+	s.add_dependency "jquery-rails"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "ffaker"
+  s.add_development_dependency "therubyracer"
+  s.add_development_dependency "sorcery"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "factory_girl_rails", "~> 4.2.1"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "remarkable_activerecord"
+  s.add_development_dependency "shoulda-matchers"
+  s.add_development_dependency "debugger"
+end

data/spec/controllers/votes_controller_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe Neutral::VotesController do
+  routes { Neutral::Engine.routes }
+
+  include VotesControllerHelpers
+  include VotesControllerBaseClass
+
+  let(:voteable) { FactoryGirl.create(:post) }
+  let(:voter) { FactoryGirl.create(:user) }
+  let(:vote) { FactoryGirl.create(:vote) }
+
+  describe "POST #create" do
+    context "when valid" do
+      context "when login required" do
+        before do
+          controller.stub(:current_user).and_return(voter)
+        end
+
+        it "creates a new vote" do
+          expect { create(voteable) }.to change(Neutral::Vote, :count).by(1)
+        end
+
+        it "assigns a newly created vote as @vote" do
+          create(voteable)
+          assigns(:vote).should be_a(Neutral::Vote)
+          assigns(:vote).should be_persisted
+        end
+
+        it "renders create template" do
+          expect(create(voteable)).to render_template(:create)
+        end
+      end
+
+      context "when login not required " do
+        before do
+          Neutral.configure { |config| config.require_login = false }
+        end
+
+        after do
+          Neutral.configure { |config| config.require_login = true }
+        end
+
+        it "creates a new vote" do
+          expect { create(voteable) }.to change(Neutral::Vote, :count).by(1)
+        end
+
+        it "assigns a newly created vote as @vote without a voter" do
+          create(voteable)
+          assigns(:vote).should be_a(Neutral::Vote)
+          assigns(:vote).voter.should be_nil
+          assigns(:vote).should be_persisted
+        end
+
+        it "renders create template" do
+          expect(create(voteable)).to render_template(:create)
+        end
+      end
+    end
+
+    context "when invalid" do
+      context "when login required" do
+        subject { -> { create(voteable) } }
+
+        it { should_not change(Neutral::Vote, :count).by(1) }
+        its(:call) { should render_template('errors/require_login') }
+      end
+    end
+  end
+
+  describe "PATCH #update" do
+    context "when valid" do
+      before do
+        controller.stub(:current_user).and_return(vote.voter)
+      end
+
+      it "updates given vote" do
+        update(vote)
+        vote.value.should_not == vote.reload.value
+      end
+
+      it "assigns the vote as @vote and persists" do
+        update(vote)
+        assigns(:vote).should eq(vote.reload)
+        assigns(:vote).should be_persisted
+      end
+
+      it "renders update template" do
+        expect(update(vote)).to render_template(:update)
+      end
+    end
+
+    context "when invalid" do
+      it_should_behave_like "unable to change", :update
+
+      context "when duplicated" do
+        before do
+          controller.stub(:current_user).and_return(vote.voter)
+        end
+
+        it "assigns the vote as @vote" do
+          update vote, duplicate=true
+          assigns(:vote).should eq(vote)
+        end
+
+        it "renders duplicate template" do
+          expect(update(vote, duplicate=true)).to render_template('errors/duplicate')
+        end
+      end
+    end
+  end
+
+  describe "DELETE #destroy" do
+    context "when valid" do
+      before do
+        controller.stub(:current_user).and_return(vote.voter)
+      end
+
+      it "destroys the vote" do
+        expect { destroy(vote) }.to change(Neutral::Vote, :count).by(-1)
+      end
+
+      it "assigns the vote as @vote and does not persist" do
+        destroy(vote)
+        assigns(:vote).should eq(vote)
+        assigns(:vote).should_not be_persisted
+      end
+
+      it "renders destroy template" do
+        expect(destroy(vote)).to render_template(:destroy)
+      end
+    end
+
+    context "when invalid" do
+      it_should_behave_like "unable to change", :destroy
+    end
+  end
+end

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__)
+
+Dummy::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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree
+//= require jquery
+//= require jquery_ujs

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

@@ -0,0 +1,29 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require neutral
+
+ *= require_tree .
+ */
+
+a:hover {
+	background-color: none;
+}
+
+#container {
+	width: 1000px;
+	margin: 0 auto;
+}
+
+div.neutral a:hover {
+  background-color: none!important;
+  color: inherit;
+}

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: Arial, 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;
+}

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,11 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+  helper_method :current_user
+
+  def current_user
+    @current_user ||= User.find(session[:user_id]) if session[:user_id]
+  end
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,33 @@
+class PostsController < ApplicationController
+  # GET /posts
+  def index
+    @posts = Post.all
+  end
+
+  # GET /posts/new
+  def new
+    @post = Post.new
+  end
+
+  # POST /posts
+  def create
+    @post = Post.new(post_params)
+
+    if @post.save
+      redirect_to @post, notice: 'Post was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_post
+      @post = Post.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def post_params
+      params.require(:post).permit(:title)
+    end
+end

data/spec/dummy/app/controllers/sessions_controller.rb

@@ -0,0 +1,21 @@
+class SessionsController < ApplicationController
+  def new
+  end
+
+  def create
+    user = User.authenticate(params[:username], params[:password])
+
+    if user
+      session[:user_id] = user.id
+      redirect_to root_url, notice: "Logged in!"
+    else
+      flash.now[:error] = "Invalid username or password."
+      render "new"
+    end
+  end
+
+  def destroy
+    session[:user_id] = nil
+    redirect_to root_url, notice: "Logged out!"
+  end
+end

data/spec/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,24 @@
+class UsersController < ApplicationController
+
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+
+  # POST /users
+  def create
+    @user = User.new(user_params)
+
+    if @user.save
+      redirect_to @user, notice: 'User was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  private
+  # Only allow a trusted parameter "white list" through.
+  def user_params
+    params.require(:user).permit(:username, :password)
+  end
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  neutral
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,7 @@
+class User < ActiveRecord::Base
+  neutral_voter
+
+  def self.authenticate(username, password)
+    User.find_by(username: username, password: password)
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<div id="container">
+	<div id="userpanel">
+    <% if current_user %>
+      <span><b><%= current_user.username %></b></span>
+      <%= link_to "Logout", logout_path %>
+    <% else %>
+      <%= link_to "Login", login_path %>
+      <%= link_to "Register", new_user_path %>
+	  <% end %>
+	</div>
+	<%= yield %>
+</div>
+
+</body>
+</html>

data/spec/dummy/app/views/posts/_form.html.erb

@@ -0,0 +1,21 @@
+<%= form_for(@post) do |f| %>
+  <% if @post.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+      <% @post.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br>
+    <%= f.text_field :title %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/spec/dummy/app/views/posts/index.html.erb

@@ -0,0 +1,26 @@
+<h1>Listing posts</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Title</th>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @posts.each do |post| %>
+      <tr>
+        <td><%= post.title %></td>
+
+        <%= voting_for post %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Post', new_post_path %>

data/spec/dummy/app/views/posts/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New post</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', posts_path %>

data/spec/dummy/app/views/sessions/new.html.erb

@@ -0,0 +1,18 @@
+<p id="error"><%= flash[:error] %></p>
+
+<h1>Login</h1>
+
+<%= form_tag sessions_path do %>
+
+  <%= label_tag :username %>
+  <%= text_field_tag :username %>
+
+  <br>
+
+  <%= label_tag :password %>
+  <%= password_field_tag :password %>
+
+  <br>
+
+  <%= submit_tag "Login!" %>
+<% end %>

data/spec/dummy/app/views/users/_form.html.erb

@@ -0,0 +1,25 @@
+<%= form_for(@user) do |f| %>
+  <% if @user.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
+
+      <ul>
+      <% @user.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :username %><br>
+    <%= f.text_field :username %>
+  </div>
+  <div class="field">
+    <%= f.label :password %><br>
+    <%= f.password_field :password %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/spec/dummy/app/views/users/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New user</h1>
+
+<%= render 'form' %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run