activecypher 0.3.0 → 0.5.0

data/lib/cyrel.rb

@@ -1,72 +1,131 @@
 # frozen_string_literal: true
 
-require 'irb' # Required for binding.irb
-
 module Cyrel
   module_function
 
-  # Define all top-level helpers as instance methods first
+  # Cyrel DSL helper: creates a CALL clause for a procedure.
+  # Example: Cyrel.call('db.labels')
   def call(procedure)
     CallProcedure.new(procedure)
   end
 
+  # Cyrel DSL helper: creates a RETURN clause.
+  # Example: Cyrel.return(name: :n)
   def return(**return_values)
     ReturnOnly.new(return_values)
   end
-  # Now make all defined instance methods module functions
 
-  # --- Pattern Helpers ---
+  # Cyrel DSL helper: creates a node pattern.
+  # Example: Cyrel.node(:n, labels: ['Person'], properties: {name: 'Alice'})
   def node(alias_name, labels: [], properties: {})
     Pattern::Node.new(alias_name, labels: labels, properties: properties)
   end
-  # Add helpers for Relationship, Path if needed
 
-  # --- Query Building Starters ---
+  # Cyrel DSL helper: starts a CREATE query.
+  # Example: Cyrel.create(pattern)
   def create(pattern)
-    Query.new.create(pattern) # Start a new query and call create
+    Query.new.create(pattern)
   end
 
+  # Cyrel DSL helper: starts a MATCH query.
+  # Example: Cyrel.match(pattern)
   def match(pattern, path_variable: nil)
-    Query.new.match(pattern, path_variable: path_variable) # Start a new query and call match
+    Query.new.match(pattern, path_variable: path_variable)
   end
-  # Add helpers for merge etc. if desired as query starters
 
-  # --- Function Helpers (Delegated) ---
-  # Keep id for now for compatibility? Or remove entirely? Let's keep it but delegate element_id too.
-  # Delegate to the correct module function
+  # Cyrel DSL helper: returns the element id of a node/relationship.
+  # Example: Cyrel.id(:n)
   def id(...) = Functions.element_id(...)
+
+  # Cyrel DSL helper: returns the element id of a node/relationship (alias).
   def element_id(...) = Functions.element_id(...)
+
+  # Cyrel DSL helper: Cypher count() aggregation.
+  # Example: Cyrel.count(:n)
   def count(...) = Functions.count(...)
+
+  # Cyrel DSL helper: Cypher labels() function.
+  # Example: Cyrel.labels(:n)
   def labels(...) = Functions.labels(...)
+
+  # Cyrel DSL helper: Cypher type() function.
+  # Example: Cyrel.type(:r)
   def type(...) = Functions.type(...)
+
+  # Cyrel DSL helper: Cypher properties() function.
+  # Example: Cyrel.properties(:n)
   def properties(...) = Functions.properties(...)
+
+  # Cyrel DSL helper: Cypher coalesce() function.
+  # Example: Cyrel.coalesce(:a, :b)
   def coalesce(...) = Functions.coalesce(...)
+
+  # Cyrel DSL helper: Cypher timestamp() function.
+  # Example: Cyrel.timestamp
   def timestamp(...) = Functions.timestamp(...)
+
+  # Cyrel DSL helper: Cypher toString() function.
+  # Example: Cyrel.to_string(:n)
   def to_string(...) = Functions.to_string(...)
+
+  # Cyrel DSL helper: Cypher toInteger() function.
+  # Example: Cyrel.to_integer(:n)
   def to_integer(...) = Functions.to_integer(...)
+
+  # Cyrel DSL helper: Cypher toFloat() function.
+  # Example: Cyrel.to_float(:n)
   def to_float(...) = Functions.to_float(...)
+
+  # Cyrel DSL helper: Cypher toBoolean() function.
+  # Example: Cyrel.to_boolean(:n)
   def to_boolean(...) = Functions.to_boolean(...)
+
+  # Cyrel DSL helper: Cypher sum() aggregation.
+  # Example: Cyrel.sum(:n)
   def sum(...) = Functions.sum(...)
+
+  # Cyrel DSL helper: Cypher avg() aggregation.
+  # Example: Cyrel.avg(:n)
   def avg(...) = Functions.avg(...)
+
+  # Cyrel DSL helper: Cypher min() aggregation.
+  # Example: Cyrel.min(:n)
   def min(...) = Functions.min(...)
+
+  # Cyrel DSL helper: Cypher max() aggregation.
+  # Example: Cyrel.max(:n)
   def max(...) = Functions.max(...)
+
+  # Cyrel DSL helper: Cypher collect() aggregation.
+  # Example: Cyrel.collect(:n)
   def collect(...) = Functions.collect(...)
-  def size(...) = Functions.size(...)
 
-  # --- Expression Helpers (Delegated) ---
+  # Cyrel DSL helper: Cypher size() function.
+  # Example: Cyrel.size(:n)
+  def size(...) = Functions.size(...)
 
-  # Helper for creating PropertyAccess expressions.
+  # Cyrel DSL helper: creates a PropertyAccess expression.
+  # Example: Cyrel.prop(:n, :name)
   def prop(variable, property_name)
     Expression.prop(variable, property_name)
   end
 
-  # Helper for creating Exists expressions.
+  # Cyrel DSL helper: creates an Exists expression.
+  # Example: Cyrel.exists(pattern)
   def exists(pattern)
     Expression.exists(pattern)
   end
 
-  # Helper for creating Logical NOT expressions.
+  # Cyrel DSL helper: creates a Logical NOT expression.
+  # Example: Cyrel.not(expression)
   def not(expression)
     Expression.not(expression)
   end
+
+  # Cyrel DSL helper: property merging (SET n += {props}).
+  # Use for updating only specified properties on a node or relationship.
+  # Example: Cyrel.plus(:n) => { name: "Alice" } generates SET n += $p1
+  def plus(variable)
+    Plus.new(variable)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activecypher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -132,6 +132,7 @@ files:
 - lib/active_cypher/generators/templates/cypher_databases.yml
 - lib/active_cypher/generators/templates/node.rb.erb
 - lib/active_cypher/generators/templates/relationship.rb.erb
+- lib/active_cypher/instrumentation.rb
 - lib/active_cypher/logging.rb
 - lib/active_cypher/model/abstract.rb
 - lib/active_cypher/model/attributes.rb
@@ -189,6 +190,7 @@ files:
 - lib/cyrel/pattern/node.rb
 - lib/cyrel/pattern/path.rb
 - lib/cyrel/pattern/relationship.rb
+- lib/cyrel/plus.rb
 - lib/cyrel/query.rb
 - lib/cyrel/return_only.rb
 - lib/cyrel/types/hash_type.rb