tree_structure 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 231e40f70e18a30b7f61dfbaaa8bd204138075338fd74e12c656bfdb789c02b7
-  data.tar.gz: 4a16610e2dd7f0bddea83ca03a04322898f2fc507301d1ea77f93550158dc363
+  metadata.gz: 70f3e844938f3d7496deb0d5c4b0ebfd981afdc644a3a0df3450c6842e54af45
+  data.tar.gz: 9f5b1c15446c2efdb91496a8313e02ce371eafaa7f4d622442c8af23e2ada8ea
 SHA512:
-  metadata.gz: b5ff00d1652e3302eb61d14f1e89dffab832ac5458061e499bd78b2657f3c860e90221636a578cf1f217c99469d7875bb0263d0cd444e151b1b6b2f7c47fc09a
-  data.tar.gz: fbdc7162345246e6891edabad91d50880cbd516bea53656ff0fdb045f6ddd157a3533aa298f18da8f03c5e486e8440034810112998b44eabfdcc92ba7ddf97a9
+  metadata.gz: 45afc30b33020fc5e12dfda16c82af5a6523d96d4891c6d5fa8eb65a063bb7c68a6f8b3bb8238be3b07000b009f3060c9873989ddda4299fa5ea77a58609ebcb
+  data.tar.gz: 5286a86079989d464d4a76ce86dfcebb6360101a905e05a047d269d315d7ccd16acbd1796359cba4faf3283b31348594dc8117c3b705a6ffe3b680ab79738ffe

data/README.md

@@ -1,8 +1,5 @@
 # TreeStructure
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tree_structure`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Tree Structure allows the records of a ActiveRecord model to be organized in a tree structure.
 
 ## Installation
 
@@ -20,15 +17,102 @@ Or install it yourself as:
 
     $ gem install tree_structure
 
-## Usage
+## Development
+
+After installing the `tree_structure` gem in your Gemfile, follow these steps to set up the tree structure:
 
-TODO: Write usage instructions here
+1. **Add a `parent_id` column** to the table where you want to organize the tree structure. You can do this by creating a migration:
+    ```ruby
+    class AddParentIdToYourModel < ActiveRecord::Migration[6.0]
+      def change
+        add_column :your_model_name, :parent_id, :integer
+        add_index :your_model_name, :parent_id
+      end
+    end
+    ```
+    
 
-## Development
+2. **Include the TreeStructure module** in the model that will be organized in a tree structure. For example:
+
+    ```ruby
+    class YourModelName < ApplicationRecord
+      include TreeStructure
+    end
+    ```
+    
+
+3. **Run your migrations** to update the database schema:
+    ```ruby
+    rails db:migrate
+    ````
+
+### Example Usage
+
+Once you have set up your model, you can start using the tree structure features. For example:
+
+# Create root nodes
+```ruby
+root1 = YourModelName.create(name: 'Root 1')
+root2 = YourModelName.create(name: 'Root 2')
+```
+
+# Create child nodes
+```ruby
+child1 = YourModelName.create(name: 'Child 1', parent: root1)
+child2 = YourModelName.create(name: 'Child 2', parent: root1)
+child3 = YourModelName.create(name: 'Child 3', parent: root2)
+```
+# Identify root nodes
+```ruby
+root1.root? #true
+child1.root? #false
+```
+
+# Identify leaf nodes
+```ruby
+root1.leaf? #false
+child1.leaf? #true
+```
+
+# Find ancestors
+```ruby
+child1.ancestors
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Find descendants(will return descendants)
+```ruby
+root1.descendants
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Find subtree(will return subtree)
+```ruby
+root1.subtree
+```
+
+# Other nodes with same parent
+```ruby
+child1.siblings
+```
+
+# Root to child path
+```ruby
+child1.path_to_root
+```
+
+# Root to child depth
+```ruby
+child2.depth
+```
+
+# Nodes without children
+```ruby
+root1.leaves
+```
+
+# Root to child depth
+```ruby
+child2.move_to_child_of root1
+```
 
 ## Contributing
 

data/lib/tree_structure/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TreeStructure
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tree_structure
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Akhlak Hussain