tardigrade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 160cb335ff516256d573539605e24a28da29e7de8f90c7a4753e5dce757c5a74
+  data.tar.gz: 7abbeb23af0f166ee377fa742af7c2e0ae3b6532d1c0e6e62464fb4b6361e412
+SHA512:
+  metadata.gz: 7884fffd2fea13f3775a0e154af15b96e924a86d13fde60d377b4e0564be10ba04ccc370b4b666e073b76bb24b7494646559b95896ec7fb00ccc278bf8fde4fc
+  data.tar.gz: 3a7462a15d73064e66233dfb3a452faf43df0cb74351f23e64e7422251c27013870aecb6d564de306ba5edf8192d0288ac10e42cec2a83ef5889a1770b4675ff

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Krzysztof Wawer
+
+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,122 @@
+# Tardigrade
+
+Inject dependency in ruby class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tardigrade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tardigrade
+
+## Usage
+
+Define dependency:
+```ruby
+class Foo
+  def call
+    :foo_response  
+  end
+end
+Tardigrade.add_dependency :foo, Foo
+```
+
+Use dependency in class
+```ruby
+class Action
+  include Tardigrade::Injector
+  
+  import :foo
+end
+
+Action.new.foo # => :foo_response
+```
+
+### Dependencies
+
+Dependency can be:
+* lambda, proc
+* class with `call` class method
+* module with `self.call` method
+* class with `call` instance method
+
+Class with `call` instance method can have context only.
+
+### Context
+
+The biggest advantage of `Tardigarde` is having context by dependency:
+
+Define dependency:
+```ruby
+class Foo
+  include Tardigrade::Dependency
+  
+  with :name
+
+  def call
+    name  
+  end
+end
+Tardigrade.add_dependency :foo, Foo
+```
+
+Use dependency in class
+```ruby
+class Action
+  include Tardigrade::Injector
+  
+  import :foo
+  
+  attr_reader :name
+  
+  def initialize(name:)
+    @name = name
+  end
+end
+
+Action.new(name: "John").foo # => "John"
+```
+
+### Memoization
+
+You can tell tardigrade to memoize method after first call. To do it write:
+```ruby
+Tardigrade.add_dependency :foo, Foo, memoize: true
+```
+
+As cache store `tardigrade` uses `request_store` gem which you can use with [Ruby on Rails application](https://github.com/steveklabnik/request_store#the-solution) and with [Rack application](https://github.com/steveklabnik/request_store#no-rails-no-problem).
+
+### Testing
+
+You can easily test dependency without main object:
+
+```ruby
+class Foo
+  include Tardigrade::Dependency
+  
+  with :name
+
+  def call
+    name  
+  end
+end
+
+Foo.new(name: "John").call # => "John"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wafcio/tardigrade.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/tardigrade.rb

@@ -0,0 +1,16 @@
+require "request_store"
+
+require "tardigrade/dependency"
+require "tardigrade/injector"
+require "tardigrade/version"
+
+module Tardigrade
+  def self.add_dependency(name, klass, **options)
+    @dependencies ||= {}
+    @dependencies[name] = { class: klass, memoize: !!options[:memoize] }
+  end
+
+  def self.dependencies
+    @dependencies || {}
+  end
+end

data/lib/tardigrade/dependency.rb

@@ -0,0 +1,30 @@
+module Tardigrade
+  module Dependency
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def with(*argument_names)
+        @argument_names = argument_names
+
+        if argument_names.size > 0
+          define_method(:initialize) do |**args|
+            argument_names.each do |arg_name|
+              unless args.keys.include?(arg_name)
+                raise ArgumentError.new("argument :#{arg_name} missing")
+              end
+
+              instance_variable_set(:"@#{arg_name}", args[arg_name])
+              self.class.attr_reader :"#{arg_name}"
+            end
+          end
+        end
+      end
+
+      def argument_names
+        @argument_names || []
+      end
+    end
+  end
+end

data/lib/tardigrade/injector.rb

@@ -0,0 +1,57 @@
+module Tardigrade
+  module Injector
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def build_dependency(parent_instance, dep_klass)
+        if dep_klass.respond_to?(:argument_names) && dep_klass.argument_names.size > 0
+          arguments = {}
+          dep_klass.argument_names.each do |name|
+            arguments[name] = parent_instance.send(name)
+          end
+          dep_klass.new(arguments)
+        else
+          dep_klass.respond_to?(:call) ? dep_klass : dep_klass.new
+        end
+      end
+
+      def call_method(klass)
+        if klass.respond_to?(:call)
+          klass.method(:call)
+        else
+          klass.instance_method(:call)
+        end
+      end
+
+      def cache(name, value, memoize)
+        if memoize
+          RequestStore.store[:"tardigrade_#{name}"] ||= value
+        else
+          value
+        end
+      end
+
+      def import(*dependency_names)
+        dependency_names.each do |dep_name|
+          dep = Tardigrade.dependencies[dep_name]
+          klass = dep[:class]
+          memoize = dep[:memoize]
+
+          if call_method(klass).arity == 0
+            define_method(dep_name) do
+              result = self.class.build_dependency(self, klass).call
+              self.class.cache(dep_name, result, memoize)
+            end
+          else
+            define_method(dep_name) do |*args|
+              result = self.class.build_dependency(self, klass).call(*args)
+              self.class.cache(dep_name, result, memoize)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tardigrade/version.rb

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

data/tardigrade.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tardigrade/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tardigrade"
+  spec.version       = Tardigrade::VERSION
+  spec.authors       = ["Krzysztof Wawer"]
+  spec.email         = ["krzysztof.wawer@gmail.com"]
+
+  spec.summary       = "Inject method with dependencies"
+  spec.homepage      = "https://github.com/wafcio/tardigrade"
+  spec.license       = "MIT"
+
+  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_dependency "request_store", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: tardigrade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krzysztof Wawer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: 
+email:
+- krzysztof.wawer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tardigrade.rb
+- lib/tardigrade/dependency.rb
+- lib/tardigrade/injector.rb
+- lib/tardigrade/version.rb
+- tardigrade.gemspec
+homepage: https://github.com/wafcio/tardigrade
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Inject method with dependencies
+test_files: []