cancancan-neo4j 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 148fb171b87ba1ffbb6445fbc94d784f17e0c7a5
+  data.tar.gz: 2a51eae6389c590145df0a17d06febd46d36cdf5
+SHA512:
+  metadata.gz: b91b481d4fd5c21a46679e639a66e01245edb84b1e0bbcf295f2a5ead6202b6a08e7fea7541f8331dc82f9a2d52fee32fcda8bf124f0351176aaf8fa94c4e7b5
+  data.tar.gz: d4d5388127d1ec21c0f107fa5fedf6b92e5187cb0fd5871cdc615091f8ba32da1dd8afda2c56dded956117f2903c0cfc6a8c037b67b3d2922a5d036752e122ce

data/cancancan-neo4j.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cancancan/neo4j/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cancancan-neo4j'
+  spec.version       = CanCanCan::Neo4j::VERSION
+  spec.authors       = ['Amit Suryavanshi']
+  spec.email         = ['amitbsuryavanshi@gmail.com']
+  spec.homepage      = 'https://github.com/CanCanCommunity/cancancan-neo4j'
+  spec.summary       = 'neo4j database adapter for CanCanCan.'
+  spec.description   = "Implements CanCanCan's rule-based record fetching using neo4j gem."
+  spec.platform      = Gem::Platform::RUBY
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files lib init.rb cancancan-neo4j.gemspec`.split($INPUT_RECORD_SEPARATOR)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '<5.2.0'
+  spec.add_dependency 'cancancan', '<=2.1.4'
+  spec.add_dependency 'neo4j', '>= 9.0.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.3'
+  spec.add_development_dependency 'neo4j-community' if RUBY_PLATFORM =~ /java/
+  spec.add_development_dependency('neo4j-rake_tasks', '>= 0.3.0')
+  spec.add_development_dependency 'pry', '>= 0.11.3'
+  spec.add_development_dependency 'rake', '>= 10.1'
+  spec.add_development_dependency 'rspec', '>= 3.2'
+  spec.add_development_dependency 'rubocop', '>= 0.48.1'
+end

data/lib/cancancan/model_adapters/neo4j_adapter.rb

@@ -0,0 +1,131 @@
+require 'cancancan/neo4j/cypher_constructor_helper'
+require 'cancancan/neo4j/rule_cypher'
+
+module CanCan
+  module ModelAdapters
+    # neo4j adapter for cancan
+    class Neo4jAdapter < AbstractAdapter
+      def database_records
+        return @model_class.where('false') if @rules.empty?
+        rule = @rules.first
+        return rule.conditions if override_scope
+        records_for_multiple_rules.distinct
+      end
+
+      def self.for_class?(model_class)
+        model_class <= Neo4j::ActiveNode
+      end
+
+      def self.override_conditions_hash_matching?(_subject, _conditions)
+        true
+      end
+
+      def self.matches_conditions_hash?(subject, conditions)
+        base_class = subject.class
+        all_conditions_match?(subject, conditions, base_class)
+      end
+
+      def self.all_conditions_match?(subject, conditions, base_class)
+        asso_conditions, model_conditions = CanCanCan::Neo4j::CypherConstructorHelper
+                                            .bifurcate_conditions(conditions)
+        associations_conditions_match?(asso_conditions, subject, base_class) &&
+          model_conditions_matches?(model_conditions, subject, base_class)
+      end
+
+      def self.model_conditions_matches?(conditions, subject, base_class)
+        return true if conditions.blank?
+        conditions = conditions.partition do |key, _|
+          base_class.associations_keys.include?(key)
+        end
+        associations_conditions, atrribute_conditions = conditions.map(&:to_h)
+        matches_attribute_conditions?(atrribute_conditions, subject) &&
+          matches_associations_relations(associations_conditions, subject)
+      end
+
+      # checks if associations exists on given node
+      def self.matches_associations_relations(conditions, subject)
+        return true if conditions.blank?
+        conditions.all? do |association, value|
+          association_exists = subject.send(association).exists?
+          value ? association_exists : !association_exists
+        end
+      end
+
+      def self.matches_attribute_conditions?(conditions, subject)
+        return true if conditions.blank?
+        if subject.is_a?(Neo4j::ActiveNode::HasN::AssociationProxy)
+          subject.where(conditions).exists?
+        else
+          conditions.all? do |attribute, value|
+            subject.send(attribute) == value
+          end
+        end
+      end
+
+      def self.associations_conditions_match?(conditions, subject, base_class)
+        return true if conditions.blank?
+        conditions.all? do |association, conditions_hash|
+          current_model = base_class.associations[association].target_class
+          current_subject = subject.send(association)
+          all_conditions_match?(current_subject, conditions_hash, current_model)
+        end
+      end
+
+      private
+
+      def records_for_multiple_rules
+        base_query = base_query_proxy.query
+        cypher_options = construct_cypher_options
+        match_string = cypher_options[:matches].uniq.join(', ')
+        base_query = base_query.match(match_string) unless match_string.blank?
+        base_query
+          .proxy_as(@model_class, var_name(@model_class))
+          .where(cypher_options[:conditions])
+      end
+
+      def construct_cypher_options
+        default_options = { conditions: '', matches: [] }
+        @rules.reverse.each_with_object(default_options) do |rule, options|
+          rule_options = { rule: rule, model_class: @model_class }
+          rule_cypher = CanCanCan::Neo4j::RuleCypher.new(rule_options)
+          CanCanCan::Neo4j::CypherConstructorHelper
+            .append_and_or_to_conditions(options, rule_cypher)
+          options[:conditions] += ('(' + rule_cypher.rule_conditions + ')')
+          options[:matches] += rule_cypher.cypher_matches
+          options
+        end
+      end
+
+      def base_query_proxy
+        @model_class.as(var_name(@model_class))
+      end
+
+      def override_scope
+        conditions = @rules.map(&:conditions).compact
+        return unless conditions.any? { |condition| condition.is_a?(Neo4j::ActiveNode::Query::QueryProxy) }
+        return conditions.first if conditions.size == 1
+        raise_override_scope_error
+      end
+
+      def raise_override_scope_error
+        rule_found = @rules.detect { |rule| rule.conditions.is_a?(Neo4j::ActiveNode::Query::QueryProxy) }
+        raise Error,
+              'Unable to merge an ActiveNode scope with other conditions. '\
+              "Instead use a hash for #{rule_found.actions.first} #{rule_found.subjects.first} ability."
+      end
+
+      def var_name(model_class)
+        CanCanCan::Neo4j::CypherConstructorHelper.var_name(model_class)
+      end
+    end
+  end
+end
+
+module Neo4j
+  module ActiveNode
+    # simplest way to add `accessible_by` to all ActiveNode models
+    module ClassMethods
+      include CanCan::ModelAdditions::ClassMethods
+    end
+  end
+end

data/lib/cancancan/neo4j.rb

@@ -0,0 +1,6 @@
+require 'cancancan'
+require 'neo4j'
+
+require 'cancancan/neo4j/version'
+require 'cancancan/model_adapters/neo4j_adapter'
+require 'cancancan/neo4j/cypher_constructor_helper'

data/lib/cancancan/neo4j/active_record_disabler.rb

@@ -0,0 +1,7 @@
+class CanCanCan::Sequel::ActiveRecordDisabler
+  ::CanCan::ModelAdapters::ActiveRecord4Adapter.class_eval do
+    def self.for_class?(_)
+      false
+    end
+  end
+end

data/lib/cancancan/neo4j/association_conditions.rb

@@ -0,0 +1,74 @@
+require 'cancancan/neo4j/cypher_constructor_helper'
+
+module CanCanCan
+  module Neo4j
+    # Constructs cypher conditions for associations conditions hash
+    class AssociationConditions
+      attr_reader :conditions_string, :cypher_matches
+
+      def initialize(options)
+        @options = options
+        @conditions_string = ''
+        @cypher_matches = []
+        construct_conditions
+      end
+
+      def construct_conditions
+        @options[:asso_conditions].each do |association, conditions|
+          relationship = association_relation(association)
+          associations_conditions, model_conditions = CypherConstructorHelper.bifurcate_conditions(conditions)
+          current_path = append_path_to_conditions(relationship, model_conditions)
+          append_model_conditions(model_conditions, relationship, current_path)
+          append_association_conditions(associations_conditions, relationship)
+        end
+      end
+
+      def association_relation(association)
+        @options[:parent_class].associations[association]
+      end
+
+      def append_association_conditions(conditions, relationship)
+        return if conditions.blank?
+        asso_conditions_obj = AssociationConditions.new(asso_conditions: conditions, parent_class: relationship.target_class, path: path_with_relationship(relationship))
+        append_and_to_conditions_string
+        @conditions_string += asso_conditions_obj.conditions_string
+        @cypher_matches += asso_conditions_obj.cypher_matches
+      end
+
+      def append_path_to_conditions(relationship, model_conditions)
+        target_class = relationship.target_class
+        model_attr_exists = model_conditions.any? do |key, _|
+          !target_class.associations_keys.include?(key)
+        end
+        end_node = model_attr_exists ? CypherConstructorHelper.match_node_cypher(target_class) : '()'
+        current_path = @options[:path] + relationship.arrow_cypher + end_node
+        if model_attr_exists
+          append_matches(relationship)
+          append_and_to_conditions_string
+          @conditions_string += current_path
+        end
+        current_path
+      end
+
+      def append_matches(relationship)
+        node_class = relationship.target_class
+        @cypher_matches << CypherConstructorHelper.match_node_cypher(node_class)
+      end
+
+      def append_and_to_conditions_string
+        @conditions_string += ' AND ' unless @conditions_string.blank?
+      end
+
+      def append_model_conditions(model_conditions, relationship, current_path)
+        return if model_conditions.blank?
+        con_string = CypherConstructorHelper.construct_conditions_string(model_conditions, relationship.target_class, current_path)
+        append_and_to_conditions_string
+        @conditions_string += con_string
+      end
+
+      def path_with_relationship(relationship)
+        @options[:path] + relationship.arrow_cypher + '()'
+      end
+    end
+  end
+end

data/lib/cancancan/neo4j/cypher_constructor_helper.rb

@@ -0,0 +1,71 @@
+module CanCanCan
+  module Neo4j
+    # Cypher query constructs
+    class CypherConstructorHelper
+      class << self
+        def match_node_cypher(node_class)
+          "(#{var_name(node_class)}:`#{node_class.mapped_label_name}`)"
+        end
+
+        def construct_conditions_string(conditions_hash, base_class, path = '')
+          variable_name = var_name(base_class)
+          conditions_hash.collect do |key, value|
+            condition = if base_class.associations_keys.include?(key)
+                          con = condtion_for_path(path: path,
+                                                  variable_name: variable_name,
+                                                  base_class: base_class,
+                                                  key: key)
+                          value ? con : ' NOT ' + con
+                        elsif key == :id
+                          condition_for_id(base_class, variable_name, value)
+                        else
+                          condition_for_attribute(value, variable_name, key)
+                        end
+            '(' + condition + ')'
+          end.join(' AND ')
+        end
+
+        def condition_for_attribute(value, variable_name, attribute)
+          lhs = variable_name + '.' + attribute.to_s
+          return lhs + ' IS NULL ' if value.nil?
+          rhs = value.to_s
+          rhs = "'" + rhs + "'" unless [true, false].include?(value)
+          lhs + '=' + rhs
+        end
+
+        def condtion_for_path(path:, variable_name:, base_class:, key:)
+          path = "(#{variable_name})" if path.blank?
+          path + base_class.associations[key].arrow_cypher + '()'
+        end
+
+        def condition_for_id(base_class, variable_name, value)
+          id_property = base_class.id_property_name
+          if id_property == :neo_id
+            "ID(#{variable_name})=#{value}"
+          else
+            variable_name + '.' + id_property.to_s + '=' + "'#{value}'"
+          end
+        end
+
+        def var_name(class_constant)
+          class_constant.name.downcase.split('::').join('_')
+        end
+
+        def bifurcate_conditions(conditions)
+          conditions.partition { |_, value| value.is_a?(Hash) }.map(&:to_h)
+        end
+
+        def append_and_or_to_conditions(cypher_options, rule_cypher)
+          conditions_string = cypher_options[:conditions]
+          connector = if conditions_string.blank?
+                        ''
+                      else
+                        rule_cypher.conditions_connector
+                      end
+          connector += 'NOT' if rule_cypher.append_not_to_conditions?
+          cypher_options[:conditions] = conditions_string + connector
+        end
+      end
+    end
+  end
+end

data/lib/cancancan/neo4j/rule_cypher.rb

@@ -0,0 +1,63 @@
+require 'cancancan/neo4j/cypher_constructor_helper'
+require 'cancancan/neo4j/association_conditions'
+
+module CanCanCan
+  module Neo4j
+    # Constructs cypher conditions for rule and cypher match classes
+    class RuleCypher
+      attr_reader :rule_conditions, :cypher_matches
+
+      def initialize(options)
+        @options = options
+        @rule_conditions = ''
+        @cypher_matches = []
+        construct_cypher_conditions
+      end
+
+      def construct_cypher_conditions
+        if @options[:rule].conditions.blank?
+          condition_for_rule_without_conditions
+        else
+          set_cypher_options
+        end
+      end
+
+      def conditions_connector
+        @options[:rule].base_behavior ? ' OR ' : ' AND '
+      end
+
+      def append_not_to_conditions?
+        !rule_conditions_blank? && !@options[:rule].base_behavior
+      end
+
+      private
+
+      def rule_conditions_blank?
+        @options[:rule].conditions.blank?
+      end
+
+      def condition_for_rule_without_conditions
+        @rule_conditions = @options[:rule].base_behavior ? '(true)' : '(false)'
+      end
+
+      def set_cypher_options
+        associations_conditions, model_conditions = CypherConstructorHelper.bifurcate_conditions(@options[:rule].conditions)
+        @rule_conditions = CypherConstructorHelper.construct_conditions_string(model_conditions, @options[:model_class], default_path) unless model_conditions.blank?
+        return if associations_conditions.blank?
+        append_association_conditions(associations_conditions)
+      end
+
+      def append_association_conditions(conditions_hash)
+        options = { asso_conditions: conditions_hash, parent_class: @options[:model_class], path: default_path }
+        asso_conditions_obj = AssociationConditions.new(options)
+        @rule_conditions += ' AND ' unless @rule_conditions.blank?
+        @rule_conditions += asso_conditions_obj.conditions_string
+        @cypher_matches += asso_conditions_obj.cypher_matches
+      end
+
+      def default_path
+        CypherConstructorHelper.match_node_cypher(@options[:model_class])
+      end
+    end
+  end
+end

data/lib/cancancan/neo4j/version.rb

@@ -0,0 +1,7 @@
+module CanCanCan
+end
+module CanCanCan
+  module Neo4j
+    VERSION = '1.0.2'.freeze
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: cancancan-neo4j
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Amit Suryavanshi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  name: activemodel
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  name: cancancan
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+  name: neo4j
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: neo4j-community
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  name: neo4j-rake_tasks
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  name: rubocop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+description: Implements CanCanCan's rule-based record fetching using neo4j gem.
+email:
+- amitbsuryavanshi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- cancancan-neo4j.gemspec
+- lib/cancancan/model_adapters/neo4j_adapter.rb
+- lib/cancancan/neo4j.rb
+- lib/cancancan/neo4j/active_record_disabler.rb
+- lib/cancancan/neo4j/association_conditions.rb
+- lib/cancancan/neo4j/cypher_constructor_helper.rb
+- lib/cancancan/neo4j/rule_cypher.rb
+- lib/cancancan/neo4j/version.rb
+homepage: https://github.com/CanCanCommunity/cancancan-neo4j
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
+specification_version: 4
+summary: neo4j database adapter for CanCanCan.
+test_files: []