active_set 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Rick Olson
+
+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,64 @@
+# Active Set
+
+This tracks the number of active objects during a certain time period in
+a Redis sorted set.  Object activity is defined by your application, and
+is out of the scope of this library.
+
+## INSTALL
+
+    gem install active_set
+
+## USAGE
+
+When an object is active, it gets added to a Redis set with a timestamp.
+
+    set = ActiveSet.new(:objects)
+    set.add(1, Time.now) # Time.now is default if no time is given.
+
+This is equivalent to the following Redis command:
+
+    ZADD active:objects 1305054408 "1"
+
+We can count the number of items in the set:
+
+    set.count # => 1
+    # ZCARD active:objects
+
+You can also count the active items since a given time:
+
+    set.count(1302462660)
+    # ZCOUNT active:objects 1302462660 +inf
+
+The set should be trimmed periodically so that old objects aren't
+counted.
+
+    set.trim(1302462660)
+    # ZREMRANGEBYSCORE active:objects -inf (1302462660
+
+If no trim date is given, 30 days is assumed.
+
+You can also check if an object is in the active set, and get it's last
+timestamp.
+
+    set.include?(1)
+    set.timestamp_for(1) # => Time
+    # ZSCORE active:objects "1"
+
+## Contribute
+
+If you'd like to hack on ActiveSet, start by forking the repo on GitHub:
+
+`https://github.com/technoweenie/redis_active_set`
+
+The best way to get your changes merged back into core is as follows:
+
+* Clone down your fork
+* Create a thoughtfully named topic branch to contain your change
+* Hack away
+* Add tests and make sure everything still passes by running rake
+* If you are adding new functionality, document it in the README
+* Do not change the version number, I will do that on my end
+* If necessary, rebase your commits into logical chunks, without errors
+* Push the branch up to GitHub
+* Send a pull request to the `technoweenie/redis_active_set` project.
+

data/Rakefile

@@ -0,0 +1,135 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end
+

data/active_set.gemspec

@@ -0,0 +1,75 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'active_set'
+  s.version           = '0.1.0'
+  s.date              = '2011-05-10'
+  s.rubyforge_project = 'active_set'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Tracks the number of active objects during a certain time period in a Redis sorted set."
+  s.description = s.summary
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Rick Olson"]
+  s.email    = 'technoweenie@example.com'
+  s.homepage = 'http://github.com/technoweenie/active_set'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  #s.require_paths << 'ext'
+  #s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  #s.executables = ["name"]
+  #s.default_executable = 'name'
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('redis', ["< 3.0", ">= 2.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.md
+    Rakefile
+    active_set.gemspec
+    lib/active_set.rb
+    test/active_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end
+

data/lib/active_set.rb

@@ -0,0 +1,97 @@
+require 'redis'
+
+class ActiveSet
+  VERSION = "0.1.0"
+  SECONDS_PER_DAY = 86400
+
+  attr_reader :key
+
+  # Initializes a new Set of active objects.
+  #
+  # name    - String name to identify this ActiveSet.
+  # options - Hash of options.
+  #           :prefix - String prefix used to namespace the Redis key.
+  #           :days   - Default Fixnum of days of items to allow in the
+  #                     set.  Default to 30.
+  #           :sec    - Fixnum of seconds of items to allow in the set.
+  #                     Defaults to using MATH to calculate seconds in
+  #                     30 days.
+  #           :redis  - An existing Redis connection.  If not set, the
+  #                     rest of this options Hash is used to initialize
+  #                     a new Redis connection.
+  def initialize(name, options = {})
+    @name = name
+    @prefix  = options.delete(:prefix) || :active
+    @days    = options.delete(:days)   || 30
+    @sec     = options.delete(:sec)    || (SECONDS_PER_DAY * @days)
+    @redis   = options.delete(:redis)
+    @key     = "#{@prefix}:#{@name}"
+    @redis ||= Redis.new(options)
+  end
+
+  # Public: Adds a new object to the Set.
+  #
+  # entry - The String identifier of the object.
+  # time  - Optional Time specifying when the object was last active.
+  #
+  # Returns nothing.
+  def add(entry, time = Time.now)
+    @redis.zadd(@key, time.to_i, entry)
+  end
+
+  # Public: Checks to see if the object is in the Set.
+  #
+  # entry - The String identifier of the object.
+  #
+  # Returns true if the object is in the set, or false.
+  def include?(entry)
+    !@redis.zscore(@key, entry).nil?
+  end
+
+  # Public: Gets the timestamp for when the given object was active.
+  #
+  # entry - The String identifier of the object.
+  #
+  # Returns the Time the object was last active, or nil.
+  def timestamp_for(entry)
+    sec = @redis.zscore(@key, entry)
+    sec ? Time.at(sec.to_i) : nil
+  end
+
+  # Public: Counts the number of objects in the set.
+  #
+  # since - An optional Time to specify the cutoff time to
+  #         count.  If provided, any object updated since the timestamp
+  #         is counted.
+  #
+  # Returns a Fixnum.
+  def count(since = nil)
+    (since ?
+      @redis.zcount(@key, since.to_i, "+inf") :
+      @redis.zcard(@key)).to_i
+  end
+
+  # Public: Trims the Set.
+  #
+  # time - Optional Time specifying the earliest cutoff point.  Any
+  #        object with a later timestamp is purged.
+  #
+  # Returns nothing.
+  def trim(time = earliest_time)
+    @redis.zremrangebyscore(@key, "-inf", "(#{time.to_i}")
+  end
+
+  # Public: Clears the Set.
+  #
+  # Returns nothing.
+  def clear
+    @redis.del(@key)
+  end
+
+  # Calculates the earliest time used as a cutoff point for #trim.
+  #
+  # Returns Fixnum seconds.
+  def earliest_time
+    Time.now.to_i - @sec
+  end
+end

data/test/active_test.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'test/unit'
+require File.expand_path("../../lib/active_set", __FILE__)
+
+class ActiveSetTest < Test::Unit::TestCase
+  def setup
+    @set = ActiveSet.new :lols, :prefix => 'active_test'
+    @set.clear
+    @key = @set.key
+  end
+
+  def test_adds_item
+    assert_equal 0, @set.count
+    assert !@set.include?('abc')
+    @set.add 'abc'
+    assert_equal 1, @set.count
+    assert @set.include?('abc')
+  end
+
+  def test_adds_item_with_custom_time
+    time = Time.local(2001)
+    @set.add 'abc', time
+    assert_equal time, @set.timestamp_for('abc')
+  end
+
+  def test_counts_items
+    assert_equal 0, @set.count
+    @set.add 'abc'
+    assert_equal 1, @set.count
+    @set.add 'def', Time.local(2001)
+    assert_equal 2, @set.count
+    @set.add 'abc'
+    assert_equal 2, @set.count
+    assert_equal 1, @set.count(Time.local(2002))
+  end
+
+  def test_trims_set
+    @set.add 'abc'
+    @set.add 'def', Time.local(2001)
+    assert_equal 2, @set.count
+    @set.trim
+    assert_equal 1, @set.count
+    assert @set.include?('abc')
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: active_set
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rick Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-10 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+description: Tracks the number of active objects during a certain time period in a Redis sorted set.
+email: technoweenie@example.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- active_set.gemspec
+- lib/active_set.rb
+- test/active_test.rb
+has_rdoc: true
+homepage: http://github.com/technoweenie/active_set
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: active_set
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Tracks the number of active objects during a certain time period in a Redis sorted set.
+test_files: []
+