dynamometer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d174af14645fe43c7e534deaad6c6c0abf04d38d
-  data.tar.gz: ab541b9eddc391dcbe15a0f8f88fbda329d6ac68
+  metadata.gz: 2a5a9ab37e0048fa465edda592aa687552fe61b2
+  data.tar.gz: 4b9b62aec8ac9d6d13b2b6df5dc1dff205bd4e96
 SHA512:
-  metadata.gz: a0181af7f0587740596cab412f42433763ad1b44f5e461a0b2c29776501ef286c65964e05be9f1ef46049e3d341780bb765fdf17213f6ee0483f6e648b6b5bf4
-  data.tar.gz: 9233fa33bc59a4071638042f41daecf06bb715baea5bbcd5b126731061db5f47bfab4a1ede92b49135a285a7d01cf9abaaabfe7f058168af00bb616c7ba9da24
+  metadata.gz: 80be7c4de6046ba5007734148de1ad4568de04125569787cb73ec773cfcdc8d63c8b29c090e6731cacf1bc84c76a26656a8351397a5ee91a7fff04cf76d4b1ad
+  data.tar.gz: 486f7e1f582c0386475d5d621f1c8ecbd66fa9799c5db42166e6db5de1657e69b5e478264dbff2299e6c3d3a35839a346a162c0d5306d3dbee7599f66a91c46e

data/README.md

@@ -1,29 +1,97 @@
 # Dynamometer
 
-TODO: Write a gem description
+Adds dynamic attributes to ActiveRecord models
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Generate a migration to enable hstore
 
-    gem 'dynamometer'
+    class EnableHstore < ActiveRecord::Migration
+      def up
+        enable_extension "hstore"
+      end
+    
+      def down
+        disable_extension "hstore"
+      end
+    end
+    
+Add a dynamic_attributes hstore when creating a table
 
-And then execute:
+    create_table :users do |t|
+      t.hstore :dynamic_attributes
+      t.index :dynamic_attributes
+    end
+    
+or add dynamic_attributes to an existing table
 
-    $ bundle
+    add_column :users, :dynamic_attributes, :hstore
+    add_index :users, :dynamic_attributes
 
-Or install it yourself as:
+Add dynamic attributes to your ActiveRecord model
 
-    $ gem install dynamometer
+    class User < ActiveRecord::Base
+      include DynamicAttributes
+    end
 
-## Usage
+## Accessors
+
+You can read dynamic attributes like you would typical attributes.
+
+    user.category
+    user[:category]
+    user['category']
+
+You can write dynamic attributes like you would typical attributes, as well.
+
+    user.category = 'superuser'
+    user[:category] = 'superuser'
+    user['category'] = 'superuser'
+    user.update_attribute(:category, 'superuser')
+    user.update_attributes(category: 'superuser')
+
+Dynamic attributes will appear in your model's attributes `user.attributes` as if they were typical database attributes.
+
+You can access just the dynamic attributes by calling `dynamic_attributes`.
+
+## Querying
 
-TODO: Write usage instructions here
+You can query for matches to dynamic_attributes by calling `where_dynamic_attributes`. 
 
-## Contributing
+    current_site.users.where_dynamic_attributes(category: 'superuser')
+    current_site.users.where_dynamic_attributes(category: 'superuser', name: 'Steve')
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+I can't figure out how to do this correctly in the gem. So, for now to use `where_dynamic_attributes`, put this in your `config/initializers`:
+
+    module ActiveRecord
+      module QueryMethods
+        extend ActiveSupport::Concern
+    
+        def where_dynamic_attributes(filters)
+          (filters || {}).each do |k, v|
+            self.where_values += build_where("dynamic_attributes @> hstore(?, ?)", [k, v])
+          end
+          self
+        end
+    
+      end
+    end
+
+## ActiveModel Serializers
+
+If you want to serialize all of your dynamic attributes using activemodel serializers
+
+    class UserSerializer < ActiveModel::Serializer
+      include DynamicAttributesSerializer
+      attributes :id
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dynamometer'
+
+And then execute:
+
+    $ bundle

data/app/models/concerns/dynamic_attributes.rb

@@ -2,12 +2,13 @@ module DynamicAttributes
 
   extend ActiveSupport::Concern
 
-  def [](name)
-    attribute_name = name.to_s
-    if attribute_name == 'dynamic_attributes' || !has_dynamic_attribute?(attribute_name)
+  def [](attr_name)
+    if @attributes.keys.include?(attr_name.to_s)
       super
+    elsif has_dynamic_attribute?(attr_name)
+      read_dynamic_attribute(attr_name)
     else
-      dynamic_attributes[attribute_name]
+      super
     end
   end
 
@@ -15,17 +16,15 @@ module DynamicAttributes
     begin
       super
     rescue ActiveModel::MissingAttributeError
-      send "#{key}=", value
+      write_dynamic_attribute(key, value)
     end
   end
 
-  def method_missing(name, *args)
-    method_name = name.to_s
-    if method_name =~ /^[\w]+\=$/
-      self[:dynamic_attributes] = dynamic_attributes.merge(method_name.chop => args[0])
-      args[0]
-    elsif has_dynamic_attribute?(method_name)
-      self[method_name]
+  def method_missing(method, *args)
+    if has_dynamic_attribute?(method)
+      read_dynamic_attribute(method)
+    elsif method =~ /^[\w]+\=$/
+      write_dynamic_attribute(method.to_s.chop, args[0])
     else
       super
     end
@@ -33,18 +32,31 @@ module DynamicAttributes
 
   def attributes
     attrs = super
-    props = attrs.delete('dynamic_attributes') || {}
-    attrs.merge(props)
+    dynamic_attrs = attrs.delete('dynamic_attributes') || {}
+    dynamic_attrs.merge(attrs)
   end
 
   def dynamic_attributes
-    self[:dynamic_attributes] || {}
+    self['dynamic_attributes'] || {}
+  end
+
+  def has_attribute?(attr_name)
+    super || has_dynamic_attribute?(attr_name)
   end
 
   private
 
-  def has_dynamic_attribute?(name)
-    dynamic_attributes.has_key?(name.to_s)
+  def has_dynamic_attribute?(attr_name)
+    dynamic_attributes.has_key?(attr_name.to_s)
+  end
+
+  def read_dynamic_attribute(attr_name)
+    dynamic_attributes[attr_name.to_s]
+  end
+
+  def write_dynamic_attribute(attr_name, value)
+    @attributes.merge('dynamic_attributes' => dynamic_attributes.merge(attr_name.to_s => value))
+    value
   end
 
 end

data/dynamometer.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "dynamometer"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["John Colvin"]
   spec.email         = ["john.colvin@neo.com"]
   spec.description   = "Adds support for searchable, sortable, dynamic ActiveRecord attributes"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamometer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Colvin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2013-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler