Module: AppBase::ModelConcern::ClassMethods

Defined in:
lib/appbase/model_concern.rb

Instance Method Summary collapse

Instance Method Details

#allow_create(criteria = :mine, &block) ⇒ Object 



86
87
88
 
# File 'lib/appbase/model_concern.rb', line 86

def allow_create(criteria=:mine, &block)
  self.appbase_allow(:create, criteria, &block)
end

#allow_delete(criteria = :mine, &block) ⇒ Object 



94
95
96
 
# File 'lib/appbase/model_concern.rb', line 94

def allow_delete(criteria=:mine, &block)
  self.appbase_allow(:delete, criteria, &block)
end

#allow_query(criteria = :mine, &block) ⇒ Object 



98
99
100
 
# File 'lib/appbase/model_concern.rb', line 98

def allow_query(criteria=:mine, &block)
  self.appbase_allow(:query, criteria, &block)
end

#allow_update(criteria = :mine, &block) ⇒ Object 



90
91
92
 
# File 'lib/appbase/model_concern.rb', line 90

def allow_update(criteria=:mine, &block)
  self.appbase_allow(:update, criteria, &block)
end

#appbase_allow(crud, criteria = :mine, &block) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/appbase/model_concern.rb', line 22

def appbase_allow(crud, criteria=:mine, &block)
  if [:create, :update, :delete, :query].index(crud).nil?
    raise "Unsupported crud operation: #{crud}, available options: create, update, delete, query"
  end
  model = self
  if criteria == :mine
    # allow_xxx :mine or simply allow_xxx
    AppBase::Engine.after_initialized do
      user_identity_attr = "#{AppBase::Engine::UserIdentity.underscore}_id"
      model.class_eval crud == :query ? %-
        def self.accessible_by(user)
          #{model.name}.where(:#{user_identity_attr} => user.id)
        end
      - : %-
        def self.allow_#{crud}?(user, obj)
          user.id == obj.#{user_identity_attr}
        end
      -
    end
  elsif crud != :query && criteria == :if && block_given? && block.parameters.count == 2
    # allow_xxx :if do; end
    AppBase::Engine.after_initialized do
      user_identity_attr = "#{AppBase::Engine::UserIdentity.underscore}_id"
      model.define_singleton_method "allow_#{crud}".to_sym, &block
    end
  elsif crud == :query && criteria == :within && block_given? && block.parameters.count == 1
    # allow_query :within {|current_user| Model.where(...)}
    AppBase::Engine.after_initialized do
      user_identity_attr = "#{AppBase::Engine::UserIdentity.underscore}_id"
      model.define_singleton_method :accessible_by, &block
    end
  elsif crud != :query && riteria.instance_of?(Hash) && criteria.has_key?(:if) && criteria[:if].instance_of?(Symbol)
    # :if => :a_singleton_method
    AppBase::Engine.after_initialized do
      user_identity_attr = "#{AppBase::Engine::UserIdentity.underscore}_id"
      model.class_eval %-
        def self.allow_#{crud}?(user, obj)
          #{model.name}.#{criteria[:if]} user
        end
      -
    end
  elsif crud == :query && criteria.instance_of?(Hash) && criteria.has_key?(:within) && criteria[:within].instance_of?(Symbol)
    # allow_query :within => :a_singleton_query_method
    AppBase::Engine.after_initialized do
      user_identity_attr = "#{AppBase::Engine::UserIdentity.underscore}_id"
      model.class_eval %-
        def self.accessible_by(user)
          #{model.name}.#{criteria[:within]} user
        end
      -
    end
  else
    raise %-
      allow_#{crud} usage:
        allow_#{crud} :mine
        allow_#{crud} :#{ crud == :query ? 'within' : 'if' } => :a_singleton_method
        allow_#{crud} :#{ crud == :query ? 'within' : 'if' } do |current_user_identity#{ crud == :query ? '' : ', model_instance' }|
          # #{ crud == :query ? 'return fitlered query, e.g. Note.where(:user_id => current_user_identity.id)' : 'return true if allowed' }
        end
    -
  end
  AppBase::Registry.register_crud self, crud
end

#expose_to_appbase(*method_names) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
 
# File 'lib/appbase/model_concern.rb', line 11

def expose_to_appbase(*method_names)
  return if method_names.count == 0
  options = {}
  if method_names.last.instance_of? Hash
    *method_names, options = method_names
  end
  method_names.each do |method_name|
    AppBase::Registry.register_rpc self, method_name, options
  end
end