module-mixins 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c61833bbcf2dd6f75e5c56eb6d302628ff75060d
+  data.tar.gz: bc5557bc6e25fe38fa48b03fc42602e880b2231c
+SHA512:
+  metadata.gz: 96d07aeb14eac0b83809516c8d2aae16db8f22658b53eab02af96989b7e8d284ed96b934a607ea9e4acaff18957ce403f679697a8801e62202758608049f00b4
+  data.tar.gz: 119c9d1b37bf15c6951e9699bf956bdc4260a63b9f39180a871036fb15dd8f4b72b416b9e2799157a9ae7afe0fffc772383d3ee1875f29999c44fa0309d787bc

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,34 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-11-04 09:40:51 -0500 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 87
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/module/mixins/included.rb'
+    - 'lib/module/mixins/including.rb'
+    - 'lib/module/mixins/version.rb'
+
+# Offense count: 3
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'lib/module/mixins/included.rb'
+    - 'lib/module/mixins/including.rb'
+    - 'lib/module/mixins/version.rb'
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Exclude:
+    - 'lib/module-mixins.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 2.2
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (2015/11/4)
+
+* Initial public release with `Module::Mixins::Included` and `Module::Mixins::Including` - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+Contributing to Module::Mixins
+==============================
+
+Module::Mixins is work of [many contributors](https://github.com/dblock/module-mixins/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/dblock/module-mixins/pulls), [propose features, ask questions and discuss issues](https://github.com/dblock/module-mixins/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/module-mixins) and check out your copy.
+
+```
+git clone https://github.com/contributor/module-mixins.git
+cd module-mixins
+git remote add upstream https://github.com/dblock/module-mixins.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/module-mixins](spec/module-mixins).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/module-mixins and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/module-mixins/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+end
+
+group :development do
+  gem 'rake'
+  gem 'rubocop', '0.34.2'
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015 Daniel Doubrovkine, Artsy and Contributors
+
+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

@@ -0,0 +1,84 @@
+Module::Mixins
+==============
+
+[![Gem Version](http://img.shields.io/gem/v/module-mixins.svg)](http://badge.fury.io/rb/module-mixins)
+[![Build Status](http://img.shields.io/travis/dblock/module-mixins.svg)](https://travis-ci.org/dblock/module-mixins)
+[![Dependency Status](https://gemnasium.com/dblock/module-mixins.svg)](https://gemnasium.com/dblock/module-mixins)
+[![Code Climate](https://codeclimate.com/github/dblock/module-mixins.svg)](https://codeclimate.com/github/dblock/module-mixins)
+
+Help with inspecting mixed-in Ruby modules.
+
+### Install
+
+Add `module-mixins` to your Gemfile.
+
+```
+gem 'module-mixins'
+```
+
+### Use
+
+#### Find All Classes that Include a Module
+
+In order to find all classes that include a module you would typically track those via the [Module.included](http://ruby-doc.org/core-2.2.0/Module.html#method-i-included) callback.
+
+```ruby
+module MyModule
+  attr_accessor :classes_including
+
+  def included(base)
+    self.classes_including ||= []
+    self.classes_including << base
+  end
+end
+```
+
+This works well and is the behavior implemented in _module-mixins_ by [Module::Mixins::Included](lib/module/mixins/included.rb). You can `extend` your modules instead of duplicating code.
+
+```ruby
+module MyModule
+  extend Module::Mixins::Included
+end
+```
+
+Ruby also provides a mechanism to enumerate all constants, which enables us to find mixed-in modules dynamically.
+
+You can extend a module and call `classes_including` similarly.
+
+```ruby
+module MyModule
+  extend Module::Mixins::Including
+end
+```
+
+You can also extend existing modules, which is quite powerful because you can apply it to modules you have not declared in your own code.
+
+```ruby
+irb> Enumerable.extend Module::Mixins::Including
+ => Enumerable
+
+irb> Enumerable.classes_including
+ => [Array, Hash, Struct, ..., Set, SortedSet]
+```
+
+You can also use a module method without needing to mix-in another module.
+
+```ruby
+irb> Module::Mixins::Including.classes_including(Comparable)
+ => [String, Symbol, Numeric, ..., Date, DateTime]
+```
+
+### References
+
+* https://www.ruby-forum.com/topic/163430
+* http://stackoverflow.com/questions/3917857/getting-a-list-of-classes-that-include-a-module
+
+### Contribute
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+### Copyright and License
+
+Copyright Daniel Doubrovkine and Contributors, Artsy Inc., 2015
+
+[MIT License](LICENSE.md)

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/lib/module-mixins.rb

@@ -0,0 +1 @@
+require 'module/mixins'

data/lib/module/mixins.rb

@@ -0,0 +1,3 @@
+require 'module/mixins/version'
+require 'module/mixins/including'
+require 'module/mixins/included'

data/lib/module/mixins/included.rb

@@ -0,0 +1,8 @@
+module Module::Mixins::Included
+  attr_accessor :classes_including
+
+  def included(base)
+    self.classes_including ||= []
+    self.classes_including << base
+  end
+end

data/lib/module/mixins/including.rb

@@ -0,0 +1,13 @@
+module Module::Mixins::Including
+  def classes_including
+    ::Module::Mixins::Including.classes_including self
+  end
+
+  def self.classes_including(klass)
+    ::Module.constants.map do |k|
+      next if k == k.upcase
+      c = Object.const_get k
+      next c if klass > c
+    end.compact
+  end
+end

data/lib/module/mixins/version.rb

@@ -0,0 +1,3 @@
+module Module::Mixins
+  VERSION = '0.1.0'
+end

data/lib/module_mixins.rb

@@ -0,0 +1 @@
+require 'module-mixins'

data/module-mixins.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'module/mixins/version'
+
+Gem::Specification.new do |s|
+  s.name = 'module-mixins'
+  s.version = Module::Mixins::VERSION
+  s.authors = ['Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/dblock/module-mixins'
+  s.licenses = ['MIT']
+  s.summary = 'Help with inspecting mixed-in Ruby modules.'
+end

data/spec/module/mixins/included_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Module::Mixins::Included do
+  context 'a class including a module' do
+    before do
+      @m = Module.new do
+        extend Module::Mixins::Included
+      end
+      @k = Class.new
+      @k.send :include, @m
+    end
+    it 'classes_including' do
+      expect(@m.classes_including).to eq [@k]
+      expect(@m.classes_including.first.new).to be_a_kind_of @k
+    end
+    context 'inherited' do
+      before do
+        @child = Class.new(@k)
+      end
+      it 'classes_including' do
+        expect(@m.classes_including).to eq [@k]
+      end
+    end
+  end
+end

data/spec/module/mixins/including_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Module::Mixins::Including do
+  context 'a class including a module' do
+    before do
+      @m = Module.new do
+        extend Module::Mixins::Including
+      end
+      @k = Class.new
+      @k.send :include, @m
+      Object.const_set "Class_#{SecureRandom.uuid.delete('-')}", @k
+    end
+    it 'classes_including' do
+      expect(@m.classes_including).to eq [@k]
+      expect(@m.classes_including.first.new).to be_a_kind_of @k
+    end
+    context 'inherited' do
+      before do
+        @child = Class.new(@k)
+        Object.const_set "Class_#{SecureRandom.uuid.delete('-')}", @child
+      end
+      it 'classes_including includes children' do
+        expect(@m.classes_including).to eq [@k, @child]
+        @child.send :include, @m
+      end
+    end
+  end
+  context 'Enumerable' do
+    before do
+      Enumerable.extend Module::Mixins::Including
+    end
+    it 'classes_including' do
+      expect(Enumerable.classes_including).to include Array
+    end
+  end
+  context 'module classes_including' do
+    it 'Enumerator' do
+      expect(Module::Mixins::Including.classes_including(Comparable)).to include String
+    end
+  end
+end

data/spec/module/mixins/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Module::Mixins do
+  it 'has a version' do
+    expect(Module::Mixins::VERSION.split('.').size).to eq 3
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+
+require 'module/mixins'
+
+RSpec.configure(&:raise_errors_for_deprecations!)

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: module-mixins
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/module-mixins.rb
+- lib/module/mixins.rb
+- lib/module/mixins/included.rb
+- lib/module/mixins/including.rb
+- lib/module/mixins/version.rb
+- lib/module_mixins.rb
+- module-mixins.gemspec
+- spec/module/mixins/included_spec.rb
+- spec/module/mixins/including_spec.rb
+- spec/module/mixins/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dblock/module-mixins
+licenses:
+- MIT
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Help with inspecting mixed-in Ruby modules.
+test_files: []