guise 0.1.1

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/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eduardo Gutierrez
+
+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,71 @@
+# guise
+
+An alternative to storing role resources in the database.
+
+guise delegates type information to roles table that determines what a resource
+can be instantiated as. In essence, it's similar to single table inheritance,
+but with multiple inheritances possible.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guise'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install guise
+```
+
+
+## Usage
+
+Create a table to store your type information:
+
+```
+rails generate model guises user:references title:string
+rake db:migrate
+```
+
+Then add the `guises` call to your model. If your table name is different or
+you want a different attribute, supply the `:as` and `:attribute` options.
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :guises
+  has_guises :DeskWorker, :MailFowarder
+end
+
+class Person < ActiveRecord::Base
+  has_many :positions
+  has_guises :Admin, :Engineer, :association => :positions, :attribute => :rank
+end
+```
+
+This adds the following methods to the `User` class:
+* `:desk_workers` and `:mail_forwarders` scopes
+* `:has_role?` that checks if a user is a particular type
+* `:desk_worker?`, `:mail_forwarder` that proxy to `:has_role?`
+* `:has_roles?` that checks if a user is of any of the types supplied
+* Aliases the association method (`:positions`) as `:guises` if association is not called `:guises`
+
+Additionally, this creates classes `DeskWorker` and `MailForwarder` that:
+* Inherit from `User`.
+* Have default scopes for `:desk_workers` and `:mail_forwarders` respectively.
+* Create users with the right associated occupation.
+
+
+## Plans
+
+* Provide generators for roles table
+* Update `has_guises` method to setup `has_many` association

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/guise.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/guise/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Eduardo Gutierrez"]
+  gem.email         = ["edd_d@mit.edu"]
+  gem.description   = %q{ Databse-indempotent roles (mostly) }
+  gem.summary       = %q{ Guise provides a (hopefully) reasonable paradigm for user roles on top of ActiveRecord }
+  gem.homepage      = "https://github.com/ecbypi/guise"
+
+  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.name          = "guise"
+  gem.require_paths = ["lib"]
+  gem.version       = Guise::VERSION
+
+  gem.add_dependency "activerecord", "~> 3.0"
+  gem.add_development_dependency "rspec", "~> 2.9"
+  gem.add_development_dependency "sqlite3", "~> 1.3.3"
+  gem.add_development_dependency "factory_girl", "~> 3.2"
+end

data/lib/guise/attributes.rb

@@ -0,0 +1,27 @@
+module Guise
+  module Attributes
+    def set_attributes(names, options)
+      @@guise_attributes = options.reverse_merge(
+        :association => :guises,
+        :attribute => :title,
+        :names => names
+      )
+
+      class_eval do
+        alias_method :guises, guise_association
+      end if guise_association != :guises
+    end
+
+    def guises
+      @@guise_attributes[:names]
+    end
+
+    def guise_association
+      @@guise_attributes[:association]
+    end
+
+    def guise_attribute
+      @@guise_attributes[:attribute]
+    end
+  end
+end

data/lib/guise/inheritance.rb

