popstar4 1.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmU5NzgwYjYxZDA5MDlhZTUxNjk0N2M2ZjI1YjNiNzA4NWZhYTE0MQ==
+  data.tar.gz: !binary |-
+    OWNlMmRkOTk3YTEyYmQ3ODE0NzY5MDFjMzk3MjJiNTNmMDdkNzQ2OA==
+SHA512:
+  metadata.gz: !binary |-
+    OWVmOWM0MWQ1YjI0MzQzMDZlZmNiNTc1OTlkNzgxMWVkYzc2Mjk2NWZlNzJl
+    ZDU1ZTcwOGM3NWQwYjNmZDYzYjBlZmEyNTdiYzkxNzY0ZmUyZjQ5NDI3ZmNi
+    ZjY3YzQyZDYxMjVkNDg1ZDJhZmVlYzA3MTI0NDA1ZmQ4NGI2MWM=
+  data.tar.gz: !binary |-
+    N2Q2MjQxYjAzMDY3YWFkMjIzZjUxYmI4ODdkOGQwNDczMWM0YzZlNjg2OTM2
+    N2FlOWYzYmJiN2E4YTllZDVhYWQxY2JiNjM5Yzk0MjNiZGEzNTY0NzZjOWU4
+    OTdlNTRjMzdjOGNmZTlmMDVhYmY5OGEzZjdkYWM5ZWFjZmE2ZDE=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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,56 @@
+# Popstar4
+Evolution of [Popstar repo][lps] for Rails4
+
+____________________________________
+
+
+Popularity system for your Rails models.
+
+## Installation
+
+Put this in your gemfile:
+
+`gem 'popstar4'`
+
+## Usage
+
+Define your badge rules in a PopularityRules class
+
+```
+class PopularityRules
+  include Popstar4::Popularity
+
+  def initialize
+    popularity_for :voteable do
+      on :create, Vote, :rate => proc { |vote| vote.rate*2 }
+      on :update, Vote, :rate => proc { |vote| (vote.rate - vote.rate_was)*2 }
+    end
+
+    popularity_for :question do
+      on :create, Answer, :rate => 2
+    end
+
+    popularity_for :viewable do
+      on :create, ViewsCount
+    end
+
+    popularity_for :widget do
+      on :create, Comment
+      on :create, Question, :rate => 2
+      on :create, Answer, :rate => 3
+    end
+  end
+end
+```
+
+## Supported ORMS
+
+- Mongoid
+
+## TODO
+
+- Add support for ActiveRecord
+- Add rake tasks to migrate popular models after defining rules
+
+
+[lps]: <https://github.com/responsa/popstar>

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Popstar4'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/app/models/popularity_rules.rb

@@ -0,0 +1,6 @@
+class PopularityRules
+  include Popstar4::Popularity
+
+  def initialize
+  end
+end

data/config/initializers/boot.rb

@@ -0,0 +1 @@
+PopularityRules.instance

data/lib/popstar.rb

@@ -0,0 +1,8 @@
+require 'popstar4/engine'
+require 'popstar4/popular'
+require 'popstar4/popularity'
+require 'popstar4/rule_group'
+require 'popstar4/migration'
+
+module Popstar4
+end

data/lib/popstar4/engine.rb

@@ -0,0 +1,5 @@
+module Popstar4
+  class Engine < ::Rails::Engine
+    isolate_namespace Popstar4
+  end
+end

data/lib/popstar4/migration.rb

@@ -0,0 +1,27 @@
+module Popstar4
+  class Migration
+    @@rules = {}
+
+    class << self
+      def up
+        @@rules.each do |target, rules|
+          rules.each do |rule|
+            if rule[:action] == :create
+              rule[:model].all.each do |model|
+                model.send(target).try(:inc, :popularity, rule[:rate].call(model))
+              end
+            end
+          end
+        end
+      end
+
+      def rules
+        @@rules || {}
+      end
+
+      def rules=(rules)
+        @@rules ||= rules
+      end
+    end
+  end
+end

data/lib/popstar4/popular.rb

@@ -0,0 +1,7 @@
+module Popstar4
+  module Popular
+    def self.included(base)
+      base.field :popularity, :type => Integer, :default => 0
+    end
+  end
+end

data/lib/popstar4/popularity.rb

@@ -0,0 +1,11 @@
+module Popstar4
+  module Popularity
+    def self.included(base)
+      base.send :include, Singleton
+    end
+
+    def popularity_for(target, &block)
+      RuleGroup.new(target, &block)
+    end
+  end
+end

data/lib/popstar4/rule_group.rb

@@ -0,0 +1,42 @@
+module Popstar4
+  class RuleGroup
+    def initialize(target, &block)
+      @target = target
+      instance_eval(&block) if block_given?
+    end
+
+    def on(action, model, *args)
+      options = args.extract_options!
+      options.reverse_merge!(
+        :rate => 1
+      )
+
+      rate = begin
+        if options[:rate].respond_to?(:call)
+          options[:rate]
+        else
+          proc { options[:rate] }
+        end
+      end
+
+      target = @target
+
+      if Popstar4::Migration.rules[target].present?
+        Popstar4::Migration.rules[target] << { :action => action, :model => model, :rate => rate }
+      else
+        Popstar4::Migration.rules[target] = [{ :action => action, :model => model, :rate => rate }]
+      end
+
+      increase_popularity = proc do |model|
+        model.send(target).inc(:popularity, rate.call(model))
+      end
+
+      decrease_popularity = proc do |model|
+        model.try(:send, target).try(:inc, :popularity, -rate.call(model))
+      end
+
+      model.send("after_#{action}", increase_popularity)
+      model.send("after_destroy", decrease_popularity) if action == :create
+    end
+  end
+end

data/lib/popstar4/version.rb

@@ -0,0 +1,3 @@
+module Popstar4
+  VERSION = "1.0.1"
+end

data/lib/tasks/popstar_tasks.rake

@@ -0,0 +1,6 @@
+namespace :popstar4 do
+  desc "Migrates the database to new popularity rules"
+  task :migrate => :environment do
+    Popstar4::Migration.up
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: popstar4
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alex Zanardo
+- Matteo Depalo
+- Eugenio Depalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  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: Popstar lets you add rules to determine your rails4 models popularity.
+email:
+- info@alexzanardo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/popularity_rules.rb
+- config/initializers/boot.rb
+- lib/popstar.rb
+- lib/popstar4/engine.rb
+- lib/popstar4/migration.rb
+- lib/popstar4/popular.rb
+- lib/popstar4/popularity.rb
+- lib/popstar4/rule_group.rb
+- lib/popstar4/version.rb
+- lib/tasks/popstar_tasks.rake
+homepage: https://github.com/responsa/popstar4
+licenses: []
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Popularity system for your Rails4 models.
+test_files: []