boffin 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.2.0
+
+ * Support for Ruby 1.8.7 thanks to Justin Giancola
+
 0.1.0
 
  * Initial public release

data/Gemfile

@@ -4,5 +4,5 @@ gemspec
 group :development do
   gem 'rake'
   gem 'redcarpet'
-  gem 'yard', git: 'https://github.com/lsegal/yard.git'
+  gem 'yard', :git => 'https://github.com/lsegal/yard.git'
 end

data/README.md

@@ -15,6 +15,7 @@ weighted combinations of different types of hits.
 Resources
 ---------
 
+ * [Documentation](http://rubydoc.info/github/heycarsten/boffin/master/frames)
  * [Source Code](https://github.com/heycarsten/boffin)
  * [Issue Tracker](https://github.com/heycarsten/boffin/issues)
  * [Test Suite](https://github.com/heycarsten/boffin/tree/master/spec)

data/Rakefile

@@ -11,4 +11,4 @@ end
 require 'yard'
 YARD::Rake::YardocTask.new
 
-task default: :spec
+task :default => :spec

data/boffin.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |s|
   s.summary           = 'Hit tracking library for Ruby using Redis'
   s.has_rdoc          = 'yard'
   s.rubyforge_project = 'boffin'
-  s.files             = `git ls-files`.split(?\n)
-  s.test_files        = `git ls-files -- spec/*`.split(?\n)
+  s.files             = `git ls-files`.split(/\n/)
+  s.test_files        = `git ls-files -- spec/*`.split(/\n/)
   s.require_paths     = ['lib']
 
   s.add_dependency             'redis',   '>= 2.2'
   s.add_development_dependency 'rspec',   '~> 2.6'
   s.add_development_dependency 'timecop'
+  s.add_development_dependency 'bundler', '>= 1.0.14'
 
   s.description = <<-END
 Boffin is a library for tracking hits to things in your Ruby application. Things

data/lib/boffin.rb

@@ -1,4 +1,3 @@
-require 'base64'
 require 'date'
 require 'time'
 require 'redis'
@@ -24,9 +23,9 @@ module Boffin
 
   # The way Time should be formatted for each interval type
   INTERVAL_FORMATS = {
-    hours:  '%F-%H',
-    days:   '%F',
-    months: '%Y-%m' }
+    :hours  => '%F-%H',
+    :days   => '%F',
+    :months => '%Y-%m' }
 
   # Different interval types
   INTERVAL_TYPES = INTERVAL_FORMATS.keys

data/lib/boffin/tracker.rb

@@ -91,6 +91,8 @@ module Boffin
     #   Perform union for hit counts over the last _n_ months.
     # @example Return IDs of most viewed and liked listings in the past 6 days with scores
     #   @tracker.top({ views: 1, likes: 1 }, counts: true, days: 6)
+    # @example Return IDS of most viewed and liked listings in the past 6 days with scores (Alternate syntax)
+    #   @tracker.top([[:views, 1], [:likes, 1]], counts: true, days: 6)
     # @example Return IDs of most viewed listings in the past 12 hours
     #   @tracker.top(:views, hours: 12)
     # @note
@@ -178,7 +180,7 @@ module Boffin
       weights.keys.each { |t| union(ks, t, unit, size, opts) }
       keys = weights.keys.map { |t| ks.hits_union(t, unit, size) }
       zfetch(ks.hits_union_multi(weights, unit, size), keys, {
-        weights: weights.values
+        :weights => weights.values
       }.merge(opts))
     end
 
@@ -194,8 +196,8 @@ module Boffin
     # @see #zrange
     def zfetch(storkey, keys, opts = {})
       zrangeopts = {
-        counts: opts.delete(:counts),
-        order:  (opts.delete(:order) || :desc).to_sym }
+        :counts => opts.delete(:counts),
+        :order  => (opts.delete(:order) || :desc).to_sym }
       if redis.zcard(storkey) == 0
         redis.zunionstore(storkey, keys, opts)
         redis.expire(storkey, @config.cache_expire_secs)
@@ -213,7 +215,7 @@ module Boffin
     #   option is `true` it returns an array of pairs where the first value is
     #   the member, and the second value is the member's score.
     def zrange(key, opts)
-      args = [key, 0, -1, opts[:counts] ? { withscores: true } : {}]
+      args = [key, 0, -1, opts[:counts] ? { :withscores => true } : {}]
       result = case opts[:order]
         when :asc  then redis.zrange(*args)
         when :desc then redis.zrevrange(*args)

data/lib/boffin/utils.rb

@@ -13,9 +13,9 @@ module Boffin
 
     # Number of seconds for a single value of each unit
     SECONDS_IN_UNIT  = {
-      hours:  SECONDS_IN_HOUR,
-      days:   SECONDS_IN_DAY,
-      months: SECONDS_IN_MONTH
+      :hours  => SECONDS_IN_HOUR,
+      :days   => SECONDS_IN_DAY,
+      :months => SECONDS_IN_MONTH
     }
 
     module_function
@@ -45,6 +45,18 @@ module Boffin
       obj.respond_to?(:empty?) ? obj.empty? : !obj
     end
 
+    # @param [Object] obj any Ruby object
+    # @return [true, false]
+    #   `true` if the provided object responds to :id, other than it's
+    #   internal object identifier
+    #   `false` if the object does not respond to :id
+    def respond_to_id?(obj)
+      # NOTE: this feels like a hack. I'm sure there is a more elegant way
+      # to determine whether the :id method is the built in Object#id but
+      # I can't think of it
+      obj.respond_to?(:id) and obj.id != obj.object_id
+    end
+
     # Pulls time interval information from a hash of options.
     # @example
     #   extract_time_unit(this: 'is ignored', days: 6, so_is: 'this')
@@ -134,13 +146,13 @@ module Boffin
     #   generated value will be Base64 encoded.
     # @return [String]
     def object_as_identifier(obj, opts = {})
-      if obj.respond_to?(:as_member) || obj.respond_to?(:id)
+      if obj.respond_to?(:as_member) || respond_to_id?(obj)
         ''.tap do |s|
           s << "#{underscore(obj.class)}:" if opts[:namespace]
           s << (obj.respond_to?(:as_member) ? obj.as_member : obj.id).to_s
         end
       else
-        opts[:encode] ? Base64.strict_encode64(obj.to_s) : obj.to_s
+        opts[:encode] ? [obj.to_s].pack("m0").chomp : obj.to_s
       end
     end
 
@@ -157,14 +169,14 @@ module Boffin
     # @return [String] A string that can be used as a member in {Keyspace#hits}.
     # @see #object_as_identifier
     def object_as_session_identifier(obj)
-      object_as_identifier(obj, namespace: true)
+      object_as_identifier(obj, :namespace => true)
     end
 
     # @param [#as_member, #id, #to_s] obj
     # @return [String] A string that can be used as part of a Redis key
     # @see #object_as_identifier
     def object_as_key(obj)
-      object_as_identifier(obj, encode: true)
+      object_as_identifier(obj, :encode => true)
     end
 
   end

data/lib/boffin/version.rb

@@ -1,4 +1,4 @@
 module Boffin
   # Version of this Boffin release
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/boffin/config_spec.rb

@@ -28,14 +28,14 @@ describe Boffin::Config do
     end
 
     it 'can be sent a hash' do
-      conf = Boffin::Config.new(namespace: 'hello')
+      conf = Boffin::Config.new(:namespace => 'hello')
       conf.namespace.should == 'hello'
     end
   end
 
   describe '#merge' do
     it 'copies the existing instance' do
-      newconf = subject.merge(namespace: 'carsten')
+      newconf = subject.merge(:namespace => 'carsten')
       newconf.namespace.should == 'carsten'
       subject.namespace.should == 'boffin'
     end

data/spec/boffin/hit_spec.rb

@@ -16,9 +16,9 @@ describe Boffin::Hit, '::new' do
   it 'stores hit data under the appropriate keys' do
     Boffin::Hit.new(@tracker, :tests, @ditty, [nil, @user])
     [:hours, :days, :months].each do |interval|
-      @tracker.top(:tests, interval => 1, counts: true).
+      @tracker.top(:tests, interval => 1, :counts => true).
         should == [['1', 1]]
-      @tracker.top(:tests, interval => 1, counts: true, unique: true).
+      @tracker.top(:tests, interval => 1, :counts => true, :unique => true).
         should == [['1', 1]]
     end
     @tracker.hit_count(:tests, @ditty).should == 1
@@ -29,9 +29,9 @@ describe Boffin::Hit, '::new' do
     Boffin::Hit.new(@tracker, :tests, @ditty, [nil, @user])
     Boffin::Hit.new(@tracker, :tests, @ditty, [nil, @user])
     [:hours, :days, :months].each do |interval|
-      @tracker.top(:tests, interval => 1, counts: true).
+      @tracker.top(:tests, interval => 1, :counts => true).
         should == [['1', 2]]
-      @tracker.top(:tests, interval => 1, counts: true, unique: true).
+      @tracker.top(:tests, interval => 1, :counts => true, :unique => true).
         should == [['1', 1]]
     end
     @tracker.hit_count_for_session_id(:tests, @ditty, @user).should == 2

data/spec/boffin/keyspace_spec.rb

@@ -42,7 +42,13 @@ describe Boffin::Keyspace do
 
   describe '#hits_union_multi' do
     specify do
-      @ks.hits_union_multi({ views: 1, likes: 3 }, :days, 5).
+      weighted_hit_types =
+        if RUBY_VERSION < '1.9'
+          [[:views, 1], [:likes, 3]]
+        else
+          { :views => 1, :likes => 3 }
+        end
+      @ks.hits_union_multi(weighted_hit_types, :days, 5).
         should == 'b:mock_ditty:views_1_likes_3:hits:current.days_5'
     end
   end

data/spec/boffin/trackable_spec.rb

@@ -21,7 +21,7 @@ describe Boffin::Trackable do
   end
 
   it 'delegates ::top_ids to the Tracker instance' do
-    MockTrackableInjected.top_ids(:views, days: 1).should == ['1']
+    MockTrackableInjected.top_ids(:views, :days => 1).should == ['1']
   end
 
   it 'delegates #hit_count to the Tracker instance' do

data/spec/boffin/tracker_spec.rb

@@ -55,14 +55,14 @@ describe Boffin::Tracker do
 
   describe '#hit' do
     it 'throws an error if the hit type is not in the list' do
-      -> { @tracker.hit(:view, @instance1) }.
+      lambda  { @tracker.hit(:view, @instance1) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
   end
 
   describe '#hit_count' do
     it 'throws an error if the hit type is not in the list' do
-      -> { @tracker.hit_count(:view, @instance1) }.
+      lambda  { @tracker.hit_count(:view, @instance1) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
@@ -77,7 +77,7 @@ describe Boffin::Tracker do
 
   describe '#uhit_count' do
     it 'throws an error if the hit type is not in the list' do
-      -> { @tracker.uhit_count(:view, @instance1) }.
+      lambda  { @tracker.uhit_count(:view, @instance1) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
@@ -92,7 +92,7 @@ describe Boffin::Tracker do
 
   describe '#hit_count_for_session_id' do
     it 'throws an error if the hit type is not in the list' do
-      -> { @tracker.hit_count_for_session_id(:view, @instance1, 'sess.1') }.
+      lambda  { @tracker.hit_count_for_session_id(:view, @instance1, 'sess.1') }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
@@ -107,32 +107,32 @@ describe Boffin::Tracker do
 
   describe '#top' do
     it 'throws an error if passed hit type is invalid' do
-      -> { @tracker.top(:view, days: 3) }.
+      lambda  { @tracker.top(:view, :days => 3) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
     it 'throws an error if passed weights with hit type that is invalid' do
-      -> { @tracker.top({ view: 1 }, days: 3) }.
+      lambda  { @tracker.top({ :view => 1 }, :days => 3) }.
         should raise_error Boffin::UndefinedHitTypeError
     end
 
     it 'returns ids ordered by hit counts of weighted totals' do
-      ids = @tracker.top({ views: 1, likes: 2 }, days: 3)
+      ids = @tracker.top({ :views => 1, :likes => 2 }, :days => 3)
       ids.should == ['300', '200', '100']
     end
 
     it 'returns ids ordered by total counts of a specific hit type' do
-      ids = @tracker.top(:views, days: 3)
+      ids = @tracker.top(:views, :days => 3)
       ids.should == ['300', '100', '200']
     end
 
     it 'returns ids in ascending order when passed { order: "asc" } as an option' do
-      ids = @tracker.top(:views, days: 3, order: 'asc')
+      ids = @tracker.top(:views, :days => 3, :order => 'asc')
       ids.should == ['200', '100', '300']
     end
 
     it 'returns ids and counts when passed { counts: true } as an option' do
-      ids = @tracker.top(:views, days: 3, counts: true)
+      ids = @tracker.top(:views, :days => 3, :counts => true)
       ids.should == [
         ['300', 12],
         ['100', 8],
@@ -141,7 +141,7 @@ describe Boffin::Tracker do
     end
 
     it 'returns ids based on unique hit data when passed { unique: true } as an option' do
-      ids = @tracker.top(:views, days: 3, counts: true, unique: true)
+      ids = @tracker.top(:views, :days => 3, :counts => true, :unique => true)
       ids.should == [
         ['300', 7],
         ['200', 5],
@@ -159,4 +159,4 @@ describe Boffin::Tracker do
       @tracker.keyspace(true).unique_namespace?.should be_true
     end
   end
-end
+end

data/spec/boffin/utils_spec.rb

@@ -44,12 +44,12 @@ describe Boffin::Utils do
   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] }
+    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') }.
+      lambda { subject.extract_time_unit(:fun => 'times') }.
         should raise_error ArgumentError
     end
   end
@@ -57,12 +57,12 @@ describe Boffin::Utils do
   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
+    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') }.
+      lambda { subject.time_ago(@time, :fun => 'fail') }.
         should raise_error ArgumentError
     end
   end
@@ -70,16 +70,16 @@ describe Boffin::Utils do
   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 { 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).
+      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).
+      subject.time_ago_range(@time, :days => 3).
         should == [
           Time.local(2011, 2, 13, 12),
           Time.local(2011, 2, 14, 12),
@@ -88,13 +88,13 @@ describe Boffin::Utils do
     end
 
     it 'ranges from n days away upto @time' do
-      times = subject.time_ago_range(@time, days: 4)
+      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') }.
+      lambda { subject.time_ago_range(@time, :fun => 'crash') }.
         should raise_error ArgumentError
     end
   end

data/spec/boffin_spec.rb

@@ -32,7 +32,7 @@ describe Boffin do
     end
 
     it 'accepts a hash' do
-      Boffin.config(namespace: 'trendy')
+      Boffin.config(:namespace => 'trendy')
       Boffin.config.namespace.should == 'trendy'
     end
 

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'timecop'
 
 $redis = if ENV['DEBUG']
   require 'logger'
-  Redis.connect(logger: Logger.new(STDERR))
+  Redis.connect(:logger => Logger.new(STDERR))
 else
   Redis.connect
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boffin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-26 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70146172825080 !ruby/object:Gem::Requirement
+  requirement: &70347564151120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70146172825080
+  version_requirements: *70347564151120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70146172824200 !ruby/object:Gem::Requirement
+  requirement: &70347564150300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70146172824200
+  version_requirements: *70347564150300
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70146172823600 !ruby/object:Gem::Requirement
+  requirement: &70347564149720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146172823600
+  version_requirements: *70347564149720
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70347564149100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.14
+  type: :development
+  prerelease: false
+  version_requirements: *70347564149100
 description: ! 'Boffin is a library for tracking hits to things in your Ruby application.
   Things
 
@@ -100,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3925281016385501386
+      hash: 3845958252376638612
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3925281016385501386
+      hash: 3845958252376638612
 requirements: []
 rubyforge_project: boffin
 rubygems_version: 1.8.6