architect4r 0.3.2

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.rvmrc
+architect4r-*.gem
+neo4j_server

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in architect4r.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    architect4r (0.3.2)
+      activemodel (~> 3.0)
+      json (~> 1.5)
+      typhoeus (~> 0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    growl (1.0.3)
+    guard (0.8.7)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.0)
+      guard (>= 0.8.4)
+    i18n (0.6.0)
+    json (1.6.1)
+    mime-types (1.17.1)
+    multi_json (1.0.3)
+    rake (0.9.2)
+    rb-fsevent (0.4.3.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    thor (0.14.6)
+    typhoeus (0.3.2)
+      mime-types
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  architect4r!
+  growl
+  guard
+  guard-rspec
+  rake
+  rb-fsevent
+  rspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec' do
+  # Check for changes in classes
+  watch(%r{^lib/architect4r/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  
+  # Check for changes in specs
+  watch(%r{^spec/.+_spec\.rb$})
+  
+  # Check for changes in the spec helper
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/License

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Maximilian Schulz
+
+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,62 @@
+# Architect4r
+
+Architect4r is intended as an easy ruby wrapper for the neo4j graph db 
+REST API. There are other solutions such as neo4j.rb if you are working 
+in a java environment or neography which provides another working wrapper 
+for the REST API.
+
+Requirements
+------------
+
+You need a running neo4j installation.
+
+Installation
+------------
+
+In oder to work with architect4r you have to install the gem by using 
+`gem install architect4r` or in case that you are using bundler, you can 
+add the following line to your _Gemfile_: `gem "architect4r"`.
+
+Quick Start
+-----------
+    
+    # Class definition
+    class Instrument < Architect4r::Model::Node
+      # Properties
+      property :name, :cast_to => String, :localize => true
+      property :name, :cast_to => String, :localize => :de
+      
+      # Validations
+      validates :name, :presence => true
+    end
+    
+    # Interfacing with the I18n class
+    I18n.locale = :en
+    
+    # Working with a record
+    instrument = Instrument.new
+    instrument.name = "Piano"
+    instrument.name(:de) = "Klavier"
+    instrument.valid?
+    instrument.save
+    
+    # Updating attributes
+    instrument.update_attributes(params[:instrument])
+    
+    # Finding records
+    Instrument.find_by_id(123)
+    
+    class Fanship < Architect4r::Model::Relationship
+      # Properties
+      property :created_at, :cast_to => DateTime
+      property :reason, :cast_to => String
+    end
+    
+    # Init a class based relationship
+    Fanship.new(@user, @instrument, { :reason => 'Because I like you' })
+
+License
+-------
+
+Architect4r is copyright (c) 2011 Maximilian Schulz. It is free software, 
+and may be redistributed under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+
+# Add rspec tasks for testing
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+# Load instance manager
+require 'lib/architect4r/instance_manager'
+
+# Setting up default tasks
+desc "Run specs"
+task :default => :spec
+
+namespace :server do
+  
+  current_path = File.dirname(__FILE__)
+  server_path = File.join(current_path, 'neo4j_server')
+  neo_manager = Architect4r::InstanceManager.new(server_path)
+  
+  desc "Install test server"
+  task :install do
+    puts '--- not implemented'
+  end
+  
+  desc "Stop the neo4j server"
+  task :start do
+    neo_manager.start
+  end
+  
+  desc "Stop the neo4j server"
+  task :stop do
+    neo_manager.stop
+  end
+  
+  desc "Reset the test server"
+  task :reset do
+    neo_manager.reset_to_sample_data("#{current_path}/spec/fixtures/graph.db.default/")
+  end
+  
+end

data/ReleaseNotes.md

@@ -0,0 +1,33 @@
+# Release Notes
+
+## v0.3.2
+
+* Support for carrierwave file upload mechanism
+
+## v0.3.1
+
+* Sync with ActiveModel records
+
+  In order to use neo4j in combination with other databases, we provide a 
+  small extension which allows you to keep a node in sync with another's 
+  datastore record.
+
+## v0.3
+
+This release marks the first public release. So I wont get into length 
+with its changes and new features. Let's just say it allows you to create
+nodes and relationships between nodes. That's it!
+
+* Nodes (create, update, destroy)
+* Relationships (create, update, destroy)
+* Querying neo4j by using cypher query language
+* Callbacks and validations for nodes and relationships
+
+## v0.2
+
+Another internal release which was not ready for development or production.
+_Please do not use it or try working with it!_ ;)
+
+## v0.1
+
+Some initial internal release which was very buggy and limited on the features.

data/Roadmap.md

@@ -0,0 +1,31 @@
+# Roadmap
+
+_Check the release notes for info on previous versions_
+
+
+There is no real roadmap for architect4r, as this project is only used in 
+a single project so far. If there is anything you miss, either fork the 
+project, implement the feature and send a pull request, or submit an issue.
+
+The following items are kinda planned to be integrated in the future:
+
+* Give the cypher plugin some more love
+* Add more default queries
+* Add tracking of dirty attributes
+* Make it compatible to file uploaders such as paperclip and carrierwave
+* Make it compatible to search engines such as sunspot, elastic search, sphinx, …
+* Rake tasks for installing neo4j
+* Rake tasks for test setup
+* Versioning of nodes (update node but create a linked node with the old properties)
+* Improve documentation
+* Improve test cases
+
+And there are a few features which might be integrated, but are not yet really planned:
+
+* Accessible relationships as you know it from active record
+* Support for indexes (nodes and relations)
+* Add more finders by using indexes
+* Add auto indexing of node properties / nodes (not neo4j auto indexing)
+* Add basic authentication
+* Add digest authentication
+* Facilitate hydra's concurrency model

data/Specs.md

@@ -0,0 +1,21 @@
+# Specs
+
+Some code which might define the future interface of the gem.
+    
+    # Finding records
+    Instrument.all
+    Instrument.find_by_name("Piano")
+    Instrument.find_by_name("Klavier", :de)
+    Instrument.find_by_cypher("start cat=(123) match (cat)--(x) return x limit 2")
+    
+    # Filter associations by relationship type (:incoming, :outgoing, :all)
+    instrument.links(:outgoing)
+    
+    # Query by model or type
+    @user.links(:all, Fanship, 'studies')
+    
+    # Create a custom relationship
+    relationship = Architect4r::Model::Relationship.create(start_node, end_note, 'CustomType', { :active => true })
+    # or
+    instrument.links(:incoming).create(:category, @other_node, { :created_at => DateTime.new, :active => true })
+    instrument.links(:incoming).create(CategoryRelation, @other_node, { :created_at => DateTime.new, :active => true })

data/architect4r.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "architect4r/version"
+
+Gem::Specification.new do |s|
+  s.name        = "architect4r"
+  s.version     = Architect4r::VERSION
+  s.authors     = ["Maximilian Schulz"]
+  s.email       = ["m.schulz@kulturfluss.de"]
+  s.homepage    = "http://www.kulturfluss.de/"
+  s.summary     = %q{A gem for working with the neo4j REST interface.}
+  s.description = %q{This gem is intended for making a neo4j graph db accessible by providing a ruby wrapper for the REST API.}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # Production dependencies
+  s.add_runtime_dependency %q<activemodel>, "~> 3.0"
+  s.add_runtime_dependency %q<json>, "~> 1.5"
+  s.add_runtime_dependency %q<typhoeus>, "~> 0.2"
+  
+  # Development dependencies
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rb-fsevent"
+  s.add_development_dependency "growl"
+end

data/lib/architect4r.rb

@@ -0,0 +1,66 @@
+#
+# Gem management
+#
+require 'architect4r/version'
+
+#
+# Extensions
+#
+require 'active_model'
+require 'active_support'
+require 'active_support/core_ext'
+#require 'architect4r/extensions/object'
+
+#
+# Core modules
+#
+require 'architect4r/core/configuration'
+require 'architect4r/core/cypher_methods'
+require 'architect4r/core/node_methods'
+require 'architect4r/core/relationship_methods'
+
+#
+# Basic server interaction
+#
+require 'architect4r/server'
+
+#
+# Model features
+#
+require 'architect4r/model/connection'
+require 'architect4r/model/properties'
+require 'architect4r/model/persistency'
+require 'architect4r/model/queries'
+require 'architect4r/model/validations'
+require 'architect4r/model/callbacks'
+require 'architect4r/model/links_query_interface'
+require 'architect4r/model/relationships'
+require 'architect4r/model/node'
+require 'architect4r/model/relationship'
+
+#
+# Generic items
+#
+require 'architect4r/generic_node'
+
+#
+# Support for multi database environments
+#
+require 'architect4r/has_node'
+# Auto load the extension when active record is used
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, Architect4r::HasNode)
+end
+
+#
+# The namespace
+#
+module Architect4r
+  
+  def self.version
+    "Architect4r version #{Architect4r::VERSION}"
+  end
+  
+  class InvalidCypherQuery < SyntaxError; end
+  
+end

data/lib/architect4r/adapters/carrier_wave.rb

@@ -0,0 +1,64 @@
+require "architect4r"
+require "carrierwave"
+require "carrierwave/validations/active_model"
+
+# In order to use this class include this file in your project
+# require 'architect4r/adapters/carrier_wave'
+#
+module Architect4r
+  module Adapters
+    module CarrierWave
+      # Import default implementation
+      include ::CarrierWave::Mount
+      
+      def mount_uploader(column, uploader = nil, options = {}, &block)
+        property "#{column}_data", :cast_to => String
+        
+        # Init by calling default initializer
+        super
+        
+        # Enable validations
+        include ::CarrierWave::Validations::ActiveModel
+        validates_integrity_of  column if uploader_option(column.to_sym, :validate_integrity)
+        validates_processing_of column if uploader_option(column.to_sym, :validate_processing)
+        
+        # Add hooks
+        after_save :"store_#{column}!"
+        before_save :"write_#{column}_identifier"
+        after_destroy :"remove_#{column}!"
+        
+        # These hooks cannot be used until dirty tracking is implemented
+        #before_update :"store_previous_model_for_#{column}"
+        #after_save :"remove_previously_stored_#{column}"
+        
+        class_eval <<-RUBY, __FILE__, __LINE__+1
+          
+          public
+          
+          def read_uploader(column)
+            self.send("#{column}_data")
+          end
+          
+          def write_uploader(column, identifier)
+            self.send("#{column}_data=", identifier)
+          end
+          
+        RUBY
+      end
+      
+    end
+  end
+end
+
+# Add this to all nodes and relationships (funky isn't it?)
+module Architect4r
+  module Model
+    class Node
+      extend Architect4r::Adapters::CarrierWave
+    end
+    
+    class Relationship
+      extend Architect4r::Adapters::CarrierWave
+    end
+  end
+end