composed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57e4dee22e5da987b4f9d1c4e81bbe57feee1c0a
+  data.tar.gz: b29b251a09aab00c8f9fd144bc9185d05d38b189
+SHA512:
+  metadata.gz: 26fe30da18033f53d77f609f15989b7955ed778cd53d41226c36af248eb6b42673cdc9ad805c854f9f5a63e487ee9c58d24b139e7badba9b4fe0c8ec63e3580c
+  data.tar.gz: a492c7861d47b5321a502ee361c7390dc2e0f05d53b694414080faee4910322d5228424552be77092acd8b5db9155521acc68aee8edcbc7a16b0e7d76b3ba557

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in composed.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/lib}) { 'spec' }
+  watch(%r{^lib/}) { 'spec' }
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Justin Scott
+
+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,54 @@
+# Composed
+
+This is a small utility to help you define new types purely through **composition**. This way you can build all the small objects you want and put them together in a simple way.
+
+## Quick Example
+
+```ruby
+#lib/report.rb
+class Report
+  def initialize(config, filter:, output_format:)
+    @config = config
+    @output_format = output_format
+    @filter = filter
+  end
+
+# ... etc ...
+end
+
+#lib/json_report.rb
+ImportantJSONReport = Composed(Report) do
+  dep :output_format { JSONFormatter.new }
+  dep :filter { ImportantStuffFilter.new }
+end
+
+#app/biz_report.rb
+ImportantJSONReport.new(my_config).generate(data)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'composed'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install composed
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dr0verride/composed.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmarks/keywords.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'benchmark/ips'
+require 'composed'
+
+class AClass
+  def initialize(a:,b:,c:,d:); end
+end
+
+class InheritedClass < AClass
+  def initialize(a: 1, b: 2, c: 3, d: 4); super; end
+end
+
+module ModuleClass
+  def self.new(a: 1, b: 2, c: 3, d: 4)
+    AClass.new(a: a,b: b, c: c, d: d)
+  end
+end
+
+HalfComposed = Composed(AClass) do
+  dep :a { 2 }
+  dep :c { 3 }
+end
+
+
+FullComposed = Composed(AClass) do
+  dep :a { 0 }
+  dep :b { 1 }
+  dep :c { 2 }
+  dep :d { 3 }
+end
+
+Benchmark.ips do |x|
+  x.report("Normal Class") { AClass.new(a: 1, b: 2, c: 3, d: 4) }
+  x.report("Inheited Class") { InheritedClass.new }
+  x.report("Module Class") { ModuleClass.new }
+  x.report("Half Composed") { HalfComposed.new(b: 1, d: 2) }
+  x.report("Full Composed") { FullComposed.new }
+
+  x.compare!
+end

data/benchmarks/positional_override.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'benchmark/ips'
+require 'composed'
+
+class AClass
+  def initialize(a,b,c,d); end
+end
+
+class InheritedClass < AClass
+  def initialize(a = 1, b = 2, c = 3, d = 4); super; end
+end
+
+module ModuleClass
+  def self.new(a = 1, b = 2, c = 3, d = 4)
+    AClass.new(a,b,c,d)
+  end
+end
+
+HalfComposed = Composed(AClass) do
+  dep 2 { 2 }
+  dep 3 { 3 }
+end
+
+
+FullComposed = Composed(AClass) do
+  dep { 0 }
+  dep { 1 }
+  dep { 2 }
+  dep { 3 }
+end
+
+Benchmark.ips do |x|
+  x.report("Normal Class") { AClass.new(1,2,3,4) }
+  x.report("Inheited Class") { InheritedClass.new }
+  x.report("Module Class") { ModuleClass.new }
+  x.report("Half Composed") { HalfComposed.new(1,2) }
+  x.report("Full Composed") { FullComposed.new }
+
+  x.compare!
+end

data/benchmarks/positional_skip.rb

@@ -0,0 +1,42 @@
+require 'bundler/setup'
+require 'benchmark/ips'
+require 'composed'
+
+Composed::Positional.strategy = :skip
+
+class AClass
+  def initialize(a,b,c,d); end
+end
+
+class InheritedClass < AClass
+  def initialize(a = 1, b = 2, c = 3, d = 4); super; end
+end
+
+module ModuleClass
+  def self.new(a = 1, b = 2, c = 3, d = 4)
+    AClass.new(a,b,c,d)
+  end
+end
+
+HalfComposed = Composed(AClass) do
+  dep 1 { 2 }
+  dep 2 { 3 }
+end
+
+
+FullComposed = Composed(AClass) do
+  dep { 0 }
+  dep { 1 }
+  dep { 2 }
+  dep { 3 }
+end
+
+Benchmark.ips do |x|
+  x.report("Normal Class") { AClass.new(1,2,3,4) }
+  x.report("Inheited Class") { InheritedClass.new }
+  x.report("Module Class") { ModuleClass.new }
+  x.report("Half Composed") { HalfComposed.new(1,2) }
+  x.report("Full Composed") { FullComposed.new }
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "composed"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/composed.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'composed/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "composed"
+  spec.version       = Composed::VERSION
+  spec.authors       = ["Justin Scott"]
+  spec.email         = ["jscott7561@gmail.com"]
+
+  spec.summary       = "Tool for defining types or operations that are composed from other types."
+  spec.description   = spec.description
+  spec.homepage      = "https://github.com/dr0verride/composed"
+  spec.licenses         = ['MIT']
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "byebug", "~> 9.0"
+  spec.add_development_dependency "benchmark-ips", "~> 2.7"
+end

data/lib/composed.rb

@@ -0,0 +1,74 @@
+require 'composed/version'
+require 'composed/positional'
+require 'composed/keywords'
+
+class Composed
+  def initialize(klass, interface = :new, &block)
+    raise ArgumentError, "Must provide a block to define Composed Type" unless block_given?
+    @klass = klass
+    @injected_pos_args = Positional.new
+    @injected_kw_args = Keywords.new
+    @interface = interface
+    @ctor = nil
+
+    instance_eval(&block)
+
+    singleton_class.send(:alias_method, interface, :execute_composition)
+    singleton_class.send(:public, interface, :execute_composition)
+    
+    if interface == :call
+      singleton_class.send(:alias_method, :[], :execute_composition)
+      singleton_class.send(:public, :[])
+    end
+  end
+
+  private
+
+  def execute_composition(*args, **kwargs, &block)
+    args = @injected_pos_args.merge(args)
+
+    object =  if kwargs.empty? && @injected_kw_args.empty?
+                @klass.send(@interface, *args, &block)
+              else
+                kwargs = @injected_kw_args.merge(kwargs)
+                @klass.send(@interface, *args, **kwargs, &block)
+              end
+
+    object.instance_eval(&@ctor) if @ctor
+    object
+  end
+
+  def define_dependency(keyword_or_idx = nil, &block)
+    case keyword_or_idx
+    when String
+      @injected_kw_args[keyword_or_idx.to_sym] = block
+    when Symbol
+      @injected_kw_args[keyword_or_idx] = block
+    when Integer
+      @injected_pos_args[keyword_or_idx] = block
+    else
+      @injected_pos_args << block
+    end
+  end
+
+  alias_method :dep, :define_dependency
+
+  def define_kw_dependency(keyword, block)
+    raise ArgumentError, <<~ERROR if @injected_kw_args.key?(keyword)
+      Cannot inject keyword argument \"#{keyword}\" more than once."
+    ERROR
+    @injected_kw_args[keyword] = block
+  end
+
+  def constructor(&block)
+    @ctor = block
+  end
+
+  module Macro
+    def Composed(*args, &block)
+      Composed.new(*args,&block)
+    end
+  end
+end
+
+include Composed::Macro

data/lib/composed/keywords.rb

@@ -0,0 +1,27 @@
+
+class Composed
+  class Keywords
+    def initialize
+      @injected = {}
+    end
+
+    def []=(keyword, value)
+      raise ArgumentError, <<~ERROR if @injected.key?(keyword)
+        Cannot inject keyword argument \"#{keyword}\" more than once."
+      ERROR
+      @injected[keyword] = value
+    end
+
+    def merge(args)
+      @injected.each do |key, value|
+        args[key] = value.call unless args.key?(key)
+      end
+
+      args
+    end
+
+    def empty?
+      @injected.empty?
+    end
+  end
+end

data/lib/composed/positional.rb

@@ -0,0 +1,100 @@
+
+class Composed
+  class Positional
+    def initialize(merge_strategy = default_strategy)
+      @injected = {}
+      @index = 0
+      @merge_strategy = merge_strategy
+    end
+
+    def []=(idx, value)
+      @index = idx
+      push(value)
+    end
+
+    def push(value)
+      set(@index,value)
+      @index += 1
+    end
+
+    alias_method :<<, :push
+
+    def merge(args)
+      @merge_strategy.call(args,@injected)
+    end
+
+    private
+    def set(idx, value)
+      @injected[idx] = value
+      @injected = Hash[@injected.sort]
+    end
+
+    class OverrideStrategy
+      def call(args, injected)
+        missing = 0
+        injected.each do |idx,value|
+          if args.size == idx
+            args[idx] = value.call
+          elsif args.size < idx
+            missing += 1
+          end
+        end
+
+        raise ArgumentError, <<~ERROR if missing > 0
+          wrong number of arguments (given #{args.size}, expected #{args.size + missing}
+        ERROR
+
+        args
+      end
+    end
+
+    class SkipStrategy
+      def call(args, injected)
+        missing = 0
+        injected.each do |idx, value|
+          missing += 1 if args.size < idx
+          args.insert(idx,value.call)
+        end
+
+        raise ArgumentError, <<~ERROR if missing > 0
+          wrong number of arguments (given #{args.size}, expected #{args.size + missing}
+        ERROR
+
+        args
+      end
+    end
+
+    def default_strategy
+      self.class.strategy
+    end
+
+    class << self
+      STRATEGY_LOOKUP = {
+        skip: SkipStrategy,
+        override: OverrideStrategy,
+        default: OverrideStrategy
+      }
+
+      def strategy=(strategy)
+        @strategy = klass_for(strategy).new
+      end
+
+      def klass_for(strategy)
+        return strategy if strategy.respond_to?(:new)
+
+        STRATEGY_LOOKUP.fetch(strategy) { raise ArgumentError, <<~ERROR }
+          Unsupported strategy: #{strategy}. Use one of the following:
+          :skip - Skips over injected arguments. Cannot override injections at call time.
+          :override - Positional arguments behave as normal function calls. Defaults are overridden in order.
+          :default - Set the default. :override
+        ERROR
+
+      end
+    end
+
+    def self.strategy
+      @strategy ||= klass_for(:default).new
+    end
+
+  end
+end

data/lib/composed/version.rb

@@ -0,0 +1,3 @@
+class Composed
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: composed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Scott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: ''
+email:
+- jscott7561@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- benchmarks/keywords.rb
+- benchmarks/positional_override.rb
+- benchmarks/positional_skip.rb
+- bin/console
+- bin/setup
+- composed.gemspec
+- lib/composed.rb
+- lib/composed/keywords.rb
+- lib/composed/positional.rb
+- lib/composed/version.rb
+homepage: https://github.com/dr0verride/composed
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Tool for defining types or operations that are composed from other types.
+test_files: []