Updated style

Andrew Kane committed Mar 11, 2015
commit 866204554bff971b95d8c702102cfdb141d963a3
Showing 34 changed files with 73 additions and 84 deletions
.rubocop.yml +41 -0
@@ @@ -0,0 +1,41 @@
+ Lint/UnusedMethodArgument:
+ Enabled: false
+
+ Style/StringLiterals:
+ EnforcedStyle: double_quotes
+
+ Style/SpaceInsideHashLiteralBraces:
+ EnforcedStyle: no_space
+
+ Style/HashSyntax:
+ EnforcedStyle: ruby19
+
+ Style/Lambda:
+ Enabled: false
+
+ Style/Documentation:
+ Enabled: false
+
+ Style/SignalException:
+ Enabled: false
+
+ Metrics/AbcSize:
+ Enabled: false
+
+ Metrics/BlockNesting:
+ Enabled: false
+
+ Metrics/ClassLength:
+ Enabled: false
+
+ Metrics/CyclomaticComplexity:
+ Enabled: false
+
+ Metrics/LineLength:
+ Enabled: false
+
+ Metrics/MethodLength:
+ Enabled: false
+
+ Metrics/PerceivedComplexity:
+ Enabled: false
Gemfile +1 -1
@@ @@ -1,4 +1,4 @@
- source 'https://rubygems.org'
+ source "https://rubygems.org"
# Specify your gem's dependencies in ahoy.gemspec
gemspec
Rakefile +1 -1
@@ @@ -1,7 +1,7 @@
require "bundler/gem_tasks"
require "rake/testtask"
- task :default => :test
+ task default: :test
Rake::TestTask.new do |t|
t.libs << "test"
t.pattern = "test/**/*_test.rb"
ahoy_matey.gemspec +4 -4
@@ @@ -1,15 +1,15 @@
# coding: utf-8
- lib = File.expand_path('../lib', __FILE__)
+ lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
- require 'ahoy/version'
+ require "ahoy/version"
Gem::Specification.new do |spec|
spec.name = "ahoy_matey"
spec.version = Ahoy::VERSION
spec.authors = ["Andrew Kane"]
spec.email = ["andrew@chartkick.com"]
- spec.summary = %q{Simple, powerful visit tracking for Rails}
- spec.description = %q{Simple, powerful visit tracking for Rails}
+ spec.summary = "Simple, powerful visit tracking for Rails"
+ spec.description = "Simple, powerful visit tracking for Rails"
spec.homepage = "https://github.com/ankane/ahoy"
spec.license = "MIT"
app/controllers/ahoy/base_controller.rb +0 -1
@@ @@ -6,6 +6,5 @@ module Ahoy
def ahoy
@ahoy ||= Ahoy::Tracker.new(controller: self, api: true)
end
-
end
end
app/controllers/ahoy/events_controller.rb +0 -2
@@ @@ -1,6 +1,5 @@
module Ahoy
class EventsController < Ahoy::BaseController
-
def create
events =
if params[:name]
@@ @@ -29,6 +28,5 @@ module Ahoy
end
render json: {}
end
-
end
end
app/controllers/ahoy/visits_controller.rb +0 -2
@@ @@ -1,10 +1,8 @@
module Ahoy
class VisitsController < BaseController
-
def create
ahoy.track_visit
render json: {visit_id: ahoy.visit_id, visitor_id: ahoy.visitor_id}
end
-
end
end
ahoy/controller.rb b/lib/ahoy/controller.rb +0 -2
@@ @@ -2,7 +2,6 @@ require "request_store"
module Ahoy
module Controller
-
def self.included(base)
base.helper_method :current_visit
base.helper_method :ahoy
@@ @@ -31,6 +30,5 @@ module Ahoy
ahoy.track_visit(defer: !Ahoy.track_visits_immediately)
end
end
-
end
end
ahoy/deckhands/location_deckhand.rb b/lib/ahoy/deckhands/location_deckhand.rb +1 -3
@@ @@ -1,7 +1,6 @@
module Ahoy
module Deckhands
class LocationDeckhand
-
def initialize(ip)
@ip = ip
end
@@ @@ -33,7 +32,7 @@ module Ahoy
protected
def location
- if !@checked
+ unless @checked
@location =
begin
Geocoder.search(@ip).first
@@ @@ -45,7 +44,6 @@ module Ahoy
end
@location
end
-
end
end
end
ahoy/deckhands/request_deckhand.rb b/lib/ahoy/deckhands/request_deckhand.rb +0 -1
@@ @@ -43,7 +43,6 @@ module Ahoy
def screen_width
request.params["screen_width"]
end
-
end
end
end
ahoy/deckhands/technology_deckhand.rb b/lib/ahoy/deckhands/technology_deckhand.rb +0 -2
@@ @@ -1,7 +1,6 @@
module Ahoy
module Deckhands
class TechnologyDeckhand
-
def initialize(user_agent)
@user_agent = user_agent
end
@@ @@ -43,7 +42,6 @@ module Ahoy
def self.user_agent_parser
@user_agent_parser ||= UserAgentParser::Parser.new
end
-
end
end
end
ahoy/deckhands/traffic_source_deckhand.rb b/lib/ahoy/deckhands/traffic_source_deckhand.rb +0 -2
@@ @@ -1,7 +1,6 @@
module Ahoy
module Deckhands
class TrafficSourceDeckhand
-
def initialize(referrer)
@referrer = referrer
end
@@ @@ -18,7 +17,6 @@ module Ahoy
def self.referrer_parser
@referrer_parser ||= RefererParser::Parser.new
end
-
end
end
end
ahoy/deckhands/utm_parameter_deckhand.rb b/lib/ahoy/deckhands/utm_parameter_deckhand.rb +1 -3
@@ @@ -1,7 +1,6 @@
module Ahoy
module Deckhands
class UtmParameterDeckhand
-
def initialize(landing_page)
@landing_page = landing_page
end
@@ @@ -13,12 +12,11 @@ module Ahoy
end
end
- %w[utm_source utm_medium utm_term utm_content utm_campaign].each do |name|
+ %w(utm_source utm_medium utm_term utm_content utm_campaign).each do |name|
define_method name do
landing_params[name]
end
end
-
end
end
end
ahoy/engine.rb b/lib/ahoy/engine.rb +7 -11
@@ @@ -1,8 +1,7 @@
module Ahoy
class Engine < ::Rails::Engine
-
# from https://github.com/evrone/quiet_assets/blob/master/lib/quiet_assets.rb
- initializer "ahoy.middleware", after: "sprockets.environment" do |app|
+ initializer "ahoy.middleware", after: "sprockets.environment" do
next unless Ahoy.quiet
# Parse PATH_INFO by assets prefix
@@ @@ -12,19 +11,16 @@ module Ahoy
# Just create an alias for call in middleware
Rails::Rack::Logger.class_eval do
def call_with_quiet_ahoy(env)
- begin
- if env["PATH_INFO"].start_with?(AHOY_PREFIX)
- env[KEY] = Rails.logger.level
- Rails.logger.level = Logger::ERROR
- end
- call_without_quiet_ahoy(env)
- ensure
- Rails.logger.level = env[KEY] if env[KEY]
+ if env["PATH_INFO"].start_with?(AHOY_PREFIX)
+ env[KEY] = Rails.logger.level
+ Rails.logger.level = Logger::ERROR
end
+ call_without_quiet_ahoy(env)
+ ensure
+ Rails.logger.level = env[KEY] if env[KEY]
end
alias_method_chain :call, :quiet_ahoy
end
end
-
end
end
ahoy/geocode_job.rb b/lib/ahoy/geocode_job.rb +0 -1
@@ @@ -9,6 +9,5 @@ module Ahoy
end
visit.save!
end
-
end
end
ahoy/model.rb b/lib/ahoy/model.rb +1 -4
@@ @@ -1,6 +1,5 @@
module Ahoy
module Model
-
def visitable(name = nil, options = {})
if name.is_a?(Hash)
name = nil
@@ @@ -11,7 +10,7 @@ module Ahoy
belongs_to name, options
before_create :set_visit
end
- class_eval %Q{
+ class_eval %{
def set_visit
self.#{name} ||= RequestStore.store[:ahoy].try(:visit)
end
@@ @@ -32,9 +31,7 @@ module Ahoy
Deckhands::UtmParameterDeckhand.new(landing_page).landing_params
end
end
-
end
end
-
end
end
ahoy/stores/active_record_store.rb b/lib/ahoy/stores/active_record_store.rb +0 -2
@@ @@ -1,7 +1,6 @@
module Ahoy
module Stores
class ActiveRecordStore < BaseStore
-
def track_visit(options, &block)
visit =
visit_model.new do |v|
@@ @@ -56,7 +55,6 @@ module Ahoy
def event_model
::Ahoy::Event
end
-
end
end
end
ahoy/stores/active_record_token_store.rb b/lib/ahoy/stores/active_record_token_store.rb +10 -14
@@ @@ -1,7 +1,6 @@
module Ahoy
module Stores
class ActiveRecordTokenStore < BaseStore
-
def track_visit(options, &block)
visit =
visit_model.new do |v|
@@ @@ -61,18 +60,18 @@ module Ahoy
def exclude?
(!Ahoy.track_bots && bot?) ||
- (
- if Ahoy.exclude_method
- warn "[DEPRECATION] Ahoy.exclude_method is deprecated - use exclude? instead"
- if Ahoy.exclude_method.arity == 1
- Ahoy.exclude_method.call(controller)
+ (
+ if Ahoy.exclude_method
+ warn "[DEPRECATION] Ahoy.exclude_method is deprecated - use exclude? instead"
+ if Ahoy.exclude_method.arity == 1
+ Ahoy.exclude_method.call(controller)
+ else
+ Ahoy.exclude_method.call(controller, request)
+ end
else
- Ahoy.exclude_method.call(controller, request)
+ false
end
- else
- false
- end
- )
+ )
end
def user
@@ @@ -89,7 +88,6 @@ module Ahoy
end
class << self
-
def uses_deprecated_subscribers
warn "[DEPRECATION] Ahoy subscribers are deprecated"
@uses_deprecated_subscribers = true
@@ @@ -98,7 +96,6 @@ module Ahoy
def uses_deprecated_subscribers?
@uses_deprecated_subscribers || false
end
-
end
protected
@@ @@ -110,7 +107,6 @@ module Ahoy
def event_model
::Ahoy::Event
end
-
end
end
end
ahoy/stores/base_store.rb b/lib/ahoy/stores/base_store.rb +1 -3
@@ @@ -1,7 +1,6 @@
module Ahoy
module Stores
class BaseStore
-
def initialize(options)
@options = options
end
@@ @@ -17,7 +16,7 @@ module Ahoy
def authenticate(user)
@user = user
- if visit and visit.respond_to?(:user) and !visit.user
+ if visit && visit.respond_to?(:user) && !visit.user
begin
visit.user = user
visit.save!
@@ @@ -84,7 +83,6 @@ module Ahoy
classes << PG::UniqueViolation if defined?(PG::UniqueViolation)
classes
end
-
end
end
end
ahoy/stores/log_store.rb b/lib/ahoy/stores/log_store.rb +1 -3
@@ @@ -1,11 +1,10 @@
module Ahoy
module Stores
class LogStore < BaseStore
-
def track_visit(options, &block)
data = {
id: ahoy.visit_id,
- visitor_id: ahoy.visitor_id,
+ visitor_id: ahoy.visitor_id
}.merge(visit_properties.to_hash)
data[:user_id] = user.id if user
data[:started_at] = options[:started_at]
@@ @@ -41,7 +40,6 @@ module Ahoy
def event_logger
@event_logger ||= ActiveSupport::Logger.new(Rails.root.join("log/events.log"))
end
-
end
end
end
ahoy/stores/mongoid_store.rb b/lib/ahoy/stores/mongoid_store.rb +0 -2
@@ @@ -1,7 +1,6 @@
module Ahoy
module Stores
class MongoidStore < BaseStore
-
def track_visit(options, &block)
visit =
visit_model.new do |v|
@@ @@ -59,7 +58,6 @@ module Ahoy
token
end
end
-
end
end
end
ahoy/subscribers/active_record.rb b/lib/ahoy/subscribers/active_record.rb +0 -2
@@ @@ -1,7 +1,6 @@
module Ahoy
module Subscribers
class ActiveRecord
-
def initialize(options = {})
@model = options[:model] || Ahoy::Event
end
@@ @@ -15,7 +14,6 @@ module Ahoy
e.time = options[:time]
end
end
-
end
end
end
ahoy/tracker.rb b/lib/ahoy/tracker.rb +2 -3
@@ @@ -70,7 +70,7 @@ module Ahoy
end
def set_visitor_cookie
- if !existing_visitor_id
+ unless existing_visitor_id
set_cookie("ahoy_visitor", visitor_id, Ahoy.visitor_duration)
end
end
@@ @@ -107,7 +107,7 @@ module Ahoy
end
def trusted_time(time)
- if !time or (@options[:api] and !(1.minute.ago..Time.now).cover?(time))
+ if !time || (@options[:api] && !(1.minute.ago..Time.now).cover?(time))
Time.zone.now
else
time
@@ @@ -145,6 +145,5 @@ module Ahoy
def ensure_uuid(id)
Ahoy.ensure_uuid(id)
end
-
end
end
ahoy/visit_properties.rb b/lib/ahoy/visit_properties.rb +1 -3
@@ @@ -1,6 +1,5 @@
module Ahoy
class VisitProperties
-
REQUEST_KEYS = [:ip, :user_agent, :referrer, :landing_page, :platform, :app_version, :os_version, :screen_height, :screen_width]
TRAFFIC_SOURCE_KEYS = [:referring_domain, :search_keyword]
UTM_PARAMETER_KEYS = [:utm_source, :utm_medium, :utm_term, :utm_content, :utm_campaign]
@@ @@ -33,7 +32,7 @@ module Ahoy
end
def to_hash
- keys.inject({}){|memo, key| memo[key] = send(key); memo }
+ keys.inject({}) { |memo, key| memo[key] = send(key); memo }
end
protected
@@ @@ -57,6 +56,5 @@ module Ahoy
def location_deckhand
@location_deckhand ||= Deckhands::LocationDeckhand.new(request_deckhand.ip)
end
-
end
end
ahoy/warden.rb b/lib/ahoy/warden.rb +1 -1
@@ @@ -1,4 +1,4 @@
- Warden::Manager.after_set_user except: :fetch do |user, auth, opts|
+ Warden::Manager.after_set_user except: :fetch do |user, auth, _|
request = ActionDispatch::Request.new(auth.env)
ahoy = Ahoy::Tracker.new(request: request)
ahoy.authenticate(user)
generators/ahoy/stores/active_record_events_generator.rb b/lib/generators/ahoy/stores/active_record_events_generator.rb +0 -1
@@ @@ -37,7 +37,6 @@ module Ahoy
def create_initializer
template "active_record_initializer.rb", "config/initializers/ahoy.rb"
end
-
end
end
end
generators/ahoy/stores/active_record_generator.rb b/lib/generators/ahoy/stores/active_record_generator.rb +0 -1
@@ @@ -10,7 +10,6 @@ module Ahoy
invoke "ahoy:stores:active_record_visits", nil, options
invoke "ahoy:stores:active_record_events", nil, options
end
-
end
end
end
generators/ahoy/stores/active_record_visits_generator.rb b/lib/generators/ahoy/stores/active_record_visits_generator.rb +0 -1
@@ @@ -37,7 +37,6 @@ module Ahoy
def create_initializer
template "active_record_initializer.rb", "config/initializers/ahoy.rb"
end
-
end
end
end
generators/ahoy/stores/custom_generator.rb b/lib/generators/ahoy/stores/custom_generator.rb +0 -1
@@ @@ -9,7 +9,6 @@ module Ahoy
def create_initializer
template "custom_initializer.rb", "config/initializers/ahoy.rb"
end
-
end
end
end
generators/ahoy/stores/log_generator.rb b/lib/generators/ahoy/stores/log_generator.rb +0 -1
@@ @@ -9,7 +9,6 @@ module Ahoy
def create_initializer
template "log_initializer.rb", "config/initializers/ahoy.rb"
end
-
end
end
end
generators/ahoy/stores/mongoid_events_generator.rb b/lib/generators/ahoy/stores/mongoid_events_generator.rb +0 -1
@@ @@ -13,7 +13,6 @@ module Ahoy
def create_initializer
template "mongoid_initializer.rb", "config/initializers/ahoy.rb"
end
-
end
end
end
generators/ahoy/stores/mongoid_generator.rb b/lib/generators/ahoy/stores/mongoid_generator.rb +0 -2
@@ @@ -4,12 +4,10 @@ module Ahoy
module Stores
module Generators
class MongoidGenerator < Rails::Generators::Base
-
def boom
invoke "ahoy:stores:mongoid_visits"
invoke "ahoy:stores:mongoid_events"
end
-
end
end
end
generators/ahoy/stores/mongoid_visits_generator.rb b/lib/generators/ahoy/stores/mongoid_visits_generator.rb +0 -1
@@ @@ -21,7 +21,6 @@ module Ahoy
def create_initializer
template "mongoid_initializer.rb", "config/initializers/ahoy.rb"
end
-
end
end
end
generators/ahoy/stores/templates/custom_initializer.rb b/lib/generators/ahoy/stores/templates/custom_initializer.rb +0 -2
@@ @@ -1,5 +1,4 @@
class Ahoy::Store < Ahoy::Stores::BaseStore
-
def track_visit(options)
end
@@ @@ -8,5 +7,4 @@ class Ahoy::Store < Ahoy::Stores::BaseStore
def current_visit
end
-
end