guise 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7c5c286fa539febf7ea6219aab2a407081b7b12
+  data.tar.gz: 848f2e32a8bcbde9fefc49fb30fc1728e8e7c989
+SHA512:
+  metadata.gz: d114f4f75bcdfc5dad56b148292883812bdbd13c0153179cbee1347f62864fab1391f68b9c17f4bd59eeacd59ac299c4eb7e3498cc6f975d75e37b3c5cd12d9b
+  data.tar.gz: d7060c18f0b08727ec9a03d1bb96f6e835ea30b5ae915fa95012af4179832aa2e289de1d66a4e493510a2fd166dcc8fd11c4bf2e45d55c236fc82d69ae0d1d78

data/.travis.yml

@@ -0,0 +1,14 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+gemfile:
+  - gemfiles/3.1.gemfile
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.0.gemfile
+install: 'bundle install -j 4'
+script: 'bundle exec rake'
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode

data/Appraisals

@@ -1,7 +1,14 @@
 appraise '3.1' do
-  gem 'activerecord', '3.1.4'
+  gem 'activerecord', '~> 3.1'
+  gem 'activesupport', '~> 3.1'
 end
 
 appraise '3.2' do
-  gem 'activerecord', '3.2.3'
+  gem 'activerecord', '~> 3.2'
+  gem 'activesupport', '~> 3.2'
+end
+
+appraise '4.0' do
+  gem 'activerecord', '~> 4.0'
+  gem 'activesupport', '~> 4.0'
 end

data/README.md

@@ -1,11 +1,16 @@
 # guise
 
+[![Build Status](https://travis-ci.org/ecbypi/guise.png?branch=master)](https://travis-ci.org/ecbypi/guise)
+[![Code Climate](https://codeclimate.com/github/ecbypi/guise.png)](https://codeclimate.com/github/ecbypi/guise)
+
+
 An alternative to storing role resources in the database.
 
-guise delegates type information to a `has_many` association that stores the
-class names a resource can be instantiated as. In essence, it's similar to
-single table inheritance, but with multiple inheritances possible.
+`guise` uses a `has_many` association to store type information instead of
+using `has_many :through` or `has_and_belongs_to_many.` The `has_many` association
+stores the role or type information as a string representing the class name.
 
+If effect, `guise` enables 'multi-table-inheritance'.
 
 ## Installation
 
@@ -37,35 +42,28 @@ rails generate model user_role user:references title:string
 rake db:migrate
 ```
 
-Then add call the `has_guises` method in your model. This will setup the
-`has_many` association for you. It requires the name of the association and
-name of the column that the sublcass name will be stored in.
+Then add `has_guises` to your model. This will setup the `has_many` association
+for you. It requires the name of the association and name of the column that
+the sublcass name will be stored in.
 
 ```ruby
 class User < ActiveRecord::Base
-  has_guises :DeskWorker, :MailFowarder,
-             :association => :user_roles,
-             :attribute => :title
+  has_guises :DeskWorker, :MailForwarder, :association => :user_roles, :attribute => :title
 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.
-
-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 type.
-
+* `:desk_workers` and `:mail_forwarders` model scopes.
+* `:has_guise?` that checks if a user is a particular type.
+* `:desk_worker?`, `:mail_forwarder` that proxy to `:has_guise?`.
+* `:has_guises?` that checks if a user has records for all the types supplied.
+* `:has_any_guises?` that checks if a user has records for any of the types supplied.
 
 To configure the other end of the association, add `guise_for`:
 
 ```ruby
 class UserRole < ActiveRecord::Base
-  guise_for :user
+  guise_for :User
 end
 ```
 
@@ -74,6 +72,55 @@ This method does the following:
 * 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.
 
+To add a class for each guise, call `:guise_of` in a subclass:
+
+```ruby
+class DeskWorker < User
+  guise_of :User
+end
+```
+
+This adds the following to the `DeskWorker` class:
+
+```ruby
+class DeskWorker < User
+  default_scope -> { joins(:user_roles).where(user_roles: { title: 'DeskWorker'}) }
+
+  after_initialize do
+    self.guises.build(title: 'DeskWorker')
+  end
+
+  after_create do
+    self.guises.create(title: 'DeskWorker')
+  end
+end
+```
+
+To scope the association class to a guise, use `scoped_guise_for`. The name of
+the class must be the guise it represents combined with the name of the parent
+class.
+
+```ruby
+class DeskWorkerUserRole < UserRole
+  scoped_guise_for :User
+end
+```
+
+This sets up the class as follows:
+
+```ruby
+class DeskWorkerUserRole < UserRole
+  default_scope -> { where(title: 'DeskWorker') }
+
+  after_initialize do
+    self.title = 'DeskWorker'
+  end
+
+  before_create do
+    self.title = 'DeskWorker'
+  end
+end
+```
 
 ### Customization
 
@@ -91,7 +138,7 @@ class Person < ActiveRecord::Base
 end
 
 class JobTitle < ActiveRecord::Base
-  guise_for :person,
+  guise_for :Person,
             :foreign_key => :employee_id,
             :validate => false # skip setting up validations
 end

data/Rakefile

@@ -8,3 +8,5 @@ desc "Run specs"
 RSpec::Core::RakeTask.new('spec') do |task|
   task.pattern = 'spec/**/*_spec.rb'
 end
+
+task :default => :spec

data/gemfiles/3.1.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "3.1.4"
+gem "activerecord", "~> 3.1"
+gem "activesupport", "~> 3.1"
 
 gemspec :path=>"../"

data/gemfiles/3.1.gemfile.lock

@@ -1,56 +1,66 @@
 PATH
-  remote: /Users/edd_d/dev/guise
+  remote: ../
   specs:
-    guise (0.2.0)
-      activerecord (~> 3.1)
-      activesupport (~> 3.1)
+    guise (0.3.0)
+      activerecord (>= 3.1, < 4.1)
+      activesupport (>= 3.1, < 4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.1.4)
-      activesupport (= 3.1.4)
+    activemodel (3.2.16)
+      activesupport (= 3.2.16)
       builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.4)
-      activemodel (= 3.1.4)
-      activesupport (= 3.1.4)
-      arel (~> 2.2.3)
+    activerecord (3.2.16)
+      activemodel (= 3.2.16)
+      activesupport (= 3.2.16)
+      arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.1.4)
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    appraisal (0.4.1)
+    appraisal (0.5.2)
       bundler
       rake
-    arel (2.2.3)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    factory_girl (3.2.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    factory_girl (4.4.0)
       activesupport (>= 3.0.0)
-    i18n (0.6.0)
-    multi_json (1.3.4)
-    rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.0)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    shoulda-matchers (1.1.0)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    multi_json (1.8.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    shoulda-matchers (2.5.0)
       activesupport (>= 3.0.0)
-    sqlite3 (1.3.6)
-    tzinfo (0.3.33)
+    slop (3.4.7)
+    sqlite3 (1.3.8)
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 3.1.4)
-  appraisal
-  factory_girl (~> 3.2)
+  activerecord (~> 3.1)
+  activesupport (~> 3.1)
+  appraisal (~> 0.5)
+  factory_girl (~> 4.4)
   guise!
-  rspec (~> 2.9)
-  shoulda-matchers (~> 1.1)
-  sqlite3 (~> 1.3.3)
+  pry (~> 0.9)
+  rake (~> 10.1)
+  rspec (~> 2.14)
+  shoulda-matchers (~> 2.5)
+  sqlite3 (~> 1.3)

data/gemfiles/3.2.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "3.2.3"
+gem "activerecord", "~> 3.2"
+gem "activesupport", "~> 3.2"
 
 gemspec :path=>"../"

data/gemfiles/3.2.gemfile.lock

@@ -1,56 +1,66 @@
 PATH
-  remote: /Users/edd_d/dev/guise
+  remote: ../
   specs:
-    guise (0.2.0)
-      activerecord (~> 3.1)
-      activesupport (~> 3.1)
+    guise (0.3.0)
+      activerecord (>= 3.1, < 4.1)
+      activesupport (>= 3.1, < 4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
+    activemodel (3.2.16)
+      activesupport (= 3.2.16)
       builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    activerecord (3.2.16)
+      activemodel (= 3.2.16)
+      activesupport (= 3.2.16)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.3)
-      i18n (~> 0.6)
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    appraisal (0.4.1)
+    appraisal (0.5.2)
       bundler
       rake
-    arel (3.0.2)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    factory_girl (3.2.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    factory_girl (4.4.0)
       activesupport (>= 3.0.0)
-    i18n (0.6.0)
-    multi_json (1.3.4)
-    rake (0.9.2.2)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.0)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    shoulda-matchers (1.1.0)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    multi_json (1.8.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    shoulda-matchers (2.5.0)
       activesupport (>= 3.0.0)
-    sqlite3 (1.3.6)
-    tzinfo (0.3.33)
+    slop (3.4.7)
+    sqlite3 (1.3.8)
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (= 3.2.3)
-  appraisal
-  factory_girl (~> 3.2)
+  activerecord (~> 3.2)
+  activesupport (~> 3.2)
+  appraisal (~> 0.5)
+  factory_girl (~> 4.4)
   guise!
-  rspec (~> 2.9)
-  shoulda-matchers (~> 1.1)
-  sqlite3 (~> 1.3.3)
+  pry (~> 0.9)
+  rake (~> 10.1)
+  rspec (~> 2.14)
+  shoulda-matchers (~> 2.5)
+  sqlite3 (~> 1.3)

data/gemfiles/4.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0"
+gem "activesupport", "~> 4.0"
+
+gemspec :path=>"../"

data/gemfiles/4.0.gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: ../
+  specs:
+    guise (0.3.0)
+      activerecord (>= 3.1, < 4.1)
+      activesupport (>= 3.1, < 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.0.3)
+      activesupport (= 4.0.3)
+      builder (~> 3.1.0)
+    activerecord (4.0.3)
+      activemodel (= 4.0.3)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.3)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (0.5.2)
+      bundler
+      rake
+    arel (4.0.2)
+    atomic (1.1.14)
+    builder (3.1.4)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.7)
+    sqlite3 (1.3.8)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.0)
+  activesupport (~> 4.0)
+  appraisal (~> 0.5)
+  factory_girl (~> 4.4)
+  guise!
+  pry (~> 0.9)
+  rake (~> 10.1)
+  rspec (~> 2.14)
+  shoulda-matchers (~> 2.5)
+  sqlite3 (~> 1.3)

data/guise.gemspec

@@ -17,12 +17,23 @@ Gem::Specification.new do |gem|
   gem.name          = "guise"
   gem.require_paths = ["lib"]
   gem.version       = Guise::VERSION
+  gem.license       = 'MIT'
 
-  gem.add_dependency "activerecord", "~> 3.1"
-  gem.add_dependency "activesupport", "~> 3.1"
-  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"
-  gem.add_development_dependency "appraisal"
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_dependency "activerecord", ">= 3.1", "< 4.1"
+  gem.add_dependency "activesupport", ">= 3.1", "< 4.1"
+  gem.add_development_dependency 'rake', '~> 10.1'
+  gem.add_development_dependency "rspec", "~> 2.14"
+  gem.add_development_dependency "factory_girl", "~> 4.4"
+  gem.add_development_dependency "shoulda-matchers", "~> 2.5"
+  gem.add_development_dependency "appraisal", '~> 0.5'
+  gem.add_development_dependency 'pry', '~> 0.9'
+
+  if RUBY_PLATFORM == 'java'
+    gem.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
+    gem.add_development_dependency 'jdbc-sqlite3'
+  else
+    gem.add_development_dependency 'sqlite3', '~> 1.3'
+  end
 end

data/lib/guise/callbacks.rb

@@ -0,0 +1,28 @@
+module Guise
+  class Callback
+    def initialize(guise, attribute)
+      @guise = guise
+      @attribute = attribute
+    end
+  end
+
+  class SourceCallback < Callback
+    def after_initialize(record)
+      record.guises.build(@attribute => @guise)
+    end
+
+    def after_create(record)
+      record.guises.create(@attribute => @guise)
+    end
+  end
+
+  class AssociationCallback < Callback
+    def after_initialize(record)
+      record.assign_attributes(@attribute => @guise)
+    end
+
+    def before_create(record)
+      record.assign_attributes(@attribute => @guise)
+    end
+  end
+end

data/lib/guise/introspection.rb

@@ -1,32 +1,31 @@
+require 'active_support/concern'
+
 module Guise
   module Introspection
+    extend ActiveSupport::Concern
 
-    def has_role?(name)
-      name = name.to_s.classify
+    def has_guise?(value)
+      value = value.to_s.classify
 
-      if !self.class.guises.include?(name)
-        raise NameError, "no such guise #{name}"
+      unless guise_options[:names].any? { |name| name == value }
+        raise ArgumentError, "no such guise #{value}"
       end
 
-      guises.map(&guise_attribute).include?(name)
+      guises.any? { |guise| guise[guise_options[:attribute]] == value }
     end
 
-    def has_any_roles?(*names)
-      names.map(&method(:has_role?)).any?
+    def has_any_guises?(*values)
+      values.any? { |value| has_guise?(value) }
     end
 
-    def has_roles?(*names)
-      names.map(&method(:has_role?)).all?
+    def has_guises?(*values)
+      values.all? { |value| has_guise?(value) }
     end
 
-    protected
-
-    def guise_attribute
-      self.class.guise_attribute
-    end
+    private
 
-    def guise_table
-      self.class.guise_table
+    def guise_options
+      Guise.registry[self.class.table_name.classify]
     end
   end
 end