forestify 1.0.2 → 1.0.3

data/lib/generators/USAGE

@@ -0,0 +1,5 @@
+Usage :
+
+  rails generate forestify Model
+
+This generator will create a migration to add the necessary columns to your model.

data/lib/generators/forestify_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/active_record'
+
+# See https://github.com/olkarls/has_permalink/blob/master/lib/generators/has_permalink_generator.rb
+class ForestifyGenerator < ActiveRecord::Generators::Base
+
+  desc "This generator creates a migration file to make your existing model 'forestify-ready'"
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "forestify_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+
+  def migration_name
+    "add_forestify_to_#{name.underscore}"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+
+end

data/lib/generators/templates/forestify_migration.rb.erb

@@ -0,0 +1,11 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+
+  def self.change
+    change_table :<%= name.underscore.camelize.tableize %> do |t|
+      t.integer :forestify_left_position
+      t.integer :forestify_right_position
+      t.integer :forestify_level
+     end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forestify
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -17,8 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- LICENSE
+- lib/generators/templates/forestify_migration.rb.erb
+- lib/generators/forestify_generator.rb
+- lib/generators/USAGE
 - lib/forestify.rb
 homepage: ''
 licenses:

data/LICENSE

@@ -1,22 +0,0 @@
-(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

@@ -1,67 +0,0 @@
-# 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
-# This produces the following tree
-# { left_position, name, right_position, level }
-# { 0, Vehicle, 9, 0 } { 10, Animal, 11, 0}
-# { 1, Car, 4, 1 } { 5, Plane, 6, 1 } { 7, Boat, 8, 1 }
-# { 2, Audi, 3, 2}
-
-vehicle = Tag.create!(name: "Vehicle")
-animal = Tag.create!(name: "Animal")
-car = Tag.create!(name: "Car", parent_id: vehicle.id)
-plane = Tag.create!(name: "plane", parent_id: vehicle.id)
-boat = Tag.create!(name: "Boat", parent_id: vehicle.id)
-audi = Tag.create!(name: "Audi", parent_id: car.id)
-
-[vehicle, animal, car, plane, boat, audi].each { |n| n.reload }
-
-audi.parents
-# => [vehicle, car]
-car.leaf?
-# => false
-car.node?
-# => true
-vehicle.parent.nil?
-# => true
-car.siblings.all
-# => [plane, boat]
-```
-
-# 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.integer :left_position
-  t.integer :right_position
-  t.integer :level
-end
-```
-
-# Updates
-## 2012-02-06 version 1.0.1
-* Cleaned up tests, added two methods: 'siblings' and 'parent'
-
-## 2012-02-05 version 1.0.0
-* First draft
-
-# LICENSE
-
-Copyright 2012 Gabriel Malkas. Released under MIT License. See LICENSE for details.