neo4j-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0ad68a0d597c5eb07fd04204d67753160f3ca37
+  data.tar.gz: 10796e7f9d7fd0237f04259862e41173e932378c
+SHA512:
+  metadata.gz: 17f1dbc7daaf197cbda8d4c06ce0d6ada2b759a0d1e0bd1399e24894b51702bd67405f3777bbd76823e65a0c2da7252808f50d6756e593635ea2ebc68520695d
+  data.tar.gz: 2a455fc7025658b6970828ed7c9f10e84d22cbfa6e5fe5b7e827fc84d7372cc2a1836d43d9662462cee3695053b509f2adac53fc604be11dcc5162443c73d1f0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.3.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rspec"
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Denis Tataurov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Neo4j::Rspec [![Build Status](https://travis-ci.org/sineed/neo4j-rspec.svg?branch=master)](https://travis-ci.org/sineed/neo4j-rspec)
+
+## Examples
+
+```ruby
+subject { ModelClass }
+
+# Properties
+
+it { is_expected.to define_property :general }
+it { is_expected.to define_property :string, String }
+it { is_expected.to define_property :boolean, Boolean } # This might need to be `ActiveAttr::Typecasting::Boolean`
+
+it { is_expected.to have_many(:written_things).with_direction(:in).without_type.with_model_class([:Post, :Comment]) }
+
+# etc...
+
+# `has_one` and `has_many`
+
+it { is_expected.to have_many(:comments) }
+it { is_expected.to have_many(:comments).with_direction(:in) }
+it { is_expected.to have_many(:comments).with_direction(:in).with_origin(:post) }
+
+# Constraints
+
+it { is_expected.to define_constraint :name, :unique }
+
+# `created_at` and `updated_at`
+
+it { is_expected.to track_creations } # `created_at`
+it { is_expected.to track_modifications } # `updated_at`
+
+```
+
+TODO: Put some examples of usage:
+- [ ] define_index
+- [ ] come_from_model
+- [ ] lead_to_model

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+end

data/lib/neo4j/rspec.rb

@@ -0,0 +1,7 @@
+require "neo4j/rspec/matchers"
+require "neo4j/rspec/version"
+
+module Neo4j
+  module RSpec
+  end
+end

data/lib/neo4j/rspec/matchers.rb

@@ -0,0 +1,11 @@
+require "neo4j/rspec/matchers/has_n"
+require "neo4j/rspec/matchers/properties"
+
+module Neo4j
+  module RSpec
+    module Matchers
+      include HasN
+      include Properties
+    end
+  end
+end

data/lib/neo4j/rspec/matchers/has_n.rb

@@ -0,0 +1,223 @@
+module Neo4j
+  module RSpec
+    module Matchers
+      module HasN
+        class BaseMatcher
+          attr_reader :matcher, :value, :key, :actual
+
+          def initialize(matcher, value)
+            @matcher = matcher
+            @value = convert_value(value)
+          end
+
+          def add
+            matcher.expectation_message << expectation_message
+            matcher.association[key] = self
+            matcher
+          end
+
+          def add_negative
+            matcher.expectation_message << negative_expectation_message
+            matcher.association[key] = self
+            matcher
+          end
+
+          def matches?(actual)
+            @actual = extact_actual(actual)
+            if matches
+              matcher.negative_result_message = result_message
+              false
+            else
+              matcher.positive_result_message = result_message
+              true
+            end
+          end
+
+          private
+
+          def matches
+            value != actual
+          end
+
+          def convert_value(val)
+            val
+          end
+        end
+
+        class DirectionMatcher < BaseMatcher
+          private
+
+          def key
+            :direction
+          end
+
+          def extact_actual(actual)
+            actual.direction
+          end
+
+          def expectation_message
+            " with #{value} direction"
+          end
+
+          def result_message
+            "#{actual} direction"
+          end
+        end
+
+        class TypeMatcher < BaseMatcher
+          private
+
+          def key
+            :type
+          end
+
+          def extact_actual(actual)
+            actual.relationship_type
+          end
+
+          def expectation_message
+            " with #{value} relationship type"
+          end
+
+          def negative_expectation_message
+            " without relationship type"
+          end
+
+          def result_message
+            "#{actual} relationship type"
+          end
+        end
+
+        class OriginMatcher < BaseMatcher
+          private
+
+          def key
+            :origin
+          end
+
+          def extact_actual(actual)
+            actual.relationship_type
+          end
+
+          def expectation_message
+            " with #{value} origin"
+          end
+
+          def result_message
+            "#{actual} origin"
+          end
+        end
+
+        class ModelClassesMatcher < BaseMatcher
+          private
+
+          def key
+            :model_classes
+          end
+
+          def convert_value(val)
+            Array(val)
+          end
+
+          def extact_actual(actual)
+            Array(actual.model_class)
+          end
+
+          def matches
+            (value & actual) != value
+          end
+
+          def expectation_message
+            " with #{value.join(", ")} model classes"
+          end
+
+          def result_message
+            "#{actual.join(", ")} model classes"
+          end
+        end
+
+
+        class AssociationMatcher
+          attr_accessor :association, :expectation_message, :negative_result_message,
+            :positive_result_message
+
+          def initialize(name, macro)
+            @association = {}
+            @association[:name] = name.to_sym
+            @association[:macro] = macro
+            @expectation_message = "#{macro_description} #{@association[:name]}"
+          end
+
+          def macro_description
+            case association[:macro]
+            when :has_many then "have many"
+            when :has_one then "have one"
+            end
+          end
+
+          def matchers
+            association.select { |_, v| v.is_a? BaseMatcher }
+          end
+
+          def with_direction(direction)
+            DirectionMatcher.new(self, direction).add
+          end
+
+          def with_type(type)
+            TypeMatcher.new(self, type).add
+          end
+
+          def without_type
+            TypeMatcher.new(self, false).add_negative
+          end
+
+          def with_origin(origin)
+            OriginMatcher.new(self, origin).add
+          end
+
+          def with_model_class(model_class)
+            ModelClassesMatcher.new(self, model_class).add
+          end
+
+          def matches?(actual)
+            @actual = actual
+            actual_association = actual.class.associations[association[:name]]
+
+            unless actual_association
+              self.negative_result_message = "no association named #{association[:name]}"
+              return false
+            else
+              self.positive_result_message = "association named #{association[:name]}"
+            end
+
+            matchers.each do |_, matcher|
+              return false unless matcher.matches?(actual_association)
+            end
+
+            true
+          end
+
+          def failure_message
+            "Expected #{@actual.class} to #{expectation_message}, got #{negative_result_message}"
+          end
+
+          def failure_message_when_negated
+            "Expected #{@actual.class} to not #{expectation_message}, got #{positive_result_message}"
+          end
+
+          def description
+            expectation_message
+          end
+        end
+
+        def have_many(association_name)
+          AssociationMatcher.new(association_name, :has_many)
+        end
+
+        def have_one(association_name)
+          AssociationMatcher.new(association_name, :has_one)
+        end
+      end
+    end
+  end
+end

data/lib/neo4j/rspec/matchers/properties.rb

@@ -0,0 +1,65 @@
+require 'rspec/expectations'
+
+module Neo4j
+  module RSpec
+    module Matchers
+      module Properties
+        extend ::RSpec::Matchers::DSL
+
+        matcher :track_creations do
+          match do |model|
+            model.attributes[:created_at] && model.attributes[:created_at][:type] == DateTime
+          end
+
+          failure_message do |model|
+            "expected the #{model.name} model to track creations (`created_at`)"
+          end
+        end
+
+        matcher :track_modifications do
+          match do |model|
+            model.attributes[:updated_at] && model.attributes[:updated_at][:type] == DateTime
+          end
+
+          failure_message do |model|
+            "expected the #{model.name} model to track modifications (`updated_at`)"
+          end
+        end
+
+        matcher :define_property do |name, type = nil|
+          match do |model|
+            model.attributes.key?(name.to_s) &&
+              (type ? model.attributes[name.to_s][:type] == type : true)
+          end
+
+          failure_message do |model|
+            "expected the #{model.name} model to have a `#{type}` property #{name}"
+          end
+
+          failure_message_when_negated do |model|
+            "expected the #{model.name} model not to have a `#{type}` property #{name}"
+          end
+        end
+
+        matcher :define_constraint do |name, type|
+          fail ArgumentError, 'constraint name should be given' if name.blank?
+          fail ArgumentError, 'constraint type should be given' if type.blank?
+
+          match do |model|
+            model.attributes.key?(name.to_s) &&
+              model.attributes[name.to_s][:constraint] == type
+          end
+
+          failure_message do |model|
+            "expected the #{model.name} model to have a #{type} constraint on #{name}"
+          end
+
+          failure_message_when_negated do |model|
+            "expected the #{model.name} model not to have a #{type} constraint on #{name}"
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/neo4j/rspec/version.rb

@@ -0,0 +1,5 @@
+module Neo4j
+  module RSpec
+    VERSION = "0.1.0"
+  end
+end

data/neo4j-rspec.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "neo4j/rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "neo4j-rspec"
+  spec.version       = Neo4j::RSpec::VERSION
+  spec.authors       = ["Denis Tataurov"]
+  spec.email         = ["sineedus@mail.ru"]
+
+  spec.summary       = "RSpec matchers for Neo4j.rb"
+  spec.description   = "RSpec matchers for Neo4j.rb"
+  spec.homepage      = "https://github.com/sineed/neo4j-rspec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "neo4j", "~> 6"
+  spec.add_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: neo4j-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Tataurov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: neo4j
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: RSpec matchers for Neo4j.rb
+email:
+- sineedus@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/neo4j/rspec.rb
+- lib/neo4j/rspec/matchers.rb
+- lib/neo4j/rspec/matchers/has_n.rb
+- lib/neo4j/rspec/matchers/properties.rb
+- lib/neo4j/rspec/version.rb
+- neo4j-rspec.gemspec
+homepage: https://github.com/sineed/neo4j-rspec
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for Neo4j.rb
+test_files: []