browsing_history 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5579aa68af285099783e050c1f060c193d4e5761
+  data.tar.gz: 55d5a56f2ddcc0e2294febb4aa2ff1175ca85d42
+SHA512:
+  metadata.gz: 665329c030a0ec2e17f6120516c315d864a5540169f720e0f50b75ad15f30e541f7cbeff4bbd237b03dddb9d2ef78a5015c460de51036841983965e4935c54fb
+  data.tar.gz: 1d56e955901f795dd373eedde90853c2aa0234bcde80f70a593685338f09a9a5ebc7dc926421c7c27543a15c73394fafaa8a139401ccb789c1c472f3b5ee60e2

data/.gitignore

@@ -0,0 +1,15 @@
+*~
+.DS_Store
+.idea
+coverage
+rdoc
+Gemfile.lock
+TODO
+.rspec
+tags
+
+.bundle/
+log/
+pkg/
+.bundle/
+tmp/

data/.rspec

@@ -0,0 +1,2 @@
+-r spec_helper
+-r pry

data/.rubocop.yml

@@ -0,0 +1,89 @@
+inherit_from:
+    - ./.rubocop_todo.yml
+
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - !ruby/regexp /old_and_unused\.rb$/
+    - 'vendor/**/*'
+    - 'spec/test_app/**/*'
+  DisplayCopNames: true
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 110
+
+Metrics/CyclomaticComplexity:
+  Max: 6
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 3
+  CountKeywordArgs: false
+
+Metrics/PerceivedComplexity:
+  Max: 6
+
+Style/AlignHash:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: always
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space

data/.rubocop_todo.yml

@@ -0,0 +1,28 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-08 15:31:21 +0000 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AlignWith, SupportedStyles, AutoCorrect.
+Lint/EndAlignment:
+  Enabled: false
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 6
+
+# Offense count: 6
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 103
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+Style/CaseIndentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'sqlite3', platforms: :ruby
+gem 'rails', '~>4.2'
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    browsing_history (0.0.2)
+      redis (>= 3.0.2)
+      redis-namespace
+      redis-objects
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    ast (2.2.0)
+    builder (3.2.2)
+    byebug (8.2.4)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.1)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    parser (2.3.0.6)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    redis (3.3.0)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    redis-objects (1.2.1)
+      redis (>= 3.0.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.37.2)
+      parser (>= 2.3.0.4, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 0.3)
+    ruby-progressbar (1.7.5)
+    slop (3.6.0)
+    sprockets (3.6.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    timecop (0.8.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  browsing_history!
+  database_cleaner
+  generator_spec
+  pry
+  pry-byebug
+  rails (~> 4.2)
+  rspec
+  rspec-rails
+  rubocop
+  sqlite3
+  timecop
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 cluex
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 tkclimb
+
+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,2 @@
+# browsing_history
+Record browsing history by browser like users or something more simple and graceful.

data/README.rdoc

@@ -0,0 +1,3 @@
+= BrowsingHistory
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BrowsingHistory'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/browsing_history.gemspec

@@ -0,0 +1,34 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'browsing_history/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'browsing_history'
+  gem.version       = BrowsingHistory::VERSION
+  gem.authors       = %w(tkclimb)
+  gem.email         = %w(tkclimb0911@gmail.com)
+  gem.homepage      = 'https://github.com/cluex/browsing_history'
+  gem.summary       = 'Record browsing history more simple and graceful.'
+  gem.description   = <<-EOS
+Record browsing history by browser like users or something.
+it make that more simple and graceful as possible.
+  EOS
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = `git ls-files -- spec`.split("\n")
+  gem.require_paths = %w(lib)
+
+  gem.add_dependency 'redis', '>= 3.0.2'
+  gem.add_dependency 'redis-objects'
+  gem.add_dependency 'redis-namespace'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'generator_spec'
+  gem.add_development_dependency 'database_cleaner'
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-byebug'
+  gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'timecop'
+end

data/dump.rdb

@@ -0,0 +1 @@
+REDIS0006�ܳC�Z��V

data/lib/browsing_history/browser.rb

@@ -0,0 +1,66 @@
+module BrowsingHistory::Browser
+  def browsing_histories
+    @browsing_histories ||= Association.new(self)
+  end
+
+  def self.included(klass)
+    klass.include IdentifyMethods
+    klass.extend  IdentifyMethods
+  end
+
+  module IdentifyMethods
+    def browser_id
+      browser_instance? ? id : nil
+    end
+
+    def browser_type
+      browser_instance? ? self.class.to_s : to_s
+    end
+
+    def browser_class
+      browser_instance? ? self.class : self
+    end
+
+    def browser_instance?
+      !instance_of?(Object)
+    end
+  end
+
+  class Association
+    def initialize(browser)
+      @browser = browser
+    end
+
+    def recent(historizable, limit: 20)
+      BrowsingHistory::History.where(
+        browser: @browser,
+        historizable: historizable,
+        limit: limit
+      )
+    end
+
+    def previous(historizable, between, limit: 20)
+      BrowsingHistory::History.where(
+        browser: @browser,
+        historizable: historizable,
+        between: between,
+        limit: limit
+      )
+    end
+
+    def add(historizable)
+      BrowsingHistory::History.create(
+        browser: @browser,
+        historizable: historizable
+      )
+    end
+    alias << add
+
+    def count(historizable)
+      BrowsingHistory::History.count(
+        browser: @browser,
+        historizable: historizable
+      )
+    end
+  end
+end

data/lib/browsing_history/configuration.rb

@@ -0,0 +1,38 @@
+module BrowsingHistory::Configuration
+  # storage type
+  attr_writer :storage_types
+
+  # BrowsingHistory namespace
+  attr_writer :namespace
+
+  # cofigure method
+  def configure
+    yield self
+  end
+
+  # BrowsingHistory storage_types
+  #
+  # @return the BrowsingHistory storage. default of :redis if not set.
+  def storage_types
+    @storage_types ||= %i(redis active_record)
+  end
+
+  # BrowsingHistory storage
+  #
+  # @return the BrowsingHistory storage. default of :redis if not set.
+  def storage_type
+    @storage_type ||= storage_types.first
+  end
+
+  def storage_type=(type)
+    return false unless storage_types.incude?(type)
+    @storage_type = type
+  end
+
+  # BrowsingHistory namespace for Redis.
+  #
+  # @return the BrowsingHistory namespace. default of 'activity_feed' if not set.
+  def namespace
+    @namespace ||= 'browsing_history'
+  end
+end

data/lib/browsing_history/error.rb

@@ -0,0 +1,2 @@
+class BrowsingHistory::Error < StandardError
+end

data/lib/browsing_history/historizable.rb

@@ -0,0 +1,26 @@
+module BrowsingHistory::Historizable
+  def self.included(klass)
+    klass.include IdentifyMethods
+    klass.extend  IdentifyMethods
+  end
+
+  module IdentifyMethods
+    attr_accessor :target_storage
+
+    def historizable_id
+      historizable_instance? ? id : nil
+    end
+
+    def historizable_type
+      historizable_instance? ? self.class.to_s : to_s
+    end
+
+    def historizable_class
+      historizable_instance? ? self.class : self
+    end
+
+    def historizable_instance?
+      !instance_of?(Object)
+    end
+  end
+end

data/lib/browsing_history/history.rb

@@ -0,0 +1,85 @@
+require 'active_model'
+require 'browsing_history/storage'
+
+class BrowsingHistory::History
+  extend  ActiveModel::Callbacks
+  include ActiveModel::Model
+  include ActiveModel::Validations
+
+  include BrowsingHistory::Storage
+
+  class ArgumentError < BrowsingHistory::Error; end
+
+  attr_accessor :browser, :historizable, :expiration
+
+  define_model_callbacks :save
+
+  after_save :save_to_storage
+
+  validate :valid_browser, :valid_historizable
+
+  def initialize(browser: nil, historizable: nil)
+    @browser      = browser
+    @historizable = historizable
+  end
+
+  def save
+    valid? ? run_callbacks(:save) { true } : false
+  end
+
+  def save!
+    valid? ? run_callbacks(:save) { true } : raise_errors
+  end
+
+  class << self
+    def create(attributes = {})
+      instance = new(**attributes)
+      instance.save ? instance : false
+    end
+
+    def create!(attributes = {})
+      instance = new(**attributes)
+      instance.save!
+      instance
+    end
+
+    def where(browser: nil, historizable: nil, **opts)
+      return [] if !browser && !historizable
+
+      current_storage.fetch(browser, historizable, opts)
+    end
+
+    def count(browser: nil, historizable: nil)
+      return 0 if !browser && !historizable
+      current_storage.count(browser, historizable)
+    end
+  end
+
+  private
+
+  def save_to_storage
+    self.class.current_storage.add(browser, historizable)
+  end
+
+  def valid_browser
+    if !browser.respond_to?(:browser_id) &&
+        !browser.respond_to?(:browser_type)
+      errors.add :browser, ':browser in args is not browser!!'
+    end
+  end
+
+  def valid_historizable
+    if !historizable.respond_to?(:historizable_id) &&
+        !historizable.respond_to?(:historizable_type)
+      errors.add :historizable, ':historizable in args is not historizable!!'
+    end
+  end
+
+  def raise_errors
+    errors.each do |_, message|
+      if message =~ /args/
+        raise ArgumentError, message
+      end
+    end
+  end
+end