Class: Avo::Resources::ResourceManager

Inherits:
Object
  • Object
show all
Defined in:
lib/avo/resources/resource_manager.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ResourceManager

Returns a new instance of ResourceManager.



54
55
56
 
# File 'lib/avo/resources/resource_manager.rb', line 54

def initialize
  @resources = []
end

Instance Attribute Details

#resources ⇒ Object Also known as: all

Returns the value of attribute resources.



4
5
6
 
# File 'lib/avo/resources/resource_manager.rb', line 4

def resources
  @resources
end

Class Method Details

.build ⇒ Object 



9
10
11
12
13
14
 
# File 'lib/avo/resources/resource_manager.rb', line 9

def build
  instance = new
  instance.init_resources
  instance.check_bad_resources
  instance
end

.fetch_resources ⇒ Object

Fetches the resources available to the application. We have two ways of doing that.

  1. Through eager loading.

We automatically eager load the resources directory and fetch the descendants from the scanned files. This is the simple way to get started.

  1. Manually, declared by the user.

We have this option to load the resources because when they are loaded automatically through eager loading, those Resource classes and their methods may trigger loading other classes. And that may disrupt Rails booting process. Ex: AdminResource may use self.model_class = User. That will trigger Ruby to load the User class and itself load other classes in a chain reaction. The scenario that comes up most often is when Rails boots, the routes are being computed which eager loads the resource files. At that boot time some migration might have not been run yet, but Rails tries to access them through model associations, and they are not available.

To enable this feature add a ‘resources` array config in your Avo initializer. config.resources = [

"UserResource",
"FishResource",

]



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/avo/resources/resource_manager.rb', line 37

def fetch_resources
  resources = if Avo.configuration.resources.nil?
    BaseResource.descendants
  else
    Avo.configuration.resources
  end

  resources.map do |resource|
    if resource.is_a?(Class)
      resource
    else
      resource.to_s.safe_constantize
    end
  end
end

Instance Method Details

#check_bad_resources ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/avo/resources/resource_manager.rb', line 71

def check_bad_resources
  resources.each do |resource|
    has_model = resource.model_class.present?

    unless has_model
      possible_model = resource.to_s.gsub "Avo::Resources::", ""
      possible_model = possible_model.gsub "Resource", ""

      Avo.error_manager.add({
        url: "https://docs.avohq.io/2.0/resources.html#custom-model-class",
        target: "_blank",
        message: "#{resource} does not have a valid model assigned. It failed to find the #{possible_model} model. \n\r Please create that model or assign one using self.model_class = YOUR_MODEL"
      })
    end
  end
end

#get_available_resources(user = nil) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/avo/resources/resource_manager.rb', line 152

def get_available_resources(user = nil)
  valid_resources
    .select do |resource|
      resource.authorization.class.authorize(
        user,
        resource.model_class,
        Avo.configuration.authorization_methods.stringify_keys["index"],
        raise_exception: false
      )
    end
    .sort_by { |r| r.name }
end

#get_model_class_by_name(name) ⇒ Object

Returns the Rails model class by singular snake_cased name

get_model_class_by_name(‘user’) => User



148
149
150
 
# File 'lib/avo/resources/resource_manager.rb', line 148

def get_model_class_by_name(name)
  name.to_s.camelize.singularize
end

#get_resource(resource) ⇒ Object

Returns the Avo resource by camelized name

get_resource_by_name(‘User’) => instance of Avo::Resources::User



96
97
98
99
100
101
102
 
# File 'lib/avo/resources/resource_manager.rb', line 96

def get_resource(resource)
  resource = "Avo::Resources::#{resource}" unless resource.to_s.starts_with?("Avo::Resources::")

  resources.find do |available_resource|
    resource.to_s == available_resource.to_s
  end
end

#get_resource_by_controller_name(name) ⇒ Object

Returns the Avo resource by singular snake_cased name

get_resource_by_controller_name(‘delayed_backend_active_record_jobs’) => instance of Avo::Resources::DelayedJob get_resource_by_controller_name(‘users’) => instance of Avo::Resources::User



133
134
135
136
137
138
 
# File 'lib/avo/resources/resource_manager.rb', line 133

def get_resource_by_controller_name(name)
  valid_resources
    .find do |resource|
      resource.model_class.to_s.pluralize.underscore.tr("/", "_") == name.to_s
    end
end

#get_resource_by_model_class(klass) ⇒ Object

Returns the Avo resource by singular snake_cased name From all the resources that use the same model_class, it will fetch the first one in alphabetical order

get_resource_by_name(‘User’) => instance of Avo::Resources::User get_resource_by_name(User) => instance of Avo::Resources::User



117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/avo/resources/resource_manager.rb', line 117

def get_resource_by_model_class(klass)
  # Fetch the mappings imposed by the user.
  # If they are present, use those ones.
  mapping = get_mapping_for_model klass
  return get_resource(mapping) if mapping.present?

  valid_resources
    .find do |resource|
      resource.model_class.model_name.name == klass.to_s
    end
end

#get_resource_by_name(name) ⇒ Object

Returns the Avo resource by singular snake_cased name

get_resource_by_name(‘user’) => instance of Avo::Resources::User



107
108
109
 
# File 'lib/avo/resources/resource_manager.rb', line 107

def get_resource_by_name(name)
  get_resource name.singularize.camelize
end

#guess_resource(name) ⇒ Object

Returns the Avo resource by some name



141
142
143
 
# File 'lib/avo/resources/resource_manager.rb', line 141

def guess_resource(name)
  get_resource_by_name(name.to_s) || get_resource_by_model_class(name)
end

#init_resources ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/avo/resources/resource_manager.rb', line 58

def init_resources
  self.resources = self.class.fetch_resources
    .reject do |resource|
      # Remove the BaseResource. We only need the descendants
      resource == Avo::BaseResource
    end
    .uniq do |klass|
      # On invalid resource configuration the resource classes get duplicated in `ObjectSpace`
      # We need to de-duplicate them
      klass.name
    end
end

#resources_for_navigation(user = nil) ⇒ Object 



165
166
167
168
169
170
 
# File 'lib/avo/resources/resource_manager.rb', line 165

def resources_for_navigation(user = nil)
  get_available_resources(user)
    .select do |resource|
      resource.visible_on_sidebar
    end
end

#valid_resources ⇒ Object

Filters out the resources that are missing the model_class



89
90
91
 
# File 'lib/avo/resources/resource_manager.rb', line 89

def valid_resources
  resources.select { |resource| resource.model_class.present? }.sort_by(&:name)
end