embedded_associations 0.0.4 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 931459993427be60c6717d86ee0e387148f34b66
+  data.tar.gz: e73417bff91288ec6b76e3fafa61a92ea74e10ec
+SHA512:
+  metadata.gz: 77b9526fdaff3aed1d35ab8a4d7d0e6ea6c2229ec4698c0a41c6fd79bb46d87a400d2c66a1898e177a8705ab94a1e94d79f17449e385b0a38da98f08118daf35
+  data.tar.gz: 38372d705068862c455f2142a459f093719360af9b8771ccf3597bd1e47e34132dd7af80c53e9ad338efee4df55f4031f9418eebc57041db40e6798d0547c567

data/.travis.yml

@@ -1,5 +1,5 @@
 rvm:
-  - 1.9.3
+  - 2.0.0
 before_install:
   - gem install bundler --version '>= 1.2.2'
-script: "bundle exec rspec"
+script: "bundle exec rspec"

data/Gemfile

@@ -3,12 +3,13 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rails', '3.2.12'
+  gem 'rails', '4.0.2'
   gem 'sqlite3'
   gem 'active_model_serializers'
 
   gem 'rspec'
   gem 'rspec-rails'
 
+  gem 'byebug'
   gem 'pry'
-end
+end

data/README.md

@@ -30,6 +30,18 @@ class PostsController < ApplicationController
 end
 ```
 
+Inside of your controllers actions, the `handle_embedded_associations` method should be called:
+
+```ruby
+def create
+  params = params.require(:post).permit(:title, tags: [:name], comments: [:title, user: [:username]])
+  post = Post.new
+  handle_embedded_associations(post, params)
+  post.update_attributes(params)
+  render json: post
+end
+```
+
 Behind the scenes, this will make the controller parse out sub-params passed in and perform the necessary ActiveRecord model manipulation. E.g., consider the params hash below:
 
 ```ruby
@@ -47,9 +59,7 @@ Based on the declared `embedded_association`s, the controller will manipulate th
 
 ### Controller and Model Pre-Requisites
 
-EmbeddedAssociations depends on your controller implementation to have two methods available, `resource` and `resource_name`. These methods will be familiar and already provided to people who use [CanCan's](https://github.com/ryanb/cancan) `load_resource` macro.
-
-When defining the relationships in the model, it is also important to set the `autosave` and `dependent` options on the association:
+When defining the relationships in the model, it is important to set the `autosave` and `dependent` options on the association:
 
 ```ruby
 class Post < ActiveRecord::Base
@@ -58,6 +68,29 @@ class Post < ActiveRecord::Base
 end
 ```
 
+### Strong Parameters
+
+As might be expected, embedded associations must have their attributes permitted via the strong parameters api. For instance, a controller with the following embedded associates configuration:
+
+```ruby
+embedded_association :comments => {:user => :account}
+embedded_association :user => [:account]
+embedded_association [:tags]
+embedded_association :category
+```
+
+The attributes of the embedded associations must be explicitly permitted:
+
+```ruby
+params.require(:post).permit(
+  :title,
+  comments: [:content, user: [:name, :email, account: [:note] ]],
+  user: [:name, :email, account: [:note] ],
+  tags: [:name],
+  category: [:name]
+)
+```
+
 ## Contributing
 
 1. Fork it

data/embedded_associations.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |gem|
   gem.email         = ["ghempton@gmail.com"]
   gem.description   = %q{ActiveRecord controller-level support for embedded associations}
   gem.summary       = %q{ActiveRecord controller-level support for embedded associations}
-  gem.homepage      = "https://github.com/GroupTalent/embedded_associations"
+  gem.homepage      = "https://github.com/getoutreach/embedded_associations"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "railties", "> 3.0.0"
+  gem.add_dependency "railties", "> 4.0.0"
 end

data/lib/embedded_associations.rb

@@ -11,23 +11,14 @@ module EmbeddedAssociations
       def self.embedded_association(definition)
         unless embedded_associations
           self.embedded_associations = Definitions.new
-          before_filter :handle_embedded_associations, only: [:update, :create, :destroy]
         end
         self.embedded_associations = embedded_associations.add_definition(definition)
       end
     end
   end
 
-  def handle_embedded_associations
-    Processor.new(embedded_associations, self).run
-  end
-
-  def root_resource
-    resource
-  end
-
-  def root_resource_name
-    resource_name
+  def handle_embedded_associations(resource, params)
+    Processor.new(embedded_associations, self, resource, params).run
   end
 
   def filter_attributes(name, attrs, action)
@@ -67,15 +58,19 @@ module EmbeddedAssociations
 
     attr_reader :definitions
     attr_reader :controller
+    attr_reader :resource
+    attr_reader :params
 
-    def initialize(definitions, controller)
+    def initialize(definitions, controller, resource, params)
       @definitions = definitions
       @controller = controller
+      @params = params
+      @resource = resource
     end
 
     def run
       definitions.each do |definition|
-        handle_resource(definition, controller.root_resource, controller.params[controller.root_resource_name])
+        handle_resource(definition, resource, params)
       end
     end
 
@@ -94,7 +89,7 @@ module EmbeddedAssociations
       definition.each do |name, child_definition|
         reflection = parent.class.reflect_on_association(name)
         attrs = parent_params && parent_params.delete(name.to_s)
-        
+
         if reflection.collection?
           attrs ||= []
           handle_plural_resource parent, name, attrs, child_definition
@@ -115,7 +110,6 @@ module EmbeddedAssociations
       end
 
       attr_array.each do |attrs|
-        attrs = ActionController::Parameters.new(attrs)
         if id = attrs['id']
           # can't use current_assoc.find(id), see http://stackoverflow.com/questions/11605120/autosave-ignored-on-has-many-relation-what-am-i-missing
           r = current_assoc.find{|r| r.id == id.to_i}
@@ -135,8 +129,7 @@ module EmbeddedAssociations
 
     def handle_singular_resource(parent, name, attrs, child_definition)
       current_assoc = parent.send(name)
-      attrs = ActionController::Parameters.new(attrs)
-      
+
       if r = current_assoc
         if attrs
           attrs = controller.send(:filter_attributes, r.class.name, attrs, :update)

data/lib/embedded_associations/version.rb

@@ -1,3 +1,3 @@
 module EmbeddedAssociations
-  VERSION = "0.0.4"
+  VERSION = "4.0.0"
 end

data/spec/embedded_associations_spec.rb

@@ -9,6 +9,7 @@ describe PostsController, type: :controller do
 
       it "should create child records" do
         json = post :create, post: {
+          title: 'ma post',
           tags: [{},{}]
         }
 
@@ -23,7 +24,7 @@ describe PostsController, type: :controller do
     context "updating" do
 
       let(:tags) {[Tag.create, Tag.create]}
-      let(:resource) { Post.create({tags: tags}, without_protection: true) }
+      let(:resource) { Post.create(tags: tags) }
       let(:hash) { serialize(resource) }
 
       it "should create new child records" do
@@ -68,6 +69,7 @@ describe PostsController, type: :controller do
 
       it "should create child record" do
         json = post :create, post: {
+          title: 'ma post',
           category: {name: 'ember-data'}
         }
 
@@ -100,7 +102,7 @@ describe PostsController, type: :controller do
 
       context do
 
-        let(:resource) { Post.create({category: Category.create(name: 'ember')}, without_protection: true) }
+        let(:resource) { Post.create(category: Category.create(name: 'ember')) }
 
         it "should destroy nil child record" do
           hash[:category] = nil
@@ -134,6 +136,7 @@ describe PostsController, type: :controller do
 
       it "should create hierarchy" do
         json = post :create, post: {
+          title: 'ma post',
           user: {name: 'G$', account: {}}
         }
 
@@ -169,7 +172,7 @@ describe PostsController, type: :controller do
 
       context do
 
-        let(:resource) { Post.create({user: User.create({name: 'G$', account: Account.create}, without_protection: true)}, without_protection: true) }
+        let(:resource) { Post.create({user: User.create({name: 'G$', account: Account.create})}) }
 
         it "should destroy nil child hierarchy" do
           hash[:user] = nil
@@ -227,8 +230,9 @@ describe PostsController, type: :controller do
 
     context "creating" do
 
-      it "should create hierarchy" do
+      it "should create hierarchy", focus: true do
         json = post :create, post: {
+          title: 'ma post',
           comments: [{user: {name: 'G$', account: {}}}]
         }
 
@@ -271,7 +275,7 @@ describe PostsController, type: :controller do
         let(:resource) {
           p = Post.create
           c = p.comments.create
-          u = c.create_user({account: Account.create}, without_protection: true)
+          u = c.create_user({account: Account.create})
           c.save
           p
         }
@@ -321,4 +325,4 @@ describe PostsController, type: :controller do
 
   end
 
-end
+end

data/spec/support/app/app/controllers/posts_controller.rb

@@ -9,12 +9,16 @@ class PostsController < ApplicationController
   attr_accessor :resource
 
   def create
-    resource.update_attributes(params[:post])
+    params = post_params
+    handle_embedded_associations(resource, params)
+    resource.update_attributes(params)
     render json: resource
   end
 
   def update
-    resource.update_attributes(params[:post])
+    params = post_params
+    handle_embedded_associations(resource, params)
+    resource.update_attributes(params)
     render json: resource
   end
 
@@ -37,4 +41,14 @@ class PostsController < ApplicationController
     'post'
   end
 
+  def post_params
+    params.require(:post).permit(
+      :title,
+      comments: [:content, user: [:name, :email, account: [:note] ]],
+      user: [:name, :email, account: [:note] ],
+      tags: [:name],
+      category: [:name]
+    )
+  end
+
 end

data/spec/support/app/app/models/account.rb

@@ -1,4 +1,3 @@
 class Account < ActiveRecord::Base
-  attr_accessible :note
   belongs_to :user
 end

data/spec/support/app/app/models/category.rb

@@ -1,4 +1,3 @@
 class Category < ActiveRecord::Base
-  attr_accessible :name
   has_many :posts
 end

data/spec/support/app/app/models/comment.rb

@@ -1,6 +1,4 @@
 class Comment < ActiveRecord::Base
-  attr_accessible :content
-
   belongs_to :post
   belongs_to :user, autosave: true, dependent: :destroy
 end

data/spec/support/app/app/models/post.rb

@@ -1,6 +1,4 @@
 class Post < ActiveRecord::Base
-  attr_accessible :title
-
   has_many :comments, autosave: true, dependent: :destroy
   has_many :tags, autosave: true, dependent: :destroy
   belongs_to :category, autosave: true, dependent: :destroy

data/spec/support/app/app/models/tag.rb

@@ -1,4 +1,3 @@
 class Tag < ActiveRecord::Base
-  attr_accessible :name
   belongs_to :post
 end

data/spec/support/app/app/models/user.rb

@@ -1,6 +1,4 @@
 class User < ActiveRecord::Base
-  attr_accessible :name, :email
-
   has_one :account, autosave: true, dependent: :destroy
   has_many :posts
   has_many :comments

data/spec/support/app/config/application.rb

@@ -47,12 +47,6 @@ module App
     # like if you have constraints or database-specific column types
     # config.active_record.schema_format = :sql
 
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
     # Enable the asset pipeline
     config.assets.enabled = true
 

metadata

@@ -1,32 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: embedded_associations
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 4.0.0
 platform: ruby
 authors:
 - Gordon L. Hempton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.0
 description: ActiveRecord controller-level support for embedded associations
 email:
 - ghempton@gmail.com
@@ -91,29 +88,28 @@ files:
 - spec/support/app/log/.gitkeep
 - spec/support/app/script/rails
 - spec/support/serialization_helpers.rb
-homepage: https://github.com/GroupTalent/embedded_associations
+homepage: https://github.com/getoutreach/embedded_associations
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: ActiveRecord controller-level support for embedded associations
 test_files:
 - spec/embedded_associations_spec.rb
@@ -163,4 +159,3 @@ test_files:
 - spec/support/app/log/.gitkeep
 - spec/support/app/script/rails
 - spec/support/serialization_helpers.rb
-has_rdoc: