X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/19ae770973482257117fe8ded5619c3018c4b60f..3aaefcb3c76ff470b475d950398d01255e87712a:/apps/workbench/app/models/arvados_base.rb diff --git a/apps/workbench/app/models/arvados_base.rb b/apps/workbench/app/models/arvados_base.rb index b02db7a6b6..c5e1a4ed22 100644 --- a/apps/workbench/app/models/arvados_base.rb +++ b/apps/workbench/app/models/arvados_base.rb @@ -1,8 +1,54 @@ -class ArvadosBase < ActiveRecord::Base - self.abstract_class = true +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + +class ArvadosBase + include ActiveModel::Validations + include ActiveModel::Conversion + include ActiveModel::Serialization + include ActiveModel::Dirty + include ActiveModel::AttributeAssignment + extend ActiveModel::Naming + + Column = Struct.new("Column", :name) + attr_accessor :attribute_sortkey attr_accessor :create_params + class Error < StandardError; end + + module Type + class Hash < ActiveModel::Type::Value + def type + :hash + end + + def default_value + {} + end + + private + def cast_value(value) + (value.class == String) ? ::JSON.parse(value) : value + end + end + + class Array < ActiveModel::Type::Value + def type + :array + end + + def default_value + [] + end + + private + def cast_value(value) + (value.class == String) ? ::JSON.parse(value) : value + end + end + end + def self.arvados_api_client ArvadosApiClient.new_or_current end @@ -31,7 +77,7 @@ class ArvadosBase < ActiveRecord::Base end def initialize raw_params={}, create_params={} - super self.class.permit_attribute_params(raw_params) + self.class.permit_attribute_params(raw_params) @create_params = create_params @attribute_sortkey ||= { 'id' => nil, @@ -54,14 +100,24 @@ class ArvadosBase < ActiveRecord::Base 'uuid' => '999', } @loaded_attributes = {} + attributes = self.class.columns.map { |c| [c.name.to_sym, nil] }.to_h.merge(raw_params) + attributes.symbolize_keys.each do |name, value| + send("#{name}=", value) + end + end + + # The ActiveModel::Dirty API was changed on Rails 5.2 + # See: https://github.com/rails/rails/commit/c3675f50d2e59b7fc173d7b332860c4b1a24a726#diff-aaddd42c7feb0834b1b5c66af69814d3 + def mutations_from_database + @mutations_from_database ||= ActiveModel::NullMutationTracker.instance end def self.columns - return @columns if @columns.andand.any? - @columns = [] + @discovered_columns = [] if !defined?(@discovered_columns) + return @discovered_columns if @discovered_columns.andand.any? @attribute_info ||= {} schema = arvados_api_client.discovery[:schemas][self.to_s.to_sym] - return @columns if schema.nil? + return @discovered_columns if schema.nil? schema[:properties].each do |k, coldef| case k when :etag, :kind @@ -69,28 +125,74 @@ class ArvadosBase < ActiveRecord::Base else if coldef[:type] == coldef[:type].downcase # boolean, integer, etc. - @columns << column(k, coldef[:type].to_sym) + @discovered_columns << column(k, coldef[:type]) else # Hash, Array - @columns << column(k, :text) - serialize k, coldef[:type].constantize - end - define_method k do - unless new_record? or @loaded_attributes.include? k.to_s - Rails.logger.debug "BUG: access non-loaded attribute #{k}" - # We should... - # raise ActiveModel::MissingAttributeError, "missing attribute: #{k}" - end - super() + @discovered_columns << column(k, coldef[:type], coldef[:type].constantize.new) end + attr_reader k @attribute_info[k] = coldef end end - @columns + @discovered_columns + end + + def new_record? + # dup method doesn't reset the uuid attr + @uuid.nil? || @new_record || false + end + + def initialize_dup(other) + super + @new_record = true + @created_at = nil end def self.column(name, sql_type = nil, default = nil, null = true) - ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null) + caster = case sql_type + when 'integer' + ActiveModel::Type::Integer + when 'string', 'text' + ActiveModel::Type::String + when 'float' + ActiveModel::Type::Float + when 'datetime' + ActiveModel::Type::DateTime + when 'boolean' + ActiveModel::Type::Boolean + when 'Hash' + ArvadosBase::Type::Hash + when 'Array' + ArvadosBase::Type::Array + when 'jsonb' + ArvadosBase::Type::Hash + else + raise ArvadosBase::Error.new("Type unknown: #{sql_type}") + end + define_method "#{name}=" do |val| + val = default if val.nil? + casted_value = caster.new.cast(val) + attribute_will_change!(name) if send(name) != casted_value + set_attribute_after_cast(name, casted_value) + end + Column.new(name.to_s) + end + + def set_attribute_after_cast(name, casted_value) + instance_variable_set("@#{name}", casted_value) + end + + def [](attr_name) + begin + send(attr_name) + rescue + Rails.logger.debug "BUG: access non-loaded attribute #{attr_name}" + nil + end + end + + def []=(attr_name, attr_val) + send("#{attr_name}=", attr_val) end def self.attribute_info @@ -144,10 +246,22 @@ class ArvadosBase < ActiveRecord::Base ArvadosResourceList.new(self).select(*args) end + def self.with_count(*args) + ArvadosResourceList.new(self).with_count(*args) + end + def self.distinct(*args) ArvadosResourceList.new(self).distinct(*args) end + def self.include_trash(*args) + ArvadosResourceList.new(self).include_trash(*args) + end + + def self.recursive(*args) + ArvadosResourceList.new(self).recursive(*args) + end + def self.eager(*args) ArvadosResourceList.new(self).eager(*args) end @@ -164,17 +278,36 @@ class ArvadosBase < ActiveRecord::Base # The following permit! is necessary even with # "ActionController::Parameters.permit_all_parameters = true", # because permit_all does not permit nested attributes. - ActionController::Parameters.new(raw_params).permit! + if !raw_params.is_a? ActionController::Parameters + raw_params = ActionController::Parameters.new(raw_params) + end + raw_params.permit! end def self.create raw_params={}, create_params={} - x = super(permit_attribute_params(raw_params)) - x.create_params = create_params + x = new(permit_attribute_params(raw_params), create_params) + x.save x end + def self.create! raw_params={}, create_params={} + x = new(permit_attribute_params(raw_params), create_params) + x.save! + x + end + + def self.table_name + self.name.underscore.pluralize.downcase + end + def update_attributes raw_params={} - super(self.class.permit_attribute_params(raw_params)) + assign_attributes(self.class.permit_attribute_params(raw_params)) + save + end + + def update_attributes! raw_params={} + assign_attributes(self.class.permit_attribute_params(raw_params)) + save! end def save @@ -186,7 +319,7 @@ class ArvadosBase < ActiveRecord::Base # old value in the update/create command) or has been added to # #changed by ActiveRecord's #attr= method. if changed.include? col.name or - (self.class.serialized_attributes.include? col.name and + ([Hash, Array].include?(attributes[col.name].class) and @loaded_attributes[col.name]) obdata[col.name.to_sym] = self.send col.name end @@ -198,7 +331,10 @@ class ArvadosBase < ActiveRecord::Base obdata.delete :uuid resp = arvados_api_client.api(self.class, '/' + uuid, postdata) else - postdata.merge!(@create_params) if @create_params + if @create_params + @create_params = @create_params.to_unsafe_hash if @create_params.is_a? ActionController::Parameters + postdata.merge!(@create_params) + end resp = arvados_api_client.api(self.class, '', postdata) end return false if !resp[:etag] || !resp[:uuid] @@ -224,6 +360,14 @@ class ArvadosBase < ActiveRecord::Base self.save or raise Exception.new("Save failed") end + def persisted? + (!new_record? && !destroyed?) ? true : false + end + + def destroyed? + !(new_record? || etag || uuid) + end + def destroy if etag || uuid postdata = { '_method' => 'DELETE' } @@ -312,6 +456,11 @@ class ArvadosBase < ActiveRecord::Base forget_uuid! end + def attributes + kv = self.class.columns.collect {|c| c.name}.map {|key| [key, send(key)]} + kv.to_h + end + def attributes_for_display self.attributes.reject { |k,v| attribute_sortkey.has_key?(k) and !attribute_sortkey[k] @@ -334,7 +483,7 @@ class ArvadosBase < ActiveRecord::Base end def self.creatable? - current_user.andand.is_active + current_user.andand.is_active && api_exists?(:create) end def self.goes_in_projects? @@ -361,6 +510,10 @@ class ArvadosBase < ActiveRecord::Base editable? end + def self.api_exists?(method) + arvados_api_client.discovery[:resources][self.to_s.underscore.pluralize.to_sym].andand[:methods].andand[method] + end + # Array of strings that are the names of attributes that can be edited # with X-Editable. def editable_attributes @@ -392,17 +545,17 @@ class ArvadosBase < ActiveRecord::Base if opts[:class].is_a? Class return opts[:class] end - if uuid.match /^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/ + if uuid.match(/^[0-9a-f]{32}(\+[^,]+)*(,[0-9a-f]{32}(\+[^,]+)*)*$/) return Collection end resource_class = nil - uuid.match /^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/ do |re| + uuid.match(/^[0-9a-z]{5}-([0-9a-z]{5})-[0-9a-z]{15}$/) do |re| resource_class ||= arvados_api_client. kind_class(self.uuid_infix_object_kind[re[1]]) end if opts[:referring_object] and opts[:referring_attr] and - opts[:referring_attr].match /_uuid$/ + opts[:referring_attr].match(/_uuid$/) resource_class ||= arvados_api_client. kind_class(opts[:referring_object]. attributes[opts[:referring_attr].