mass_assignable 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mass_assignable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Derrick Reimer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# MassAssignable
+
+MassAssignable is a simple gem that adds Rails-like mass-assignment behavior
+to ordinary Ruby objects. This gem has no external dependencies and works
+everywhere.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mass_assignable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mass_assignable
+
+## Usage
+
+Simply include `MassAssignable` in your class and specify mass assignable
+attributes using `attr_mass_assignable`. Any attributes not specified
+will not be mass assignable.
+
+```ruby
+require 'mass_assignable' # not needed with Rails
+
+class Person
+  include MassAssignable
+  
+  attr_accessor :name, :age, :height
+  attr_mass_assignable :name, :age
+end
+```
+
+Then, mass assignment is as easy as calling `attributes=`.
+
+```ruby
+person = Person.new
+person.attributes = { :name => "Derrick", :age => 24, :height => 77 }
+
+person.name
+# => "Derrick"
+
+person.age
+# => 24
+
+person.height
+# => nil
+```
+
+Notice that `#height` is nil, because we didn't include it in our call to
+`attr_mass_assignable`.
+
+If you want an error to be raised when invalid mass assignment is attempted,
+simply use `attr_mass_assignable!`.
+
+```ruby
+class ParanoidPerson
+  include MassAssignable
+  
+  attr_accessor :name, :age, :height
+  attr_mass_assignable! :name, :age
+end
+
+person = ParanoidPerson.new
+person.attributes = { :height => 77 }
+# => Raises a RuntimeError
+```
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/mass_assignable.rb

@@ -0,0 +1,64 @@
+module MassAssignable
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    # Internal: Flag determining whether to raise an exception when
+    # you attempt to mass-assign attributes that are not allowed.
+    attr_accessor :raise_on_invalid_mass_assignment
+    
+    # Internal: The Array of Symbols representing attributes that are
+    # mass assignable. This property is defined by the attr_assignable
+    # method.
+    attr_writer :mass_assignable_attributes
+    
+    def mass_assignable_attributes
+      @mass_assignable_attributes ||= []
+    end
+    
+    # Public: Accepts a list of symbols representing instance methods
+    # that allow mass-assignment.
+    #
+    # *attributes - An Array of symbols or strings.
+    #
+    # Returns nothing.
+    def attr_mass_assignable(*attributes)
+      self.raise_on_invalid_mass_assignment = false
+      self.mass_assignable_attributes ||= []
+      self.mass_assignable_attributes.push(*attributes)
+    end
+    
+    # Public: Accepts a list of symbols representing instance methods
+    # that allow mass-assignment and will raise an exception if
+    # mass assignment is attempted for attributes not specified here.
+    #
+    # *attributes - An Array of symbols or strings.
+    #
+    # Returns nothing.
+    def attr_mass_assignable!(*attributes)
+      attr_mass_assignable(*attributes)
+      self.raise_on_invalid_mass_assignment = true
+    end
+  end
+  
+  # Public: Assigns a Hash of attributes to their corresponding
+  # instance methods. If attributes are specified with attr_assignable,
+  # then only those attributes are allowed to be assigned.
+  #
+  # attribute_hash - A Hash of attribute values with symbol keys.
+  #
+  # Returns nothing.
+  def attributes=(attribute_hash)
+    paranoid = self.class.raise_on_invalid_mass_assignment
+    allowed = self.class.mass_assignable_attributes.map { |a| a.to_s }
+    
+    attribute_hash.each do |key, value|
+      if allowed.include?(key.to_s)
+        send(:"#{key}=", value)
+      else
+        raise(RuntimeError, "Mass assignment error") if paranoid
+      end
+    end
+  end
+end

data/mass_assignable.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "mass_assignable"
+  gem.version       = "1.0.0"
+  gem.authors       = ["Derrick Reimer"]
+  gem.email         = ["derrickreimer@gmail.com"]
+  gem.description   = %q{Add Rails-like mass assignment to any Ruby object}
+  gem.summary       = %q{MassAssignable provides mass assignment functionality to any Ruby object.}
+  gem.homepage      = "https://github.com/djreimer/mass_assignable"
+
+  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_development_dependency "shoulda-context"
+end

data/test/mass_assignable_test.rb

@@ -0,0 +1,114 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'mass_assignable'
+require 'minitest/autorun'
+require 'shoulda-context'
+
+class MassAssignableTest < Test::Unit::TestCase
+  class Person
+    include MassAssignable
+    
+    attr_accessor :name, :age, :height
+    attr_mass_assignable :name, :age, :height
+  end
+  
+  class Car
+    include MassAssignable
+    
+    attr_mass_assignable :make
+    attr_mass_assignable :model
+  end
+  
+  class BlankClass
+    include MassAssignable
+  end
+  
+  class NothingAssignable
+    include MassAssignable
+    attr_mass_assignable
+  end
+  
+  class ParanoidNothingAssignable
+    include MassAssignable
+    attr_mass_assignable!
+  end
+  
+  class ProtectedAttributes
+    include MassAssignable
+    
+    attr_accessor :name, :age, :height
+    attr_mass_assignable :name
+  end
+  
+  class ParanoidPerson
+    include MassAssignable
+    
+    attr_accessor :name, :age, :height
+    attr_mass_assignable! :name, :age, :height
+  end
+  
+  context ".attr_mass_assignable" do
+    should "set mass assignable attributes" do
+      assert_equal [:name, :age, :height], Person.mass_assignable_attributes
+    end
+    
+    should "set mass assignable attribute to an empty array if not called" do
+      assert BlankClass.mass_assignable_attributes.is_a?(Array)
+      assert BlankClass.mass_assignable_attributes.empty?
+    end
+    
+    should "set mass assignable attribute to an empty array if no arguments given" do
+      assert NothingAssignable.mass_assignable_attributes.is_a?(Array)
+      assert NothingAssignable.mass_assignable_attributes.empty?
+    end
+    
+    should "append attributes on multiple calls" do
+      assert Car.mass_assignable_attributes.include?(:make)
+      assert Car.mass_assignable_attributes.include?(:model)
+    end
+    
+    should "not raise an exception for invalid mass assignment attempts" do
+      person = Person.new
+      person.attributes = { :gender => "male" }
+    end
+  end
+  
+  context ".attr_mass_assignable!" do
+    should "set mass assignable attributes" do
+      assert_equal [:name, :age, :height], ParanoidPerson.mass_assignable_attributes
+    end
+    
+    should "set mass assignable attribute to an empty array if no arguments given" do
+      assert ParanoidNothingAssignable.mass_assignable_attributes.is_a?(Array)
+      assert ParanoidNothingAssignable.mass_assignable_attributes.empty?
+    end
+    
+    should "raise an exception for invalid mass assignment attempts" do
+      assert_raises(RuntimeError) do
+        person = ParanoidPerson.new
+        person.attributes = { :gender => "male" }
+      end
+    end
+  end
+  
+  context "#attributes=" do
+    should "set attribute values" do
+      person = Person.new
+      person.attributes = { :name => "Derrick", :age => 24, :height => 77 }
+      assert_equal "Derrick", person.name
+      assert_equal 24, person.age
+      assert_equal 77, person.height
+    end
+    
+    should "not overwrite unspecified attributes" do
+      original_attr = { :name => "Derrick" }
+      new_attr = { :age => 24, :height => 77 }
+      person = Person.new
+      person.attributes = original_attr
+      person.attributes = new_attr
+      
+      assert_equal "Derrick", person.name
+      assert_equal 24, person.age
+      assert_equal 77, person.height
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: mass_assignable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Derrick Reimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add Rails-like mass assignment to any Ruby object
+email:
+- derrickreimer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mass_assignable.rb
+- mass_assignable.gemspec
+- test/mass_assignable_test.rb
+homepage: https://github.com/djreimer/mass_assignable
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: MassAssignable provides mass assignment functionality to any Ruby object.
+test_files:
+- test/mass_assignable_test.rb