su_attr_accessibility 0.5.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,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+group :test do
+  gem 'activerecord'
+  gem 'sqlite3'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gert Goet
+
+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,78 @@
+# SuAttrAccessibility
+
+Using attr_accessible you can explicitly define what attributes of a model can be assigned.
+As of Rails 3.1 this got even better as you can define different lists of attributes for different roles.
+
+While this is all good and fine to protect your models from malicious input from outside (handled mostly in controllers), it will also make other interactions with your models somewhat harder: e.g. when testing or when in the console you always have to pass a role which can access the correct attributes.
+
+This gem tries to solve this by letting you define roles that are allowed to access all attribites. It even makes it possible to forget all this role-stuff and only explicitly use roles in places where it matters (again: mostly in controllers).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'su_attr_accessibility'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install su_attr_accessibility
+
+## Usage
+
+```ruby
+    class Person < ActiveRecord::Base
+      belongs_to :account
+
+      # attributes mass-assignable as role default
+      attr_accessible :email
+
+      # the admin-role can access all...
+      su_attr_accessible_as :admin
+
+      # ...even attributes defined later on
+      attr_accessor :current_step
+    end
+
+    p1 = Person.new(:email => 'person1@example.org', :active => true)
+    p1.email    # => 'person1@example.org'
+    p1.active   # => nil
+    p2 = Person.new({:email => 'person1@example.org', :active => true,
+                      :account => Account.first, :current_step => 1},
+                      :as => :admin)
+    p2.email        # => 'person1@example.org'
+    p2.active       # => true
+    p2.current_step # => 2
+    p2.account      # => <Account ...>
+```
+
+Alternatively the default-role is passed to su_attr_accessible_as and
+another role is used for attr_accessible. This is more convenient when
+working in the console for example (no ':as => :role' is needed) though
+is less secure of course.
+
+Enabling this behaviour by default for all subclasses of AR:
+
+```ruby
+    class ActiveRecord::Base
+      def self.inherited(child_class)
+        child_class.class_eval{ su_attr_accessible_as :default }
+        super
+      end
+    end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Author
+
+Gert Goet (eval) :: gert@thinkcreate.nl :: @gertgoet

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+end
+
+desc "Run the specs"
+task :default => :spec
+
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/lib/su_attr_accessibility.rb

@@ -0,0 +1,79 @@
+require 'active_support'
+
+module SuAttrAccessibility
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Make all attributes of an AR-model accessible to some roles.
+    #
+    # @example
+    #   class Person < ActiveRecord::Base
+    #     include SuAttrAccessibility
+    #
+    #     belongs_to :account
+    #
+    #     # attributes mass-assignable as role default
+    #     attr_accessible :email
+    #
+    #     # the admin-role can access all...
+    #     su_attr_accessible_as :admin
+    #
+    #     # ...even attributes defined later on
+    #     attr_accessor :current_step
+    #   end
+    #
+    #   p1 = Person.new(:email => 'person1@example.org', :active => true)
+    #   p1.email    # => 'person1@example.org'
+    #   p1.active   # => nil
+    #   p2 = Person.new({:email => 'person1@example.org', :active => true,
+    #                     :account => Account.first, :current_step => 1},
+    #                     :as => :admin)
+    #   p2.email        # => 'person1@example.org'
+    #   p2.active       # => true
+    #   p2.current_step # => 2
+    #   p2.account      # => <Account ...>
+    #
+    #   Alternatively the default-role is passed to su_attr_accessible_as and
+    #   another role is used for attr_accessible. This is more convenient when
+    #   working in the console for example (no ':as => :role' is needed) though
+    #   is less secure of course.
+    #
+    #   Enabling this behaviour by default for all subclasses of AR:
+    #   class ActiveRecord::Base
+    #     def self.inherited(child_class)
+    #       child_class.class_eval{ su_attr_accessible_as :default }
+    #       super
+    #     end
+    #   end
+    def su_attr_accessible_as(*roles)
+      re_method_filter = %r{(.+)=\z}
+
+      # take care of any future attribute
+      unless respond_to?(:method_added_with_su_attr_accessibility)
+        class_eval %{
+          def self.method_added_with_su_attr_accessibility(m)
+            if attribute = m.to_s[#{re_method_filter.inspect}, 1]
+              attr_accessible attribute, :as => #{roles.inspect}
+          end
+            method_added_without_su_attr_accessibility(m)
+            end
+
+            class << self
+            alias_method_chain :method_added, :su_attr_accessibility
+            end
+        }, __FILE__, __LINE__ + 1
+      end
+
+      # handle current attributes
+      attributes = [].tap do |a|
+        a.push *self.attribute_names
+        a.push *self.instance_methods(false).map do |m|
+          m.to_s[re_method_filter, 1]
+        end.compact
+      end.each do |attr|
+        attr_accessible attr, :as => roles
+      end
+    end
+  end
+end
+ActiveRecord::Base.send(:include, SuAttrAccessibility) if defined?(ActiveRecord)

data/lib/su_attr_accessibility/version.rb

@@ -0,0 +1,3 @@
+module SuAttrAccessibility
+  VERSION = "0.5.0"
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'active_record'
+require "su_attr_accessibility"
+
+Bundler.require(:test)

data/spec/su_attr_accessibility/saa_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database  => ":memory:")
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define do
+  create_table :people do |t|
+    t.column :name, :string
+    t.column :age, :integer
+
+    t.timestamps
+  end
+end
+
+class Person < ActiveRecord::Base
+  include SuAttrAccessibility
+
+  attr_accessible :name
+  su_attr_accessible_as :admin
+end
+
+describe SuAttrAccessibility do
+  it "let's admin assign protected attributes" do
+    p1 = Person.new(:age => 12)
+    p1.age.should be_nil
+
+    p2 = Person.new({:age => 12}, :as => :admin)
+    p2.age.should == 12
+  end
+end

data/su_attr_accessibility.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/su_attr_accessibility/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gert Goet"]
+  gem.email         = ["gert@thinkcreate.nl"]
+  gem.description   = %q{Make all attributes of an AR-model accessible to some roles}
+  gem.summary       = %q{Make all attributes of an AR-model accessible to some roles}
+  gem.homepage      = "https://github.com/eval/su_attr_accessibility"
+  gem.license       = "MIT"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "su_attr_accessibility"
+  gem.require_paths = ["lib"]
+  gem.version       = SuAttrAccessibility::VERSION
+  gem.required_ruby_version = '>= 1.8.7'
+
+  gem.add_dependency "activesupport", ">= 3.0.0"
+  gem.add_dependency "activemodel", ">= 3.0.0"
+
+  gem.add_development_dependency "rspec", "~> 2.7.0"
+  gem.add_development_dependency "ZenTest", "~> 4.6.2"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: su_attr_accessibility
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Gert Goet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70333118809820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333118809820
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70333118807440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70333118807440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70333118804600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70333118804600
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &70333118801720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *70333118801720
+description: Make all attributes of an AR-model accessible to some roles
+email:
+- gert@thinkcreate.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/su_attr_accessibility.rb
+- lib/su_attr_accessibility/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/su_attr_accessibility/saa_spec.rb
+- su_attr_accessibility.gemspec
+homepage: https://github.com/eval/su_attr_accessibility
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1626760348264754570
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Make all attributes of an AR-model accessible to some roles
+test_files:
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/su_attr_accessibility/saa_spec.rb