super_module 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: def423de958bb4f6b3d2c6b3edb60908d42bbe86
+  data.tar.gz: 962866a97336aaeeebd16386e1cf37417e1d2aa9
+SHA512:
+  metadata.gz: 99668ddec0c2e332493f7cda830428e4915d65eaf35bde9b5a0336233396425c458746734082917028a310b8fa0e4a01d0b430f0f3a78a31b7cd5afdd541e5c1
+  data.tar.gz: fb848a9f6979fe0f079ddc9d3967eb600b85186659ce6457d220ec5ce55be0c460928fe09e5403cfe0689009a4c93ae9a3ce4102e1b07ac27785027f525e7b02

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Andy Maleh
+
+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,146 @@
+# SuperModule
+[![Gem Version](https://badge.fury.io/rb/super_module.png)](http://badge.fury.io/rb/super_module)
+[![Build Status](https://api.travis-ci.org/AndyObtiva/super_module.png?branch=master)](https://travis-ci.org/AndyObtiva/super_module)
+[![Coverage Status](https://coveralls.io/repos/AndyObtiva/super_module/badge.png?branch=master)](https://coveralls.io/r/AndyObtiva/super_module?branch=master)
+[![Code Climate](https://codeclimate.com/github/AndyObtiva/super_module.png)](https://codeclimate.com/github/AndyObtiva/super_module)
+
+Tired of Ruby's modules not allowing you to mix in class methods easily?
+Tired of writing complex code and using complex libraries like ActiveSupport::Concern to accomplish that goal?
+
+Well, worry no more! SuperModule comes to the rescue!
+
+![SuperModule](https://raw.githubusercontent.com/AndyObtiva/super_module/master/SuperModule.jpg)
+
+SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base).
+
+This succeeds ActiveSupport::Concern by offering lighter syntax and simpler module dependency support.
+
+## Instructions
+
+### 1) Install and require gem
+
+<b>Using Bundler</b>
+
+Add the following to Gemfile: <pre>gem 'super_module', '1.0.0'</pre>
+Run: <code>bundle</code>
+
+It will automatically get required in the application when loading with bundler (e.g. in a Rails application)
+
+<b>Using RubyGem Directly</b>
+
+Run: <pre>gem install super_module</pre>
+(add <code>--no-ri --no-rdoc</code> if you wish to skip downloading them for a faster install)
+
+Add <code>require 'super_module'</code> at the top of your Ruby file
+
+### 2) Include SuperModule at the top of the module
+
+>     module UserIdentifiable
+>       include SuperModule
+>
+>       belongs_to :user
+>       validates :user_id, presence: true
+>
+>       def self.most_active_user
+>         User.find_by_id(select('count(id) as head_count, user_id').group('user_id').order('count(id) desc').first.user_id)
+>       end
+>
+>       def slug
+>         "#{self.class.name}_#{user_id}"
+>       end
+>     end
+
+### 3) Mix newly defined module into a class or another super module
+
+>     class ClubParticipation < ActiveRecord::Base
+>       include UserIdentifiable
+>     end
+>     class CourseEnrollment < ActiveRecord::Base
+>       include UserIdentifiable
+>     end
+>     module Accountable
+>       include SuperModule
+>       include UserIdentifiable
+>     end
+>     class Activity < ActiveRecord::Base
+>       include Accountable
+>     end
+
+### 4) Start using by invoking class methods or instance methods
+
+>     CourseEnrollment.most_active_user
+>     ClubParticipation.most_active_user
+>     Activity.last.slug
+>     ClubParticipation.create(club_id: club.id, user_id: user.id).slug
+>     CourseEnrollment.new(course_id: course.id).valid?
+
+## Example
+
+>     require 'super_module'
+>
+>     module Foo
+>       include SuperModule
+>
+>       validates :credit_card_id, presence: true
+>
+>       def foo
+>         puts 'foo'
+>         'foo'
+>       end
+>
+>       def self.foo
+>         puts 'self.foo'
+>         'self.foo'
+>       end
+>     end
+>
+>     module Bar
+>       include SuperModule
+>       include Foo
+>
+>       validates :user_id, presence: true
+>
+>       def bar
+>         puts 'bar'
+>         'bar'
+>       end
+>
+>       def self.bar
+>         puts 'self.bar'
+>         'self.bar'
+>       end
+>     end
+>
+>     class MediaAuthorization < ActiveRecord::Base
+>       include Bar
+>     end
+>
+>     MediaAuthorization.create.errors.messages.inspect
+
+=> "{:credit_card_id=>[\"can't be blank\"], :user_id=>[\"can't be blank\"]}"
+
+>     MediaAuthorization.new.foo
+
+=> "foo"
+
+>     MediaAuthorization.new.bar
+
+=> "bar"
+
+>     MediaAuthorization.foo
+
+=> "self.foo"
+
+>     MediaAuthorization.bar
+
+=> "self.bar"
+
+## Design Limitations
+
+This has been designed to be used only in the code definition of a module.
+
+## Copyright
+
+Copyright (c) 2014 Andy Maleh. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/super_module.rb

@@ -0,0 +1,66 @@
+# SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base).
+#
+# Author::    Andy Maleh
+# Copyright:: Copyright (c) 2014 Andy Maleh
+# License::   MIT License
+
+# This module allows defining class methods and method invocations the same way a super class does without using def included(base).
+
+module SuperModule
+  EXCLUDED_SINGLETON_METHODS = [
+    :__super_module_class_methods,
+    :__invoke_super_module_class_method_calls,
+    :__define_super_module_class_methods,
+    :__restore_original_method_missing,
+    :included, :method_missing,
+    :singleton_method_added
+  ]
+  def self.included(base)
+    base.class_eval do
+      class << self
+
+        def include(base, &block)
+          method_missing('include', base, &block)
+        end
+
+        def __super_module_class_method_calls
+          @__super_module_class_method_calls ||= []
+        end
+
+        def __super_module_class_methods
+          @__super_module_class_methods ||= []
+        end
+
+        def singleton_method_added(method_name)
+          __super_module_class_methods << [method_name, method(method_name)] unless EXCLUDED_SINGLETON_METHODS.include?(method_name)
+          super
+        end
+
+        def method_missing(method_name, *args, &block)
+          __super_module_class_method_calls << [method_name, args, block]
+        end
+
+        def __invoke_super_module_class_method_calls(base)
+          __super_module_class_method_calls.each do |method_name, args, block|
+            base.class_eval do
+              send(method_name, *args, &block)
+            end
+          end
+        end
+
+        def __define_super_module_class_methods(base)
+          __super_module_class_methods.each do |method_name, method|
+            base.class_eval do
+              self.class.send(:define_method, method_name, &method)
+            end
+          end
+        end
+
+        def included(base)
+          __invoke_super_module_class_method_calls(base)
+          __define_super_module_class_methods(base)
+        end
+      end
+    end
+  end
+end

data/spec/lib/super_module_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe SuperModule do
+  module Foo
+    include SuperModule
+    validates 'foo', presence: true
+
+    def self.foo
+      'self.foo'
+    end
+
+    def foo
+      'foo'
+    end
+  end
+  module Bar
+    include SuperModule
+    validates 'bar', presence: true
+
+    class << self
+      def bar
+        'self.bar'
+      end
+    end
+
+    def bar
+      'bar'
+    end
+  end
+  class FakeActiveRecord
+    class << self
+      def validates(attribute, options)
+        validations << [attribute, options]
+      end
+      def validations
+        @validations ||= []
+      end
+    end
+  end
+
+  context "a base class includes a module enhanced as a super module" do
+    before do
+      FakeActiveRecord.send(:include, Foo)
+    end
+
+    it 'allows invoking class methods in the including base class body' do
+      FakeActiveRecord.validations.should include(['foo', {presence: true}])
+    end
+    it 'includes instance methods in the including base class' do
+      instance = FakeActiveRecord.new
+
+      instance.foo.should == 'foo'
+    end
+    it 'includes class methods in the including base class' do
+      FakeActiveRecord.foo.should == 'self.foo'
+    end
+  end
+
+  context "a base class includes a base module enhanced as a super module that includes another module enhanced as a super module" do
+    before do
+      Bar.send(:include, Foo)
+      FakeActiveRecord.send(:include, Bar)
+    end
+
+    it 'allows invoking class methods in the including base class body' do
+      FakeActiveRecord.validations.should include(['foo', {presence: true}])
+      FakeActiveRecord.validations.should include(['bar', {presence: true}])
+    end
+    it 'includes instance methods in the including base class' do
+      instance = FakeActiveRecord.new
+
+      instance.foo.should == 'foo'
+      instance.bar.should == 'bar'
+    end
+    it 'includes class methods in the including base class' do
+      FakeActiveRecord.foo.should == 'self.foo'
+      FakeActiveRecord.bar.should == 'self.bar'
+    end
+  end
+
+end

data/super_module.gemspec

@@ -0,0 +1,50 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: super_module 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "super_module"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Andy Maleh"]
+  s.date = "2014-03-27"
+  s.description = "SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base). This also succeeds ActiveSupport::Concern by offering lighter syntax"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.md",
+    "SuperModule.jpg",
+    "VERSION",
+    "lib/super_module.rb",
+    "spec/lib/super_module_spec.rb",
+    "super_module.gemspec"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/super_module"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "SuperModule allows defining class methods and method invocations the same way a super class does without using def included(base). This also succeeds ActiveSupport::Concern by offering lighter syntax"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+    else
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: super_module
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Maleh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: SuperModule allows defining class methods and method invocations the
+  same way a super class does without using def included(base). This also succeeds
+  ActiveSupport::Concern by offering lighter syntax
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- LICENSE.txt
+- README.md
+- SuperModule.jpg
+- VERSION
+- lib/super_module.rb
+- spec/lib/super_module_spec.rb
+- super_module.gemspec
+homepage: http://github.com/AndyObtiva/super_module
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: SuperModule allows defining class methods and method invocations the same
+  way a super class does without using def included(base). This also succeeds ActiveSupport::Concern
+  by offering lighter syntax
+test_files: []