dawn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff614e1aab7364c357895c1580cbebab964b155e94fb72d52b00a31e224becd7
+  data.tar.gz: fae73234075fb18289088e0aa1f4e49cfe917e721bc04f47fe5e06b065277786
+SHA512:
+  metadata.gz: 7ce6e37497dfcfa13406602e973529ef581d99f5ec0f76ed65f2cafa40a2e60c4313986c402c54721497d00984f31b7af4e39a49a46a3ab2e82b0681e65b903c
+  data.tar.gz: e8deccb8a66598ada426cdf83508420a3b3c285e3faf18bc254c8fbc839a691200e7f82f89969d1091e9f89cef5c6861502038243f5bb9e43dacd5b96c3509d9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dawn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    dawn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  dawn!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Eliav Lavi
+
+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,142 @@
+# Dawn
+`Dawn` is a simple and intuitive instances container for Ruby. It was born out of the need to reference existing application instances in Rails controllers, without having to re-initialize them upon each controller call or using the singleton pattern; however, while `Dawn` can be used in a Rails app, it may fit any Ruby application that is built with dependency injection in mind.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dawn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dawn
+
+## Usage
+
+`Dawn` allows you to build a container of namespaces which are registered with instances. Upon the booting stages of your application, you might want to initialize instances of classes which serve different purposes (e.g. `ChargeCreationService` for handling the complexity of creating a new charge in your system), accross different business domains. That way you can reference those instances later, when requests start arriving at your application, without having re-initialize those instances each time. This idea also allows you to build your app as a hierarchical tree of dependnecies, as will be demonstrated later.
+
+You can build a `Dawn` container with multiple namespaces, each namespace having a unique name and containing several instances:
+
+```ruby
+# Assuming instance_a and instance_b were just initialized:
+foo_namespace_request = Dawn::Namespace::Request.new(name: :foo) do |namespace|
+    namespace
+        .set(key: :instance_a, instance: instance_a)
+        .set(key: :instance_b, instance: instance_b)
+end
+
+CONTAINER = Dawn::Container.build([foo_namespace_request])
+```
+
+Later, you may fetch instances from the container:
+```ruby
+CONTAINER.fetch(namespace: foo, key: :instance_a)
+```
+![](https://i.imgur.com/GFEKDlh.png)
+
+### Dependency Injection Based Applications
+Since `Dawn` was created to support the development of dependency injection based application, I will briefly discuss this topic in this section. Usage in Rails will be clearer hence.
+
+Crafting your application as such that is based on a nested tree of injected dependencies has many benefits that has been described in many writings before. That is, in contrary to an opposing design choice, which is fairly common in the Ruby eco-system, in which dependencies are hard coded. The following example demonstrates this in a nutshell.
+
+Assuming some `FooService` class:
+
+```ruby
+class FooService
+    def call
+        # Return some value / do something
+    end
+end
+```
+
+We can use it as a dependency in another class, `BarService` in two ways. Either directly, as an hard-coded dependency:
+```ruby
+class BarService
+    def call
+        FooService.new.call
+    end
+end
+```
+
+Or as injected dependency:
+```ruby
+class BarService
+    def self.build
+        foo_service = FooService.new
+        new(foo_service: foo_service)
+    end
+
+    def initialize(foo_service:)
+        @foo_service = foo_service
+    end
+    def call
+        @foo_service.call
+    end
+end
+```
+
+This is just a single level of dependency, real-life application are often much more nested.
+Notice that I did mentioned `FooService` in an hard-coded fashion, in my `.build` method, but that is just a helper method to get the common usage of `BarService` instances and its not on the instant scope, but on the class scope. I can pass anything I want to `BarService#initialize`.
+
+I urge you to read more about dependency injection, but the advantages of the latter approach are numerous! From testing to code reusability, dependency injection is a real thing, and it doesn't have to be complex or scary at all.
+
+### Usage In Rails
+One problem that sometimes  emerges is that we don't have control of everything in our application, and the most prominent example is if we are building our application on top of Rails. When Rails receives a request to a certain route, it will find the controller which is registered with this route **and will initialize a new instance of that controller with the parameters of the request as the instance variable `@param`**. This pattern is the complete opposite of dependency injection based design, but we have nothing to do about it (other than not using Rails, which is not always a choice we can make).
+While we cannot change this behaviour of Rails - a new controller instance will be created upon each request - we can choose to stop this pattern right there, and use pre-initialized instances from there on. This is where `Dawn` becomes really helpful.
+
+For example, let's assume some `ChargesController`, whose `#create` method needs to pass request's data to some `ChargeCreationService`. Usually, the implementation would look like this:
+```ruby
+    class ChargesController < ApplicationController
+        def create
+            ChargeCreationService.new.call(params[:charge])
+            
+            # Note: In this manner, ChargeCreationService instances have no members / instance variables.
+            # Some people also do the following, which might feel slicker at first:
+            # ChargeCreationService.new(params[:charge]).call
+            # Honestly, assuming ChargeCreationService has dependencies of it's own, both feel wrong to me.
+        end
+    end
+```
+
+With `Dawn` we can do this:
+```ruby
+    class ChargesController < ApplicationController
+        def create
+            # Assuming we initialized a proper Dawn container in the initialization stages of our application, and assigned it the the global const CONTAINER:
+
+            service = CONTAINER.fetch(namespace: :charges, key: :creation_service)
+            service.call(params[:charge])
+        end
+    end
+```
+
+Rails offers the `after_initialize` hook that you can use in `application.rb` - this is a proper place to initialize your `Dawn::Container`. In the previous example, I have referenced it from the top level contsant `CONTAINER`, which could be assigned there. See [here](https://guides.rubyonrails.org/configuring.html#rails-general-configuration) for more info on `after_initialize`.
+
+## 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).
+
+## Feature Requests
+
+Dawn is open for changes and requests!
+If you have an idea, a question or some need, feel free to contact me here or at eliavlavi@gmail.com.
+
+## Contributing
+
+1. Fork it ( https://github.com/eliav-lavi/dawn/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
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dawn"
+
+# 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/dawn.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dawn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dawn"
+  spec.version       = Dawn::VERSION
+  spec.authors       = ["Eliav Lavi"]
+  spec.email         = ["eliavlavi@gmail.com"]
+
+  spec.summary       = %q{A Object Initialization Utility for Dependency Injection Based Design Purposes}
+  spec.description   = %q{A a simple and intuitive instances container for Ruby. Dawn helps in managing re-usable instances in an application, without having to recreate them upon each request. }
+  spec.homepage      = "https://github.com/eliav-lavi/dawn"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", '~> 0.12.2'
+end

data/lib/dawn.rb

@@ -0,0 +1,20 @@
+require 'dawn/version'
+require 'dawn/container'
+require 'dawn/namespace/request'
+
+module Dawn
+  class Error < StandardError
+  end
+
+  class NamespaceNotRegisteredError < Error
+  end
+
+  class NamespaceAlreadyRegisteredError < Error
+  end
+
+  class InstanceNotRegisteredError < Error
+  end
+
+  class InstanceAlreadyRegisteredError < Error
+  end
+end

data/lib/dawn/container.rb

@@ -0,0 +1,23 @@
+module Dawn
+  class Container
+    class << self
+      def build(namespace_requests)
+        namespaces = namespace_requests.each_with_object({}) do |request, hash|
+          raise Dawn::NamespaceAlreadyRegisteredError if hash.key?(request.name)
+          hash[request.name] = request.process
+        end
+
+        new(namespaces: namespaces)
+      end
+    end
+
+    def initialize(namespaces:)
+			@namespaces = namespaces
+		end
+
+    def fetch(namespace:, key:)
+      raise Dawn::NamespaceNotRegisteredError unless @namespaces.key?(namespace)
+			@namespaces[namespace].get(key: key)
+		end
+  end
+end

data/lib/dawn/namespace/finalized.rb

@@ -0,0 +1,16 @@
+require 'dawn'
+
+module Dawn
+  module Namespace
+    class Finalized
+      def initialize(instances:)
+        @instances = instances
+      end
+
+      def get(key:)
+        raise Dawn::InstanceNotRegisteredError unless @instances.key?(key)
+        @instances[key]
+      end
+    end
+  end
+end

data/lib/dawn/namespace/request.rb

@@ -0,0 +1,18 @@
+require 'dawn/namespace/transitional'
+
+module Dawn
+  module Namespace
+    class Request
+      attr_reader :name
+
+      def initialize(name:, &proc)
+        @name = name
+        @proc = proc
+      end
+  
+      def process
+        @proc.call(Transitional.new).finalize
+      end
+    end
+  end
+end

data/lib/dawn/namespace/transitional.rb

@@ -0,0 +1,21 @@
+require 'dawn/namespace/finalized'
+require 'dawn'
+
+module Dawn
+  module Namespace
+    class Transitional
+      def initialize(instances: {})
+        @instances = instances
+      end
+
+      def set(key:, instance:)
+        raise Dawn::InstanceAlreadyRegisteredError if @instances.key?(key)
+        Transitional.new(instances: @instances.merge(Hash[key, instance]))
+      end
+
+      def finalize
+        Finalized.new(instances: @instances)
+      end
+    end
+  end
+end

data/lib/dawn/version.rb

@@ -0,0 +1,3 @@
+module Dawn
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dawn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eliav Lavi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+description: 'A a simple and intuitive instances container for Ruby. Dawn helps in
+  managing re-usable instances in an application, without having to recreate them
+  upon each request. '
+email:
+- eliavlavi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dawn.gemspec
+- lib/dawn.rb
+- lib/dawn/container.rb
+- lib/dawn/namespace/finalized.rb
+- lib/dawn/namespace/request.rb
+- lib/dawn/namespace/transitional.rb
+- lib/dawn/version.rb
+homepage: https://github.com/eliav-lavi/dawn
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Object Initialization Utility for Dependency Injection Based Design Purposes
+test_files: []