redis-set 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f92eb97fa5e6b6a92a3fd2626601b71fa3fd672c
-  data.tar.gz: e4a4ef26258223dbf23648ad9451808ef531e7ff
+  metadata.gz: 85fb6b90aa4d2878c749b147389a183557967f5a
+  data.tar.gz: e6d89f6f66dd79108298f7d97cab63ca8e3a1e22
 SHA512:
-  metadata.gz: 44445bd85204bacb5d94c8916d3ef040f32ec61ae87ea917f7071856d456cb145c9e5c41cd57d4cacf8b5c39edc69e1e8dddfbbfc8fc66658a10b6a32858c0d1
-  data.tar.gz: cdf1eb9a32bf14bad861a68425411bf1696aace19872c7ca3276c02928545cca5dfee99d046da4c91db34776dfe5a7422b14e438a95892a2682ed04e040aa7c4
+  metadata.gz: 703d725c82cc116107ded6d3174dc2646ab419cbc0c11665523a0386e6688f104854a7c45c8feaaf18e61fdbcaf5a6e8c862ba3605461bb4b86962f0832275c5
+  data.tar.gz: a1ac7949c4cbf73eb0c9bd4f5d1c930e355860d1064a7a8dfd5c2c19d9b4d0cff4f189bc3b0f1b23705a6398fd4899e206c444195db9951d9282c225fbddf56a

data/README.md

@@ -1,6 +1,6 @@
 # Redis::Set
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redis/set`. To experiment with that code, run `bin/console` for an interactive prompt.
+A unique set of unordered items. Lightweight wrapper over redis sets with some additional enumeration and atomic operations.
 
 TODO: Delete this and the text above, and describe your gem
 
@@ -20,17 +20,99 @@ Or install it yourself as:
 
     $ gem install redis-set
 
-## Usage
+## Getting started
 
-TODO: Write usage instructions here
+```ruby
+s = Redis::Set.new 'completed_customer_ids'
+```
+
+Or you can pass in your own instance of the Redis class.
+
+```ruby
+s = Redis::Set.new 'completed_customer_ids', Redis.new(:host => "10.0.1.1", :port => 6380, :db => 15)
+```
+
+A third option is to instead pass your Redis configurations.
+
+```ruby
+s = Redis::Set.new 'completed_customer_ids', :host => "10.0.1.1", :port => 6380, :db => 15
+```
+
+## Using the set
+
+You can add data to the set using either the add or push methods.
+
+```ruby
+s.add "hello"
+s.add "world"
+s.add "hello" # the item 'hello' will only exist once in the set since it is unique
+```
 
-## Development
+You can insert multiple items set using the add_multi or push_multi methods
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+s.add_multi ["one","two","three"]
+s.add_multi "four","five","six"
+# set should have items "one","two","three","four","five","six" now
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can insert a new item into the set and get the resultant size of the set atomically
+```ruby
+new_count = s.add_with_count "awesome"
+```
 
-## Contributing
+You can pop a random item from the set
+```ruby
+result = s.pop
+```
+
+You can pop multiple random items from the set
+```ruby
+result = s.pop_multi 5 # pop 5 random items from set and return them
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redis-set.
+You can remove a specific item from the set
+```ruby
+s.remove 5  #remove the item 5 from the set if it exists
+```
+
+You can atomically remove multiple items from the set.
+
+```ruby
+s.remove_multi 3,4,5  #removes items 3,4, and 5 from the set if they exist
+```
+
+You can get the size of the set.
+
+```ruby
+s.size
+```
+
+You can see if an item exists in the set.
+
+```ruby
+s.include? "hello"
+```
+
+You can get all items in the set.
+
+```ruby
+s.all
+```
+
+The set can be cleared of all items
+```ruby
+s.clear
+```
+
+The set can also be set to expire (in seconds).
+```ruby
+# expire in five minutes
+s.expire 60*5
+```
+
+You can enumerate the set in batches.
+```ruby
+s.enumerator(100).each{ |i| puts i } #enumerate through the set in batches of 100 items per redis op
+```
 

data/lib/redis/set.rb

@@ -4,12 +4,14 @@ class Redis
   class Set
     attr_reader :name
 
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
 
     class InvalidNameException < StandardError; end;
     class InvalidRedisConfigException < StandardError; end;
 
     def initialize(name, redis_or_options = {})
+      name = name.to_s if name.kind_of? Symbol
+      
       raise InvalidNameException.new unless name.kind_of?(String) && name.size > 0
       @name  = name
       @redis = if redis_or_options.kind_of? Redis
@@ -25,6 +27,8 @@ class Redis
       @redis.sadd name, value
     end
 
+    alias push add
+
     def add_multi *values
       if values.size > 0
         values = values.first if 1 == values.size && values.first.kind_of?(Array)
@@ -32,6 +36,14 @@ class Redis
       end
     end
 
+    alias push_multi add_multi
+
+    def add_with_count value
+      block_on_atomic_attempt{ attempt_atomic_add_read_count value }
+    end
+
+    alias push_with_count add_with_count
+
     def remove value
       @redis.srem name, value
     end
@@ -43,6 +55,14 @@ class Redis
       end
     end
 
+    def pop
+      @redis.pop name, 1
+    end
+
+    def pop_multi amount
+      @redis.pop name, amount
+    end
+
     def include? value
       @redis.sismember(name, value)
     end
@@ -51,17 +71,69 @@ class Redis
       @redis.scard name
     end
 
+    alias count size
+
     def all
       @redis.smembers name
     end
 
+    def scan cursor = 0, amount=10, match = "*"
+      @redis.sscan name, cursor, :count => amount, :match => match
+    end
+
+    def enumerator(slice_size = 10)
+      cursor = 0
+      Enumerator.new do |yielder|
+        loop do
+          cursor, items = scan cursor, slice_size
+          items.each do |item|
+            yielder << item
+          end
+          raise StopIteration if cursor.to_i.zero?
+        end
+      end
+    end
+
     def clear
       @redis.del name
       []
     end
 
+    alias flush clear
+
     def expire seconds
       @redis.expire name, seconds
     end
+
+private
+
+    def attempt_atomic_add_read_count value
+      attempt_atomic_write_read lambda{ add value }, lambda{ |multi, read_result| multi.scard name}
+    end
+
+    def block_on_atomic_attempt
+      begin
+        success, result = yield
+        #puts "success is #{success} and result is #{result}"
+      end while !success && result
+      result.value
+    end
+
+    def attempt_atomic_write_read write_op, read_op
+
+      write_result, read_result  = nil, nil
+      success = @redis.watch(name) do
+        write_result = write_op.call
+        #if write_result
+          @redis.multi do |multi|
+            read_result = read_op.call multi, write_result
+          end
+        #end
+      end
+
+      [success, read_result]
+    end
+
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-set
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Misha Conway
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-14 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler