mixes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 226e7e13c0b7f569d886d1d9a5783c2a30aa7fcb
+  data.tar.gz: 0edb7e45d02c0b2c98ea6c35936ffdbb9a196236
+SHA512:
+  metadata.gz: 65e66a2884f526d378bf3ac9fd03754cd238c5019a949e069ab2772f97ce992fd43573a5e1f7a24d9915e16cd9fd1c1e2e76b643899553984d4baaaa3644c69a
+  data.tar.gz: b58da2d0421299794b5b3205576b909bccb971f5cf548f7a1335c3eba713cb4686d357eb3afc0c759398c9edf08727592f4c359a2f78bcb59901cd4a4999f737

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kuba Łopusiński
+
+MIT License
+
+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,79 @@
+# Mixes
+
+Simple Ruby objects mixin, with configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mixes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mixes
+
+## Usage
+### Plain object extending
+
+Include your module inside any Ruby object using the `mixes` syntax:
+
+```ruby
+module FooModule
+  def instance_method
+  end
+
+  module ClassMethods
+    def class_method
+    end
+  end
+end
+
+class FooClass
+  mixes FooModule
+end
+```
+
+`FooModule` module level methods would become instance methods within host object, and `FooModule::ClassMethods` methods would become class level methods.
+
+### Extending and configuring extended objects
+You can pass a second argument to `mixes` method, holding the per-extension configuration values for module beeing mixed in.
+
+```ruby
+class FooClass
+  mixes FooModule, :foo
+  # OR
+  mixes FooModule, {foo: :bar}
+  # OR
+  mixes FooModule, [:foo, :bar]
+  # OR
+  # any other configuration values
+end
+```
+
+This values would be available inside extended module throught the `mixin_configuration` class level accessor:
+
+```ruby
+module FooModule
+  def self.included(base)
+    # prepare module host object based on values held by mixin_configuration
+  end
+end
+
+class FooClass
+  mixes FooModule, :foo
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/siemakuba/mixes/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 @@
+require 'bundler/gem_tasks'

data/lib/mixes/configurator.rb

@@ -0,0 +1,19 @@
+module Mixes
+  module Configurator
+    def perform(source, config = nil)
+      source.send(:extend, ::Mixes::Configurator::Extension)
+      source.mixin_configuration = config
+    end
+    module_function :perform
+
+    module Extension
+      def mixin_configuration=(value)
+        @mixin_configuration = value
+      end
+
+      def mixin_configuration
+        @mixin_configuration
+      end
+    end
+  end
+end

data/lib/mixes/extender.rb

@@ -0,0 +1,9 @@
+module Mixes
+  module Extender
+    def perform(target, source)
+      target.send(:extend, source.const_get(:ClassMethods)) if source.const_defined?(:ClassMethods)
+      target.send(:include, source)
+    end
+    module_function :perform
+  end
+end

data/lib/mixes/version.rb

@@ -0,0 +1,3 @@
+module Mixes
+  VERSION = "0.1.0"
+end

data/lib/mixes.rb

@@ -0,0 +1,12 @@
+require_relative "mixes/version"
+require_relative "mixes/configurator"
+require_relative "mixes/extender"
+
+module Mixes
+  def mixes(mixed_module, *config)
+    ::Mixes::Configurator.perform(mixed_module, *config)
+    ::Mixes::Extender.perform(self, mixed_module)
+  end
+end
+
+Object.extend(::Mixes)

data/mixes.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mixes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mixes"
+  spec.version       = Mixes::VERSION
+  spec.authors       = ["Kuba Łopusiński"]
+  spec.email         = ["siemakuba@gmail.com"]
+  spec.summary       = %q{Load a Mixin with initial configuration.}
+  spec.description   = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/spec/mixes_spec.rb

@@ -0,0 +1,73 @@
+require 'mixes'
+
+module FooBar
+  def foobar_instance_method
+  end
+
+  def self.included(base)
+    config = mixin_configuration
+
+    base.instance_eval do
+      define_method(:passed_configuration) do
+        config
+      end
+    end
+  end
+
+  module ClassMethods
+    def foobar_class_method
+    end
+  end
+end
+
+describe "mixed_with" do
+  let(:foo_class) do
+    Class.new do
+      mixes ::FooBar, :foo_config
+    end
+  end
+
+  let(:bar_class) do
+    Class.new do
+      mixes ::FooBar, :bar_config
+    end
+  end
+
+  let(:baz_class) do
+    Class.new do
+      mixes ::FooBar
+    end
+  end
+
+  context "on class level" do
+    it "includes FooBar module" do
+      expect(foo_class.included_modules).to include(FooBar)
+      expect(bar_class.included_modules).to include(FooBar)
+      expect(baz_class.included_modules).to include(FooBar)
+    end
+
+    it "extends FooBar::ClassMethods" do
+      expect(foo_class.methods(true)).to include(:foobar_class_method)
+      expect(bar_class.methods(true)).to include(:foobar_class_method)
+      expect(baz_class.methods(true)).to include(:foobar_class_method)
+    end
+  end
+
+  context "on instance level" do
+    subject(:foo_object) { foo_class.new }
+    subject(:bar_object) { bar_class.new }
+    subject(:baz_object) { baz_class.new }
+
+    it "includes FooBar module methods" do
+      expect(foo_object.methods(true)).to include(:foobar_instance_method)
+      expect(bar_object.methods(true)).to include(:foobar_instance_method)
+      expect(baz_object.methods(true)).to include(:foobar_instance_method)
+    end
+
+    it "passes configuration for each inclusion" do
+      expect(foo_object.passed_configuration).to eql(:foo_config)
+      expect(bar_object.passed_configuration).to eql(:bar_config)
+      expect(baz_object.passed_configuration).to eql(nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: mixes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kuba Łopusiński
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-19 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ''
+email:
+- siemakuba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mixes.rb
+- lib/mixes/configurator.rb
+- lib/mixes/extender.rb
+- lib/mixes/version.rb
+- mixes.gemspec
+- spec/mixes_spec.rb
+homepage: ''
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Load a Mixin with initial configuration.
+test_files:
+- spec/mixes_spec.rb