datts_right 0.0.20 → 0.0.21

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datts_right (0.0.19)
+    datts_right (0.0.20)
       datts_right
       rails (>= 3.0.0)
 

data/README.textile

@@ -15,238 +15,6 @@ h2. Why make this?
 ** Could not find by dynamic attribute straight with SQL, like so: @MyModel.find_by_dynamic_attribute_phone_which_is_dynamic("2398291308")@
 ** Had to add migrations to each model that you wanted to have dynamic attributes
 
-h2. Installation
-
-Create a migration:
-
-<pre>
-class CreateDynamicAttributes < ActiveRecord::Migration
-  def self.up
-    create_table(:dynamic_attributes) do |t|
-      t.string :name, :null => false
-      t.string :attr_key, :null => false
-      t.string :object_type, :null => false
-      t.string :attributable_type, :null => false
-      t.integer :attributable_id, :null => false
-      %w(integer string boolean text float).each do |type|
-        t.send(type, "#{type}_value".to_sym)
-      end
-    end
-
-    add_index "dynamic_attributes", ["attributable_id"], :name => "index_dynamic_attributes_on_attributable_id"
-    add_index "dynamic_attributes", ["attributable_type"], :name => "index_dynamic_attributes_on_attributable_type"
-    add_index "dynamic_attributes", ["attr_key"], :name => "index_dynamic_attributes_on_attr_key"
-
-    create_table(:dynamic_attribute_definitions) do |t|
-      t.text :definition
-      t.string :attribute_defineable_type, :null => false
-      t.integer :attribute_defineable_id, :null => false
-    end
-
-    add_index "dynamic_attribute_definitions", ["attribute_defineable_id"], :name => "index_dynamic_attribute_definitions_on_attribute_defineable_id"
-    add_index "dynamic_attribute_definitions", ["attribute_defineable_type"], :name => "index_dynamic_attribute_definitions_on_attribute_defineable_type"
-  end
-
-  def self.down
-    remove_index "dynamic_attribute_definitions", :name => "index_dynamic_attribute_definitions_on_attribute_defineable_id"
-    remove_index "dynamic_attribute_definitions", :name => "index_dynamic_attribute_definitions_on_attribute_defineable_type"
-
-    drop_table(:dynamic_attribute_definitions)
-
-    remove_index "dynamic_attributes", :name => "index_dynamic_attributes_on_attr_key"
-    remove_index "dynamic_attributes", :name => "index_dynamic_attributes_on_attributable_type"
-    remove_index "dynamic_attributes", :name => "index_dynamic_attributes_on_attributable_id"
-
-    drop_table(:dynamic_attributes)
-  end
-end
-</pre>
-
-* *attr_key* the name of the dynamic attribute
-* *object_type* what type of value is saved. See "object_type":#object_type.
-* *attributable_id* and *attributable_type* are for the polymorphic association
-* *integer_value*, *string_value*, *boolean_value*, *text_value*, *float_value* are used to store the data. See "object_type":#object_type.
-
-Add this to your Gemfile:
-
-@gem 'datts_right'@
-
-Add this to the model that you want to have dynamic attributes:
-
-@has_dynamic_attributes@
-
-h2. Usage
-
-First, you should know _when_ to use it.
-
-* Definitely more expensive than normal attributes
-* Can easily complicate your app if overused
-
-Knowing that, read on...
-
-h3. Adding a dynamic attribute to a record
-
-pre. @user = User.create :name => "Roland Deschain"
-@user.add_dynamic_attribute(:age, "integer")
-@user.write_dynamic_attribute :age, 820
-@user.save
-
-h3. @instance.dynamic_attribute_details
-
-pre. @user.dynamic_attribute_details(:age) # Returns a dynamic attribute record, where you can access the following:
-@user.dynamic_attribute_details(:age).object_type # "integer"
-@user.dynamic_attribute_details(:age).value # 820
-
-h3. dynamic_attribute?(:some_attribute)
-
-Returns true or false
-
-h3. Dynamic find
-
-pre. User.find_by_dynamic_attribute_age(240) # returns the first user with that age
-
-You can also use:
-
-pre. find_all_by_dynamic_attribute
-find_last_by_dynamic_attribute
-
-h3. Mimicking ActiveRecord
-
-You can read and write the attributes directly:
-
-@page.age = 200 # here, age is a dynamic attribute
-@page.age # returns 200
-
-h3. Defining attributes
-
-If you want to define what attributes will exist, you can set an associated record to define what will attributes will automatically exist. Best explained by example:
-
-<pre>
-class Category < AR::Base
-  has_dynamic_attributes :definition => true
-  has_many :pages
-end
-
-class Page < AR::Base
-  has_dynamic_attributes :of => :category
-  belongs_to :category
-end
-</pre>
-
-pre. @category = Category.create
-@category.definition = {:price => {:object_type => "integer"}, :description => {:object_type => "text"}}
-@category.save
-@page = Page.create :category => category
-@page.price = 200
-@page.description = "hi there"
-
-What happened here was that for every definition in category, a dynamic attribute was created on every page that belongs to that category. These dynamic attributes are added to page after_create. That means if you change the definition of the category afterwards, then it won't affect the pages that already exist.
-
-The only thing that is *required* is @:price => {:object_type => "integer"}@ - you may add more information like: @:price => {:object_type => "integer", :name => "Price", :description => "How much this will cost."}@
-
-You can access all that other information this way:
-
-pre. @page.dynamic_attribute_details(:price).definer[:name] # "Price"
-@page.dynamic_attribute_details(:price).definer[:description] # "How much this will cost."
-
-h3. create_defitions!
-
-You can call @create_definitions!@ on a model if you later on add the ability for that model to be a definer. For example, if you first start your Category without @has_dynamic_attributes :definition => true@, then later on you install datts_right, and you want Category to have a definition, you first add @has_dynamic_attributes :definition => true@ to Category, then you call @Category.create_definitions!@
-
-h2. Stuff that make things faster
-
-The dynamic attributes are only actually saved when save is called on the record that has them.
-
-pre. @user.add_dynamic_attribute(:gunslinger, "boolean") # a column is already written on the "dynamic_attributes" table, with a null value.
-@user.add_dynamic_attribute(:middle_name, "string") # a column is already written on the "dynamic_attributes" table, with a null value.
-@user.write_dynamic_attribute :gunslinger, true # saves into memory
-@user.middle_name = "Unknown" # saves into memory
-@user.save # the respective dynamic attribute columns are written in the dynamic_attributes table
-
-h2. Structure of the dynamic_attributes table
-
-Although you probably shouldn't work with it directly, the dynamic_attributes table looks like this:
-
-pre. ActiveRecord::Base.connection.create_table(:dynamic_attributes) do |t|
-  t.string :name, :null => false
-  t.string :attr_key, :null => false
-  t.string :object_type, :null => false
-  t.string :attributable_type, :null => false
-  t.integer :attributable_id, :null => false
-  %w(integer string boolean text float).each do |type|
-    t.send(type, "#{type}_value".to_sym)
-  end
-end
-
-This means that depending on the type of dynamic attribute you're creating, things will get saved in the respective column in the dynamic_attributes table.
-
-pre. @user.add_dynamic_attribute(:gunslinger, "boolean")
-adds this to the dynamic_attributes table: 
-
-pre. { 
-  :attr_key => "gunslinger", 
-  :attributable_id => [the user's id],
-  :attributable_type => "User",
-  :object_type => "boolean",
-  :boolean_value => true
-}
-
-*Why have different value columns?* Because I couldn't find any other way to perform SQL operations/calculations on a generic "value" column. Besides, what kind of column would that be? A text blob?
-
-h2(#object_type). Dynamic attribute "type"
-
-Here are the different types of dynamic attributes you can save:
-
-* string
-* text
-* integer
-* float
-* boolean
-
-If you assign a value to a dynamic attribute that isn't the original type, it is ignored.
-
-pre. @user.write_dynamic_attribute :gunslinger, true
-@user.save
-@user.read_dynamic_attribute(:gunslinger) # true
-@user.write_dynamic_attribute :gunslinger, "hey there"
-@user.save
-@user.read_dynamic_attribute(:gunslinger) # true
-
-h2. Removing a dynamic attribute
-
-pre. @user.remove_dynamic_attribute(:gunslinger)
-@user.read_dynamic_attribute(:gunslinger) # NoMethodError
-@user.dynamic_columns # will not include :gunslinger => {...}
-
-h2. Ordering
-
-You can call
-
-pre. Product.order_by_dynamic_attribute("price", "float") # returns all users with their dynamic attribute "name" in ascending order
-
-Why pass the "float" in the order method? Because what if 2 different user records both have the dynamic attribute "price", but for one it's a float, and for the other it's an integer? How would you know which to order things by?
-
-h2. Where
-
-You can do:
-
-pre. Product.where_dynamic_attribute(:price => 200.0, :rating => 5)
-
-As of now it accepts a hash only. If you want to scope to normal attributes, use the normal @where@ method.
-
-h2. Shortcuts
-
-Pretty much all methods that have dynamic_attribute can be shorter:
-
-|_. Long name |_. Short name |
-| write_dynamic_attribute | write_datt |
-| read_dynamic_attribute | read_datt |
-| update_dynamic_attribute | update_datt |
-| update_dynamic_attributes | update_datts |
-| find_by_dynamic_attribute_ | find_by_datt_ |
-| order_by_dynamic_attribute | order_by_datt |
-| where_dynamic_attribute | where_datt |
-
 h2. Contributing to dynamic_attributes_right
 
 There are definitely things that don't work, and could be done better. For example, it would be nice to:

data/VERSION

@@ -1 +1 @@
-0.0.20
+0.0.21

data/datts_right.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datts_right}
-  s.version = "0.0.20"
+  s.version = "0.0.21"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ramon Tayag"]
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/datts_right/query_methods.rb",
     "spec/datt_spec.rb",
     "spec/datts_right/add_definition_spec.rb",
+    "spec/datts_right/add_definitions_spec.rb",
     "spec/datts_right/add_dynamic_attribute_spec.rb",
     "spec/datts_right/add_dynamic_attributes_spec.rb",
     "spec/datts_right/attributes_spec.rb",
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
     "spec/datts_right/inheritance_spec.rb",
     "spec/datts_right/read_dynamic_attribute_spec.rb",
     "spec/datts_right/remove_definition_spec.rb",
+    "spec/datts_right/remove_definitions_spec.rb",
     "spec/datts_right/remove_dynamic_attribute_spec.rb",
     "spec/datts_right/where_dynamic_attribute_spec.rb",
     "spec/datts_right_spec.rb",
@@ -63,6 +65,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/datt_spec.rb",
     "spec/datts_right/add_definition_spec.rb",
+    "spec/datts_right/add_definitions_spec.rb",
     "spec/datts_right/add_dynamic_attribute_spec.rb",
     "spec/datts_right/add_dynamic_attributes_spec.rb",
     "spec/datts_right/attributes_spec.rb",
@@ -73,6 +76,7 @@ Gem::Specification.new do |s|
     "spec/datts_right/inheritance_spec.rb",
     "spec/datts_right/read_dynamic_attribute_spec.rb",
     "spec/datts_right/remove_definition_spec.rb",
+    "spec/datts_right/remove_definitions_spec.rb",
     "spec/datts_right/remove_dynamic_attribute_spec.rb",
     "spec/datts_right/where_dynamic_attribute_spec.rb",
     "spec/datts_right_spec.rb",
@@ -296,6 +300,12 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<autotest>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<datts_right>, [">= 0"])
       s.add_dependency(%q<rails>, [">= 3.0.0"])
