Class: Neo4j::Core::QueryClauses::Clause

Inherits:
Object
  • Object
show all
Defined in:
lib/neo4j/core/query_clauses.rb

Constant Summary collapse

UNDERSCORE =
'_'
COMMA_SPACE =
', '
AND =
' AND '
PRETTY_NEW_LINE =
"\n  "

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg, params, options = {}) ⇒ Clause

Returns a new instance of Clause



21
22
23
24
25
26
# File 'lib/neo4j/core/query_clauses.rb', line 21

def initialize(arg, params, options = {})
  @arg = arg
  @options = options
  @params = params
  @param_vars_added = []
end

Instance Attribute Details

#argObject

Returns the value of attribute arg



18
19
20
# File 'lib/neo4j/core/query_clauses.rb', line 18

def arg
  @arg
end

#optionsObject (readonly)

Returns the value of attribute options



19
20
21
# File 'lib/neo4j/core/query_clauses.rb', line 19

def options
  @options
end

#param_vars_addedObject (readonly)

Returns the value of attribute param_vars_added



19
20
21
# File 'lib/neo4j/core/query_clauses.rb', line 19

def param_vars_added
  @param_vars_added
end

#paramsObject

Returns the value of attribute params



18
19
20
# File 'lib/neo4j/core/query_clauses.rb', line 18

def params
  @params
end

Class Method Details

.clause_colorObject



155
156
157
# File 'lib/neo4j/core/query_clauses.rb', line 155

def clause_color
  ANSI::CYAN
end

.clause_joinObject



151
152
153
# File 'lib/neo4j/core/query_clauses.rb', line 151

def clause_join
  ''
end

.clause_string(clauses, pretty) ⇒ Object



142
143
144
145
146
147
148
149
# File 'lib/neo4j/core/query_clauses.rb', line 142

def clause_string(clauses, pretty)
  join_string = pretty ? clause_join + PRETTY_NEW_LINE : clause_join

  strings = clause_strings(clauses)
  stripped_string = strings.join(join_string)
  stripped_string.strip!
  pretty && strings.size > 1 ? PRETTY_NEW_LINE + stripped_string : stripped_string
end

.from_arg(arg, params, options = {}) ⇒ Object



126
127
128
# File 'lib/neo4j/core/query_clauses.rb', line 126

def from_arg(arg, params, options = {})
  new(arg, params, options) if !arg.respond_to?(:empty?) || !arg.empty?
end

.from_args(args, params, options = {}) ⇒ Object



121
122
123
124
# File 'lib/neo4j/core/query_clauses.rb', line 121

def from_args(args, params, options = {})
  args.flatten!
  args.map { |arg| from_arg(arg, params, options) }.tap(&:compact!)
end

.from_key_and_single_value(key, value) ⇒ Object



159
160
161
# File 'lib/neo4j/core/query_clauses.rb', line 159

def from_key_and_single_value(key, value)
  value.to_sym == :neo_id ? "ID(#{key})" : "#{key}.#{value}"
end

.keywordObject



113
114
115
# File 'lib/neo4j/core/query_clauses.rb', line 113

def keyword
  self::KEYWORD
end

.keyword_downcaseObject



117
118
119
# File 'lib/neo4j/core/query_clauses.rb', line 117

def keyword_downcase
  keyword.downcase
end

.paramaterize_key!(key) ⇒ Object



164
165
166
167
# File 'lib/neo4j/core/query_clauses.rb', line 164

def self.paramaterize_key!(key)
  key.tr_s!('^a-zA-Z0-9', UNDERSCORE)
  key.gsub!(/^_+|_+$/, '')
end

.to_cypher(clauses, pretty = false) ⇒ Object



130
131
132
133
134
135
136
137
138
139
140
# File 'lib/neo4j/core/query_clauses.rb', line 130

def to_cypher(clauses, pretty = false)
  string = clause_string(clauses, pretty)

  final_keyword = if pretty
                    "#{clause_color}#{keyword}#{ANSI::CLEAR}"
                  else
                    keyword
                  end

  "#{final_keyword} #{string}" if !string.empty?
end

Instance Method Details

#_nested_value_hash?(value) ⇒ Boolean

Returns:

  • (Boolean)


102
103
104
# File 'lib/neo4j/core/query_clauses.rb', line 102

def _nested_value_hash?(value)
  value.values.any? { |v| v.is_a?(Hash) }
end

#_use_key_for_var?(value, prefer) ⇒ Boolean

Returns:

  • (Boolean)


98
99
100
# File 'lib/neo4j/core/query_clauses.rb', line 98

def _use_key_for_var?(value, prefer)
  _nested_value_hash?(value) || prefer == :var
end

#add_param(key, value) ⇒ Object



169
170
171
172
# File 'lib/neo4j/core/query_clauses.rb', line 169

def add_param(key, value)
  @param_vars_added << key
  @params.add_param(key, value)
end

#add_params(keys_and_values) ⇒ Object



174
175
176
177
# File 'lib/neo4j/core/query_clauses.rb', line 174

def add_params(keys_and_values)
  @param_vars_added += keys_and_values.keys
  @params.add_params(keys_and_values)
end

#attributes_from_key_and_value(_key, value) ⇒ Object



106
107
108
109
110
# File 'lib/neo4j/core/query_clauses.rb', line 106

def attributes_from_key_and_value(_key, value)
  return nil unless value.is_a?(Hash)

  value.values.map(&:class) == [Hash] ? value.first[1] : value
end

#from_hash(value) ⇒ Object



44
45
46
47
48
49
50
# File 'lib/neo4j/core/query_clauses.rb', line 44

def from_hash(value)
  fail ArgError if !respond_to?(:from_key_and_value)

  value.map do |k, v|
    from_key_and_value k, v
  end
end

#from_string(value) ⇒ Object



52
53
54
# File 'lib/neo4j/core/query_clauses.rb', line 52

def from_string(value)
  value
end

#label_from_key_and_value(key, value, prefer = :var) ⇒ Object



83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/neo4j/core/query_clauses.rb', line 83

def label_from_key_and_value(key, value, prefer = :var)
  case value
  when String, Symbol, Array, NilClass then value
  when Class, Module then value.name
  when Hash
    if value.values.map(&:class) == [Hash]
      value.first.first
    elsif !_use_key_for_var?(value, prefer)
      key
    end
  else
    fail ArgError, value
  end
end

#node_from_key_and_value(key, value, options = {}) ⇒ Object



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/neo4j/core/query_clauses.rb', line 56

def node_from_key_and_value(key, value, options = {})
  prefer = options[:prefer] || :var
  var = var_from_key_and_value(key, value, prefer)
  label = label_from_key_and_value(key, value, prefer)

  attributes = attributes_from_key_and_value(key, value)

  prefix_value = value
  if value.is_a?(Hash)
    prefix_value = (value.keys.join(UNDERSCORE) if value.values.any? { |v| v.is_a?(Hash) })
  end

  prefix_array = [key, prefix_value].tap(&:compact!).join(UNDERSCORE)
  formatted_attributes = attributes_string(attributes, "#{prefix_array}#{UNDERSCORE}")
  "(#{var}#{format_label(label)}#{formatted_attributes})"
end

#valueObject



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/neo4j/core/query_clauses.rb', line 28

def value
  return @value if @value

  [String, Symbol, Integer, Hash, NilClass].each do |arg_class|
    from_method = "from_#{arg_class.name.downcase}"
    return @value = send(from_method, @arg) if @arg.is_a?(arg_class) && respond_to?(from_method)
  end

  fail ArgError
rescue ArgError => arg_error
  message = "Invalid argument for #{self.class.keyword}.  Full arguments: #{@arg.inspect}"
  message += " | Invalid part: #{arg_error.arg_part.inspect}" if arg_error.arg_part

  raise ArgumentError, message
end

#var_from_key_and_value(key, value, prefer = :var) ⇒ Object



73
74
75
76
77
78
79
80
81
# File 'lib/neo4j/core/query_clauses.rb', line 73

def var_from_key_and_value(key, value, prefer = :var)
  case value
  when String, Symbol, Class, Module, NilClass, Array then key
  when Hash
    key if _use_key_for_var?(value, prefer)
  else
    fail ArgError, value
  end
end