xylem 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f36a0a448ea0f87bbb5bb18b7ebb4f090e8a724
-  data.tar.gz: 74c92b1a1d23c3524480c3c97521f5f1bf3395b7
+  metadata.gz: a66a285e5aacfa913b065f184b825218e6cfa07d
+  data.tar.gz: 7edc791c60d6c1638c460c2975a125ac746af45a
 SHA512:
-  metadata.gz: 25b9ac95f3a6c51d2abc5195269a7f6bab89376dffb32034db0a9aad18cf52974083ac5666515cdd0ebb6d93b77f68c80d1253ff256a4900e271ab99f6aec9b3
-  data.tar.gz: 9406bb0aec116ecee01b8f7dfdd3c5e3f190580eba20afb2f8e3a2a0fe57b81b4a23aa1d2d68889ed92fdd7adf6f2e982d55cf9429d223bfb7f9c9e57ad962c1
+  metadata.gz: cddec6fbfc58582508343ba1b1fd5b32ff22ca67468df10a4491e9a1eb78b9f527b80429777f0144a452305b43e86bb417b4a381cb80f17c50c3ef98fd487d77
+  data.tar.gz: dd325095109b73ec7e9ae6a0db5abd5ecf6d5344483a6703c363bc1286ce350ea62de865e94d6040020eaab6e424ba444c5946ff0db4f53b0ba7c6faac4ef4b5

data/README.md