@@ -510,6 +520,12 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<autotest>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<datts_right>, [">= 0"])
@@ -725,6 +741,12 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<autotest>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/lib/datts_right/base.rb

@@ -43,6 +43,8 @@ module DattsRight
       }
       
       scope :where_datt, lambda { |opts| where_dynamic_attribute(opts) }
+      scope :where_datts, lambda { |opts| where_dynamic_attribute(opts) }
+      scope :where_dynamic_attributes, lambda { |opts| where_dynamic_attribute(opts) }
       scope :where_dynamic_attribute, lambda { |opts|
         # TODO accept stuff other than the normal hash
         # Lifted from AR::Relation#build_where

data/lib/datts_right/instance_methods.rb

@@ -132,6 +132,12 @@ module DattsRight
       end
     end
 
+    def add_definitions(hash)
+      hash.each do |k, v|
+        add_definition k, v
+      end
+    end
+
     def remove_definition(key)
       key = key.to_sym
       if dynamic_attributes_options[:definition]
@@ -145,6 +151,12 @@ module DattsRight
       end
     end
 
+    def remove_definitions(*array)
+      array.each do |a|
+        remove_definition a
+      end
+    end
+
     private
 
     # Called after validation on update so that dynamic attributes behave

data/spec/datts_right/add_definitions_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe DattsRight, ".add_definitions(hash)" do
+  before do
+    reset_database
+  end
+  
+  it "should add a definition to the existing definition" do
+    c = Category.create
+    c.should_receive(:add_definition).with(:robot, :object_type => "text")
+    c.should_receive(:add_definition).with(:another, :object_type => "string")
+    c.add_definitions(:robot => {:object_type => "text"}, :another => {:object_type => "string"})
+  end
+end

data/spec/datts_right/remove_definitions_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe DattsRight, ".remove_definitions(array)" do
+  before do
+    reset_database
+  end
+  
+  it "should add a definition to the existing definition" do
+    c = Category.create
+    c.should_receive(:remove_definition).with(:robot)
+    c.should_receive(:remove_definition).with(:another)
+    c.remove_definitions(:robot, :another)
+  end
+end

data/spec/datts_right/where_dynamic_attribute_spec.rb

@@ -12,6 +12,18 @@ describe DattsRight, ".where_dynamic_attribute" do
     Page.where_dynamic_attribute(:price => 200.0).should == Page.where_datt(:price => 200.0)
   end
 
+  it "should be aliased by where_datts" do
+    @page.add_dynamic_attribute(:price, "float")
+    @page.write_dynamic_attribute :price, 200.0
+    Page.where_dynamic_attribute(:price => 200.0).should == Page.where_datts(:price => 200.0)
+  end
+
+  it "should be aliased by where_dynamic_attributes" do
+    @page.add_dynamic_attribute(:price, "float")
+    @page.write_dynamic_attribute :price, 200.0
+    Page.where_dynamic_attribute(:price => 200.0).should == Page.where_dynamic_attributes(:price => 200.0)
+  end
+
   it "should automatically join in the dynamic_attributes table" do
     @page.add_dynamic_attribute(:price, "float")
     @page.write_dynamic_attribute :price, 200.0

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: datts_right
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 0
-  - 20
-  version: 0.0.20
+  - 21
+  version: 0.0.21
 platform: ruby
 authors: 
 - Ramon Tayag
@@ -3214,6 +3214,96 @@ dependencies:
   name: rcov
   version_requirements: *id213
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id214 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: autotest
+  version_requirements: *id214
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id215 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: sqlite3
+  version_requirements: *id215
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id216 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id216
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id217 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id217
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id218 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id218
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id219 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id219
+  prerelease: false
 description: Creates a separate table that saves all your dynamic attributes.
 email: ramon@tayag.net
 executables: []
@@ -3247,6 +3337,7 @@ files:
 - lib/datts_right/query_methods.rb
 - spec/datt_spec.rb
 - spec/datts_right/add_definition_spec.rb
+- spec/datts_right/add_definitions_spec.rb
 - spec/datts_right/add_dynamic_attribute_spec.rb
 - spec/datts_right/add_dynamic_attributes_spec.rb
 - spec/datts_right/attributes_spec.rb
@@ -3257,6 +3348,7 @@ files:
 - spec/datts_right/inheritance_spec.rb
 - spec/datts_right/read_dynamic_attribute_spec.rb
 - spec/datts_right/remove_definition_spec.rb
+- spec/datts_right/remove_definitions_spec.rb
 - spec/datts_right/remove_dynamic_attribute_spec.rb
 - spec/datts_right/where_dynamic_attribute_spec.rb
 - spec/datts_right_spec.rb
@@ -3298,6 +3390,7 @@ summary: Allows saving of dynamic attributes in your ActiveRecord model
 test_files: 
 - spec/datt_spec.rb
 - spec/datts_right/add_definition_spec.rb
+- spec/datts_right/add_definitions_spec.rb
 - spec/datts_right/add_dynamic_attribute_spec.rb
 - spec/datts_right/add_dynamic_attributes_spec.rb
 - spec/datts_right/attributes_spec.rb
@@ -3308,6 +3401,7 @@ test_files:
 - spec/datts_right/inheritance_spec.rb
 - spec/datts_right/read_dynamic_attribute_spec.rb
 - spec/datts_right/remove_definition_spec.rb
+- spec/datts_right/remove_definitions_spec.rb
 - spec/datts_right/remove_dynamic_attribute_spec.rb
 - spec/datts_right/where_dynamic_attribute_spec.rb
 - spec/datts_right_spec.rb