nesting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: dc78b802ce1d9064e4f6f617cf9c35d5349ee187
+  data.tar.gz: f585ba62184efafba53d9943d262372b15e6ae2d
+SHA512:
+  metadata.gz: 06689cacfa1be069d0be8cda3e89eb97f2eaaaaaeac05941f741ecb82e05bccdce5a0e49e60c1a654ffe82e9db1343c5270f32d4cb2e17cb36711dd5b5f8d93b
+  data.tar.gz: 0de37e3bd6b50da15bea44d874487bb8866e4bcd6962c0f854ad35ce52feea43f1d51c1d1037d3520632e4c6fc77e5afbd1e11d20d583b80acad5ccc2e351e08

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'pry', '~> 0.10'
+  gem 'pry-theme', '~> 1.1'
+end
+
+group :test do
+  gem 'rspec', '~> 3.1'
+end

data/LICENCE.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2014 Kyrylo Silin
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+      in a product, an acknowledgment in the product documentation would be
+         appreciated but is not required.
+
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+3. This notice may not be removed or altered from any source distribution.

data/README.md

@@ -0,0 +1,31 @@
+# Nesting
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nesting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nesting
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nesting/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/nesting.rb

@@ -0,0 +1,51 @@
+module Nesting
+  class << self
+    def of(mod)
+      if nonmodule?(mod)
+        raise TypeError, 'mod is not a class or module'
+      end
+
+      level = 0
+
+      # Special case Object as it's the namespace of all classes.
+      return level if mod == Object
+
+      level = if mod.name
+                mod.name.split('::').count
+              else
+                -1 # Probably an anonymous module.
+              end
+
+      level
+    end
+
+    def parents(mod)
+      if nonmodule?(mod)
+        raise TypeError, 'mod is not a class or module'
+      end
+
+      parents = []
+
+      return nil if mod == Object
+
+      if mod.name
+        mod.name.split('::')[0..-2].inject(Object) do |parent, child|
+          const = parent.const_get(child)
+          parents << const
+          const
+        end
+        parents.reverse! << Object
+      else
+        parents = nil # Probably an anonymous module.
+      end
+
+      parents
+    end
+
+    private
+
+    def nonmodule?(mod)
+      !((mod.class == Module) ^ (mod.class == Class))
+    end
+  end
+end

data/nesting.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |spec|
+  spec.name          = "nesting"
+  spec.version       = File.read('VERSION')
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.authors       = ["Kyrylo Silin"]
+  spec.email         = ["silin@kyrylo.org"]
+  spec.summary       = %q{Detects nesting of a module/class}
+  spec.homepage      = "https://github.com/kyrylo/nesting"
+  spec.license       = "zlib"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/nesting_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+
+
+RSpec.describe Nesting do
+  describe ".of" do
+    it "raises an error on a non-module or a non-class argument" do
+      expect { Nesting.of(123) }.to raise_error(TypeError)
+    end
+
+    it "doesn't raise error on an instance of Module" do
+      expect { Nesting.of(Module.new).not_to raise_error(TypeError) }
+    end
+
+    it "doesn't raise error on an instance of Class" do
+      expect { Nesting.of(Class.new).not_to raise_error(TypeError) }
+    end
+
+    it "detects nesting of BasicObject" do
+      expect(Nesting.of(BasicObject)).to eq(1)
+    end
+
+    it "detects nesting of Object" do
+      expect(Nesting.of(Object)).to eq(0)
+    end
+
+    it "detects nesting of a top-level class" do
+      class ::TopLevelClass1; end
+      expect(Nesting.of(TopLevelClass1)).to eq(1)
+    end
+
+    it "detects nesting of a top-level module" do
+      module ::TopLevelModule1; end
+      expect(Nesting.of(TopLevelModule1)).to eq(1)
+    end
+
+    it "returns -1 if a class is anonymous" do
+      expect(Nesting.of(Class.new)).to eq(-1)
+    end
+
+    it "returns -1 if a module is anonymous" do
+      expect(Nesting.of(Module.new)).to eq(-1)
+    end
+
+    it "detects nesting of a nested class" do
+      class A1
+        class B1; end
+      end
+
+      expect(Nesting.of(A1)).to eq(1)
+      expect(Nesting.of(A1::B1)).to eq(2)
+    end
+
+    it "detects nesting of a nested module" do
+      module A2
+        module B2; end
+      end
+
+      expect(Nesting.of(A2)).to eq(1)
+      expect(Nesting.of(A2::B2)).to eq(2)
+    end
+
+    it "detects mixed module/class nesting" do
+      module A3
+        class B3
+          module C3; end
+        end
+      end
+
+      expect(Nesting.of(A3)).to eq(1)
+      expect(Nesting.of(A3::B3)).to eq(2)
+      expect(Nesting.of(A3::B3::C3)).to eq(3)
+    end
+
+    it "detects nesting of a nested module defined via the shortcut" do
+      module A4; end
+      module A4::B4; end
+
+      expect(Nesting.of(A4)).to eq(1)
+      expect(Nesting.of(A4::B4)).to eq(2)
+    end
+
+    it "detects nesting of the class whose superclass is BasicObject" do
+      class A5 < BasicObject; end
+      expect(Nesting.of(A5)).to eq(1)
+    end
+
+    it "detects nesting of the nested class whose superclass is BasicObject" do
+      class A6; end
+      class A6::B6 < BasicObject; end
+
+      expect(Nesting.of(A6)).to eq(1)
+      expect(Nesting.of(A6::B6)).to eq(2)
+    end
+
+    it "detects nesting of a module depending on the context" do
+      $expect = method(:expect)
+      $eq = method(:eq)
+
+      module A7
+        module B7
+          module C7
+            $expect.(Nesting.of(B7)).to $eq.(2)
+            $expect.(Nesting.of(C7)).to $eq.(3)
+          end
+          $expect.(Nesting.of(A7)).to $eq.(1)
+          $expect.(Nesting.of(B7)).to $eq.(2)
+        end
+
+        $expect.(Nesting.of(A7)).to $eq.(1)
+        $expect.(Nesting.of(B7)).to $eq.(2)
+        $expect.(Nesting.of(B7::C7)).to $eq.(3)
+      end
+    end
+  end
+
+  describe ".parents" do
+    it "raises an error on a non-module or a non-class argument" do
+      expect { Nesting.parents(123) }.to raise_error(TypeError)
+    end
+
+    it "doesn't raise error on an instance of Module" do
+      expect { Nesting.parents(Module.new).not_to raise_error(TypeError) }
+    end
+
+    it "doesn't raise error on an instance of Class" do
+      expect { Nesting.parents(Class.new).not_to raise_error(TypeError) }
+    end
+
+    it "detects parents of BasicObject" do
+      expect(Nesting.parents(BasicObject)).to eq([Object])
+    end
+
+    it "detects parents of Object" do
+      expect(Nesting.parents(Object)).to eq(nil)
+    end
+
+    it "detects parents of a top-level class" do
+      class ::TopLevelClass2; end
+      expect(Nesting.parents(TopLevelClass2)).to eq([Object])
+    end
+
+    it "detects parents of a top-level module" do
+      module ::TopLevelModule2; end
+      expect(Nesting.parents(TopLevelModule2)).to eq([Object])
+    end
+
+    it "returns nil if a class is anonymous" do
+      expect(Nesting.parents(Class.new)).to eq(nil)
+    end
+
+    it "returns nil if a module is anonymous" do
+      expect(Nesting.parents(Module.new)).to eq(nil)
+    end
+
+    it "detects parents of a nested class" do
+      class A1
+        class B1; end
+      end
+
+      expect(Nesting.parents(A1)).to eq([Object])
+      expect(Nesting.parents(A1::B1)).to eq([A1, Object])
+    end
+
+    it "detects parents of a nested module" do
+      module A2
+        module B2; end
+      end
+
+      expect(Nesting.parents(A2)).to eq([Object])
+      expect(Nesting.parents(A2::B2)).to eq([A2, Object])
+    end
+
+    it "detects mixed module/class parents" do
+      module A3
+        class B3
+          module C3
+            class D3; end
+          end
+        end
+      end
+
+      expect(Nesting.parents(A3)).to eq([Object])
+      expect(Nesting.parents(A3::B3)).to eq([A3, Object])
+      expect(Nesting.parents(A3::B3::C3)).to eq([A3::B3, A3, Object])
+    end
+
+    it "detects parents of a nested module defined via the shortcut" do
+      module A4; end
+      module A4::B4; end
+
+      expect(Nesting.parents(A4)).to eq([Object])
+      expect(Nesting.parents(A4::B4)).to eq([A4, Object])
+    end
+
+    it "detects parents of the class whose superclass is BasicObject" do
+      class A5 < BasicObject; end
+      expect(Nesting.parents(A5)).to eq([Object])
+    end
+
+    it "detects parents of the nested class whose superclass is BasicObject" do
+      class A6; end
+      class A6::B6 < BasicObject; end
+
+      expect(Nesting.parents(A6)).to eq([Object])
+      expect(Nesting.parents(A6::B6)).to eq([A6, Object])
+    end
+
+    it "detects parents of a module depending on the context" do
+      $expect = method(:expect)
+      $eq = method(:eq)
+
+      module A7
+        module B7
+          module C7
+            $expect.(Nesting.parents(A7)).to $eq.([Object])
+            $expect.(Nesting.parents(B7)).to $eq.([A7, Object])
+            $expect.(Nesting.parents(C7)).to $eq.([A7::B7, A7, Object])
+          end
+
+          $expect.(Nesting.parents(A7)).to $eq.([Object])
+          $expect.(Nesting.parents(B7)).to $eq.([A7, Object])
+          $expect.(Nesting.parents(C7)).to $eq.([A7::B7, A7, Object])
+        end
+
+        $expect.(Nesting.parents(A7)).to $eq.([Object])
+        $expect.(Nesting.parents(B7)).to $eq.([A7, Object])
+        $expect.(Nesting.parents(B7::C7)).to $eq.([A7::B7, A7, Object])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+
+Bundler.require :default, :test

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: nesting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyrylo Silin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- silin@kyrylo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENCE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/nesting.rb
+- nesting.gemspec
+- spec/nesting_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kyrylo/nesting
+licenses:
+- zlib
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Detects nesting of a module/class
+test_files:
+- spec/nesting_spec.rb
+- spec/spec_helper.rb
+has_rdoc: