Class: Ecoportal::API::GraphQL::Logic::BaseQuery
- Inherits:
-
Object
- Object
- Ecoportal::API::GraphQL::Logic::BaseQuery
- Includes:
- Common::GraphQL::ClassHelpers
- Defined in:
- lib/ecoportal/api/graphql/logic/base_query.rb
Instance Attribute Summary collapse
-
#base_path ⇒ Object
readonly
Returns the value of attribute base_path.
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Class Method Summary collapse
- .accepted_params(*keys, default: :unused) ⇒ Object
- .clear_accepted_params ⇒ Object
-
.field_name(str = nil) ⇒ Object
Used to obtain the full
path
in the GraphQL query by usingbase_path
. - .param_defaults ⇒ Object
- .slice_params(kargs) ⇒ Object
Instance Method Summary collapse
- #access_point(path = []) ⇒ Object
-
#initialize(client, path: nil, base_path: []) ⇒ BaseQuery
constructor
A new instance of BaseQuery.
-
#path(field_name = self.class.field_name) ⇒ Object
Resolves the
path
by usingpath
orbase_path
+class.field_name
. -
#query(path: self.path, **kargs, &block) ⇒ Class
Query rely that manages the different blocks.
- #response_class ⇒ Object
Constructor Details
#initialize(client, path: nil, base_path: []) ⇒ BaseQuery
Returns a new instance of BaseQuery.
47 48 49 50 51 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 47 def initialize(client, path: nil, base_path: []) @path = path @base_path = base_path @client = client end |
Instance Attribute Details
#base_path ⇒ Object (readonly)
Returns the value of attribute base_path.
45 46 47 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 45 def base_path @base_path end |
#client ⇒ Object (readonly)
Returns the value of attribute client.
44 45 46 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 44 def client @client end |
Class Method Details
.accepted_params(*keys, default: :unused) ⇒ Object
14 15 16 17 18 19 20 21 22 23 24 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 14 def accepted_params(*keys, default: :unused) @accepted_params ||= [] return @accepted_params if keys.empty? keys.map(&:to_sym).uniq.each do |key| @accepted_params |= [key] param_defaults[key] = default unless default == :unused end @accepted_params.push(*keys).tap {|ks| ks.uniq!} @accepted_params end |
.clear_accepted_params ⇒ Object
26 27 28 29 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 26 def clear_accepted_params @param_defaults = {} @accepted_params = [] end |
.field_name(str = nil) ⇒ Object
Note:
it is meant for reusability of queries from different end-points
Used to obtain the full path
in the GraphQL query by using base_path
37 38 39 40 41 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 37 def field_name(str = nil) return @field_name unless str @field_name = nil @field_name = str.to_s if str end |
.param_defaults ⇒ Object
10 11 12 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 10 def param_defaults @param_defaults ||= {} end |
.slice_params(kargs) ⇒ Object
31 32 33 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 31 def slice_params(kargs) kargs.slice(*accepted_params) end |
Instance Method Details
#access_point(path = []) ⇒ Object
71 72 73 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 71 def access_point(path = []) path.last end |
#path(field_name = self.class.field_name) ⇒ Object
Resolves the path
by using path
or base_path
+ class.field_name
.
54 55 56 57 58 59 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 54 def path(field_name = self.class.field_name) result = @path result ||= default_path if self.respond_to?(:default_path, true) result ||= (base_path + [field_name]) if base_path && field_name result end |
#query(path: self.path, **kargs, &block) ⇒ Class
Query rely that manages the different blocks.
63 64 65 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 63 def query(path: self.path, **kargs, &block) graphql_query(path: path, **kargs, &basic_block(&block)) end |
#response_class ⇒ Object
67 68 69 |
# File 'lib/ecoportal/api/graphql/logic/base_query.rb', line 67 def response_class raise "You should override this method in #{self.class}" end |