views_count 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6eccaf5cb6ddabc13f1af49806569dbcc265b3c5
+  data.tar.gz: 49ea063b00f93a4c6d95cf31694b54f8c5227bd2
+SHA512:
+  metadata.gz: 299ab7d8e404d64e4bc8745865ceeef1a957252409db825bdfe50d97e94cebde11b8d95b7635c126700218fe859860bbf6b9db36432d5c6146fd22c1a33221db
+  data.tar.gz: ecf72a2fb3eb456ea7687fe5d4e1ac3ade88fb75aa4ad59b40c3d73237b1b6837f2657aa544bd66c4db78c8d529d310b5cda193fc08862f1990c969627ec5c39

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in views_count.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ben Zhang
+
+MIT License
+
+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,40 @@
+# ViewsCount
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'views_count'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install views_count
+
+Generate the config file and table migration
+
+    $ rails g views_count
+
+This allows you to attach views count method to an AR model instance. By default, 
+it requires a column views_count to keep track of the view hits. You can specify column_name to whatever fits your situation.
+
+    class Topic < ActiveRecord::Base
+      has_views_count
+    end
+    
+    class Topic < ActiveRecord::Base
+      has_views_count column_name: 'views_count'
+    end    
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/views_count/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/active_record/templates/create_view_items_table.rb

@@ -0,0 +1,18 @@
+class CreateViewItemsTable < ActiveRecord::Migration
+  def self.up
+    create_table :view_items, force: true do |t|
+      t.string   :target_type
+      t.integer  :target_id
+      t.integer  :user_id
+      t.string   :ip_address
+      t.datetime :viewed_on
+    end
+
+    add_index :view_items,  [:target_type, :target_id, :user_id], unique: true
+    add_index :view_items,  [:target_type, :target_id, :ip_address], unique: true
+  end
+
+  def self.down
+    drop_table :view_items
+  end
+end

data/lib/generators/active_record/views_count_generator.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module Generators
+    class ViewsCountGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'create_view_items_table.rb', 'db/migrate/create_view_items_table.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/views_count.rb

@@ -0,0 +1,4 @@
+# ViewsCount.setup do |config|
+  # Define time frame
+  # config.time_frame = 24.hours
+# end

data/lib/generators/views_count_generator.rb

@@ -0,0 +1,13 @@
+module ViewsCount
+  module Generators
+    class ViewsCountGenerator < Rails::Generators::Base
+      hook_for :orm
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config_file
+        template 'views_count.rb', 'config/initializers/views_count.rb'
+      end
+
+    end
+  end
+end

data/lib/models/views_count/view_item.rb

@@ -0,0 +1,10 @@
+module ViewsCount
+  class ViewItem < ActiveRecord::Base
+    belongs_to :target, polymorphic: true
+
+    if respond_to?(:attr_accessible)
+      attr_accessible :user_id, :viewed_on, :ip_address
+    end
+
+  end
+end

data/lib/models/views_count/views_countable.rb

@@ -0,0 +1,49 @@
+module ViewsCount
+  module ViewsCountable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def has_views_count(options = {})
+        has_many :view_items, as: :target, dependent: :destroy, class_name: 'ViewsCount::ViewItem'
+        @@views_count_options = {
+          counter_cache: true,
+          column_name:   :views_count,
+          unique:        true
+        }.merge(options)
+
+        class_eval do
+          def add_views_count(request, user = nil)
+            raise ArgumentError if request.nil? && user.nil?
+
+            view_item = if user.nil?
+              self.view_items.where(ip_address: request.remote_ip).last
+            else
+              self.view_items.where(user_id: user.id).last
+            end
+            
+            return if view_item and view_item.viewed_on >= ViewsCount.time_frame.ago
+            
+            if view_item
+              view_item.viewed_on = Time.now
+            else
+              view_item = self.view_items.build(ip_address: request.remote_ip, user_id: user.try(:id), viewed_on: Time.now)
+            end
+
+            begin
+              transaction do
+                view_item.save!
+                self.class.update_all("#{@@views_count_options[:column_name]} = COALESCE(\"#{@@views_count_options[:column_name]}\", 0) + 1", "id = #{id}")
+                self.reload
+              end
+            rescue ActiveRecord::RecordNotUnique
+            rescue ActiveRecord::RecordInvalid
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/views_count/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module ViewsCount
+  class Railtie < Rails::Railtie
+
+    initializer 'views_count.model' do |app|
+      require "models/views_count/views_countable.rb"
+      require "models/views_count/view_item.rb"
+      ActiveRecord::Base.send(:include, ViewsCount::ViewsCountable)
+    end
+
+  end
+end

data/lib/views_count/version.rb

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

data/lib/views_count.rb

@@ -0,0 +1,13 @@
+require "views_count/version"
+require "views_count/railtie"
+
+module ViewsCount
+  
+  mattr_accessor :time_frame
+  @@time_frame = 24.hours
+
+  # Load configuration from initializer
+  def self.setup
+    yield self
+  end
+end

data/views_count.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'views_count/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "views_count"
+  spec.version       = ViewsCount::VERSION
+  spec.authors       = ["Ben Zhang"]
+  spec.email         = ["bzbnhang@gmail.com"]
+  spec.summary       = %q{ViewsCount is a lightweight plugin to keep track of views of an ActiveRecord model.}
+  spec.description   = %q{ViewsCount is a lightweight plugin to keep track of views of an ActiveRecord model.}
+  spec.homepage      = "https://github.com/BenZhang/views_count"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: views_count
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: ViewsCount is a lightweight plugin to keep track of views of an ActiveRecord
+  model.
+email:
+- bzbnhang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/active_record/templates/create_view_items_table.rb
+- lib/generators/active_record/views_count_generator.rb
+- lib/generators/templates/views_count.rb
+- lib/generators/views_count_generator.rb
+- lib/models/views_count/view_item.rb
+- lib/models/views_count/views_countable.rb
+- lib/views_count.rb
+- lib/views_count/railtie.rb
+- lib/views_count/version.rb
+- views_count.gemspec
+homepage: https://github.com/BenZhang/views_count
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ViewsCount is a lightweight plugin to keep track of views of an ActiveRecord
+  model.
+test_files: []