boffin 0.1.0

data/spec/boffin/utils_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe Boffin::Utils do
+  describe '::underscore' do
+    it 'works with namespaces' do
+      subject.underscore('MyMod::MyClass').should == 'my_mod_my_class'
+    end
+
+    it 'works without namespaces' do
+      subject.underscore('MyMod').should == 'my_mod'
+      subject.underscore('Mod').should == 'mod'
+    end
+
+    it 'works with blank strings' do
+      subject.underscore('').should == ''
+      subject.underscore(' ').should == ' '
+    end
+  end
+
+  describe '::blank?' do
+    it 'returns true for []' do
+      subject.blank?([]).should be_true
+    end
+
+    it 'returns true for {}' do
+      subject.blank?({}).should be_true
+    end
+
+    it 'returns true for nil' do
+      subject.blank?(nil).should be_true
+    end
+
+    it 'returns true for ""' do
+      subject.blank?('').should be_true
+    end
+
+    it 'returns true for false' do
+      subject.blank?(false).should be_true
+    end
+
+    it 'returns false for non-blank things' do
+      subject.blank?(0).should be_false
+    end
+  end
+
+  describe '::extract_time_unit' do
+    specify { subject.extract_time_unit(hours:  6).should == [:hours,  6] }
+    specify { subject.extract_time_unit(days:   2).should == [:days,   2] }
+    specify { subject.extract_time_unit(months: 3).should == [:months, 3] }
+
+    it 'throws an error if no time unit pair exists in the hash' do
+      lambda { subject.extract_time_unit(fun: 'times') }.
+        should raise_error ArgumentError
+    end
+  end
+
+  describe '::time_ago' do
+    before { @time = Time.local(2011, 2, 15, 12) }
+
+    specify { subject.time_ago(@time, hours:  6).should == Time.local(2011, 2,  15, 6)  }
+    specify { subject.time_ago(@time, days:   5).should == Time.local(2011, 2,  10, 12) }
+    specify { subject.time_ago(@time, months: 1).should == Time.local(2011, 1,  16, 12) } # A "month" is 30 days
+
+    it 'throws an error if no time unit pair exists in the hash' do
+      lambda { subject.time_ago(@time, fun: 'fail') }.
+        should raise_error ArgumentError
+    end
+  end
+
+  describe '::time_ago_range' do
+    before { @time = Time.local(2011, 2, 15, 12) }
+
+    specify { subject.time_ago_range(@time, hours:  6).size.should == 6 }
+    specify { subject.time_ago_range(@time, months: 1).size.should == 1 }
+
+    specify do
+      subject.time_ago_range(@time, days: 2).
+        should == [Time.local(2011, 2, 14, 12), Time.local(2011, 2, 15, 12)]
+    end
+
+    specify do
+      subject.time_ago_range(@time, days: 3).
+        should == [
+          Time.local(2011, 2, 13, 12),
+          Time.local(2011, 2, 14, 12),
+          Time.local(2011, 2, 15, 12)
+        ]
+    end
+
+    it 'ranges from n days away upto @time' do
+      times = subject.time_ago_range(@time, days: 4)
+      times.first.should == Time.local(2011, 2, 12, 12)
+      times.last.should == @time
+    end
+
+    it 'throws an error if no time unit pair exists in the hash' do
+      lambda { subject.time_ago_range(@time, fun: 'crash') }.
+        should raise_error ArgumentError
+    end
+  end
+
+  describe '::uniquenesses_as_session_identifier' do
+    specify do
+      subject.uniquenesses_as_session_identifier([]).
+        should == Boffin::NIL_SESSION_MEMBER
+    end
+
+    specify do
+      subject.uniquenesses_as_session_identifier([nil, 'hi']).
+        should == 'hi'
+    end
+
+    specify do
+      subject.uniquenesses_as_session_identifier([MockDitty.new]).
+        should == 'mock_ditty:1'
+    end
+  end
+
+  describe '::object_as_session_identifier' do
+    specify { subject.object_as_session_identifier(nil).should == '' }
+    specify { subject.object_as_session_identifier(3.14).should == '3.14' }
+
+    specify do
+      subject.object_as_session_identifier(MockDitty.new).
+        should == 'mock_ditty:1'
+    end
+  end
+
+  describe '::object_as_member' do
+    it 'calls #as_member on the object if available' do
+      obj = MockMember.new(100)
+      subject.object_as_member(obj).should == '100'
+    end
+
+    it 'calls #id.to_s on the object if available' do
+      obj = MockDitty.new(100)
+      subject.object_as_member(obj).should == '100'
+    end
+
+    it 'calls #to_s on everything else' do
+      subject.object_as_member(3.14).should == '3.14'
+      subject.object_as_member(:symbol).should == 'symbol'
+      subject.object_as_member('string').should == 'string'
+    end
+  end
+
+  describe '::object_as_namespace' do
+    specify { subject.object_as_namespace(:ns).should == 'ns' }
+    specify { subject.object_as_namespace(MockDitty).should == 'mock_ditty' }
+    specify { subject.object_as_namespace('ns').should == 'ns' }
+  end
+
+  describe '::object_as_key' do
+    specify { subject.object_as_key(MockDitty.new).should == '1' }
+    specify { subject.object_as_key(100).should == 'MTAw' }
+    specify { subject.object_as_key('/test?te=st').should == 'L3Rlc3Q/dGU9c3Q=' }
+  end
+end

