relix 1.4.1 → 1.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Yzc4YzAwNWQ2OTc0NmU4NjYxOTRjMzNiMTliNGYwZTQyM2E1NDYzOA==
+    MzI0ZGYzYjgyYjdiMjlkN2ExZjA3MTk0ZjRkYTM3YmZiMmFjMjJlYQ==
   data.tar.gz: !binary |-
-    OWU3YjljMmY1NjZlNmZlMjBhYTk5MjFmOWY2ZmYxZjQxZjg1ZDljOQ==
+    YmZjNDU0NmUwMGI0NGY5OGE0ZjUxMTBkNmQyOGVjY2VhMTM2NmVhMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzYzOTk2YjQyZWI3MjU1MjEyZmEyNmIwYjQxYmFjZWFlNWRjYWFmZmRlYzlh
-    NjM2M2Y5ZjBhYjgxNGE5NzdiZjdkNmQ3ZjE1N2Y4NDFjZTI3Nzk1ZWY3YjUx
-    YjY3YTRjMDA0YmI0MTc0NzFiNWYxZTAyODViZjFlZmMzZDhkZjA=
+    NDhjZjgyY2RjYTIzMWU0YmMyZjI5MDEwNTg4ZmVkYTZkYjRkYjBhYTBiZDZk
+    Yjk4MWQ1YjE0MjFmOTc4YzlhZWFhZjNiN2I0MWIwMTdkMmVjMDYxODIzMWNj
+    Y2RhMDU2MDI0ZTVmM2FiNjRhY2EzMDg5MDMzM2JhZGQ2Y2M5ZTY=
   data.tar.gz: !binary |-
-    OTQ1MzljMWFhZjBjMjQ3ZWI5MGE4NDRmOWVkODQwNmRiMDdkYThlNjM2YTk5
-    ZmE0Zjc0M2ZkYjI3MzE5MTI1NjNiYjk0NTA2YTc4NGJkZDg3MjAyNTAyNmU5
-    NmMzZjEyMjJlN2FiN2M5MjdmZGExMmZhMTQxMDQzMDlkNjBkZmM=
+    MjI1MDIyN2Y1ZDZiOGIwYjJlOGJlZDQ5NjNmZjdmMjc2ZWRmOWQ5NTAxNWNi
+    MTUzODBiZDM4NDdkZDI2ZTNkY2ZlNWYyNDI3NmE1MTk2N2YxZDNlYjFmNTA4
+    MjIyZGQ2MTk3NjdiMjAzMGQwYTc4ZWZhNmFkYzQ0MWE3ZDA5YzQ=

data/HISTORY.md

@@ -1,3 +1,7 @@
+### 1.5.0
+
+* Add special handling for interrogative methods. (ntalbott)
+
 ### 1.4.1
 
 * Fix double #deindex_by_primary_key when there's a multi index. (ntalbott)

data/README.md

@@ -130,7 +130,6 @@ The from option is exclusive - it does not return or count the key you pass to i
 
 Indexes are inherited up the Ruby ancestor chain, so you can for instance set the primary_key in a base class and then not have to re-declare it in each subclass.
 
-
 ### Multiple Value Indexes
 
 Indexes can be built over multiple attributes:
@@ -146,6 +145,22 @@ When there are multiple attributes, they are specified in a hash:
         {storage_state: 'cached', account_id: 'bob'}, limit: 10)
     end
 
+### Interrogative Accessors
+
+Relix has some special handling for interrogative accessors (i.e. those ending with a `?`). When one is used, Relix is smart and does not require the `?` when querying:
+
+    class Account
+      include Relix
+      relix do
+        primary_key :key
+        multi :active_and_admin, on: %w(active? admin?)
+      end
+    end
+
+    accounts = Account.lookup{|q| q[:active_and_admin].eq(active: true, admin: true)}
+
+It also auto-casts `nil` to `false` and any other object to `true` for interrogative accessors, so that lookups work like you'd expect them to in a Ruby context. If you don't want to auto-casting, just alias your interrogative to a non-interrogative name and index on that instead.
+
 ### Space efficiency
 
 Model attributes that are indexed on but that never change can be marked as immutable to prevent them being stored (since they don't have to be reindexed). The primary key is marked immutable by default, but other attributes can be as well:

data/lib/relix/index.rb

@@ -8,13 +8,32 @@ module Relix
       @compact_kind ||= kind[0..0]
     end
 
+    class Accessor
+      attr_reader :identifier
+      def initialize(name)
+        @accessor = name.to_s
+        if @accessor =~ /^(.+)\?$/
+          @identifier = $1
+          @interrogative = true
+        else
+          @identifier = @accessor
+        end
+      end
+
+      def read(object)
+        result = object.send(@accessor)
+        result = !!result if @interrogative
+        result
+      end
+    end
+
     attr_reader :model_name
-    def initialize(set, base_name, accessor, options={})
+    def initialize(set, base_name, accessors, options={})
       @set = set
       @base_name = base_name
       @model_name = @set.klass.name
-      @accessor = [accessor].flatten.collect{|a| a.to_s}
-      @attribute_immutable = !!options[:immutable_attribute]
+      @accessors = Array(accessors).collect{|a| Accessor.new(a)}
+      @attribute_immutable = options[:immutable_attribute]
       @options = options
     end
 
@@ -23,7 +42,7 @@ module Relix
     end
 
     def read(object)
-      @accessor.inject({}){|h,e| h[e] = object.send(e); h}
+      @accessors.inject({}){|h,e| h[e.identifier] = e.read(object); h}
     end
 
     def read_normalized(object)
@@ -35,13 +54,13 @@ module Relix
       when Hash
         value.inject({}){|h, (k,v)| h[k.to_s] = v; h}
       else
-        {@accessor.first => value}
+        {@accessors.first.identifier => value}
       end
-      @accessor.collect do |k|
-        if value_hash.include?(k)
-          value_hash[k].to_s
+      @accessors.collect do |accessor|
+        if value_hash.include?(accessor.identifier)
+          value_hash[accessor.identifier].to_s
         else
-          raise MissingIndexValueError, "Missing #{k} when looking up by #{name}"
+          raise MissingIndexValueError, "Missing #{accessor.identifier} when looking up by #{name}"
         end
       end.join(":")
     end

data/lib/relix/version.rb

@@ -1,3 +1,3 @@
 module Relix
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relix
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Nathaniel Talbott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false