guise 0.1.1 → 0.2.0

data/README.md

@@ -37,35 +37,65 @@ 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.
+Then add call the `has_guises` method in your model. This will setup the
+`has_many` association for you.
 
 ```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`
+* `: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.
 
-Additionally, this creates classes `DeskWorker` and `MailForwarder` that:
+And 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
+To configure the other end of the association, add `guise_for`:
+
+```ruby
+class Guise < ActiveRecord::Base
+  guise_for :user
+end
+```
+
+This method does the following:
+* Sets up `belongs_to` association and accepts the standard options.
+* Validates the column storing the name of the guise in the list supplied is
+  unique to the resource it belongs to and is one of the provided names.
+
+
+### Customization
+
+If the association doesn't fit what is assumed, you can pass in the options for
+`has_many` into `has_guises`. The same applies to `guise_for` with the addition that you can specify not to validate attributes 
+
+```ruby
+class Person < ActiveRecord::Base
+  has_guises :Admin, :Engineer,
+             :association => :positions,
+             :attribute => :rank,
+             :foreign_key => :employee_id,
+             :class_name => :JobTitle
+end
+
+class JobTitle < ActiveRecord::Base
+  guise_for :person,
+            :foreign_key => :employee_id,
+            :validate => false # skip setting up validations
+end
+```
+
+
+## The Future
 
 * Provide generators for roles table
 * Update `has_guises` method to setup `has_many` association
+* Adding validations on `guise_attribute` column into association class

data/guise.gemspec

@@ -4,7 +4,7 @@ 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.description   = %q{ Database-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"
 
@@ -15,8 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Guise::VERSION
 
-  gem.add_dependency "activerecord", "~> 3.0"
+  gem.add_dependency "activerecord", "~> 3.2"
   gem.add_development_dependency "rspec", "~> 2.9"
   gem.add_development_dependency "sqlite3", "~> 1.3.3"
   gem.add_development_dependency "factory_girl", "~> 3.2"
+  gem.add_development_dependency "shoulda-matchers", "~> 1.1"
 end

data/lib/guise/options.rb

@@ -0,0 +1,25 @@
+module Guise
+  module Options
+    def extract_guise_options(names, options)
+      @@guise_options = {
+        :association => options.delete(:association) || :guises,
+        :attribute   => options.delete(:attribute)   || :title,
+        :names       => names
+      }
+
+      return @@guise_options, options
+    end
+
+    def guises
+      @@guise_options[:names]
+    end
+
+    def guise_association
+      @@guise_options[:association]
+    end
+
+    def guise_attribute
+      @@guise_options[:attribute]
+    end
+  end
+end

data/lib/guise/version.rb

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

data/lib/guise.rb

@@ -1,21 +1,76 @@
 require 'guise/version'
-require 'guise/attributes'
-require 'guise/inheritance'
+require 'guise/options'
 require 'guise/introspection'
 
 module Guise
-  def self.extended(base)
-    base.extend Inheritance
-    base.extend Attributes
-    base.send :include, Introspection
-  end
 
   def has_guises(*names)
+    extend Options
+
     options = names.last.is_a?(Hash) ? names.pop : {}
     class_names = names.map(&:to_s).map(&:classify)
 
-    set_attributes(class_names, options)
-    build_guises
+    guise_options, association_options = extract_guise_options(class_names, options)
+
+    build_guises(class_names, guise_options)
+    introspect_guises(class_names)
+
+    has_many guise_association, association_options
+
+    if guise_association != :guises
+      alias_method :guises, guise_association
+    end
+  end
+
+  def guise_for(name, options = {})
+    association = Object.const_get(name.to_s.classify)
+    foreign_key = options[:foreign_key] || "#{association.name}_id"
+
+    belongs_to name, options
+
+    if options[:validate] != false
+      validates association.guise_attribute,
+                :uniqueness => { :scope => foreign_key },
+                :presence => true,
+                :inclusion => { :in => association.guises }
+    end
+  end
+
+  private
+
+  def build_guises(names, options)
+    names.each do |name|
+      scope_name = name.tableize.to_sym
+
+      # 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)
+    end
+  end
+
+  def introspect_guises(names)
+    include Introspection
+
+    names.each do |name|
+      method_name = "#{name.underscore}?"
+      define_method method_name do
+        has_role?(name)
+      end
+    end
   end
 end
 

data/spec/guise_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Guise do
+
+  let(:user) { create(:user) }
+  let(:supervisor) { create(:supervisor) }
+  let(:technician) { create(:technician) }
+
+  describe ".has_guises" do
+    subject { user }
+
+    it "sets up has_many association" do
+      should have_many :user_roles
+    end
+
+    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
+
+    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?
+
+      user.technician?.should be_false
+      technician.technician?.should be_true
+    end
+  end
+
+  describe ".guise_for" do
+    subject { create(:user_role) }
+
+    it "sets up belongs_to" do
+      should belong_to(:user)
+    end
+
+    describe "adds validations to ensure guise attribute is" do
+
+      it "present" do
+        should validate_presence_of(:name)
+      end
+
+      it "unique per resource" do
+        should validate_uniqueness_of(:name).scoped_to(:person_id)
+      end
+
+      it "is one of the guise names provided" do
+        expect { create(:user_role, :name => 'Farmer') }.to raise_error ActiveRecord::RecordInvalid
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
+require 'active_record'
 require 'factory_girl'
+require 'shoulda-matchers'
+require 'guise'
 
 require File.expand_path('../support/database.rb', __FILE__)
 

data/spec/support/database.rb

@@ -1,23 +1,24 @@
 # 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
+  has_guises :Technician, :Supervisor,
+             :association => :user_roles,
+             :attribute => :name,
+             :foreign_key => :person_id
 end
 
 class UserRole < ActiveRecord::Base
-  belongs_to :user
+  guise_for :user,
+            :foreign_key => :person_id
 end
 
+
 module Database
   def self.create
     ActiveRecord::Base.silence do
@@ -31,7 +32,7 @@ module Database
 
         create_table :user_roles, :force => true do |t|
           t.string :name
-          t.integer :user_id
+          t.integer :person_id
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guise
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-04 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70099999163140 !ruby/object:Gem::Requirement
+  requirement: &70304078344960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70099999163140
+  version_requirements: *70304078344960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70099999161660 !ruby/object:Gem::Requirement
+  requirement: &70304078344320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.9'
   type: :development
   prerelease: false
-  version_requirements: *70099999161660
+  version_requirements: *70304078344320
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70099999160760 !ruby/object:Gem::Requirement
+  requirement: &70304078343680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.3.3
   type: :development
   prerelease: false
-  version_requirements: *70099999160760
+  version_requirements: *70304078343680
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70099999159300 !ruby/object:Gem::Requirement
+  requirement: &70304078342460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,8 +54,19 @@ dependencies:
         version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *70099999159300
-description: ! ' Databse-indempotent roles (mostly) '
+  version_requirements: *70304078342460
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: &70304078341900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: *70304078341900
+description: ! ' Database-indempotent roles (mostly) '
 email:
 - edd_d@mit.edu
 executables: []
@@ -70,13 +81,11 @@ files:
 - Rakefile
 - guise.gemspec
 - lib/guise.rb
-- lib/guise/attributes.rb
-- lib/guise/inheritance.rb
 - lib/guise/introspection.rb
+- lib/guise/options.rb
 - lib/guise/version.rb
 - spec/factories.rb
-- spec/guise/inheritance_spec.rb
-- spec/guise/introspection_spec.rb
+- spec/guise_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
 homepage: https://github.com/ecbypi/guise
@@ -106,7 +115,6 @@ summary: Guise provides a (hopefully) reasonable paradigm for user roles on top
   ActiveRecord
 test_files:
 - spec/factories.rb
-- spec/guise/inheritance_spec.rb
-- spec/guise/introspection_spec.rb
+- spec/guise_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb

data/lib/guise/attributes.rb

@@ -1,27 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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/spec/guise/inheritance_spec.rb

@@ -1,22 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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