neutral 0.0.1

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

@@ -0,0 +1,11 @@
+$(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' %>");
+
+});

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/neutral/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/impartial.yml

@@ -0,0 +1,6 @@
+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!"
+  

data/config/routes.rb

@@ -0,0 +1,3 @@
+Neutral::Engine.routes.draw do
+  resources :votes, only: [:create, :update, :destroy]
+end

data/lib/generators/neutral/formats.rb

@@ -0,0 +1,16 @@
+module Neutral
+  module Formats
+    def css_format
+      return [css_manifest('.css'), ' *='] if File.exist? css_manifest('.css')
+      return [css_manifest('.css.sass'), ' //='] if File.exists? css_manifest('.css.sass')
+      return [css_manifest('.sass'), ' //='] if File.exist? css_manifest('.sass')
+      return [css_manifest('.css.scss'), ' //='] if File.exist? css_manifest('.css.scss')
+      return [css_manifest('.scss'), ' //='] if File.exist? css_manifest('.scss')
+    end
+
+    private
+    def css_manifest(extension)
+      "app/assets/stylesheets/application#{extension}"
+    end
+  end
+end

data/lib/generators/neutral/install/install_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/migration'
+require File.expand_path('../../formats', __FILE__)
+
+module Neutral
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      include Neutral::Formats
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def migrations
+        migration_template "votes.rb", "db/migrate/create_neutral_votes"
+        migration_template "votings.rb", "db/migrate/create_neutral_votings"
+      end
+
+      def routes
+        route "neutral"
+      end
+
+      def locale
+        template "locale.yml", "config/locales/neutral.yml"
+      end
+
+      def stylesheet
+        if File.binread(css_format[0]).include? "require neutral"
+          say_status "skipped", "insert into '#{css_format[0]}'", :yellow
+        else
+          insert_into_file css_format[0], "\n#{css_format[1]} require neutral\n", after: /require_self/
+        end
+      end
+
+      def initializer
+        template "initializer.rb", "config/initializers/neutral.rb"
+      end
+
+      private
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+ end

data/lib/generators/neutral/install/templates/initializer.rb

@@ -0,0 +1,41 @@
+#Neutral engine Initializer
+
+Neutral.configure do |config|
+  # Set to false wheter a voter cannot change(i.e. update or delete) his vote.
+  #config.can_change = true
+
+  # Configure method providing a voter instance.
+  # Also make sure your current voter method is accessible from your ApplicationController
+  # as a helper_method.
+  #config.current_voter_method = :current_user
+
+  # Determine wheter a voter is required to be logged in. Setting to false
+  # is not recommended.
+  #config.require_login = true
+
+  # Define a vote owner class(usually User, Client, Customer)
+  #config.vote_owner_class = 'User'
+
+  # Define default icon set. Used when no explicit icon set for helper
+  # 'voting_for' is passed.
+  #config.default_icon_set = :thumbs
+end
+
+# You can also define your custom icon set providing valid FontAwesome icon class definitions for
+# positive, negative and remove icon. You cannot override icon sets that already exist('thumbs' and 'operations' by default).
+# Beware of typos and non-existent FontAwesome icon classes.
+# Then you can used your own icon set by passing its name to the view helper : 'voting_for voteable, icons: :mysupericons'
+
+# Neutral.define do
+#   set :myicons do
+#     positive "fa-plus-circle"
+#     negative "fa-minus-circle"
+#     remove   "fa-times"
+#   end
+#
+#   set :mythumbs do
+#     positive "fa-thumbs-up"
+#     negative "fa-thumbs-down"
+#     remove "fa-times"
+#   end
+# end

data/lib/generators/neutral/install/templates/locale.yml

@@ -0,0 +1,5 @@
+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!"

data/lib/generators/neutral/install/templates/votes.rb

@@ -0,0 +1,12 @@
+class CreateNeutralVotes < ActiveRecord::Migration
+  def change
+    create_table :neutral_votes do |t|
+      t.string :voteable_type
+      t.integer :voteable_id
+      t.integer :voter_id
+      t.integer :value
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/neutral/install/templates/votings.rb

@@ -0,0 +1,12 @@
+class CreateNeutralVotings < ActiveRecord::Migration
+  def change
+    create_table :neutral_votings do |t|
+      t.string :votingable_type
+      t.integer :votingable_id
+      t.integer :positive, default: 0
+      t.integer :negative, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/neutral/uninstall/templates/drop_neutral_votes_table.rb

@@ -0,0 +1,9 @@
+class DropNeutralVotesTable < ActiveRecord::Migration
+  def up
+    drop_table :neutral_votes
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/neutral/uninstall/templates/drop_neutral_votings_table.rb

@@ -0,0 +1,9 @@
+class DropNeutralVotingsTable < ActiveRecord::Migration
+  def up
+    drop_table :neutral_votings
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/neutral/uninstall/uninstall_generator.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../../formats', __FILE__)
+
+module Neutral
+  module Generators
+    class UninstallGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      include Neutral::Formats
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def remove_route
+        comment_lines "config/routes.rb", /neutral/
+      end
+
+      def remove_locale
+        remove_file "config/locales/neutral.yml"
+      end
+
+      def remove_stylesheet
+        if File.binread(css_format[0]).include? "require neutral"
+          gsub_file css_format[0], "\n#{css_format[1]} require neutral\n", ""
+        else
+          say_status("skipped", "remove from '#{css_format[0]}'", :yellow)
+        end
+      end
+
+      def remove_database_entities
+        -> {
+          migration_template "drop_neutral_votes_table.rb", "db/migrate/drop_neutral_votes_table"
+          migration_template "drop_neutral_votings_table.rb", "db/migrate/drop_neutral_votings_table"
+
+          rake("db:migrate")
+
+          Dir.glob("db/migrate/*").keep_if { |f| f.include?("neutral") }.each do |file|
+            remove_file(file)
+          end if yes?("Remove also remaining migration files?")
+
+        }.call if yes?("Remove database entities?('neutral_votes' and 'neutral_votings' tables)")
+      end
+
+      def remove_initializer
+        remove_file "config/initializers/neutral.rb"
+      end
+
+      private
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S%6N")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end

data/lib/neutral/configuration.rb

@@ -0,0 +1,27 @@
+module Neutral
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    yield config if block_given?
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :can_change
+    config_accessor :current_voter_method
+    config_accessor :require_login
+    config_accessor :vote_owner_class
+    config_accessor :default_icon_set
+  end
+
+  configure do |config|
+    config.can_change = true
+    config.current_voter_method = :current_user
+    config.require_login = true
+    config.vote_owner_class = 'User'
+    config.default_icon_set = :thumbs
+  end
+end

data/lib/neutral/engine.rb

@@ -0,0 +1,28 @@
+module Neutral
+  class Engine < ::Rails::Engine
+    isolate_namespace Neutral
+
+    initializer 'extensions' do
+      ::ActiveSupport.on_load(:active_record) { extend Neutral::Model::ActiveRecordExtension }
+      ::ActiveSupport.on_load(:action_view) { include Neutral::Helpers::ActionViewExtension }
+      ::ActionDispatch::Routing::Mapper.send(:include, Neutral::Helpers::Routes)
+    end
+
+    config.after_initialize do
+      ::ApplicationController.class_eval do
+        alias_method :current_voter, Neutral.config.current_voter_method
+        helper_method :current_voter
+      end
+
+      require 'neutral/application_controller'
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets = false
+      g.helpers = false
+    end
+  end
+end
+

data/lib/neutral/errors.rb

@@ -0,0 +1,11 @@
+module Neutral
+  module Errors
+    class InvalidVoteableObject < StandardError;end
+    class RequireLogin < StandardError;end
+    class InvalidVoterInstance < StandardError;end
+    class CannotChange < StandardError;end
+    class DuplicateVote < StandardError;end
+    class UndefinedIconSet < StandardError;end
+    class AlreadyDefinedIconSet < StandardError;end
+  end
+end

data/lib/neutral/helpers/action_view_extension.rb

@@ -0,0 +1,19 @@
+module Neutral
+  module Helpers
+    module ActionViewExtension
+      def voting_for(*args)
+        voteable = args.shift
+        options = args.extract_options!.merge(voter: current_voter)
+
+        not_voteable(voteable) unless voteable.is_a?(Neutral::Model::ActiveRecordExtension::Voteable)
+
+        Neutral::VotingBuilder::Builder.new(voteable, options).build
+      end
+
+      private
+      def not_voteable(voteable)
+        raise Neutral::Errors::InvalidVoteableObject, "#{voteable.inspect} is not a voteable object. Try adding 'neutral' into your object's model class definition."
+      end
+    end
+  end
+end

data/lib/neutral/helpers/routes.rb

@@ -0,0 +1,9 @@
+module Neutral
+  module Helpers
+    module Routes
+      def neutral
+        mount Neutral::Engine => '/neutral', as: 'neutral'
+      end
+    end
+  end
+end

data/lib/neutral/icons/collection.rb

@@ -0,0 +1,55 @@
+module Neutral
+  module Icons
+    class Collection
+      DEFAULTS = {
+        thumbs: {
+          positive: 'fa-thumbs-o-up',
+          negative: 'fa-thumbs-o-down',
+          remove: 'fa-times'
+          },
+        operations: {
+          positive: 'fa-plus-circle',
+          negative: 'fa-minus-circle',
+          remove: 'fa-times'
+        }
+      }.freeze
+
+      def initialize
+        DEFAULTS.each do |name, definitions|
+          define!(name, definitions)
+        end
+      end
+
+      def add(set)
+        already_defined(set.name) if exists? set.name
+        define!(set.name, set.definitions)
+      end
+
+      private
+
+      class Definitions < Struct.new(:positive, :negative, :remove)
+        [:positive=, :negative=, :remove=].each { |method| undef_method method }
+      end
+
+      def define!(name, definitions)
+        class_eval do
+          define_method(name) do
+            Definitions.new definitions[:positive], definitions[:negative], definitions[:remove]
+          end
+        end
+      end
+
+      def exists?(name)
+        respond_to? name
+      end
+
+      def already_defined(name)
+        raise Neutral::Errors::AlreadyDefinedIconSet, "Icon set '#{name}' is already defined"
+      end
+
+      def method_missing(name)
+        raise Neutral::Errors::UndefinedIconSet, "Icon set '#{name}' is not defined"
+      end
+    end
+  end
+end

data/lib/neutral/icons/set.rb

@@ -0,0 +1,22 @@
+module Neutral
+  module Icons
+    class Set
+      attr_reader :definitions
+      def initialize(name, &block)
+        @name = name
+        @definitions = Neutral.icons.send(Neutral.config.default_icon_set).to_h
+        instance_eval(&block) if block_given?
+      end
+
+      def name
+        @name.to_sym
+      end
+
+      [:positive, :negative, :remove].each do |icon|
+        define_method(icon) do |definition|
+          definitions[icon] = definition.to_s
+        end
+      end
+    end
+  end
+end

data/lib/neutral/model/active_record_extension.rb

@@ -0,0 +1,31 @@
+module Neutral
+  module Model
+    module ActiveRecordExtension
+      def neutral
+        include Voteable
+      end
+
+      def neutral_voter
+        include Voter
+      end
+
+      module Voteable
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :votes, as: :voteable, class_name: Neutral::Vote, dependent: :destroy
+          has_one :voting, as: :votingable, class_name: Neutral::Voting, dependent: :destroy
+          has_many :voters, through: :votes, source: :voter
+        end
+      end
+
+      module Voter
+        extend ActiveSupport::Concern
+
+        included do
+          has_many :votes_given, class_name: Neutral::Vote, foreign_key: :voter_id
+        end
+      end
+    end
+  end
+end

data/lib/neutral/model/vote_cached.rb