data/spec/boffin_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class MockEmptyDitty < MockDitty; end
+
+describe Boffin do
+  describe '::track' do
+    before do
+      @tracker = Boffin.track(MockEmptyDitty, [:views, :tests])
+    end
+
+    it 'injects Trackable into a class' do
+      MockEmptyDitty.include?(Boffin::Trackable).should be_true
+    end
+
+    it 'sets hit types' do
+      MockEmptyDitty.boffin.hit_types.should == [:views, :tests]
+    end
+
+    it 'returns Trackable' do
+      Boffin.track(:thing).should be_a Boffin::Tracker
+    end
+  end
+
+  describe '::config' do
+    before do
+      @config = Boffin.config.dup
+      Boffin.instance_variable_set(:@config, nil)
+    end
+
+    after do
+      Boffin.instance_variable_set(:@config, @config)
+    end
+
+    it 'accepts a hash' do
+      Boffin.config(namespace: 'trendy')
+      Boffin.config.namespace.should == 'trendy'
+    end
+
+    it 'accepts a block' do
+      Boffin.config { |c| c.namespace = 'jazzy' }
+      Boffin.config.namespace.should == 'jazzy'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'bundler/setup'
+
+require 'rspec'
+require 'redis'
+require 'timecop'
+
+$redis = if ENV['DEBUG']
+  require 'logger'
+  Redis.connect(logger: Logger.new(STDERR))
+else
+  Redis.connect
+end
+
+require File.expand_path('../../lib/boffin', __FILE__)
+
+Boffin.config do |c|
+  c.redis     = $redis
+  c.namespace = 'boffin_test'
+end
+
+class MockDitty
+  attr :id
+  def initialize(id = 1); @id = id; end
+end
+
+# Just a different namespace to make the specs easier to follow.
+class MockUser < MockDitty; end
+
+class MockMember
+  attr :as_member
+  def initialize(id = 1); @as_member = id; end
+end
+
+class MockTrackableIncluded < MockDitty
+  include Boffin::Trackable
+  boffin.hit_types = [:views, :likes]
+end
+
+class MockTrackableInjected < MockDitty
+  Boffin.track(self, [:views, :likes])
+end
+
+module SpecHelper
+  module_function
+  def flush_keyspace!
+    if (keys = $redis.keys("#{Boffin.config.namespace}*")).any?
+      $redis.del(*keys)
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: boffin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Carsten Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70146172825080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70146172825080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70146172824200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70146172824200
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70146172823600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70146172823600
+description: ! 'Boffin is a library for tracking hits to things in your Ruby application.
+  Things
+
+  can be IDs of records in a database, strings representing tags or topics, URLs
+
+  of webpages, names of places, whatever you desire. Boffin is able to provide
+
+  lists of those things based on most hits, least hits, it can even report on
+
+  weighted combinations of different types of hits.
+
+'
+email: heycarsten@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- boffin.gemspec
+- lib/boffin.rb
+- lib/boffin/config.rb
+- lib/boffin/hit.rb
+- lib/boffin/keyspace.rb
+- lib/boffin/trackable.rb
+- lib/boffin/tracker.rb
+- lib/boffin/utils.rb
+- lib/boffin/version.rb
+- spec/boffin/config_spec.rb
+- spec/boffin/hit_spec.rb
+- spec/boffin/keyspace_spec.rb
+- spec/boffin/trackable_spec.rb
+- spec/boffin/tracker_spec.rb
+- spec/boffin/utils_spec.rb
+- spec/boffin_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/heycarsten/boffin
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3925281016385501386
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3925281016385501386
+requirements: []
+rubyforge_project: boffin
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Hit tracking library for Ruby using Redis
+test_files:
+- spec/boffin/config_spec.rb
+- spec/boffin/hit_spec.rb
+- spec/boffin/keyspace_spec.rb
+- spec/boffin/trackable_spec.rb
+- spec/boffin/tracker_spec.rb
+- spec/boffin/utils_spec.rb
+- spec/boffin_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard