notches 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed673601115b4a08c8c6f46ac1ba576217d16d5a
-  data.tar.gz: 65eb69efd2001ce4f544e70f6e5db92fd5f73781
+SHA256:
+  metadata.gz: 586425ba4443bad8f9b073dedd839f73f48321e086421ed084137385b6faeaba
+  data.tar.gz: 9892fd375c4cf59bd677a35f7193312fd90411a26d8ca58581ee579fb2674524
 SHA512:
-  metadata.gz: 887a3b48a25567423d9b1bb38c4f72f93e7824eb2c391db65ad7decebb6b2f5cb854ef817733fd00ce6a13c30962140edaac39e29ccddebbdaca50158d35e6de
-  data.tar.gz: 01eb20fe4cba9d8a82f7b4c48d7cd316377c13e1182e0d40061c8c42d6ee6d222ccd74e95f1c9f10b6432b212845bf1707e24c8ff2d3576fa27ac0ea83670d07
+  metadata.gz: d23197a84edea814e445c9e0e10ee933ed6fbd15b4b5b7b75e7d8534efb82ec73614acf9bb9be37fc109b313990d943e6482b14a2838b4be6e273a20c57c53ec
+  data.tar.gz: 6735b0b2120ba48d9820851b090710bff0cb6286f43deb126a5fa48aae8e8115f0f164ff5f1c8454228bfa749f02e72250e255b71cc8ce95fe2e9f95a67ab59e

data/README.md

@@ -8,7 +8,7 @@ Installation
 
 Add this to your Gemfile and run the `bundle` command.
 
-    gem 'notches', '~> 0.6.0'
+    gem 'notches', '~> 0.7.1'
 
 And then install and run the necessary migrations.
 
@@ -59,19 +59,25 @@ To get a better idea of how Notches is setup check out the
 Recording events
 ----------------
 
-To record events make the following call, the scope is optional.
+To record events make the following call:
 
-    Notches::Event.log(name: 'An important event', scope: 'A scope')
+    Notches::Event.log(name: 'An event')
+
+Events can have one or two optional scopes:
+
+    Notches::Event.log(name: 'An event', scope: 'A person')
+    Notches::Event.log(name: 'An event', scope: ['A person', 'An object'])
 
 Counting events
 -------------
 
 For a name:
 
-    Notches::Event.joins(:name).where('name like ?', 'An important event').count
+    Notches::Event.joins(:name).where('name = ?', 'An event').count
 
 For a name and scope:
 
     Notches::Event.joins(:name, :scope).where(
-      'name like = ? and scope like ?', 'An important event', 'A scope'
+      'name = ? and scopes.primary = ? and scopes.secondary = ?',
+      'An event', 'A person', 'An object'
     ).count

data/app/models/notches/event.rb

@@ -2,21 +2,22 @@ class Notches::Event < ActiveRecord::Base
   self.table_name = "notches_events"
 
   validates :name, presence: true
+  validates :scope, presence: true
 
   validates_associated :name, :scope
 
   belongs_to :date,  foreign_key: :notches_date_id
-  belongs_to :name,  foreign_key: :notches_name_id, :class_name => Name.to_s
-  belongs_to :scope, foreign_key: :notches_scope_id, :class_name => Scope.to_s
+  belongs_to :name,  foreign_key: :notches_name_id, :class_name => Notches::Name.to_s
+  belongs_to :scope, foreign_key: :notches_scope_id, :class_name => Notches::Scope.to_s
   belongs_to :time,  foreign_key: :notches_time_id
 
   def self.log(attributes)
     event = self.new
     event.transaction do
       Rails.logger.info("[Notches] Tracking #{attributes.inspect} at #{Date.today} #{Time.now}")
-      now            = Time.zone.now
+      now         = Time.zone.now
       event.name  = Notches::Name.find_or_create_by(name: attributes[:name])
-      event.scope = Notches::Scope.find_or_create_by(scope: attributes[:scope]) if attributes[:scope].present?
+      event.scope = Notches::Scope.find_or_create_by(scope_attributes_for(attributes[:scope]))
       event.date  = Notches::Date.find_or_create_by(date: now.to_date)
       event.time  = Notches::Time.find_or_create_by_time(now)
 
@@ -28,4 +29,12 @@ class Notches::Event < ActiveRecord::Base
     end
     event
   end
+
+  def self.scope_attributes_for(scope)
+    scope = [scope] if !scope.is_a?(Array)
+    {
+      primary:   scope.first.to_s,
+      secondary: scope.second.to_s
+    }
+  end
 end

