acts_as_hashish 0.3.0 → 0.4.0

data/lib/acts_as_hashish.rb

@@ -2,6 +2,7 @@ require 'redis'
 require 'json'
 require 'timeout'
 require 'acts_as_hashish'
+require 'acts_as_hashish/private_class_methods'
 require 'acts_as_hashish/version'
 require 'acts_as_hashish/configuration'
 require 'acts_as_hashish/hashish'

data/lib/acts_as_hashish/hashish.rb

@@ -9,68 +9,25 @@ module Hashish
     
     @options = options
     extend ClassMethods
+    extend PrivateClassMethods
   end
 
   module ClassMethods
-    
-    private
-    def get_hashish_key(item)
-      key = @options[:key]
-      key_value = key.is_a?(Proc) ? key.call(item) : item[key]
-    end
 
-    def remove_hashish_metadata(key)
-      prefix = @options[:key_prefix]
-      Hashish.redis_connection.smembers("#{prefix}#INDEXES").each do |member|
-        Hashish.redis_connection.zrem(member, "#{prefix}@#{key}")
-        Hashish.redis_connection.srem("#{prefix}#INDEXES", member) if Hashish.redis_connection.zcard(member) == 0
+    def hashish_rebuild(data = nil)
+      hashish_wait_on_lock do
+        data ||= hashish_list(:page_size => 0)
+        hashish_flush!
       end
-      Hashish.redis_connection.smembers("#{prefix}#SORTERS").each do |member|
-        if member =~ /^#{prefix}\$[\w]+@#{key}$/
-          Hashish.redis_connection.del(member)
-          Hashish.redis_connection.srem("#{prefix}#SORTERS", member)
-        end
-       end
-    end
-
-    def add_hashish_metadata(name, category)
-      prefix = @options[:key_prefix]
-      Hashish.redis_connection.sadd("#{prefix}##{category}", name)
-    end
-
-    def redis_keys
-      Hashish.redis_connection.keys("#{@options[:key_prefix]}*").inject({}){|h,x| h[x] = Hashish.redis_connection.type(x);h}
-    end
-
-    def wait_on_lock(timeout = 0)
-      lock_key = "#{@options[:key_prefix]}#MUTEX_LOCK"
       begin
-        Timeout::timeout(timeout) do 
-          while Hashish.redis_connection.incr(lock_key) != 1
-            sleep(1)
-          end
-        end
         yield if block_given?
       ensure
-        Hashish.redis_connection.del(lock_key)
-      end
-    end
-
-    public
-    def hashish_rebuild
-      temp = nil
-      wait_on_lock do
-        temp = hashish_list(:page_size => 0)
-        hashish_flush!
-      end
-      yield if block_given?
-      temp.each do |item|
-        hashish_insert(item)
+        hashish_insert(data, Time.now.to_i)
       end
     end
 
     def hashish_flush!
-      Hashish.redis_connection.keys("#{@options[:key_prefix]}*").each{|x| Hashish.redis_connection.del(x)}
+      hashish_redis_keys.each{|x| Hashish.redis_connection.del(x)}
     end
 
     def hashish_length
@@ -78,43 +35,23 @@ module Hashish
     end
     
     def hashish_delete(key = nil)
-      key ||= get_hashish_key(hashish_list.first)
+      key ||= hashish_get_key(hashish_list.first)
       prefix = @options[:key_prefix]
       Hashish.redis_connection.zrem("#{prefix}*", "#{prefix}@#{key}")
-      remove_hashish_metadata("#{key}")
+      hashish_remove_metadata("#{key}")
       Hashish.redis_connection.del("#{prefix}@#{key}")
     end
     