@@ -0,0 +1,35 @@
+module Guise
+  module Inheritance
+    def build_guises
+      guises.each do |name|
+        scope_name = name.tableize.to_sym
+        introspective_name = "#{name.underscore}?"
+
+        # Add a scope for this type of resource
+        scope scope_name, joins(guise_association).where(guise_association => { guise_attribute => name })
+
+        # build the class setting it's default scope to limit to those of itself
+        guise_class = Class.new(self) do
+          default_scope { send(scope_name) }
+
+          after_initialize do
+            self.guises.new(self.guise_attribute => name) unless self.has_role?(name)
+          end
+
+          after_create do
+            self.guises.create(self.guise_attribute => name)
+          end
+        end
+
+        Object.const_set(name, guise_class)
+
+        # define the introspection method for the type
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{introspective_name}
+            has_role?(#{name})
+          end
+        METHOD
+      end
+    end
+  end
+end

data/lib/guise/introspection.rb

@@ -0,0 +1,32 @@
+module Guise
+  module Introspection
+
+    def has_role?(name)
+      name = name.to_s.classify
+
+      if !self.class.guises.include?(name)
+        raise NameError, "no such guise #{name}"
+      end
+
+      guises.pluck(guise_attribute).include?(name)
+    end
+
+    def has_any_roles?(*names)
+      names.map(&method(:has_role?)).any?
+    end
+
+    def has_roles?(*names)
+      names.map(&method(:has_role?)).all?
+    end
+
+    protected
+
+    def guise_attribute
+      self.class.guise_attribute
+    end
+
+    def guise_table
+      self.class.guise_table
+    end
+  end
+end

data/lib/guise/version.rb

@@ -0,0 +1,3 @@
+module Guise
+  VERSION = "0.1.1"
+end

data/lib/guise.rb

@@ -0,0 +1,22 @@
+require 'guise/version'
+require 'guise/attributes'
+require 'guise/inheritance'
+require 'guise/introspection'
+
+module Guise
+  def self.extended(base)
+    base.extend Inheritance
+    base.extend Attributes
+    base.send :include, Introspection
+  end
+
+  def has_guises(*names)
+    options = names.last.is_a?(Hash) ? names.pop : {}
+    class_names = names.map(&:to_s).map(&:classify)
+
+    set_attributes(class_names, options)
+    build_guises
+  end
+end
+
+ActiveRecord::Base.extend Guise

data/spec/factories.rb

@@ -0,0 +1,24 @@
+FactoryGirl.define do
+
+  factory :user do
+    name 'Micro Helpline'
+    email 'mrhalp@mit.edu'
+
+    factory :technician do
+      after_create do |user|
+        FactoryGirl.create(:user_role, :name => 'Technician', :user => user)
+      end
+    end
+
+    factory :supervisor do
+      after_create do |user|
+        FactoryGirl.create(:user_role, :name => 'Supervisor', :user => user)
+      end
+    end
+  end
+
+  factory :user_role do
+    association :user
+    name 'Technician'
+  end
+end

data/spec/guise/inheritance_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Guise
+  describe Inheritance do
+    let!(:user) { create(:user) }
+    let!(:technician) { create(:technician) }
+    let!(:supervisor) { create(:supervisor) }
+
+    it "builds subclasses of names called in :guise" do
+      Technician.new.should be_a User
+      Technician.new.guises.should_not be_empty
+    end
+
+    it "adds scopes for each type" do
+      User.technicians.should include(technician)
+      User.technicians.should_not include(user)
+
+      User.supervisors.should include(supervisor)
+      User.supervisors.should_not include(user)
+    end
+  end
+end

data/spec/guise/introspection_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Guise
+  describe Introspection do
+    let!(:user) { create(:user) }
+    let!(:technician) { create(:technician) }
+    let!(:supervisor) { create(:supervisor) }
+
+    describe "#has_role?" do
+      it "checks if resource is of the type provided" do
+        user.has_role?(:technician).should be_false
+        technician.has_role?(:Technician).should be_true
+      end
+
+      it "raises an error if type was not added in :guises call" do
+        expect { user.has_role?(:Accountant) }.to raise_error(NameError)
+      end
+    end
+
+    describe "#has_roles?" do
+      before :each do
+        create(:user_role, :name => 'Technician', :user => supervisor)
+      end
+
+      it "checks if resource is all of the provided types" do
+        technician.has_roles?(:Supervisor, :Technician).should be_false
+        supervisor.has_roles?('Supervisor', Technician).should be_true
+      end
+    end
+
+    describe "#has_any_roles?" do
+      it "checks if resource is any of the supplied roles" do
+        user.has_any_roles?(:Supervisor, :Technician).should be_false
+        technician.has_any_roles?('supervisor', 'technician').should be_true
+      end
+    end
+
+    it "adds methods that proxy to #has_role? for ease" do
+      user.should respond_to :technician?
+      user.should respond_to :supervisor?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'factory_girl'
+
+require File.expand_path('../support/database.rb', __FILE__)
+
+RSpec.configure do |config|
+
+  config.before :suite do
+    Database.create
+    FactoryGirl.find_definitions
+  end
+
+  config.include FactoryGirl::Syntax::Methods
+end
+

data/spec/support/database.rb

@@ -0,0 +1,39 @@
+# Inspired/borrowed from @ernie's way of building out a database in
+# ransack and squeel
+
+require 'active_record'
+require 'guise'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+class User < ActiveRecord::Base
+  has_many :user_roles
+  has_guises :Technician, :Supervisor, :association => :user_roles, :attribute => :name
+end
+
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+end
+
+module Database
+  def self.create
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+
+      ActiveRecord::Schema.define do
+        create_table :users, :force => true do |t|
+          t.string :name
+          t.string :email
+        end
+
+        create_table :user_roles, :force => true do |t|
+          t.string :name
+          t.integer :user_id
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: guise
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Eduardo Gutierrez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70099999163140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70099999163140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70099999161660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70099999161660
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70099999160760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *70099999160760
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &70099999159300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70099999159300
+description: ! ' Databse-indempotent roles (mostly) '
+email:
+- edd_d@mit.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- guise.gemspec
+- lib/guise.rb
+- lib/guise/attributes.rb
+- lib/guise/inheritance.rb
+- lib/guise/introspection.rb
+- lib/guise/version.rb
+- spec/factories.rb
+- spec/guise/inheritance_spec.rb
+- spec/guise/introspection_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+homepage: https://github.com/ecbypi/guise
+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.11
+signing_key: 
+specification_version: 3
+summary: Guise provides a (hopefully) reasonable paradigm for user roles on top of
+  ActiveRecord
+test_files:
+- spec/factories.rb
+- spec/guise/inheritance_spec.rb
+- spec/guise/introspection_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb