neo4j_ancestry 0.0.1

data/lib/neo4j_ancestry.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'neography'
+require 'neoid'
+
+require "models/neo4j_ancestry/active_record_additions"
+require "models/neo4j_ancestry/node_instance_methods"
+require "models/neo4j_ancestry/link"
+
+require "neo4j_ancestry/engine"
+require "neo4j_ancestry/railtie"
+require "neo4j_ancestry/version"

data/lib/neo4j_ancestry/engine.rb

@@ -0,0 +1,13 @@
+module Neo4jAncestry
+  class Engine < ::Rails::Engine
+    
+    engine_name "neo4j_ancestry"
+    
+    config.generators do |g|
+      # use rspec, see: http://whilefalse.net/2012/01/25/testing-rails-engines-rspec/
+      g.test_framework :rspec
+      g.integration_tool :rspec
+    end
+    
+  end
+end

data/lib/neo4j_ancestry/railtie.rb

@@ -0,0 +1,22 @@
+module Neo4jAncestry
+  class Railtie < Rails::Railtie
+    
+    # rake_tasks do
+    #   tasks = %w(setup start stop)
+    #   for task in tasks
+    #     load File.expand_path("../../../lib/tasks/#{task}.rake", __FILE__)
+    #   end
+    # end
+    # 
+    # initializer 'setup neo4j database connection' do
+    #   load File.expand_path("../../../config/initializers/001_neo4j.rb", __FILE__)
+    # end
+    
+    initializer 'neo4j_ancestry.active_record_additions' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send(:extend, Neo4jAncestry::ActiveRecordAdditions)
+      end
+    end
+
+  end
+end

data/lib/neo4j_ancestry/version.rb

@@ -0,0 +1,3 @@
+module Neo4jAncestry
+  VERSION = "0.0.1"
+end

data/lib/tasks/db_test_prepare.rake

@@ -0,0 +1,26 @@
+namespace :neo4j_ancestry do
+  namespace :db do
+    namespace :test do
+      
+      desc "Setup Neo4j Database for Testing"
+      task :prepare do
+        
+        rails_version = `bundle exec rails --version`.gsub("Rails ", "")
+        
+        dummy_path = File.expand_path(
+          "../../../spec/dummy-rails#{rails_version[0]}",
+          __FILE__
+        )
+        
+        unless File.exists?("#{dummy_path}/db/neo4j")
+          `cd #{dummy_path} && bundle exec rake neo4j:install neo4j:setup`
+        end
+        
+        `cd #{dummy_path} && bundle exec rake neo4j:start`
+        `cd #{dummy_path} && bundle exec rake db:create db:migrate db:test:prepare`
+        
+      end
+      
+    end
+  end
+end

data/lib/tasks/setup.rake

@@ -0,0 +1,24 @@
+namespace :neo4j do
+  
+  desc "Setup Neo4j Database Stages (development, test)"
+  task :setup do
+    
+    # neo4j folders for the development stage and for the test stage
+    #
+    `mkdir db/neo4j`
+    `mv neo4j db/neo4j/development`
+    `cp -r db/neo4j/development db/neo4j/test`
+    
+    # the port number for the development database is 7474 (default),
+    # the port number for the test database is 7574.
+    # For https, the ports are 7473 (development) and 7573 (test). 
+    #
+    `sed -i -e 's/7474/7574/g' db/neo4j/test/conf/neo4j-server.properties`
+    `sed -i -e 's/7473/7573/g' db/neo4j/test/conf/neo4j-server.properties`    
+    
+    # the wrapper names are 'neo4j-development' and 'neo4j-test' respectively.
+    #
+    `sed -i -e 's/wrapper.name=neo4j/wrapper.name=neo4j-development/g' db/neo4j/development/conf/neo4j-wrapper.conf`
+    `sed -i -e 's/wrapper.name=neo4j/wrapper.name=neo4j-test/g' db/neo4j/test/conf/neo4j-wrapper.conf`
+  end
+end

data/lib/tasks/start.rake

@@ -0,0 +1,12 @@
+
+Rake::Task["neo4j:start"].clear
+namespace :neo4j do
+  
+  desc "Start Neo4j Databases Deamons for Stages (development, test)"
+  task :start do
+    
+    `db/neo4j/development/bin/neo4j start`
+    `db/neo4j/test/bin/neo4j start`
+
+  end
+end

data/lib/tasks/stop.rake

@@ -0,0 +1,12 @@
+
+Rake::Task["neo4j:stop"].clear
+namespace :neo4j do
+  
+  desc "Stop Neo4j Databases Deamons for Stages (development, test)"
+  task :stop do
+    
+    `db/neo4j/development/bin/neo4j stop`
+    `db/neo4j/test/bin/neo4j stop`
+
+  end
+end

data/neo4j_ancestry.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'neo4j_ancestry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "neo4j_ancestry"
+  spec.version       = Neo4jAncestry::VERSION
+  spec.authors       = ["Sebastian Fiedlschuster"]
+  spec.email         = ["sebastian@fiedlschuster.de"]
+  spec.description   = "This ruby on rails gem makes it easy to store polymorphic structure information --- parents, children, ancestors, descendants, ... --- in a neo4j graph database parallel to using ActiveRecord."
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/fiedl/neo4j_ancestry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency 'activerecord'
+  
+  spec.add_dependency "rails", ">= 3.2"
+  spec.add_dependency "neography"
+  spec.add_dependency "neoid"
+end

data/rails3.2.Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Testing for Rails 3.2
+gem 'rails', '~> 3.2'
+
+# Specify your gem's dependencies in neo4j_ancestry.gemspec
+gemspec

data/rails4.Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Testing for Rails 4
+gem 'rails', '~> 4'
+
+# Specify your gem's dependencies in neo4j_ancestry.gemspec
+gemspec

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/neo4j_ancestry/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/dummy-rails3/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/dummy-rails3/Gemfile

@@ -0,0 +1,40 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.13'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'
+
+gem 'neo4j_ancestry', path: '../../'

data/spec/dummy-rails3/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.