forestify 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 Gabriel Malkas
+
+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,49 @@
+# forestify
+
+forestify creates forests out of your Active Record models : it implements a simple data-structure which hierarchizes your data.
+
+For example, given the following model :
+
+```ruby
+class Tag < ActiveRecord::Base
+  attr_accessible :name
+  forestify
+end
+```
+
+You can then do something like this :
+
+```ruby
+vehicle = Tag.new(name: "Vehicle")
+vehicle.save!
+car = Tag.new(name: "Car", parent: vehicle.id)
+car.save!
+audi = Tag.new(name: "Audi", parent: car.id)
+audi.save!
+
+audi.parents
+# => [vehicle, car]
+car.is_leaf?
+# => false
+car.is_node?
+# => true
+```
+
+# Installation
+
+Run ```gem install forestify``` or add this line to your Gemfile  ```gem 'forestify'``` then run ```bundle install```
+
+Although I will add generators later, you still need to manually add migrations to make your models "forestify-ready".
+
+```ruby
+change_table :tags do |t|
+	t.string :name
+	t.integer :left_position
+	t.integer :right_position
+	t.integer :level
+end
+```
+
+# LICENSE
+
+Copyright 2012 Gabriel Malkas. Released under MIT License. See LICENSE for details.

data/lib/forestify.rb

@@ -0,0 +1,73 @@
+module Forestify
+  def forestify
+		unless included_modules.include? InstanceMethods
+			include InstanceMethods
+		end
+		before_create :initialize_position
+		before_destroy :update_positions_after_delete
+		attr_accessor :parent
+	end
+
+	module InstanceMethods
+
+		# Initialize position fields
+		# Should be run only once
+		def initialize_position
+			# @parent = -1 is the option 'No parent'
+			if @parent.nil? || @parent == "-1"
+				# No parent has been specified, we need to add this leaf
+				# to the right side of the last root node.
+				last = self.class.order("right_position DESC").first
+				self.left_position = (last.nil?) ? 0 : last.right_position + 1
+				self.right_position = self.left_position + 1
+				self.level = 0
+			else
+				# Makes sure it's an integer
+				@parent = @parent.to_i
+				p = self.class.find(@parent)
+				self.left_position = p.right_position
+				self.right_position = self.left_position + 1
+				self.level = p.level + 1
+				# update nodes on the right hand side of parent
+				self.class.update_all "left_position = left_position + 2", ['left_position > ?', p.right_position]
+				self.class.update_all "right_position = right_position + 2", ['right_position > ?', p.right_position]
+				# update parent
+				p.update_attribute 'right_position', p.right_position + 2
+			end
+		end
+
+		def update_positions_after_delete
+			if is_node?
+				# Update nodes to the right
+				self.class.update_all "left_position = left_position - 2", ['left_position > ?', self.right_position]
+				self.class.update_all "right_position = right_position - 2", ['right_position > ?', self.right_position]
+				# Update children
+				self.class.update_all "level = level - 1", ['left_position > ? AND right_position < ?', self.left_position, self.right_position]
+				self.class.update_all "left_position = left_position - 1, right_position = right_position - 1", ['left_position > ? AND right_position < ?', self.left_position, self.right_position]
+			else
+				self.class.update_all "left_position = left_position - 2", ['left_position > ?', self.right_position]
+				self.class.update_all "right_position = right_position - 2", ['right_position > ?', self.right_position]
+			end
+		end
+
+
+		def parents
+			self.class.where('left_position < ?', self.left_position).where('right_position > ?', self.right_position)
+		end
+
+		def children
+      [] if is_leaf?
+			self.class.where('left_position > ?', self.left_position).where('right_position < ?', self.right_position)
+		end
+
+    def is_node?
+			(self.right_position - self.left_position) > 1
+		end
+		
+		def is_leaf?
+			!is_node?
+		end
+	end
+end
+
+ActiveRecord::Base.send :extend, Forestify

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: forestify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Malkas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-05 00:00:00.000000000 Z
+dependencies: []
+description: Forestify brings a tree data-structure to your Active Record models
+email: gabriel.malkas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/forestify.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Forestify brings a tree data-structure to your Active Record models
+test_files: []