easyredis 0.0.4 → 0.0.5

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Alec Benzer
+
+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/Manifest

@@ -1,6 +1,8 @@
+LICENSE
 Manifest
 README.md
 Rakefile
+easyredis.gemspec
 lib/easyredis.rb
 tests/benchmark.rb
 tests/test.rb

data/README.md

@@ -46,14 +46,24 @@ We can now make post objects:
 Posts are automatically given ids that we can then use to retrive them:
 
     id = p.id
-    p = Post.find(id)
-    p.title  # => "My First Post"
+    p2 = Post.find(id)
+    p2.title  # => "My First Post"
+
+Or, we can choose our own ids:
+
+    p = Post.new("coolpost")
+    p.title = "A Cool Post"
+    p.body = "This post has a high level of coolnes."
+
+    p2 = Post.find("coolpost")  # this is a very fast lookup
+    p2.title  # => "A Cool Post"
 
 We also get a created_at field for free that we can sort by.
 
     p.created_at  # a ruby Time object
     Post.all  # get all posts, ordered by creation time
     Post.all :order => :desc  # specifying an order option
+    Post[41]  # the 42nd (0-based indexing) post that was created
     
 ## Searching and Sorting
 

data/Rakefile

@@ -2,8 +2,8 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('easyredis','0.0.4') do |p|
-  p.description = "simple framework designed to make using redis as a database simpler"
+Echoe.new('easyredis','0.0.5') do |p|
+  p.description = "framework designed to make using redis as a database simpler"
   p.url = "https://github.com/alecbenzer/easyredis"
   p.author = "Alec Benzer"
   p.email = "alecbezer @nospam@ gmail.com"

data/easyredis.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easyredis}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alec Benzer"]
-  s.date = %q{2011-02-07}
-  s.description = %q{simple framework designed to make using redis as a database simpler}
+  s.date = %q{2011-02-09}
+  s.description = %q{framework designed to make using redis as a database simpler}
   s.email = %q{alecbezer @nospam@ gmail.com}