-    def hashish_insert(o, t = Time.now.to_i)
-      wait_on_lock do 
-        data = o.to_json
-        prefix = @options[:key_prefix]
-        key = get_hashish_key(o)
-        raise "Error: Computed data key as '#{key}'. Only alphanumeric characters allowed!" unless key.to_s =~ /^[\w]+$/
-        Hashish.redis_connection.multi do 
-          Hashish.redis_connection.zadd("#{prefix}*", t , "#{prefix}@#{key}")
-          # Hashish.redis_connection.zremrangebyrank("#{prefix}:", 0, -(@options[:max_size] + 1)) if @options[:max_size]
-          @options[:indexes].each do |index_field, index|
-            index_value = index.is_a?(Proc) ? index.call(o) : o[index]
-            if index_value.is_a?(Array)
-              index_value.each do |i|
-                Hashish.redis_connection.zadd("#{prefix}!#{index_field}=#{i}", t, "#{prefix}@#{key}") if i.is_a?(String)
-                add_hashish_metadata("#{prefix}!#{index_field}=#{i}", 'INDEXES')
-              end
-            else
-              Hashish.redis_connection.zadd("#{prefix}!#{index_field}=#{index_value}", t, "#{prefix}@#{key}")
-              add_hashish_metadata("#{prefix}!#{index_field}=#{index_value}", 'INDEXES')
-            end
-          end
-          @options[:sorters].each do |sort_field, sort|
-            sort_value = sort.is_a?(Proc) ? sort.call(o) : o[sort]
-            Hashish.redis_connection.set("#{prefix}$#{sort_field}@#{key}", sort_value)
-            add_hashish_metadata("#{prefix}$#{sort_field}@#{key}", 'SORTERS')
-          end
-          Hashish.redis_connection.set("#{prefix}@#{key}", data)
+    def hashish_insert(data, t = Time.now.to_i)
+      if data.is_a?(Array)
+        data.each do |d|
+          hashish_single_insert(d, t)
         end
+      elsif data.is_a?(Hash)
+        hashish_single_insert(data, t)
+      else
+        raise "Data must be of type Hash or Array of Hash"
       end
-      true
     end
 
     def hashish_list(options = {})
@@ -178,7 +115,7 @@ module Hashish
       result = nil
       if sort_by
         custom_sort_key = "#{@options[:key_prefix]}#CUSTOM_SORT##{seq}"
-        Hashish.redis_connection.sort(result_key, :by => "*:#{sort_by}",:get => '*', :store => custom_sort_key, :order => sort_order)
+        Hashish.redis_connection.sort(result_key, :by => "*$#{sort_by}",:get => '*', :store => custom_sort_key, :order => sort_order)
         Hashish.redis_connection.expire(custom_sort_key, Hashish.redis_search_keys_ttl * 60)
         result = Hashish.redis_connection.lrange(custom_sort_key, offset, limit -1)
       else

data/lib/acts_as_hashish/private_class_methods.rb

