Module: Neo4j::ActiveNode::Scope::ClassMethods

Defined in:
lib/neo4j/active_node/scope.rb

Instance Method Summary collapse

Instance Method Details

#_call_scope_context(eval_context, query_params, proc) ⇒ Object


79
80
81
# File 'lib/neo4j/active_node/scope.rb', line 79

def _call_scope_context(eval_context, query_params, proc)
  eval_context.instance_exec(*query_params.fill(nil, query_params.length..proc.arity - 1), &proc)
end

#all(new_var = nil) ⇒ Object


91
92
93
94
95
96
97
98
# File 'lib/neo4j/active_node/scope.rb', line 91

def all(new_var = nil)
  var = new_var || (current_scope ? current_scope.node_identity : :n)
  if current_scope
    current_scope.new_link(var)
  else
    self.as(var)
  end
end

#current_scopeObject

:nodoc:


83
84
85
# File 'lib/neo4j/active_node/scope.rb', line 83

def current_scope #:nodoc:
  ScopeRegistry.value_for(:current_scope, base_class.to_s)
end

#current_scope=(scope) ⇒ Object

:nodoc:


87
88
89
# File 'lib/neo4j/active_node/scope.rb', line 87

def current_scope=(scope) #:nodoc:
  ScopeRegistry.set_value_for(:current_scope, base_class.to_s, scope)
end

#full_scopesHash

Returns of scopes available to this model. Keys are scope name, value is scope callable.

Returns:

  • (Hash)

    of scopes available to this model. Keys are scope name, value is scope callable.


73
74
75
76
77
# File 'lib/neo4j/active_node/scope.rb', line 73

def full_scopes
  self.ancestors.find_all { |a| a.respond_to?(:scopes) }.reverse.inject({}) do |scopes, a|
    scopes.merge(a.scopes)
  end
end

#has_scope?(name) ⇒ Boolean

rubocop:disable Naming/PredicateName

Returns:


55
56
57
58
59
# File 'lib/neo4j/active_node/scope.rb', line 55

def has_scope?(name)
  ActiveSupport::Deprecation.warn 'has_scope? is deprecated and may be removed from future releases, use scope? instead.', caller

  scope?(name)
end

#scope(name, proc) ⇒ Object

Similar to ActiveRecord scope

Examples:

without argument

class Person
  include Neo4j::ActiveNode
  property :name
  property :score
  has_many :out, :friends, type: :has_friend, model_class: self
  scope :top_students, -> { where(score: 42)}") }
end
Person.top_students.to_a
a_person.friends.top_students.to_a
a_person.friends.friends.top_students.to_a
a_person.friends.top_students.friends.to_a

Argument for scopes

Person.scope :level, ->(num) { where(level_num: num)}

Argument as a cypher identifier

class Person
  include Neo4j::ActiveNode
  property :name
  property :score
  has_many :out, :friends, type: :has_friend, model_class: self
  scope :great_students, ->(identifier) { where("#{identifier}.score > 41") }
end
Person.as(:all_people).great_students(:all_people).to_a

See Also:


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/neo4j/active_node/scope.rb', line 37

def scope(name, proc)
  scopes[name.to_sym] = proc

  klass = class << self; self; end
  klass.instance_eval do
    define_method(name) do |*query_params|
      eval_context = ScopeEvalContext.new(self, current_scope || self.query_proxy)
      proc = full_scopes[name.to_sym]
      _call_scope_context(eval_context, query_params, proc)
    end
  end

  define_method(name) do |*query_params|
    as(:n).public_send(name, *query_params)
  end
end

#scope?(name) ⇒ Boolean

Returns true if model has access to scope with this name.

Returns:

  • (Boolean)

    true if model has access to scope with this name


63
64
65
# File 'lib/neo4j/active_node/scope.rb', line 63

def scope?(name)
  full_scopes.key?(name.to_sym)
end

#scopesHash

Returns of scopes assigned to this model. Keys are scope name, value is scope callable.

Returns:

  • (Hash)

    of scopes assigned to this model. Keys are scope name, value is scope callable.


68
69
70
# File 'lib/neo4j/active_node/scope.rb', line 68

def scopes
  @scopes ||= {}
end