redis-objects 0.7.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c9dea664a6595b39e8542280a5b91091d204d72
+  data.tar.gz: 953f0b08f429ee68d58bb50d4db16c2f93840781
+SHA512:
+  metadata.gz: 7ad7b1a216ff428b194bc2b6156f5fde907cbed35dd93780e3193b69cee1306f1b66a20cb3e952fbee3280b2acf4e9a1b7d83c3caea56e95f616a9f962e2bdc9
+  data.tar.gz: a08b2a851e6390ab78e9ca8102efab41784468aa2fbc9f3471327b13f271dc3ab981a4c055963de4ad4ad397fe7539826bef3d1f90af887bc620986ebcecd72e

data/.gitignore

@@ -0,0 +1,11 @@
+.*.swp
+*.gemspec
+nbproject
+pkg/
+spec/*.sqlite3
+.rvmrc
+spec/redis.pid
+.bundle/
+dump.rdb
+Gemfile.lock
+redis-objects-*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.rdoc

@@ -1,5 +1,21 @@
 = Changelog for Redis::Objects
 
+== 0.8.0 (9 Nov 2013)
+
+* Refactor to modular include/extend approach to enable hooking and remove evals [nateware]
+
+* Custom id field via redis_id_field :whatever [liuming]
+
+* Support marshaling of sorted set key names for incr/decr [hfwang]
+
+* Add support for pushing multiple values into a list [scranton]
+
+* Fix problematic typo in HashKey#fill [johnmaxwell]
+
+* Fix wrong parameter order for revrangebyscore method [FoGhost]
+
+* Convert to using Bundler from Jeweler to manage gem [nateware]
+
 == 0.7.0 (27 Feb 2013)
 
 * Enable inheritance of Redis::Objects models [rossta]

data/Gemfile

@@ -1,8 +1,4 @@
 source 'https://rubygems.org'
-gem 'redis', '>= 3.0.2'
-#group :development do
-#  gem 'redis-namespace'
-#  gem 'bacon'
-#  gem 'jeweler'
-#  gem 'activerecord'
-#end
+
+# Specify your gem's dependencies in redis-objects.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+		       The Artistic License 2.0
+
+	    Copyright (c) 2000-2006, The Perl Foundation.
+
+     Everyone is permitted to copy and distribute verbatim copies
+      of this license document, but changing it is not allowed.
+
+Preamble
+
+This license establishes the terms under which a given free software
+Package may be copied, modified, distributed, and/or redistributed.
+The intent is that the Copyright Holder maintains some artistic
+control over the development of that Package while still keeping the
+Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this
+license directly with the Copyright Holder of a given Package.  If the
+terms of this license do not permit the full use that you propose to
+make of the Package, you should contact the Copyright Holder and seek
+a different licensing arrangement.
+
+Definitions
+
+    "Copyright Holder" means the individual(s) or organization(s)
+    named in the copyright notice for the entire Package.
+
+    "Contributor" means any party that has contributed code or other
+    material to the Package, in accordance with the Copyright Holder's
+    procedures.
+
+    "You" and "your" means any person who would like to copy,
+    distribute, or modify the Package.
+
+    "Package" means the collection of files distributed by the
+    Copyright Holder, and derivatives of that collection and/or of
+    those files. A given Package may consist of either the Standard
+    Version, or a Modified Version.
+
+    "Distribute" means providing a copy of the Package or making it
+    accessible to anyone else, or in the case of a company or
+    organization, to others outside of your company or organization.
+
+    "Distributor Fee" means any fee that you charge for Distributing
+    this Package or providing support for this Package to another
+    party.  It does not mean licensing fees.
+
+    "Standard Version" refers to the Package if it has not been
+    modified, or has been modified only in ways explicitly requested
+    by the Copyright Holder.
+
+    "Modified Version" means the Package, if it has been changed, and
+    such changes were not explicitly requested by the Copyright
+    Holder.
+
+    "Original License" means this Artistic License as Distributed with
+    the Standard Version of the Package, in its current version or as
+    it may be modified by The Perl Foundation in the future.
+
+    "Source" form means the source code, documentation source, and
+    configuration files for the Package.
+
+    "Compiled" form means the compiled bytecode, object code, binary,
+    or any other form resulting from mechanical transformation or
+    translation of the Source form.
+
+
+Permission for Use and Modification Without Distribution
+
+(1)  You are permitted to use the Standard Version and create and use
+Modified Versions for any purpose without restriction, provided that
+you do not Distribute the Modified Version.
+
+
+Permissions for Redistribution of the Standard Version
+
+(2)  You may Distribute verbatim copies of the Source form of the
+Standard Version of this Package in any medium without restriction,
+either gratis or for a Distributor Fee, provided that you duplicate
+all of the original copyright notices and associated disclaimers.  At
+your discretion, such verbatim copies may or may not include a
+Compiled form of the Package.
+
+(3)  You may apply any bug fixes, portability changes, and other
+modifications made available from the Copyright Holder.  The resulting
+Package will still be considered the Standard Version, and as such
+will be subject to the Original License.
+
+
+Distribution of Modified Versions of the Package as Source
+
+(4)  You may Distribute your Modified Version as Source (either gratis
+or for a Distributor Fee, and with or without a Compiled form of the
+Modified Version) provided that you clearly document how it differs
+from the Standard Version, including, but not limited to, documenting
+any non-standard features, executables, or modules, and provided that
+you do at least ONE of the following:
+
+    (a)  make the Modified Version available to the Copyright Holder
+    of the Standard Version, under the Original License, so that the
+    Copyright Holder may include your modifications in the Standard
+    Version.
+
+    (b)  ensure that installation of your Modified Version does not
+    prevent the user installing or running the Standard Version. In
+    addition, the Modified Version must bear a name that is different
+    from the name of the Standard Version.
+
+    (c)  allow anyone who receives a copy of the Modified Version to
+    make the Source form of the Modified Version available to others
+    under
+
+	(i)  the Original License or
+
+	(ii)  a license that permits the licensee to freely copy,
+	modify and redistribute the Modified Version using the same
+	licensing terms that apply to the copy that the licensee
+	received, and requires that the Source form of the Modified
+	Version, and of any works derived from it, be made freely
+	available in that license fees are prohibited but Distributor
+	Fees are allowed.
+
+
+Distribution of Compiled Forms of the Standard Version
+or Modified Versions without the Source
+
+(5)  You may Distribute Compiled forms of the Standard Version without
+the Source, provided that you include complete instructions on how to
+get the Source of the Standard Version.  Such instructions must be
+valid at the time of your distribution.  If these instructions, at any
+time while you are carrying out such distribution, become invalid, you
+must provide new instructions on demand or cease further distribution.
+If you provide valid instructions or cease distribution within thirty
+days after you become aware that the instructions are invalid, then
+you do not forfeit any of your rights under this license.
+
+(6)  You may Distribute a Modified Version in Compiled form without
+the Source, provided that you comply with Section 4 with respect to
+the Source of the Modified Version.
+
+
+Aggregating or Linking the Package
+
+(7)  You may aggregate the Package (either the Standard Version or
+Modified Version) with other packages and Distribute the resulting
+aggregation provided that you do not charge a licensing fee for the
+Package.  Distributor Fees are permitted, and licensing fees for other
+components in the aggregation are permitted. The terms of this license
+apply to the use and Distribution of the Standard or Modified Versions
+as included in the aggregation.
+
+(8) You are permitted to link Modified and Standard Versions with
+other works, to embed the Package in a larger work of your own, or to
+build stand-alone binary or bytecode versions of applications that
+include the Package, and Distribute the result without restriction,
+provided the result does not expose a direct interface to the Package.
+
+
+Items That are Not Considered Part of a Modified Version
+
+(9) Works (including, but not limited to, modules and scripts) that
+merely extend or make use of the Package, do not, by themselves, cause
+the Package to be a Modified Version.  In addition, such works are not
+considered parts of the Package itself, and are not subject to the
+terms of this license.
+
+
+General Provisions
+
+(10)  Any use, modification, and distribution of the Standard or
+Modified Versions is governed by this Artistic License. By using,
+modifying or distributing the Package, you accept this license. Do not
+use, modify, or distribute the Package, if you do not accept this
+license.
+
+(11)  If your Modified Version has been derived from a Modified
+Version made by someone other than you, you are nevertheless required
+to ensure that your Modified Version complies with the requirements of
+this license.
+
+(12)  This license does not grant you the right to use any trademark,
+service mark, tradename, or logo of the Copyright Holder.
+
+(13)  This license includes the non-exclusive, worldwide,
+free-of-charge patent license to make, have made, use, offer to sell,
+sell, import and otherwise transfer the Package with respect to any
+patent claims licensable by the Copyright Holder that are necessarily
+infringed by the Package. If you institute patent litigation
+(including a cross-claim or counterclaim) against any party alleging
+that the Package constitutes direct or contributory patent
+infringement, then this Artistic License to you shall terminate on the
+date that such litigation is filed.
+
+(14)  Disclaimer of Warranty:
+THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
+IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
+NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL
+LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -1,6 +1,9 @@
 Redis::Objects - Map Redis types directly to Ruby objects
 =========================================================
 
+[![Build Status](https://travis-ci.org/nateware/redis-objects.png)](https://travis-ci.org/nateware/redis-objects)
+[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MJF7JU5M7F8VL)
+
 This is **not** an ORM. People that are wrapping ORM’s around Redis are missing the point.
 
 The killer feature of Redis is that it allows you to perform _atomic_ operations
@@ -8,7 +11,7 @@ on _individual_ data structures, like counters, lists, and sets.  The **atomic**
 Using an ORM wrapper that retrieves a "record", updates values, then sends those values back,
 _removes_ the atomicity, cutting the nuts off the major advantage of Redis.  Just use MySQL, k?
 
-This gem provides a Rubyish interface to Redis, by mapping [Redis types](http://redis.io/commands)
+This gem provides a Rubyish interface to Redis, by mapping [Redis data types](http://redis.io/commands)
 to Ruby objects, via a thin layer over the `redis` gem.  It offers several advantages
 over the lower-level redis-rb API:
 
@@ -22,8 +25,8 @@ for a fun rant on the topic, see [An Atomic Rant](http://nateware.com/2010/02/18
 or scroll down to [Atomic Counters and Locks](#atomicity) in this README.
 
 There are two ways to use Redis::Objects, either as an include in a model class (to
-integrate with ORMs or other classes), or by using new with the type of data structure
-you want to create. 
+tightly integrate with ORMs or other classes), or standalone by using classes such
+as `Redis::List` and `Redis::SortedSet`.
 
 Installation and Setup
 ----------------------
@@ -31,22 +34,21 @@ Add it to your Gemfile as:
 
     gem 'redis-objects'
 
-**Redis::Objects** needs a handle created by `Redis.new`. The recommended approach
-is to set `Redis.current` to point to your server, which **Redis::Objects** will
+Redis::Objects needs a handle created by `Redis.new`. The recommended approach
+is to set `Redis.current` to point to your server, which Redis::Objects will
 pick up automatically.
 
-    require 'redis/objects'
     Redis.current = Redis.new(:host => '127.0.0.1', :port => 6379)
 
 (If you're on Rails, `config/initializers/redis.rb` is a good place for this.)
-Remember you can use **Redis::Objects** in any Ruby code.  There are **no** dependencies
+Remember you can use Redis::Objects in any Ruby code.  There are **no** dependencies
 on Rails.  Standalone, Sinatra, Resque - no problem.
 
 Alternatively, you can set the `redis` handle directly:
 
     Redis::Objects.redis = Redis.new(...)
 
-Finally, you can even setup different handles for different classes:
+Finally, you can even set different handles for different classes:
 
     class User
       include Redis::Objects
@@ -55,23 +57,19 @@ Finally, you can even setup different handles for different classes:
       include Redis::Objects
     end
 
-    User.redis = Redis.new(...)
-    Post.redis = Redis.new(...)
+    User.redis = Redis.new(:host => '1.2.3.4')
+    Post.redis = Redis.new(:host => '5.6.7.8')
 
 As of `0.7.0`, `redis-objects` now autoloads the appropriate `Redis::Whatever`
 classes on demand.  Previous strategies of individually requiring `redis/list`
 or `redis/set` are no longer required.
 
-There are two ways to use **Redis::Objects**: As part of an model class (ActiveRecord,
-DataMapper, Mongoid, etc) or as standalong data type classes (`Redis::Set`, `Redis::List`, etc).
-
-Option 1: Model Class Usage
-============================
-Using Redis::Objects this way makes it trivial to integrate Redis types with an
-existing ActiveRecord model, DataMapper resource, or other class.  **Redis::Objects**
-will work with _any_ class that provides an `id` method that returns a unique
-value.  **Redis::Objects** will then automatically create keys that are unique to
-each object, in the format:
+Option 1: Model Class Include
+=============================
+Including Redis::Objects in a model class makes it trivial to integrate Redis types
+with an existing ActiveRecord, DataMapper, Mongoid, or similar class.  **Redis::Objects
+will work with _any_ class that provides an `id` method that returns a unique value.**
+Redis::Objects automatically creates keys that are unique to each object, in the format:
 
     model_name:id:field_name
 
@@ -91,8 +89,12 @@ For illustration purposes, consider this stub class:
     user.my_posts.increment
     user.my_posts.increment
     puts user.my_posts  # 3
+    user.my_posts.reset
+    puts user.my_posts.value # 0
+    user.my_posts.reset 5
+    puts user.my_posts.value # 5
 
-You can include Redis::Objects in any type of class:
+Here's an example that integrates several data types with an ActiveRecord model:
 
     class Team < ActiveRecord::Base
       include Redis::Objects
@@ -133,7 +135,7 @@ Sets work too:
     end
     player = @team.outfielders.detect{|of| of == 'outfielder2'}
 
-And you can do intersections between objects (kinda cool):
+And you can do unions and intersections between objects (kinda cool):
 
     @team1.outfielders | @team2.outfielders   # outfielders on both teams
     @team1.outfielders & @team2.outfielders   # in baseball, should be empty :-)
@@ -145,6 +147,17 @@ Counters can be atomically incremented/decremented (but not assigned):
     @team.hits.incr(3)    # add 3
     @team.runs = 4        # exception
 
+Defining a different method as the `id` field is easy
+
+    class User
+      include Redis::Objects
+      redis_id_field :uid
+      counter :my_posts
+    end
+
+    user.uid                # 195137a1bdea4473
+    user.my_posts.increment # 1
+
 Finally, for free, you get a `redis` method that points directly to a Redis connection:
 
     Team.redis.get('somekey')
@@ -230,7 +243,7 @@ You can bound the size of the list to only hold N elements like so:
     # Only holds 10 elements, throws out old ones when you reach :maxlength.
     @list = Redis::List.new('list_name', :maxlength => 10)
 
-Complex data types are no handled with :marshal => true:
+Complex data types are now handled with :marshal => true:
 
     @list = Redis::List.new('list_name', :marshal => true)
     @list << {:name => "Nate", :city => "San Diego"}

data/Rakefile

@@ -1,62 +1,9 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "redis-objects"
-    gem.summary = %Q{Map Redis types directly to Ruby objects}
-    gem.description = %Q{Map Redis types directly to Ruby objects. Works with any class or ORM.}
-    gem.email = "nwiger@gmail.com"
-    gem.homepage = "http://github.com/nateware/redis-objects"
-    gem.authors = ["Nate Wiger"]
-    gem.add_development_dependency "bacon", ">= 0"
-    gem.add_development_dependency "redis-namespace", ">= 1.2.0"
-    #gem.requirements << 'redis, v3.0.2 or greater'
-    #gem.add_dependency('redis', '>= 3.0.2')  # ALSO: update spec/spec_helper.rb
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-# require 'rdoc/task'
-# Rake::TestTask.new(:spec) do |spec|
-#   spec.libs << 'lib' << 'spec'
-#   spec.pattern = 'spec/**/*_spec.rb'
-#   spec.verbose = true
-# end
+require "bundler/gem_tasks"
 
 desc "run all the specs"
 task :test do
   sh "bacon spec/*_spec.rb"
 end
 
+task :default => :test
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |spec|
-    spec.libs << 'spec'
-    spec.pattern = 'spec/**/*_spec.rb'
-    spec.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "Redis::Objects #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end