@@ -0,0 +1,32 @@
+module Neutral
+  module Model
+    module VoteCached
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :voting, to: :voteable
+
+        after_create :add_vote_to_voting
+        after_update :edit_vote_within_voting
+        after_destroy :remove_vote_from_voting
+      end
+
+      def add_vote_to_voting
+        if voting
+          voting.add_to_existing(nature)
+        else
+          Voting.init(self)
+          clear_association_cache
+        end
+      end
+
+      def edit_vote_within_voting
+        voting.edit nature
+      end
+
+      def remove_vote_from_voting
+        voting.remove nature
+      end
+    end
+  end
+end

data/lib/neutral/version.rb

@@ -0,0 +1,3 @@
+module Neutral
+  VERSION = "0.0.1"
+end

data/lib/neutral/voting_builder/builder.rb

@@ -0,0 +1,42 @@
+module Neutral
+  module VotingBuilder
+    class Builder
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::OutputSafetyHelper
+      include Elements
+
+      attr_reader :voteable, :voter, :icons, :difference
+      def initialize(voteable, options)
+        @voteable = voteable
+        @voter = options[:voter]
+        @icons = options[:icons] || Neutral.config.default_icon_set
+        @difference = options[:difference]
+      end
+
+      def build
+        content_tag :div, elements, class: 'neutral'
+      end
+
+      private
+      def elements
+        safe_join(structure.map { |element| send(element) })
+      end
+
+      def voting
+        voteable.voting || Neutral::Voting.new
+      end
+
+      def vote
+        @vote ||= voter && voteable.votes.where(voter_id: voter.id).first_or_initialize || voteable.votes.new
+      end
+
+      def router
+        @router ||= Router.new vote
+      end
+
+      def structure
+        Structure.new(vote.persisted?, difference).to_a
+      end
+    end
+  end
+end

data/lib/neutral/voting_builder/elements/link.rb

@@ -0,0 +1,46 @@
+module Neutral
+  module VotingBuilder
+    module Elements
+      class Link
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::UrlHelper
+
+        def initialize(router, icon)
+          @router = router
+          @icon = icon
+        end
+
+        private
+        def fa_icon
+          "fa #{@icon}"
+        end
+
+        def path
+          @router[:path]
+        end
+
+        def verb
+          @router[:method]
+        end
+
+        class Positive < Link
+          def to_s
+            link_to content_tag(:i, nil, class: fa_icon), path, class: 'positive', method: verb, remote: true
+          end
+        end
+
+        class Negative < Link
+          def to_s
+            link_to content_tag(:i, nil, class: fa_icon), path, class: 'negative', method: verb, remote: true
+          end
+        end
+
+        class Remove < Link
+          def to_s
+            link_to content_tag(:i, nil, class: fa_icon), path, class: 'remove', method: verb, remote: true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neutral/voting_builder/elements/span.rb

@@ -0,0 +1,41 @@
+module Neutral
+  module VotingBuilder
+    module Elements
+      class Span
+        include ActionView::Helpers::TagHelper
+
+        def initialize(total)
+          @total = total
+        end
+
+        private
+        def total
+          @total.nonzero?
+        end
+
+        class Positive < Span
+          def to_s
+            content_tag :span, total, id: 'positive'
+          end
+        end
+
+        class Negative < Span
+          def to_s
+            content_tag :span, total, id: 'negative'
+          end
+        end
+
+        class Difference < Span
+          def to_s
+            content_tag :span, total.try(:abs), class: color, id: 'difference'
+          end
+
+          private
+          def color
+            total > 0 ? 'positive' : 'negative' if total
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neutral/voting_builder/elements.rb

@@ -0,0 +1,23 @@
+require 'neutral/voting_builder/elements/link'
+require 'neutral/voting_builder/elements/span'
+
+module Neutral
+  module VotingBuilder
+    module Elements
+      private
+
+      %w[positive negative difference].each do |span|
+        define_method("#{span}_span") do
+          Span.const_get(span.capitalize).new voting.send(span)
+        end
+      end
+
+
+      %w[positive negative remove].each do |link|
+        define_method("#{link}_link") do
+          Link.const_get(link.capitalize).new router[link], Neutral.icons.send(icons).send(link)
+        end
+      end
+    end
+  end
+end