@@ -0,0 +1,85 @@
+module Hashish
+  module PrivateClassMethods
+    
+    private
+    def hashish_get_key(item)
+      key = @options[:key]
+      key_value = key.is_a?(Proc) ? key.call(item) : item[key]
+    end
+
+    def hashish_remove_metadata(key)
+      prefix = @options[:key_prefix]
+      Hashish.redis_connection.smembers("#{prefix}#INDEXES").each do |member|
+        Hashish.redis_connection.zrem(member, "#{prefix}@#{key}")
+        Hashish.redis_connection.srem("#{prefix}#INDEXES", member) if Hashish.redis_connection.zcard(member) == 0
+      end
+      Hashish.redis_connection.smembers("#{prefix}#SORTERS").each do |member|
+        if member =~ /^#{prefix}@#{key}\$.+$/
+          Hashish.redis_connection.del(member)
+          Hashish.redis_connection.srem("#{prefix}#SORTERS", member)
+        end
+       end
+    end
+
+    def hashish_add_metadata(name, category)
+      prefix = @options[:key_prefix]
+      Hashish.redis_connection.sadd("#{prefix}##{category}", name)
+    end
+
+    def hashish_wait_on_lock(timeout = 0)
+      lock_key = "#{@options[:key_prefix]}#MUTEX_LOCK"
+      begin
+        Timeout::timeout(timeout) do 
+          while Hashish.redis_connection.incr(lock_key) != 1
+            sleep(1)
+          end
+        end
+        yield if block_given?
+      ensure
+        Hashish.redis_connection.del(lock_key)
+      end
+    end
+
+    def hashish_redis_keys
+      Hashish.redis_connection.keys("#{@options[:key_prefix]}*")
+    end
+
+    def hashish_single_insert(o, t) 
+      raise "Data must be of type Hash or Array of Hash" unless o.is_a?(Hash)
+      hashish_wait_on_lock do 
+        data = o.to_json
+        prefix = @options[:key_prefix]
+        key = hashish_get_key(o)
+        raise "Error: Computed data key as '#{key}'. Only alphanumeric characters and underscore allowed!" unless key.to_s =~ /^[\w_]+$/
+        Hashish.redis_connection.multi do 
+          Hashish.redis_connection.zadd("#{prefix}*", t , "#{prefix}@#{key}")
+          # Hashish.redis_connection.zremrangebyrank("#{prefix}:", 0, -(@options[:max_size] + 1)) if @options[:max_size]
+          @options[:indexes].each do |index_field, index|
+            index_value = index.is_a?(Proc) ? index.call(o) : o[index]
+            if index_value.is_a?(Array)
+              index_value.each do |i|
+                if i.is_a?(String) and !i.empty?
+                  Hashish.redis_connection.zadd("#{prefix}!#{index_field}=#{i}", t, "#{prefix}@#{key}") 
+                  hashish_add_metadata("#{prefix}!#{index_field}=#{i}", 'INDEXES')
+                end
+              end
+            elsif index_value.is_a?(String) and !index_value.empty?
+              Hashish.redis_connection.zadd("#{prefix}!#{index_field}=#{index_value}", t, "#{prefix}@#{key}")
+              hashish_add_metadata("#{prefix}!#{index_field}=#{index_value}", 'INDEXES')
+            end
+          end
+          @options[:sorters].each do |sort_field, sort|
+            sort_value = sort.is_a?(Proc) ? sort.call(o) : o[sort]
+            if sort_value # only if there is a sort_value
+              Hashish.redis_connection.set("#{prefix}@#{key}$#{sort_field}", sort_value)
+              hashish_add_metadata("#{prefix}@#{key}$#{sort_field}", 'SORTERS')
+            end
+          end
+          Hashish.redis_connection.set("#{prefix}@#{key}", data)
+        end
+      end
+      true
+    end
+
+  end
+end

data/lib/acts_as_hashish/version.rb

@@ -1,3 +1,3 @@
 module Hashish
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/hashish_spec.rb

@@ -1,12 +1,13 @@
 require 'spec_helper'
+require 'set'
 
 describe Hashish do
 
   before :each do
-    @sample_data_1 = {'id' => 1, 'name' => 'Joe'}
-    @sample_data_2 = {'id' => 3, 'name' => 'Doe'}
-    @sample_data_3 = {'id' => 2, 'name' => 'Moe'}
-    @sample_data_4 = {'id' => 4, 'name' => 'Loe'}
+    @sample_data_1 = {'id' => 1, 'name' => 'Joe', 'location' => 'Lisbon'}
+    @sample_data_2 = {'id' => 3, 'name' => 'Doe', 'location' => 'London'}
+    @sample_data_3 = {'id' => 2, 'name' => 'Moe', 'location' => 'Mumbai'}
+    @sample_data_4 = {'id' => 4, 'name' => 'Loe', 'location' => 'Goa'}
 
     @primary_key = 'id'
 
@@ -23,7 +24,7 @@ describe Hashish do
 
     @options = SampleClass.instance_variable_get(:@options)
   end
-  
+
   describe ".acts_as_hashish" do
     it "should hashify the class" do
       @options = SampleClass.instance_variable_get(:@options)
@@ -37,18 +38,18 @@ describe Hashish do
   describe ".hashish_insert" do
     it "should insert the data into the list" do
       SampleClass.hashish_insert(@sample_data_1)
-      Hashish.redis_connection.zscore("#{@options[:key_prefix]}*", "#{@options[:key_prefix]}@#{SampleClass.send(:get_hashish_key, @sample_data_1)}").should_not be_nil
+      Hashish.redis_connection.zscore("#{@options[:key_prefix]}*", "#{@options[:key_prefix]}@#{SampleClass.send(:hashish_get_key, @sample_data_1)}").should_not be_nil
     end
 
     it "should create appropriate indexes" do
       SampleClass.hashish_insert(@sample_data_1)
