popularable 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87cb950ce8fbcb244d3331dcf656e052dceeaaea
+  data.tar.gz: 26d563f2c0906f4972abd6b47d2e50f3474ed701
+SHA512:
+  metadata.gz: 777d98c936990f73114222162de22048daa5525c18171cbfe2aae061d4191d03077308078e4be1312058d150b2d228bdfd6fbb8aef2a8ee8207fe4c57827fd68
+  data.tar.gz: 94997b2e73c3cee9c47981d448f1484f124ea5bc97544475939a8acd34182f44b03e071f884c3ca418b3dcf02ef5df27ba696d852a7c0bcd763486196bf5ede3

data/.gitignore

@@ -0,0 +1,41 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp
+
+
+/solr/data/*
+/solr/development/*
+/solr/default/data/*
+/solr/pids/*
+sunspot-solr.pid
+
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+/vendor/bundle
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+.DS_Store
+*.swp
+
+# Ignore application configuration
+/config/application.yml

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2015 Jeff McFadden
+
+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,19 @@
+# popularable
+
+Add management for ordering your models by a historical popularity value.
+
+## Installation
+
+    gem 'popularable'
+
+    $ bundle install
+    $ bundle exec rails g popularable:install
+    $ bundle exec rake db:migrate
+
+## Usage
+
+    class Widget < ActiveRecord::Base
+      include Popularable::Concern
+      
+      
+    widget.first.bump_popularity!

data/lib/concerns/popularable.rb

@@ -0,0 +1,32 @@
+module Popularable
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      # scope :order_by_recent_popularity, -> { .joins( "LEFT OUTER JOIN popularable_popularity_events ON (" + self.to_s.pluralize.underscore + ".id = popularable_popularity_events.popularable_id AND popularable_popularity_events.popularable_type = '" + self.to_s + "')").where( ["popularable_popularity_events.popularity_event_date >= ?", 1.month.ago] ).group( self.to_s.pluralize.underscore + ".id" ).order( "popularity DESC" ) }
+
+      scope :popular_today,      -> { find_by_sql( ["SELECT " + self.table_name + ".*, 0 + SUM(popularable_popularity_events.popularity) AS popularity FROM " + self.table_name + " LEFT OUTER JOIN popularable_popularity_events ON (" + self.table_name + ".id = popularable_popularity_events.popularable_id AND popularable_popularity_events.popularable_type = '" + self.to_s + "') WHERE popularable_popularity_events.popularity_event_date >= ? GROUP BY " + self.table_name + ".id ORDER BY popularity DESC", Time.now.to_date] ) }
+
+      scope :popular_this_week,  -> { find_by_sql( ["SELECT " + self.table_name + ".*, 0 + SUM(popularable_popularity_events.popularity) AS popularity FROM " + self.table_name + " LEFT OUTER JOIN popularable_popularity_events ON (" + self.table_name + ".id = popularable_popularity_events.popularable_id AND popularable_popularity_events.popularable_type = '" + self.to_s + "') WHERE popularable_popularity_events.popularity_event_date >= ? GROUP BY " + self.table_name + ".id ORDER BY popularity DESC", Time.now.beginning_of_week.to_date] ) }
+
+      scope :popular_this_month, -> { find_by_sql( ["SELECT " + self.table_name + ".*, 0 + SUM(popularable_popularity_events.popularity) AS popularity FROM " + self.table_name + " LEFT OUTER JOIN popularable_popularity_events ON (" + self.table_name + ".id = popularable_popularity_events.popularable_id AND popularable_popularity_events.popularable_type = '" + self.to_s + "') WHERE popularable_popularity_events.popularity_event_date >= ? GROUP BY " + self.table_name + ".id ORDER BY popularity DESC", Time.now.beginning_of_month.to_date] ) }
+
+      scope :popular_this_year,  -> { find_by_sql( ["SELECT " + self.table_name + ".*, 0 + SUM(popularable_popularity_events.popularity) AS popularity FROM " + self.table_name + " LEFT OUTER JOIN popularable_popularity_events ON (" + self.table_name + ".id = popularable_popularity_events.popularable_id AND popularable_popularity_events.popularable_type = '" + self.to_s + "') WHERE popularable_popularity_events.popularity_event_date >= ? GROUP BY " + self.table_name + ".id ORDER BY popularity DESC", Time.now.beginning_of_year.to_date] ) }
+
+      scope :popular_all_time,   -> { find_by_sql( ["SELECT " + self.table_name + ".*, 0 + SUM(popularable_popularity_events.popularity) AS popularity FROM " + self.table_name + " LEFT OUTER JOIN popularable_popularity_events ON (" + self.table_name + ".id = popularable_popularity_events.popularable_id AND popularable_popularity_events.popularable_type = '" + self.to_s + "') GROUP BY " + self.table_name + ".id ORDER BY popularity DESC"] ) }
+
+      has_many :popularable_popularity_events, as: :popularable
+
+      def self.has_popularable_concern?
+        true
+      end
+
+    end
+
+    def bump_popularity!( popularity_add_value = 1, popularity_event_time = Time.now )
+      popularable_popularity_event = self.popularable_popularity_events.find_or_create_by( popularity_event_date: popularity_event_time.to_date )
+
+      popularable_popularity_event.update_attributes( popularity: popularable_popularity_event.popularity.to_i + popularity_add_value )
+    end
+  end
+end

data/lib/generators/popularable/install_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators'
+
+module Popularable
+  class InstallGenerator < ::Rails::Generators::Base
+    desc "Install a migration for the popularable gem"
+    source_root File.expand_path('../generators', __FILE__)
+
+    def create_migration_file
+      destination = "db/migrate/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_popularable_installation_migration.rb".gsub(" ", "")
+      migration_name = "PopularableInstallationMigration".gsub(" ", "")
+      count = nil
+      i = 1
+      while !Dir.glob("db/migrate/*_popularable_installation_migration.rb".gsub(" ", "")).empty?
+        i += 1
+        count = "_#{i}"
+        destination = "db/migrate/#{Time.now.utc.strftime('%Y%m%d%H%M%S')}_popularable_installation_migration.rb".gsub(" ", "")
+        migration_name = "PopularableInstallationMigration#{i}".gsub(" ", "")
+      end
+      create_file destination, <<-FILE
+class #{migration_name} < ActiveRecord::Migration
+  def change
+    create_table :popularable_popularity_events do |t|
+      t.string  :popularable_type
+      t.integer :popularable_id
+
+      t.date :popularity_event_date
+      t.integer :popularity, default: 0
+
+      t.timestamps null: false
+    end
+
+    add_index :popularable_popularity_events, [:popularable_type, :popularable_id], name: "index_popularable_popularity_events_type_id"
+    add_index :popularable_popularity_events, [:popularity_event_date, :popularable_type, :popularable_id, :popularity], name: "index_popularable_popularity_events_type_id_popularity"
+    add_index :popularable_popularity_events, :popularity
+  end
+end
+FILE
+    end
+  end
+end

data/lib/models/popularable_popularity_event.rb

@@ -0,0 +1,4 @@
+class PopularablePopularityEvent < ActiveRecord::Base
+  belongs_to :popularable, polymorphic: true
+
+end

data/lib/popularable.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'concerns/popularable'
+require 'popularable/popularable'
+require 'models/popularable_popularity_event'
+require 'popularable/engine'
+require 'popularable/version'
+
+# ActiveSupport.on_load(:active_record) do
+#   include Trendable::Manager
+# end
+
+module Popularable
+  class Manager
+  end
+end

data/lib/popularable/engine.rb

@@ -0,0 +1,6 @@
+module Popularable
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/popularable/popularable.rb

@@ -0,0 +1,2 @@
+module Popularable
+end

data/lib/popularable/version.rb

@@ -0,0 +1,5 @@
+module Popularable
+  module Rails
+    VERSION = "1.1.0"
+  end
+end

data/popularable.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/popularable/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "popularable"
+  s.version     = Popularable::Rails::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors = ["Jeff McFadden"]
+  s.date = "2015-08-27"
+  s.description = "Organize your models by a historical popularity value"
+  s.email = "jeff@forgeapps.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt"
+  ]
+  s.files        = `git ls-files`.split("\n")
+
+  s.homepage = "http://github.com/ForgeApps/popularable"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = Popularable::Rails::VERSION
+  s.summary = "Organize your models by a historical popularity value"
+
+  s.add_dependency "activesupport", ">= 4.1.0"
+  s.add_dependency "sidekiq"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: popularable
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Jeff McFadden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Organize your models by a historical popularity value
+email: jeff@forgeapps.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/concerns/popularable.rb
+- lib/generators/popularable/install_generator.rb
+- lib/models/popularable_popularity_event.rb
+- lib/popularable.rb
+- lib/popularable/engine.rb
+- lib/popularable/popularable.rb
+- lib/popularable/version.rb
+- popularable.gemspec
+homepage: http://github.com/ForgeApps/popularable
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Organize your models by a historical popularity value
+test_files: []