redis-attrs 0.0.1 → 0.1.0

data/README.md

@@ -133,6 +133,23 @@ it must be declared with the singular version of the method `redis_attrs`, like
 For more details about the supported configuration options for each of the complex
 data types, please refer to the [redis-objects][redis-objects] gem.
 
+### Filtering collection values
+
+There's an attribute configuration option for lists and sets, the `:filter` option,
+that allows the user to define a function that will modify the items upon insertion
+into the collection.
+
+    class Film
+      redis_attr :genres, :set, :filter => lambda { |v| v.strip.downcase.gsub(/\s+/, ' ') }
+    end
+
+After the above declaration we could do:
+
+    >> film = Film.new(1)
+    >> film.genres = ["Action ", "  drama", "film   Noir", "Drama", "Film noir "]
+    >> puts film.genres.members.sort
+    ["action", "drama", "film noir"]
+
 ## Contributing
 
 1. Fork it

data/lib/redis-attrs/complex.rb

@@ -4,6 +4,7 @@ require "redis/set"
 require "redis/sorted_set"
 require "redis/lock"
 require "redis/counter"
+require "redis-attrs/objects_extensions"
 
 class Redis
   module Attrs
@@ -36,8 +37,8 @@ class Redis
           lock:       Redis::Lock,
           counter:    Redis::Counter,
           hash:       Redis::HashKey,
-          list:       Redis::List,
-          set:        Redis::Set,
+          list:       Redis::Attrs::FilteredList,
+          set:        Redis::Attrs::FilteredSet,
           sorted_set: Redis::SortedSet,
         }
       end

data/lib/redis-attrs/objects_extensions.rb

@@ -0,0 +1,57 @@
+class Redis
+  module Attrs
+
+    class FilteredList < Redis::List
+      def push(value)
+        value = options[:filter].call(value) if options[:filter]
+        super
+      end
+
+      # Add a member before or after pivot in the list. Redis: LINSERT
+      def insert(where,pivot,value)
+        if options[:filter]
+          value = options[:filter].call(value)
+          pivot = options[:filter].call(pivot)
+        end
+        super
+      end
+
+      # Add a member to the start of the list. Redis: LPUSH
+      def unshift(value)
+        value = options[:filter].call(value) if options[:filter]
+        super
+      end
+
+      def delete(name, count=0)
+        name = options[:filter].call(name) if options[:filter]
+        super
+      end
+    end
+
+    class FilteredSet < Redis::Set
+      def add(value)
+        value = options[:filter].call(value) if options[:filter]
+        super
+      end
+
+      def merge(*values)
+        if options[:filter]
+          filter = options[:filter]
+          values = values.map { |value| filter.call(value) }
+        end
+        super
+      end
+
+      def member?(value)
+        value = options[:filter].call(value) if options[:filter]
+        super
+      end
+
+      def delete(value)
+        value = options[:filter].call(value) if options[:filter]
+        super
+      end
+    end
+
+  end
+end

data/lib/redis-attrs/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module Attrs
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/spec/redis_attrs_spec.rb

@@ -168,5 +168,15 @@ describe Redis::Attrs do
       Film.redis_attr :watching, :lock, :expiration => 3.hours
       film.watching.options[:expiration].should == 3.hours
     end
+
+    it "supports filtering the values inserted into a list or set" do
+      Film.redis_attr :genres, :set, filter: lambda { |genre| genre.strip.downcase.gsub(/\s+/, ' ') }
+      film.genres = ["Action ", "  drama", "film   Noir", "Drama", "Film noir "]
+      film.genres.members.sort.should == ["action", "drama", "film noir"]
+      film.genres << " ACTION  " << "Western"
+      film.genres.should_not include("Western")
+      film.genres.should include("western")
+      film.genres.members.sort.should == ["action", "drama", "film noir", "western"]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-attrs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -98,6 +98,7 @@ files:
 - lib/redis-attrs/hash.rb
 - lib/redis-attrs/integer.rb
 - lib/redis-attrs/list.rb
+- lib/redis-attrs/objects_extensions.rb
 - lib/redis-attrs/scalar.rb
 - lib/redis-attrs/string.rb
 - lib/redis-attrs/time.rb