@@ -19,7 +19,7 @@ Also queries that traverse the tree (such as get ancestors or descendants of a n
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'xylem', github: 'oesgalha/xylem'
+gem 'xylem', '~> 0.0.1'
 ```
 
 And then execute:
@@ -48,8 +48,8 @@ Some notes regarding migration:
 * Add a foreign key is optional, but it's recommended to guarantee data consistency
 * The `foreign_key: true` option is available in [rails 4.2.1](https://github.com/rails/rails/blob/v4.2.1/activerecord/CHANGELOG.md) or newer
 
-Now you need to enable the tree behavior in or model by adding the `acts_as_tree` directive in it.
-Let's suppose again that you're dealing with a model called `Menu`, you should add the following:
+Now you need to enable the tree behavior in our model by adding the `acts_as_tree` directive in it.
+Let's continue supposing that you're dealing with a model called `Menu`, you should add the following:
 
 ```ruby
 class Menu < ActiveRecord::Base
@@ -88,14 +88,15 @@ Xylem adds the following class methods to a class with the `acts_as_tree` direct
 * `self_and_ancestors` returns the ancestors from the root to the node itself. Ordered from the root to the node.
 * `descendants` returns all the descendants of the given node. Ordered by depth from the closer to the node to the more distant ones.
 * `self_and_descendants` returns the node and all it's descendants. Ordered by depth with the node first and the descendants later.
-* `root` returns the current node root.
-* `siblings` returns the siblings from the node, excluding itself.
+* `root` returns the current node's root.
+* `siblings` returns the node's siblings, excluding itself.
 * `self_and_siblings` returns the node and it's siblings.
 * `children` returns the direct children of the node.
 * `self_and_children` returns the node and it's direct children.
 * `parent` returns the node parent.
 * `root?` returns true if the current node is a root, false otherwise.
 * `leaf?` returns true if the current node is a leaf, false otherwise.
+* `leaves`: returns the leaves from the current node
 
 ### Examples
 
@@ -121,6 +122,8 @@ child1.root                 # => root
 child1.self_and_ancestors   # => [ root, child1 ]
 
 child1.self_and_siblings    # => [ child1, child2 ]
+
+child2.leaves               # => [ subchild ]
 ```
 
 ## Dependencies

data/Rakefile

@@ -5,4 +5,10 @@ task :test do
   require './test/xylem_tests.rb'
 end
 
+task :bench do
+  ['acts_as_tree', 'ancestry', 'awesome_nested_set', 'xylem'].each do |benched_gem|
+    sh "cd bench/ && BENCH_GEM=#{benched_gem} ruby benchmark.rb"
+  end
+end
+
 task default: :test

data/bench/acts_as_tree.json

@@ -1,32 +1,32 @@
 [
   {
     "name": "insertion",
-    "ips": 412.7091261183738,
-    "stddev": 51
+    "ips": 1036.8914832940068,
+    "stddev": 195
   },
   {
     "name": "parent",
-    "ips": 633.857043437574,
-    "stddev": 85
+    "ips": 1215.4998688546427,
+    "stddev": 252
   },
   {
     "name": "children",
-    "ips": 8.660125142509473,
-    "stddev": 2
+    "ips": 5.281724863837879,
+    "stddev": 1
   },
   {
     "name": "roots",
-    "ips": 1029.8556860775493,
-    "stddev": 136
+    "ips": 2607.3692118170793,
+    "stddev": 260
   },
   {
     "name": "ancestors",
-    "ips": 251.68388495529973,
-    "stddev": 33
+    "ips": 570.7095294720626,
+    "stddev": 86
   },
   {
     "name": "descendants",
-    "ips": 0.19643176694334188,
+    "ips": 0.17416664663106435,
     "stddev": 0
   }
 ]

data/bench/ancestry.json

@@ -1,32 +1,32 @@
 [
   {
     "name": "insertion",
-    "ips": 529.3829399001362,
-    "stddev": 68
+    "ips": 1360.3315899162535,
+    "stddev": 117
   },
   {
     "name": "parent",
-    "ips": 798.8413756182359,
-    "stddev": 112
+    "ips": 1488.4291424270232,
+    "stddev": 132
   },
   {
     "name": "children",
-    "ips": 19.534339432833036,
-    "stddev": 2
+    "ips": 10.612767367103928,
+    "stddev": 0
   },
   {
     "name": "roots",
-    "ips": 1306.76576446662,
-    "stddev": 254
+    "ips": 2715.6226013175074,
+    "stddev": 380
   },
   {
     "name": "ancestors",
-    "ips": 501.12099359692917,
-    "stddev": 112
+    "ips": 873.9805587004587,
+    "stddev": 228
   },
   {
     "name": "descendants",
-    "ips": 14.539749441549349,
-    "stddev": 2
+    "ips": 7.527704078159802,
+    "stddev": 1
   }
 ]

data/bench/awesome_nested_set.json

@@ -1,32 +1,32 @@
 [
   {
     "name": "insertion",
-    "ips": 7.721853007625269,
-    "stddev": 2
+    "ips": 36.71486077897211,
+    "stddev": 6
   },
   {
     "name": "parent",
-    "ips": 569.4524509694182,
-    "stddev": 191
+    "ips": 1345.607177431047,
+    "stddev": 302
   },
   {
     "name": "children",
-    "ips": 154.39379306573127,
-    "stddev": 34
+    "ips": 94.31692142141924,
+    "stddev": 18
   },
   {
     "name": "roots",
-    "ips": 820.8230612972056,
-    "stddev": 119
+    "ips": 2093.0953165525248,
+    "stddev": 495
   },
   {
     "name": "ancestors",
-    "ips": 346.3686578783685,
-    "stddev": 70
+    "ips": 747.8587257570059,
+    "stddev": 110
   },
   {
     "name": "descendants",
-    "ips": 52.86002694684352,
-    "stddev": 7
+    "ips": 64.8752595391903,
+    "stddev": 8
   }
 ]

data/bench/benchmark.rb

@@ -9,7 +9,7 @@ end
 gemfile(true) do
   source 'https://rubygems.org'
   gem 'activerecord', require: 'active_record'
-  gem 'pg'
+  gem 'sqlite3'
   gem 'benchmark-ips'
 
   case BENCH_GEM
@@ -25,8 +25,7 @@ gemfile(true) do
   end
 end
 
-ActiveRecord::Base.establish_connection(adapter: 'postgresql', database: 'xylem_test', username: 'postgres')
-ActiveRecord::Base.connection.execute('DROP SCHEMA public CASCADE; CREATE SCHEMA public;')
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
 
 ActiveRecord::Base.send(:include, ActsAsTree) if BENCH_GEM == 'acts_as_tree'
 
@@ -81,5 +80,5 @@ Benchmark.ips do |x|
   x.report('descendants') do |times|
     times.times { @comment1.reload.descendants.to_a }
   end
-  x.json!("#{ENV['BENCH_GEM']}.json")
+  x.json!("#{BENCH_GEM}.json")
 end

data/bench/xylem.json

@@ -1,32 +1,32 @@
 [
   {
     "name": "insertion",
-    "ips": 600.964555391788,
-    "stddev": 34
+    "ips": 1077.9540036082653,
+    "stddev": 181
   },
   {
     "name": "parent",
-    "ips": 1070.2536522884402,
-    "stddev": 120
+    "ips": 1469.5468609459379,
+    "stddev": 153
   },
   {
     "name": "children",
-    "ips": 11.90851991649796,
-    "stddev": 2
+    "ips": 5.6771757145767,
+    "stddev": 1
   },
   {
     "name": "roots",
-    "ips": 1713.3724759018537,
-    "stddev": 210
+    "ips": 2425.567017433215,
+    "stddev": 485
   },
   {
     "name": "ancestors",
-    "ips": 511.49023662770406,
-    "stddev": 61
+    "ips": 950.0877817762773,
+    "stddev": 112
   },
   {
     "name": "descendants",
-    "ips": 12.000439734178782,
-    "stddev": 2
+    "ips": 8.066457306631666,
+    "stddev": 1
   }
 ]

data/bootstrap.sh

@@ -6,14 +6,17 @@ function install {
 }
 
 echo updating package information
+export DEBIAN_FRONTEND=noninteractive
+curl -sSL "https://ftp-master.debian.org/keys/archive-key-7.0.asc" | sudo -E apt-key add -
+echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | sudo tee -a /etc/apt/sources.list > /dev/null
 apt-add-repository -y ppa:brightbox/ruby-ng >/dev/null 2>&1
 apt-get -y update >/dev/null 2>&1
 
 install 'development tools' build-essential
 
-install Ruby ruby2.2 ruby2.2-dev
-update-alternatives --set ruby /usr/bin/ruby2.2 >/dev/null 2>&1
-update-alternatives --set gem /usr/bin/gem2.2 >/dev/null 2>&1
+install Ruby ruby2.3 ruby2.3-dev
+update-alternatives --set ruby /usr/bin/ruby2.3 >/dev/null 2>&1
+update-alternatives --set gem /usr/bin/gem2.3 >/dev/null 2>&1
 
 echo installing Bundler
 gem install bundler -N >/dev/null 2>&1

data/gemfiles/ar_5beta.gemfile

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 
 gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "appraisal"
-gem "activerecord", "5.0.0.beta1"
+gem "activerecord", "5.0.0.rc1"
 
 gemspec :path => "../"

data/lib/xylem/version.rb

@@ -1,3 +1,3 @@
 module Xylem
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/xylem.rb

@@ -42,6 +42,10 @@ module Xylem
       children.size == 0
     end
 
+    def leaves
+      descendants.leaves
+    end
+
     private
 
     def _xylem_query(where_col, where_val, join_lft_col, join_rgt_col, order_stmt)

data/test/xylem_tests.rb

@@ -223,4 +223,12 @@ class InstanceMethodsTest < XylemTestCase
     refute @training.leaf?
     refute @option1.leaf?
   end
+
+  def test_leaves
+    assert_equal [@suboption11, @suboption12], @option1.leaves
+    assert_equal [@option3, @suboption11, @suboption12], @main.leaves
+    assert_equal [@physical, @digital], @product.leaves
+    assert_equal [@daily_training, @weekly_training], @training.leaves
+    assert_equal [@consultancy, @hosting, @daily_training, @weekly_training], @service.leaves
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xylem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Oscar Esgalha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Xylem uses the Adjacency List approach to store and query through hierarchical