kingpin 0.6.1 → 0.7.0

data/README.markdown

@@ -59,11 +59,11 @@ Integration
 -----------
 
 Integration into you models is straight forward. Assuming that your model has an attribute_reader or accessor_method like one of the following:
-    [:latitude, :ltt, :ltd, :lat]
+    [:latitude, :lati, :ltt, :ltd, :lat, :lttd]
 
 as well as one of the following for longitude:
 
-    [:longitude, :long, :lng, :lgt, :lgdt]
+    [:longitude, :long, :lng, :lgt, :lgtd, :lngtd]
 
 **and** the values are in *DEG* **not** *RAD*, your way of integration looks like that:
 
@@ -78,7 +78,7 @@ Either way, Kingpin tries to minimize your pain, so some configuration options a
 * `:methods => {:lat => :your_latitude, :lng => :your_longitude}` in case your location accessors have different names
 * `:rad => true` defaults to *false* if not mentioned, and assumes your lat and lng in *RAD* instead of *DEG*
 * `:autopin => true` automatically generates a Pincaster record every time an instance of an enabled model is saved
-* `:include => [unimplemented yet]`
+* `:include => :all | {:only => [:attr_1, :attr_2, ...]} | {:except => [:attr_1, :attr_2, ...]}`
 
 Example: In case your longitude resides at :cool_longitude, your latitude at :cool_latitude, the values are stored in *RAD* and you would like to automatically create Pincaster pins, your classes head should look like this:
 
@@ -87,6 +87,15 @@ Example: In case your longitude resides at :cool_longitude, your latitude at :co
       ...
     end
 
+In case you would like to integrate the instances values for :name and :title only into the pin, your class definition looked like that:
+
+    class FooWithLocation
+      pinnable :include => {:only => [:name, :title]}
+      ...
+    end
+
+Vice versa `:include => {:except => [:name, :title]}` would integrate all attributes but :name and :title, `:include => :all` integrated all available attributes of the instance.
+
 Indexing
 --------
 
@@ -189,7 +198,6 @@ Coming soon
 Kingpin is missing some functionality yet, but this will arrive soon:
 
 - support for rectangle search
-- support for storage of optional AR attributes of an instance via include
 - distance integration into every returned AR record at retrieval time
 - automated Raketask for index creation
 - tests

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/kingpin.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kingpin}
-  s.version = "0.6.1"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Roesner"]

data/lib/king_pin.rb

@@ -50,7 +50,7 @@ module KingpinInstanceMethods
   # returns objects longitude depending on configured method name for access as well as DEG or RAD configuration
   def pin_lng
     if not !!self.class.kingpin_args[:methods]
-      [:longitude, :long, :lng, :lgt, :lgdt].each do |l|
+      [:longitude, :long, :lng, :lgt, :lgtd, :lngtd].each do |l|
         if self.respond_to?(l)
           return !!self.class.kingpin_args[:rad] ? self.send(l).to_f * 180 / Math::PI : self.send(l)
         end
@@ -64,7 +64,7 @@ module KingpinInstanceMethods
   # returns objects latitude depending on configured method name for access as well as DEG or RAD configuration
   def pin_lat
     if not !!self.class.kingpin_args[:methods]
-      [:latitude, :lati, :ltt, :ltd, :lat].each do |l|
+      [:latitude, :lati, :ltt, :ltd, :lat, :lttd].each do |l|
         if self.respond_to?(l)
           return !!self.class.kingpin_args[:rad] ? self.send(l).to_f * 180 / Math::PI : self.send(l)
         end
@@ -80,6 +80,28 @@ module KingpinInstanceMethods
     self.add_pin
   end
 
+  # returns additional attributes of self that shall be included into the pin
+  def additional_attributes
+    return {} unless !!self.class.kingpin_args[:include]
+    case self.class.kingpin_args[:include].class.to_s
+    when "Symbol"
+      raise ":all is the only stand alone symbol that is allowed with :include" unless self.class.kingpin_args[:include] == :all
+      self.attributes
+    when "Hash"
+      if self.class.kingpin_args[:include].size > 1 or not [:only, :except].include? self.class.kingpin_args[:include].first.first
+        raise ":include supports :only => [:foo, :bar] and :except => [:scooby, :doo] only"
+      end
+      case self.class.kingpin_args[:include].first.first
+      when :only
+        self.attributes.delete_if{ |name, value| !self.class.kingpin_args[:include].first[1].include?(name.to_sym) }
+      when :except
+        self.attributes.delete_if{ |name, value| self.class.kingpin_args[:include].first[1].include?(name.to_sym) }
+      end
+    else
+      raise ":include needs :all, {:only => [:foo, :bar]} or {:except => [:scooby, :doo]}"
+    end
+  end
+
 end
 
 ###

data/lib/pincaster.rb

@@ -67,7 +67,7 @@ class Pincaster
                                "/records/#{record.class.to_s}/#{record.id}.json",
                                nil,
                                nil,
-                               {:_loc => "#{record.pin_lat},#{record.pin_lng}"}).code == "200" ? true : false
+                               {:_loc => "#{record.pin_lat},#{record.pin_lng}"}.merge(record.additional_attributes)).code == "200" ? true : false
   end
 
   # returns a pin object for the given ActiveRecord object

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kingpin
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Jan Roesner