neo4j 1.0.0.beta.20 → 3.0.0.alpha.2

data/README.rdoc

@@ -1,135 +0,0 @@
-== Welcome to Neo4j.rb
-
-Neo4j.rb is a graph database for JRuby.
-
-You can think of \Neo4j as a high-performance graph engine with all the features of a mature and robust database.
-The programmer works with an object-oriented, flexible network structure rather than with strict and static tables — yet enjoys all the benefits of a fully transactional, enterprise-strength database.
-
-It uses two powerful and mature Java libraries:
-* {Neo4J}[http://www.neo4j.org] - for persistence and traversal of the graph
-* {Lucene}[http://lucene.apache.org/java/docs/index.html] for querying and indexing.
-
-=== Why Neo4j.rb or a Graph Database ?
-
-Here are some of the major benefits of Neo4j.rb
-
-* Domain Modeling - use the language of a graph (nodes/relationship/properties) to express your domain !
-  * Schema Less and Efficient storage of Semi Structured Information
-  * No {O/R mismatch}[http://en.wikipedia.org/wiki/Object-relational_impedance_mismatch] - very natural to map a graph to an \Object Oriented language like Ruby.
-* {Performance}[http://www.oscon.com/oscon2009/public/schedule/detail/8364]
-* Embedded Database - no database tier, easier to install, test, deploy and configure. It is run in the same process as your application.
-* Express Queries as Traversals
-  * Fast deep traversal instead of slow SQL queries that span many table joins.
-  * Very natural to express graph related problem with traversals (recommendation engine, find shortest parth etc..)
-* Seamless integration with Ruby on \Rails.
-* ACID Transaction with rollbacks support.
-
-=== Documentation
-
-* {API Documentation}[http://neo4j.rubyforge.org]
-* {Documentation and Getting Started with Neo4j}[http://neo4j.rubyforge.org/guides/index.html]
-
-=== Some Examples
-
-==== Neo4j::Node
-
-Example of creating a Neo4j::Node
-
-  require "rubygems"
-  require 'neo4j'
-
-  Neo4j::Transaction.run do
-    node = Neo4j::Node.new (:name => 'andreas')
-    node.outgoing(:friends) << Neo4j::Node.new (:name => 'peter')
-    node.outgoing(:friends).each {|node| puts "name #{node[:name]}"}
-  end
-
-==== Neo4j::Mapping::NodeMixin
-
-Example of mapping a ruby class to a node and delaring properties and relationships and lucene index.
-
-  class Person
-    include Neo4j::NodeMixin
-    property :name
-    property :city
-
-    has_n :friends
-    has_one :address
-    index :name
-  end
-
-  # assume we have an transaction already running
-  andreas = Person.new (:name => 'andreas')
-  andreas.friends << Person.new (:name => 'peter')
-  andreas.friends.each {|person| puts "name #{person.name}" }
-  Person.find("name: andreas").first.name # => 'andreas'
-
-==== Neo4j::Rails::Model
-
-Example of using Neo4j with Rails 3 (ActiveModel)
-
-  class User < Neo4j::Model
-    attr_accessor :password
-    attr_accessible :email, :password, :password_confirmation, :pending_account
-
-    after_save   :encrypt_password
-
-    email_regex = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
-
-    property :email
-    index :email
-
-    has_one(:avatar).to(Avator)
-
-    validates :email, :presence => true,:format   => { :with => email_regex }
-    validates :email, :uniqueness => true, :unless => :pending_account?
-    accepts_nested_attributes_for :avatar, :allow_destroy => true
-
-    ...
-  end
-
-==== Generate a Rails Application
-
-Example of creating an Neo4j Application from scratch:
-
- gem install rails
- rails new myapp -m http://andreasronge.github.com/rails3.rb
- cd myapp
- bundle
- rails generate scaffold User name:string email:string
- rails s
- open a webbrowser: http://localhost:3000/users
-
-You may get an error message "ERROR IOError: Connection reset by peer"
-using WEBrick (it still works). This error message is not shown when running
-the application with {Tomcat/Trinidad}[https://github.com/calavera/trinidad]
-
-To run it with Tomcat
-  
-  gem install trinidad
-  trinidad
-
-
-=== Presentation Materials and other URLs
-* {Intoduction to Neo4j.rb}[http://www.slideshare.net/andreasronge/neo4jrb]
-* {Nordic Ruby 2010 May 21-23}[http://nordicruby.org/speakers#user_29]
-* {Neo4j wiki, check the guidelines and domain modeling gallery pages}[http://wiki.neo4j.org/content/Main_Page]
-
-=== Project information
-* {GitHub}[http://github.com/andreasronge/neo4j/tree/master]
-* {Lighthouse Issue Tracking}[http://neo4j.lighthouseapp.com]
-* {Twitter}[http://twitter.com/ronge]
-* IRC -  #neo4j @ irc.freenode.net
-* {Mailing list, neo4jrb@googlegroups.com}[http://groups.google.com/group/neo4jrb]
-
-=== Contributing
-
-Have you found a bug, need help or have a patch ?
-Just clone neo4j.rb and send me a pull request or email me.
-Do you need help - send me an email (andreas.ronge at gmail dot com).
-Please also check/add issues at lighthouse, http://neo4j.lighthouseapp.com
-
-=== License
-* Neo4j.rb - MIT, see the LICENSE file http://github.com/andreasronge/neo4j/tree/master/LICENSE.
-* Lucene -  Apache, see http://lucene.apache.org/java/docs/features.html
-* \Neo4j - Dual free software/commercial license, see http://neo4j.org/

data/lib/generators/neo4j.rb

@@ -1,65 +0,0 @@
-require 'rails/generators/named_base'
-require 'rails/generators/active_model'
-
-module Neo4j
-	module Generators
-	end
-end
-
-class Neo4j::Generators::Base < Rails::Generators::NamedBase #:nodoc:
-	def self.source_root
-		@_neo4j_source_root ||= File.expand_path(File.join(File.dirname(__FILE__),
-			'neo4j', generator_name, 'templates'))
-	end
-end
-
-class Neo4j::Generators::ActiveModel < Rails::Generators::ActiveModel #:nodoc:
-	def self.all(klass)
-		"#{klass}.all"
-	end
-
-	def self.find(klass, params=nil)
-		"#{klass}.find(#{params})"
-	end
-
-	def self.build(klass, params=nil)
-		if params
-			"#{klass}.new(#{params})"
-		else
-			"#{klass}.new"
-		end
-	end
-
-	def save
-		"#{name}.save"
-	end
-
-	def update_attributes(params=nil)
-		"#{name}.update_attributes(#{params})"
-	end
-
-	def errors
-		"#{name}.errors"
-	end
-
-	def destroy
-		"#{name}.destroy"
-	end
-end
-
-module Rails
-  module Generators
-    class GeneratedAttribute #:nodoc:
-      def type_class
-      	case type.to_s.downcase
-					when 'datetime' 										then 'DateTime'
-					when 'date' 												then 'Date'
-					when 'text' 												then 'String'
-					when 'integer', 'number', 'fixnum' 	then 'Fixnum'
-					when 'float' 												then 'Float'
-					else 'String'
-      	end
-      end
-    end
-  end
-end

data/lib/generators/neo4j/model/model_generator.rb

@@ -1,39 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'neo4j.rb')
-
-class Neo4j::Generators::ModelGenerator < Neo4j::Generators::Base
-	argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
-	
-	check_class_collision
-	
-	class_option :timestamps, :type => :boolean
-	class_option :parent,     :type => :string, :desc => "The parent class for the generated model"
-	
-	def create_model_file
-		template "model.erb", File.join('app/models', "#{singular_name}.rb")
-	end
-	
-	protected
-	def migration?
-		false
-	end
-	
-	def timestamps?
-		options[:timestamps]
-	end
-	
-	def parent?
-		options[:parent]
-	end
-	
-	def timestamp_statements
-		%q{
-  property :created_at, DateTime
-  # property :created_on, Date
-
-  property :updated_at, DateTime
-  # property :updated_on, Date
-}            
-	end
-	
-	hook_for :test_framework
-end

data/lib/generators/neo4j/model/templates/model.erb

@@ -1,7 +0,0 @@
-class <%= class_name %> < <%= parent? ? options[:parent].classify : "Neo4j::Rails::Model" %>
-<% attributes.each do |attribute| -%>
-  property :<%= attribute.name %><%= ", :type => #{attribute.type_class}" %>
-<% end -%>
-
-<%= timestamp_statements if timestamps? -%>
-end

data/lib/neo4j/config.rb

@@ -1,153 +0,0 @@
-
-module Neo4j
-
-
-  # == Keeps configuration for neo4j
-  #
-  # The most important configuration is <tt>Neo4j::Config[:storage_path]</tt> which is used to
-  # locate where the neo4j database is stored on the filesystem.
-  # If this directory is empty then a new database will be created, otherwise it will use the
-  # database from that directory.
-  #
-  # ==== Default Configurations
-  # <tt>:storage_path</tt>::   default <tt>tmp/neo4j</tt> where the database is stored
-  # <tt>:timestamps</tt>::     default <tt>true</tt> for Rails Neo4j::Model - if timestamps should be used when saving the model
-  # <tt>:lucene</tt>::         default hash keys: <tt>:fulltext</tt>, <tt>:exact</tt> configuration how the lucene index is stored
-  # <tt>:converters</tt>::     defines which converters should be used before writing and reading to neo4j, see Neo4j::TypeConverters
-  #
-  class Config
-    # This code is copied from merb-core/config.rb.
-    class << self
-      # Returns the hash of default config values for neo4j
-      #
-      # ==== Returns
-      # Hash:: The defaults for the config.
-      def defaults
-        @defaults ||= {
-          :storage_path => 'tmp/neo4j',
-          :timestamps => true,
-          
-          # TODO: Just pickup all converter classes that are in the Neo4j::TypeConverters module?
-          :converters => { 	Date 			=> Neo4j::TypeConverters::DateConverter, 
-          									DateTime 	=> Neo4j::TypeConverters::DateTimeConverter,
-          									Time 			=> Neo4j::TypeConverters::TimeConverter
-          								},
-          								
-          :lucene => {
-                  :fulltext =>  {"provider" => "lucene", "type" => "fulltext" },
-                  :exact =>  {"provider" => "lucene", "type" => "exact" }}
-        }
-      end
-
-     
-      # Yields the configuration.
-      #
-      # ==== Block parameters
-      # c :: The configuration parameters, a hash.
-      #
-      # ==== Examples
-      # Neo4j::Config.use do |config|
-      #   config[:storage_path] = '/var/neo4j'
-      # end
-      #
-      # ==== Returns
-      # nil
-      def use
-        @configuration ||= {}
-        yield @configuration
-        nil
-      end
-      
-      
-      # Set the value of a config entry.
-      #
-      # ==== Parameters
-      # key :: The key to set the parameter for.
-      # val :: The value of the parameter.
-      #
-      def []=(key, val)
-        (@configuration ||= setup)[key] = val
-      end
-
-
-      # Gets the the value of a config entry
-      #
-      # ==== Parameters
-      # key:: The key of the config entry value we want
-      #
-      def [](key)
-        (@configuration ||= setup)[key]
-      end
-
-
-      # Remove the value of a config entry.
-      #
-      # ==== Parameters
-      # key<Object>:: The key of the parameter to delete.
-      #
-      # ==== Returns
-      # The value of the removed entry.
-      #
-      def delete(key)
-        @configuration.delete(key)
-      end
-
-
-      # Remove all configuration. This can be useful for testing purpose.
-      #
-      #
-      # ==== Returns
-      # nil
-      #
-      def delete_all
-        @configuration = nil
-      end
-
-
-      # Retrieve the value of a config entry, returning the provided default if the key is not present
-      #
-      # ==== Parameters
-      # key:: The key to retrieve the parameter for.
-      # default::The default value to return if the parameter is not set.
-      #
-      # ==== Returns
-      # The value of the configuration parameter or the default.
-      #
-      def fetch(key, default)
-        @configuration.fetch(key, default)
-      end
-
-      # Sets up the configuration
-      #
-      # ==== Returns
-      # The configuration as a hash.
-      #
-      def setup()
-        @configuration = {}
-        @configuration.merge!(defaults)
-        @configuration
-      end
-
-
-      # Returns the configuration as a hash.
-      #
-      # ==== Returns
-      # The config as a hash.
-      #
-      def to_hash
-        @configuration
-      end
-
-      # Returns the config as YAML.
-      #
-      # ==== Returns
-      # The config as YAML.
-      #
-      def to_yaml
-        require "yaml"
-        @configuration.to_yaml
-      end
-    end
-  end
-
-end

data/lib/neo4j/database.rb

@@ -1,56 +0,0 @@
-module Neo4j
-  class Database #:nodoc:
-    attr_reader :graph, :lucene, :event_handler
-
-    def initialize()
-      @event_handler = EventHandler.new
-    end
-
-
-    def start
-      @graph = org.neo4j.kernel.EmbeddedGraphDatabase.new(Config[:storage_path])
-      @lucene =  @graph.index #org.neo4j.index.impl.lucene.LuceneIndexProvider.new
-      @graph.register_transaction_event_handler(@event_handler)
-      @running = true
-      @event_handler.neo4j_started(self)
-      at_exit { shutdown }
-    end
-
-    def shutdown
-      if @running
-        @graph.unregister_transaction_event_handler(@event_handler)
-        @event_handler.neo4j_shutdown(self)
-        @graph.shutdown
-        @graph = nil
-        @lucene = nil
-      end
-
-      @running = false
-    end
-
-    def running?
-      @running
-    end
-
-    def begin_tx
-      @graph.begin_tx
-    end
-
-
-    def each_node
-      iter = @graph.all_nodes.iterator
-      while (iter.hasNext)
-        yield iter.next.wrapper
-      end
-    end
-
-    def _each_node
-      iter = @graph.all_nodes.iterator
-      while (iter.hasNext)
-        yield iter.next
-      end
-    end
-
-  end
-
-end