-      Hashish.redis_connection.zscore("#{@options[:key_prefix]}!#{@index_name}=#{@sample_data_1[@index_value]}", "#{@options[:key_prefix]}@#{SampleClass.send(:get_hashish_key, @sample_data_1)}").should_not be_nil
-      Hashish.redis_connection.zscore("#{@options[:key_prefix]}!#{@proc_index_name}=#{@proc_index_value.call(@sample_data_1)}", "#{@options[:key_prefix]}@#{SampleClass.send(:get_hashish_key, @sample_data_1)}").should_not be_nil
+      Hashish.redis_connection.zscore("#{@options[:key_prefix]}!#{@index_name}=#{@sample_data_1[@index_value]}", "#{@options[:key_prefix]}@#{SampleClass.send(:hashish_get_key, @sample_data_1)}").should_not be_nil
+      Hashish.redis_connection.zscore("#{@options[:key_prefix]}!#{@proc_index_name}=#{@proc_index_value.call(@sample_data_1)}", "#{@options[:key_prefix]}@#{SampleClass.send(:hashish_get_key, @sample_data_1)}").should_not be_nil
     end
 
     it "should create appropriate sorters" do
       SampleClass.hashish_insert(@sample_data_1)
-      Hashish.redis_connection.get("#{@options[:key_prefix]}$#{@sorter_name}@#{SampleClass.send(:get_hashish_key, @sample_data_1)}").should == @sample_data_1[@sorter_value].to_s
+      Hashish.redis_connection.get("#{@options[:key_prefix]}@#{SampleClass.send(:hashish_get_key, @sample_data_1)}$#{@sorter_name}").should == @sample_data_1[@sorter_value].to_s
     end
   end
 
@@ -56,19 +57,108 @@ describe Hashish do
     it "should delete the data from the list" do
       SampleClass.hashish_insert(@sample_data_1)
       SampleClass.hashish_delete(@sample_data_1[@primary_key])
-      Hashish.redis_connection.zscore("#{@options[:key_prefix]}:", "#{@options[:key_prefix]}:#{SampleClass.send(:get_hashish_key, @sample_data_1)}").should be_nil
-      Hashish.redis_connection.exists("#{@options[:key_prefix]}:#{SampleClass.send(:get_hashish_key, @sample_data_1)}").should be_false
+      Hashish.redis_connection.zscore("#{@options[:key_prefix]}:", "#{@options[:key_prefix]}:#{SampleClass.send(:hashish_get_key, @sample_data_1)}").should be_nil
+      Hashish.redis_connection.exists("#{@options[:key_prefix]}:#{SampleClass.send(:hashish_get_key, @sample_data_1)}").should be_false
     end
 
     it "should delete appropriate sorters and indexes" do
       SampleClass.hashish_insert(@sample_data_1)
       SampleClass.hashish_delete(@sample_data_1[@primary_key])
-      SampleClass.send(:redis_keys).should == {}
+      SampleClass.send(:hashish_redis_keys).should == []
     end
   end
 
   describe ".hashish_list" do
-    it "should list the items from the list"
+    it "should return all the items from the list" do
+      test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+      test_data.each do |data|
+        SampleClass.hashish_insert(data)        
+      end
+      test_data.each do |data|
+        SampleClass.hashish_list.include?(data).should be_true
+      end
+    end
+
+    it "should not return any items that are not from the list" do
+      test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+      test_data.each do |data|
+        SampleClass.hashish_insert(data)        
+      end
+      SampleClass.hashish_list.include?(@sample_data_4).should be_false
+    end
+
+    context "when sort_by is not specified" do
+      it "should sort the items based on the insert time with no specified sorter" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+          sleep(1) # avoid exact same time of insert (redis is quick!!!)
+        end
+        SampleClass.hashish_list.should == test_data
+      end
+    end
+
+    context "when sort_by is not specified and sort_order is DESC" do
+      it "should sort the items based on the insert time with no specified sorter" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+          sleep(1) # avoid exact same time of insert (redis is quick!!!)
+        end
+        SampleClass.hashish_list(:sort_order => 'DESC').should == test_data.reverse
+      end
+    end
+
+    context "when sort_by is specified and sort_order is not specified" do
+      it "should sort the items based on the sorter with a specified sorter" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+        end
+        SampleClass.hashish_list(:sort_by => @sorter_name).should == [@sample_data_1, @sample_data_3, @sample_data_2]
+      end
+    end
+
+    context "when sort_by is specified and sort_order is DESC" do
+      it "should sort the items based on the sorter with a specified sorter" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+        end
+        SampleClass.hashish_list(:sort_by => @sorter_name, :sort_order => 'DESC').should == [@sample_data_1, @sample_data_3, @sample_data_2].reverse
+      end
+    end
+
+    context "when a filter is provided" do
+      it "should find items using indexes based on filters" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+        end
+        SampleClass.hashish_list(:filters => {@index_name => 'Moe'}).should == [@sample_data_3]
+      end
+    end
+    
+    context "when a multiple values for filter is provided (OR)" do
+      it "should find items using indexes based on multiple values for filters" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+        end
+        SampleClass.hashish_list(:filters => {@index_name => ['Moe', 'Joe']}).should == [@sample_data_1, @sample_data_3]
+      end
+    end
+
+    context "when a multiple filters are provided (AND)" do
+      it "should find items using indexes based on multiple filters" do
+        test_data = [@sample_data_2, @sample_data_1, @sample_data_3]
+        test_data.each do |data|
+          SampleClass.hashish_insert(data)
+        end
+        SampleClass.hashish_list(:filters => {@index_name => 'Joe', @proc_index_name => ['1=>Joe']}).should == [@sample_data_1]
+      end
+    end
+
   end
 
   describe ".hashish_flush!" do
@@ -77,7 +167,7 @@ describe Hashish do
       SampleClass.hashish_insert(@sample_data_2)
       SampleClass.hashish_insert(@sample_data_3)
       SampleClass.hashish_flush!
-      SampleClass.send(:redis_keys).should == {}
+      SampleClass.send(:hashish_redis_keys).should == []
     end
   end
 
@@ -90,24 +180,25 @@ describe Hashish do
   end
 
   describe ".hashish_rebuild" do
-    it "should rebuild the list correctly" do
+    it "should build the list correctly" do
       SampleClass.hashish_insert(@sample_data_1)
       SampleClass.hashish_insert(@sample_data_2)
       SampleClass.hashish_insert(@sample_data_3)
-      before = SampleClass.send(:redis_keys) 
+      before = SampleClass.hashish_list
       SampleClass.hashish_rebuild
-      after = SampleClass.send(:redis_keys) 
+      after = SampleClass.hashish_list
       before.should == after
     end
+    
   end
   
-  describe ".wait_on_lock" do
+  describe ".hashish_wait_on_lock" do
     it "should avoid concurrency issues" do
       x = 0        
       threads = []
       (0..1).each do |i|
         threads << Thread.new do
-          SampleClass.send(:wait_on_lock) do
+          SampleClass.send(:hashish_wait_on_lock) do
             a = x + 1
             sleep(5)
             x = a
@@ -118,6 +209,6 @@ describe Hashish do
       x.should == 2
     end
   end
-  
+
 end
 

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ RSpec.configure do |config|
 
   config.before(:all) do
     Hashish.configure do |configuration|
-      configuration.redis_connection = Redis.new(:db => 15, :host => '172.16.54.24')
+      configuration.redis_connection = Redis.new(:db => 15, :host => '127.0.0.1')
       configuration.redis_namespace = 'hashish_test_namspace'
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: acts_as_hashish
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Schubert Cardozo
@@ -18,9 +18,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -29,9 +29,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.6.6
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 10.0.3
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -53,7 +53,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.11.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -64,10 +64,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.12.7
   type: :development
   version_requirements: *id005
-description: A sortable and searchable list backed by Redis
+description: A sortable and searchable list backed by Redis.  You can use it as a quick actionable workflow queue which you can search/sort and paginate thorough
 email: 
 - cardozoschubert@gmail.com
 executables: []
@@ -79,6 +79,7 @@ extra_rdoc_files: []
 files: 
 - lib/acts_as_hashish/configuration.rb
 - lib/acts_as_hashish/hashish.rb
+- lib/acts_as_hashish/private_class_methods.rb
 - lib/acts_as_hashish/version.rb
 - lib/acts_as_hashish.rb
 - spec/hashish_spec.rb