data/app/models/notches/hit.rb

@@ -7,10 +7,10 @@ class Notches::Hit < ActiveRecord::Base
 
   validates_associated :url, :session, :ip
 
-  belongs_to :url,        :foreign_key => :notches_url_id, :class_name => "URL"
+  belongs_to :url,        :foreign_key => :notches_url_id, :class_name => "Notches::URL"
   belongs_to :user_agent, :foreign_key => :notches_user_agent_id
   belongs_to :session,    :foreign_key => :notches_session_id
-  belongs_to :ip,         :foreign_key => :notches_ip_id, :class_name => "IP"
+  belongs_to :ip,         :foreign_key => :notches_ip_id, :class_name => "Notches::IP"
   belongs_to :date,       :foreign_key => :notches_date_id
   belongs_to :time,       :foreign_key => :notches_time_id
 

data/app/models/notches/scope.rb

@@ -4,5 +4,19 @@ class Notches::Scope < ActiveRecord::Base
   has_many :events, class_name: Notches::Event.to_s,
                     foreign_key: "notches_scope_id"
 
-  validates :scope, presence: true
+  validate :no_nulls
+  validate :no_secondary_scope_without_primary
+
+  private
+
+  def no_nulls
+    errors[:primary] << "can't be null"   if primary.nil?
+    errors[:secondary] << "can't be null" if secondary.nil?
+  end
+
+  def no_secondary_scope_without_primary
+    if secondary.present? && primary.blank?
+      errors[:secondary] << "is invalid"
+    end
+  end
 end

data/db/migrate/20160815100820_add_secondary_to_notches_scopes.rb

@@ -0,0 +1,13 @@
+class AddSecondaryToNotchesScopes < ActiveRecord::Migration
+  def up
+    rename_column :notches_scopes, :scope, :primary
+    add_column    :notches_scopes, :secondary, :string
+    change_column_null :notches_events, :notches_scope_id, false
+  end
+
+  def down
+    change_column_null :notches_events, :notches_scope_id, true
+    remove_column :notches_scopes, :secondary
+    rename_column :notches_scopes, :primary, :scope
+  end
+end

data/lib/notches/version.rb

@@ -1,3 +1,3 @@
 module Notches
-  VERSION = '0.6.0'
+  VERSION = '0.7.1'
 end

data/notches.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency     'rails',       '>= 4.1'
 
   s.add_development_dependency 'combustion',  '~> 0.5.5'
-  s.add_development_dependency 'rspec-rails', '~> 3.4.2'
+  s.add_development_dependency 'rspec-rails', '~> 3.9.1'
   s.add_development_dependency 'sqlite3',     '~> 1.3.11'
 end

data/spec/models/notches/event_spec.rb

@@ -4,8 +4,8 @@ describe Notches::Event do
   describe "validations" do
     let(:event) do
       Notches::Event.new(
-        name: Notches::Name.new(name: 'An important event'),
-        scope: Notches::Scope.new(scope: 'An important person')
+        name: Notches::Name.new(name: 'An event'),
+        scope: Notches::Scope.new(primary: 'A person', secondary: '')
       )
     end
 
@@ -19,10 +19,10 @@ describe Notches::Event do
       expect(event.errors[:name]).to eq(["can't be blank"])
     end
 
-    it "does not require a scope" do
+    it "requires a scope" do
       event.scope = nil
       event.valid?
-      expect(event).to be_valid
+      expect(event.errors[:scope]).to eq(["can't be blank"])
     end
 
     it "does not validate if its Name's name is blank" do
@@ -31,72 +31,101 @@ describe Notches::Event do
       expect(event.errors[:name]).to eq(["is invalid"])
     end
 
-    it "does not validate if it has a Scope but it's invalid" do
-      event.scope.scope = nil
+    it "does not validate if it has a scope but it's value is nil" do
+      event.scope.primary = nil
+      event.valid?
+      expect(event.errors[:scope]).to eq(["is invalid"])
+    end
+
+    it "does not validate if it has a secondary scope but no primary scope" do
+      event.scope.primary = nil
+      event.scope.secondary = 'Secondary scope'
       event.valid?
       expect(event.errors[:scope]).to eq(["is invalid"])
     end
   end
 
   describe ".log" do
+    let(:now) { Time.zone.now }
+    let(:existing_event) { Notches::Event.log(name: "An event", scope: "A person") }
 
-    context "with valid attributes" do
-      let(:now) { Time.zone.now }
-      before do
-        allow(Time).to receive_message_chain(:zone, :now).and_return(now)
-      end
+    before do
+      allow(Time).to receive_message_chain(:zone, :now).and_return(now)
+    end
 
+    context "with valid attributes" do
       it "creates a event for today and current time with those attributes" do
-        Notches::Event.log(name: "An important event")
+        Notches::Event.log(name: "An event")
         event = Notches::Event.first
         expect(event).to be_present
-        expect(event.name.name).to eq("An important event")
-        expect(event.scope).to be_nil
+        expect(event.name.name).to eq("An event")
+        expect(event.scope.primary).to eq("")
+        expect(event.scope.secondary).to eq("")
         expect(event.date.date).to eq(now.to_date)
         expect(event.time.time.strftime('%H:%M:%S')).to eq(now.strftime('%H:%M:%S'))
       end
     end
 
-    let(:existing_event) {
-      Notches::Event.log(
-        name: "An important event",
-        scope: "An important person"
-      )
-    }
-
     it "does not create a new Name record if there's a record for that Name already" do
-      event = Notches::Event.log(name: "An important event")
+      event = Notches::Event.log(name: "An event")
       expect(event.name.id).to eq(existing_event.name.id)
     end
 
     it "does not create a new Scope record if there's a record for that Scope already" do
-      event = Notches::Event.log(
-        name: "An important event",
-        scope: "An important person"
-      )
+      event = Notches::Event.log(name: "An event", scope: "A person")
       expect(event.scope.id).to eq(existing_event.scope.id)
     end
 
     it "does not create a new Date record there's a record for that Date already" do
-      event = Notches::Event.log(name: "Another important event")
+      event = Notches::Event.log(name: "Another event")
       expect(event.date.id).to eq(existing_event.date.id)
     end
 
     it "does not create a new Time record if there's a record for that Time already even if date was different" do
-      existing_event.time.update_attributes!(time: Time.parse('2016-08-03 14:15:59 UTC'))
-      allow(Time).to receive_message_chain(:zone, :now).and_return(Time.parse('2016-08-04 14:15:59 UTC'))
-      event = Notches::Event.log(name: "Another important event")
+      event = Notches::Event.log(name: "Another event")
       expect(event.time.id).to eq(existing_event.time.id)
     end
 
     context "a event with the same name, scope, date and time exists already" do
       it "does not log the event" do
-        allow(Time).to receive_message_chain(:zone, :now).and_return(existing_event.time.time)
+        event_attributes = {
+          name: "An event",
+          scope: "A person"
+        }
+        Notches::Event.log(event_attributes)
+
+        expect {
+          Notches::Event.log(event_attributes)
+        }.to_not change { Notches::Event.count }
+      end
+    end
+
+    context "logging an event with a primary and secondary scope" do
+      it do
+        event = Notches::Event.log(
+          name: "An event",
+          scope: ["A person", "An object"]
+        )
+
+        expect(event).to be_persisted
+        expect(event.name.name).to eq("An event")
+        expect(event.scope.primary).to eq("A person")
+        expect(event.scope.secondary).to eq("An object")
+        expect(event.date.date).to eq(now.to_date)
+        expect(event.time.time.strftime('%H:%M:%S')).to eq(now.strftime('%H:%M:%S'))
+      end
+    end
+
+    context "logging an event with a primary and secondary scope when a event with same name, scope, date and time exists already" do
+      it "does not log the event" do
+        event_attributes = {
+          name: "An event",
+          scope: ["A person", "An object"]
+        }
+        Notches::Event.log(event_attributes)
+
         expect {
-          event = Notches::Event.log(
-            name: "An important event",
-            scope: "An important person"
-          )
+          Notches::Event.log(event_attributes)
         }.to_not change { Notches::Event.count }
       end
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: notches
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Cillian O'Ruanaidh
 - Paul Campbell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: 3.9.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ files:
 - db/migrate/20120910093652_add_index_to_user_agents.rb
 - db/migrate/20130918115023_create_notches_user_sessions.rb
 - db/migrate/20160804111320_create_notches_events.rb
+- db/migrate/20160815100820_add_secondary_to_notches_scopes.rb
 - lib/notches.rb
 - lib/notches/engine.rb
 - lib/notches/version.rb
@@ -116,7 +117,7 @@ files:
 homepage: http://github.com/hypertiny/notches
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: notches
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Simple Rails web traffic counter
 test_files: []