-  s.extra_rdoc_files = ["README.md", "lib/easyredis.rb"]
-  s.files = ["Manifest", "README.md", "Rakefile", "lib/easyredis.rb", "tests/benchmark.rb", "tests/test.rb", "easyredis.gemspec"]
+  s.extra_rdoc_files = ["LICENSE", "README.md", "lib/easyredis.rb"]
+  s.files = ["LICENSE", "Manifest", "README.md", "Rakefile", "easyredis.gemspec", "lib/easyredis.rb", "tests/benchmark.rb", "tests/test.rb"]
   s.homepage = %q{https://github.com/alecbenzer/easyredis}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Easyredis", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{easyredis}
   s.rubygems_version = %q{1.5.0}
-  s.summary = %q{simple framework designed to make using redis as a database simpler}
+  s.summary = %q{framework designed to make using redis as a database simpler}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/easyredis.rb

@@ -18,6 +18,9 @@ module EasyRedis
   #
   # This method effectively turns a string into a base 27 floating point number,
   # where 0 corresponds to no letter, 1 to A, 2 to B, etc.
+  #
+  # @param [String] str the string we are computing a score for
+  # @return [Number] the string's score
   def self.string_score(str)
     str = str.downcase
     mult = 1.0
@@ -32,9 +35,12 @@ module EasyRedis
   # gets a score for a generic object
   #
   # The score is determined as follows:
-  # First, if the object is a string, string_score is used to get its score.
+  # First, if the object is a string, {string_score} is used to get its score.
   # Otherwise, we try calling the following methods on the object in turn, returning the first that works: score, to_f, to_i.
   # If none of those work, we simply return the object itself.
+  #
+  # @param obj the object to retrive a score for
+  # @return [Number] the object's score
   def self.score(obj)
     if obj.is_a? String
       string_score(obj)
@@ -50,6 +56,7 @@ module EasyRedis
   end
 
   # access the redis object
+  # @return [Redis]
   def self.redis
     @redis
   end
@@ -57,6 +64,8 @@ module EasyRedis
   # connect to a redis server
   #
   # takes the same options that Redis#new does from the redis gem
+  #
+  # @param [Hash] options a hash of options to feed to Redis.new
   def self.connect(options = {})
     @redis = Redis.new(options)
   end
@@ -102,6 +111,12 @@ module EasyRedis
     #
     # Work's like an Array's [] method. It can take a specific index, a range, or an offset and an amount/limit.
     # This method uses the underlying access method, which handles the actual retrival.
+    #
+    # @param [Range, Number] index either a number corresponding to a specific element,
+    #   a range corresponding to a range of elements,
+    #   or a number indicating an offset, if limit is also specified
+    #
+    # @param [Number] limit index is interpreted as an offset and limit is the number of elements to return from that offset
     def [](index,limit=nil)
       if limit
         offset = index
@@ -151,6 +166,10 @@ module EasyRedis
   class Sort < Collection
 
     # initialize the sort with a specific field, ordering option, and model
+    #
+    # @param [Symbol] field a symbol corresponding to a field of klass
+    # @param [:asc, :desc] order a symbol specifying to sort in either ascending or descending order
+    # @param [Class] klass the klass whose entries we are accessing
     def initialize(field,order,klass)
       raise EasyRedis::FieldNotSortable, field  unless klass.sortable?(field) 
       raise EasyRedis::UnknownOrderOption, order  unless [:asc,:desc].member? order
@@ -164,7 +183,8 @@ module EasyRedis
     # As of now, idential to the Model's count method.
     # This method is explicility defined here to overwrite the default one in Enumerable, which iterates through all the entries to count them, which is much slower than a ZCARD command
     def count
-      EasyRedis.zcard(@klass.sort_key(@field))
+      @count ||= EasyRedis.redis.zcard(@klass.sort_key(@field))
+      @count
     end
 
     def inspect
@@ -184,7 +204,7 @@ module EasyRedis
       elsif @order == :desc
         ids = EasyRedis.redis.zrevrange(@klass.sort_key(@field),a,b)
       end
-      ids.map{|i|@klass.new(i)}
+      ids.map{|i|@klass.build(i)}
     end
 
   end
@@ -198,6 +218,8 @@ module EasyRedis
     @@text_searches = []
 
     # add a field to the model
+    #
+    # @param [Symbol] name a symbol representing the name of the field
     def self.field(name)
       @@fields ||= []
       @@fields << name.to_sym
@@ -233,11 +255,15 @@ module EasyRedis
     end
 
     # index a field to be sorted/searched
+    #
+    # @param (see #field)
     def self.sort_on(field)
       @@sorts << field.to_sym
     end
 
     # index a field for text searching
+    #
+    # @param (see #field)
     def self.text_search(field)
       @@text_searches << field.to_sym
       sort_on(field) unless sortable? field
@@ -254,12 +280,12 @@ module EasyRedis
       self.sort_by :created_at, options
     end
 
-    # same as all.first
+    # same as calling self.all.first
     def self.first(n = nil)
       self.all.first(n)
     end
 
-    # same as all.last
+    # same as calling self.all.last
     def self.last(n = nil)
       self.all.last(n)
     end
@@ -269,10 +295,12 @@ module EasyRedis
       self[Kernel.rand(self.count)]
     end
 
-    # find an instance of this model based on its id
+    # find an entry of this model based on its id
+    #
+    # @param [Integer] id the id of the entry to retrive
     def self.find(id)
       if EasyRedis.redis.zscore(prefix,id)
-        new(id)
+        build(id)
       else
         nil
       end
@@ -280,28 +308,33 @@ module EasyRedis
 
     # access entries of this model based on time
     # 
-    # same as all.[]
+    # same as calling self.all.[]
     def self.[](index,amt=nil)
       self.all[index,amt]
     end
 
     # get all entries where field matches val
+    #
+    # @param [Symbol] field a symbol representing the field to search on
+    # @param val the value of field to search for
     def self.search_by(field, val, options = {})
       raise EasyRedis::FieldNotSortable, field unless @@sorts.member? field.to_sym
       scr = EasyRedis.score(val)
       # options[:limit] = [0,options[:limit]] if options[:limit]
       ids = EasyRedis.redis.zrangebyscore(sort_key(field),scr,scr,proc_options(options))
-      ids.map{|i| new(i) }
+      ids.map{|i| build(i) }
     end
 
     # get the first entry where field matches val
+    #
+    # @param (see #search_by)
     def self.find_by(field,val)
       search_by(field,val,:limit => 1).first
     end
 
     # search the model based on multiple parameters
     #
-    # takes a hash of field => value pairs
+    # @param [Hash] params a hash of field => value pairs
     def self.search(params)
       return search_by(*params.first) if params.size == 1  # comment out for benchmarking purposes
       result_set = nil
@@ -310,7 +343,7 @@ module EasyRedis
         ids = EasyRedis.redis.zrangebyscore(sort_key(field),scr,scr)
         result_set = result_set ? (result_set & Set.new(ids)) : Set.new(ids)
       end
-      result_set.map{|i|new(i)}
+      result_set.map{|i|build(i)}
     end
 
     # get all entries, sorted by the given field
@@ -320,7 +353,7 @@ module EasyRedis
 
     # gives all values for the given field that begin with str
     #
-    # The field must have been indexed with text_search.
+    # @param [Symbol] field a symbol representing a field indexed with text_search.
     def self.matches(field,str)
       raise FieldNotTextSearchable, field unless self.text_search? field
       scr = EasyRedis.score(str)
@@ -335,7 +368,7 @@ module EasyRedis
     def self.match(field,str, options = {})
       raise EasyRedis::FieldNotTextSearchable, filename unless text_search? field
       ids = EasyRedis.redis.zrange(term_key(field,str), 0, -1, proc_options(options))
-      ids.map{|i| new(i)}
+      ids.map{|i| build(i)}
     end
 
     # indicates whether field has been indexed with sort_on
@@ -356,23 +389,27 @@ module EasyRedis
       EasyRedis.redis.del(prefix)
       EasyRedis.redis.del(prefix + ":next_id")
     end
-
+    
 
     # the id of this entry
     attr_reader :id
 
     # create a new instance of this model
     #
-    # If no id is passed, one is generated for you.
-    # Otherwise, sets the id field to the passed id, but does not check to see if it is a valid id for this model.
-    # Users should use find when retiving models by id, as these check for valid ids.
-    def initialize(id=nil)
+    # @param [String] id optional id to use for the entry
+    #   if you leave this parameter out an id will be generated for you
+    # @param [Boolean] check this flag is used for internal purposes.
+    #   LEAVE IT AS TRUE
+    def initialize(id=nil,check=true)
       if id
-        @id = id
+        @id = id.to_s
+        if check
+          raise "id #{id} is already in use" if EasyRedis.redis.zscore(prefix,id)
+          EasyRedis.redis.zadd(prefix,Time.now.to_i,@id)
+        end
       else
-        @id = EasyRedis.redis.incr(prefix + ':next_id')
+        @id = EasyRedis.redis.incr(prefix + ':next_id').to_s
         EasyRedis.redis.zadd(prefix,Time.now.to_i,@id)
-        @id
       end
     end
 
@@ -407,7 +444,7 @@ module EasyRedis
 
     # returns the key name of this entry's redis hash  
     def key_name
-      prefix + ':' + @id.to_s
+      "#{prefix}:#{@id}"
     end
 
     def inspect
@@ -424,6 +461,10 @@ module EasyRedis
 
     private 
 
+    def self.build(id)
+      new(id,false)
+    end
+
     # generate a temporary key name associated with this model
     def self.get_temp_key
       i = EasyRedis.redis.incr "#{prefix}:next_tmp_id"

metadata

@@ -2,7 +2,7 @@
 name: easyredis
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Alec Benzer
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 -05:00
+date: 2011-02-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,23 +24,25 @@ dependencies:
         version: 2.1.1
   type: :development
   version_requirements: *id001
-description: simple framework designed to make using redis as a database simpler
+description: framework designed to make using redis as a database simpler
 email: alecbezer @nospam@ gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.md
 - lib/easyredis.rb
 files: 
+- LICENSE
 - Manifest
 - README.md
 - Rakefile
+- easyredis.gemspec
 - lib/easyredis.rb
 - tests/benchmark.rb
 - tests/test.rb
-- easyredis.gemspec
 has_rdoc: true
 homepage: https://github.com/alecbenzer/easyredis
 licenses: []
@@ -73,6 +75,6 @@ rubyforge_project: easyredis
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: simple framework designed to make using redis as a database simpler
+summary: framework designed to make using redis as a database simpler
 test_files: []