descendants-loader 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 5a4da25288b46378e4bd0f2586c0feeeb67c7d18
-  data.tar.gz: ccba8c77dab22aa017571f75705874d7fe5bf5a0
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2Y2Y2QyYTAxODA0YzZkMjc4NjI1NzliOTdjZjc4ZDg3MDZhMTA1NA==
+  data.tar.gz: !binary |-
+    ZmQ3NjM4MDZiMzkxM2FkMTA3MmRjZGQ3OGIxMjIyM2VmYmI5ZWZiMQ==
 SHA512:
-  metadata.gz: 6c6498507b94299517fdb85ab247990eec340a60fef3795f81c76595a9fc8e6d0050f60d694a6055f254228797ef9a1899845f1940ca624f9f8ae2122aff2050
-  data.tar.gz: 04e0e173ae6674e3246aa81adc8288ca9f8388a96c458edc912484cb9a4b1972181a5db89fa66ac838939bec14074bc127021a6947deb22be224f90e12cc04a5
+  metadata.gz: !binary |-
+    MjE4Yjc4MzgwMjhiZTgyYmQ4MDk0ZWFiNjQyOGExY2EyNGUzZDU5YmE2ODhj
+    MjkyNGM3Y2M2MGY1YjhhYjU3OTVkYTlkYTI5YjRkODljNjVmNjY4NDU1ZmJj
+    NzgxMTEwZjQ2MTAxODgzNWMzZjFhNTdlMWE3OTlhYjY5YzFhYjY=
+  data.tar.gz: !binary |-
+    ZWM3ZTM0M2QyMDIyZWMyNTAyZGQyNGQ5NDQ5NjBjNTc0YmQ4YTc5NzU0NmY0
+    OWY2Zjc5ZWYzY2Q0MTYwMmMwOTI3MGJiNzk2OTMyYTc5YmRjMjNjZWE2ODM4
+    Y2JjM2M1MDgyYjgwNWQ0YzNiMGRlYjYxNGFkMjRjNjBlN2ZmODI=

data/lib/descendants_loader.rb

@@ -1,16 +1,36 @@
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/class/subclasses'
 
 path = File.expand_path(File.dirname(__FILE__))
 Dir["#{path}/descendants_loader/**/*.rb"].each do |file|
   require file
 end
 
+#
+# Descendants loader. Please check out README for a full introduction.
+#
 module DescendantsLoader
+  #
+  # If the module is included it is forced to be extended.
+  # Usage:
+  #   require 'descendants_loader'
+  #   class MyClass
+  #     include DescendantsLoader
+  #
+  #     ...
+  #   end
+  #
   def self.included(base)
     base.extend(ClassMethods)
   end
 
+  #
+  # Definition of class methods.
+  #
   module ClassMethods
+    #
+    # Overwrites Object.descendants injecting an autoload process.
+    #
     def descendants
       if (classes = super).empty?
         load_self_descendants
@@ -20,6 +40,9 @@ module DescendantsLoader
       classes
     end
 
+    #
+    # Overwrites Object.subclasses injecting an autoload process.
+    #
     def subclasses
       if (classes = super).empty?
         load_self_descendants
@@ -29,6 +52,15 @@ module DescendantsLoader
       classes
     end
 
+    private
+
+    #
+    # Find and load all ruby files under the same directory structure
+    # of the declared class which is including DescendantsLoader module.
+    #
+    # This is the trick to put the classes into ObjectSpace and have the
+    # desired behavior of Object.descendants and Object.subclasses.
+    #
     def load_self_descendants
       file = ClassFinder.where_is(self)
       path = File.expand_path(File.dirname(file))

data/lib/descendants_loader/class_finder.rb

@@ -12,14 +12,7 @@ module DescendantsLoader
       def class_name_from_path(path)
         ary = path.split('/')
         ary.map! { |s| s.gsub(/\.rb/, '') }
-
-        index = ary.index('models') ||
-          ary.index('workers') ||
-          ary.index('helpers') ||
-          ary.index('controllers') ||
-          ary.index('mailers') ||
-          ary.index('lib')
-        ary.slice!(0, index + 1)
+        ary.slice!(0, index_of_base_dir(ary) + 1)
 
         ary.map(&:camelize).join('::')
       end
@@ -53,6 +46,16 @@ module DescendantsLoader
       def class_and_source_eq?(klass, file)
         class_name_from_path(file) == klass.to_s
       end
+
+      def index_of_base_dir(path_array)
+        base_dirs = %w(lib models workers schedulers controllers mailers)
+        index = base_dirs.map { |dir| path_array.index(dir) }.compact.first
+
+        fail ArgumentError, 'Not a valid file path. Expect to ' \
+          'have a base known directory.' if index.nil?
+
+        index
+      end
     end
   end
 end

data/lib/descendants_loader/version.rb

@@ -1,3 +1,3 @@
 module DescendantsLoader
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/descendants_loader/class_finder_spec.rb

@@ -0,0 +1,56 @@
+module DescendantsLoader
+  describe ClassFinder do
+    subject { ClassFinder }
+
+    describe '.where_is' do
+      it 'returns ClassFinder file path' do
+        file_path = File.expand_path(__FILE__)
+                    .gsub(/\/spec/, '/lib')
+                    .gsub(/_spec/, '')
+
+        expect(subject.where_is(ClassFinder)).to eq(file_path)
+      end
+
+      it 'returns nil if the class does not exists in project file tree' do
+        expect(subject.where_is(ArgumentError)).to be_nil
+      end
+    end
+
+    describe '.class_name_from_path' do
+      let(:base_path) { '/a/b/c/prj' }
+
+      it 'fails if there is no mapped dirs in the given path' do
+        expect do
+          subject.class_name_from_path(base_path)
+        end.to raise_error(ArgumentError)
+      end
+
+      %w(lib models workers schedulers controllers mailers).each do |dir|
+        let(:path) { [base_path, dir, ''].join('/') }
+
+        it "returns not nil for #{dir}" do
+          expect(subject.class_name_from_path(path)).not_to be_nil
+        end
+
+        it "returns camelized single name in #{dir}" do
+          file_path = path + 'classname.rb'
+
+          expect(subject.class_name_from_path(file_path)).to eq('Classname')
+        end
+
+        it "returns camelized composed name #{dir}" do
+          file_path = path + 'class_name.rb'
+
+          expect(subject.class_name_from_path(file_path)).to eq('ClassName')
+        end
+
+        it "returns camelized composed name with modules in #{dir}" do
+          file_path = path + 'module_a/module_b/class_name.rb'
+          class_name = 'ModuleA::ModuleB::ClassName'
+
+          expect(subject.class_name_from_path(file_path)).to eq(class_name)
+        end
+      end
+    end
+  end
+end

data/spec/descendants_loader_spec.rb

@@ -0,0 +1,36 @@
+describe DescendantsLoader do
+  examples_path = "#{File.expand_path(File.dirname(__FILE__))}/examples"
+  context 'dumb' do
+    require "#{examples_path}/dumb/lib/dumb_base.rb"
+
+    describe '.descendants' do
+      it 'cannot find inherited classes' do
+        expect(DumbBase.descendants).to be_empty
+      end
+    end
+
+    describe '.subclasses' do
+      it 'cannot find inherited classes' do
+        expect(DumbBase.subclasses).to be_empty
+      end
+    end
+  end
+
+  context 'smart' do
+    require "#{examples_path}/smart/lib/smart_base.rb"
+
+    describe '.descendants' do
+      it 'finds SonA, SonB and SonC' do
+        sons = %w(SmartSonA SmartSonB SmartSonC)
+        expect(SmartBase.descendants.map(&:to_s)).to match_array(sons)
+      end
+    end
+
+    describe '.subclasses' do
+      it 'finds SonA and SonB' do
+        sons = %w(SmartSonA SmartSonB)
+        expect(SmartBase.subclasses.map(&:to_s)).to match_array(sons)
+      end
+    end
+  end
+end

data/spec/examples/dumb/lib/dumb_base.rb

@@ -0,0 +1,5 @@
+class DumbBase
+  def my_method
+    nil
+  end
+end

data/spec/examples/dumb/lib/dumb_son.rb

@@ -0,0 +1,5 @@
+class DumbSon < DumbBase
+  def my_method
+    nil
+  end
+end

data/spec/examples/smart/lib/smart_base.rb

@@ -0,0 +1,7 @@
+class SmartBase
+  include DescendantsLoader
+
+  def my_method
+    nil
+  end
+end

data/spec/examples/smart/lib/smart_sons.rb

@@ -0,0 +1,17 @@
+class SmartSonA < SmartBase
+  def my_method
+    nil
+  end
+end
+
+class SmartSonB < SmartBase
+  def my_method
+    nil
+  end
+end
+
+class SmartSonC < SmartSonA
+  def my_method
+    nil
+  end
+end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
 SimpleCov.start do
   `git checkout origin/master coverage/.last_run.json`
 
-  minimum_coverage(45)
+  minimum_coverage(96)
   maximum_coverage_drop(2)
 
   add_filter 'spec/'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: descendants-loader
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Silvestre
@@ -14,73 +14,73 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-description: "\n    This gem is an Object.descendants and Object.subclasses loader.\n
+        version: '3.2'
+description: ! "\n    This gem is an Object.descendants and Object.subclasses loader.\n
   \   The desired classes will have an autoload of its hierarchy.\n    This aims a
   problem with lazy loading ruby classes (usually under\n    development environment).
   For more information please check README.\n  "
@@ -93,6 +93,12 @@ files:
 - lib/descendants_loader.rb
 - lib/descendants_loader/class_finder.rb
 - lib/descendants_loader/version.rb
+- spec/descendants_loader/class_finder_spec.rb
+- spec/descendants_loader_spec.rb
+- spec/examples/dumb/lib/dumb_base.rb
+- spec/examples/dumb/lib/dumb_son.rb
+- spec/examples/smart/lib/smart_base.rb
+- spec/examples/smart/lib/smart_sons.rb
 - spec/spec_helper.rb
 homepage: http://github.com/djlebersilvestre/descendants-loader
 licenses:
@@ -104,17 +110,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: This gem is an Object.descendants and Object.subclasses loader. The desired
@@ -123,3 +129,9 @@ summary: This gem is an Object.descendants and Object.subclasses loader. The des
   check README.
 test_files:
 - spec/spec_helper.rb
+- spec/examples/smart/lib/smart_sons.rb
+- spec/examples/smart/lib/smart_base.rb
+- spec/examples/dumb/lib/dumb_son.rb
+- spec/examples/dumb/lib/dumb_base.rb
+- spec/descendants_loader_spec.rb
+- spec/descendants_loader/class_finder_spec.rb