ruby_beans 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6dc9f2ea59685d46f6982aa7a68bff52f639b43
+  data.tar.gz: c74618ab31ad2afe709cf4cb9ddaf200f3d75d7c
+SHA512:
+  metadata.gz: aebe7d7e86dddfcc2aa0466755ff522b58dc856be82a0873e252d2a685d948d287eb389b4a9c76475a1121352f43b0e754db7c80bbfba41f99a96e598b51fd94
+  data.tar.gz: 9649481b176e46fce2a5a59d9d2fed9168b51bdb8039e7dc0efab803b2e1a2d5cb18fde827f171a1687d59415f3a1699e0bb88e7d5365e2ac75b9b2cc32b7463

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sebi
+
+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,152 @@
+# RubyBeans
+
+*simple to use and test dependency injection framework*
+
+**RubyBeans** is a better alternative to
+```ruby
+class MyClass
+  include Singleton
+end
+#singleton classes
+MyClass.instance
+```
+
+```ruby
+class MyCache
+  class << self
+    def my_cached_item
+      ...
+    end
+  end
+end
+# global accessable objects(cacheable)
+MyCache.my_cached_item
+```
+
+
+```ruby
+class MyService
+  include Singleton
+  def my_method; end
+end
+
+class ProductsController < ApplicationController
+  def index
+    # polute code with hard to test code
+    # increases coupling
+    MyService.instance.my_method
+  end
+end
+```
+
+### Define beans
+
+```ruby
+class MyContainer < RubyBeans::Container
+  # load dependent container
+  load_containers 'MyContainer2'
+
+  def get_first_bean
+    1 + second_bean # => 3
+  end
+
+  def get_second_bean
+    2
+  end
+
+  def get_third_bean
+    3 + forth_bean #=> 7
+  end
+
+  def get_fifth_bean
+    sixth_bean #=> nil
+  end
+end
+
+class MyContainer2 < RubyBeans::Container
+  def get_forth_bean
+    4
+  end
+end
+```
+
+### Usage
+
+```ruby
+# get a bean manualy by name
+RubyBeans.get_bean('first_bean') # => 3
+
+# inject them into your class instances
+
+class MyClass
+  extend RubyBeans::Injector
+
+  inject :first_bean, :second_MyContainerMyContainerbean
+end
+
+my_ins = MyClass.new
+my_ins.first_bean #=> 3
+my_ins.second_bean #=> 2
+```
+
+### Test
+
+Load helpers
+```ruby
+require 'ruby_beans/stub'
+RSpec.configure do |c|
+  c.include RubyBeans::Stub
+end
+```
+
+```ruby
+# test containers
+subject(:container){ MyContainer.instance)
+it 'has the bean' do
+  expect(container.first_bean).to eq 3 # to use cache
+  expect(container.get_first_bean).to eq 3 # without cache
+end
+
+# stub containers
+before do
+  @my_container = stub_container do
+    def get_my_bean
+      33
+    end
+  end
+end
+
+it 'my test' do
+  expect(@my_container.class).to be_a Class # @container is class
+  expect(@my_containe.instance).to be_a RubyBeans::Container #access the instance
+end
+# stub_container_main is the same as stub_container, it just sets the  # RubyBeans.main_container too.
+
+# stub beans
+before do
+ stub_bean('test', 1)
+end
+
+it 'stubs the bean' do
+  expect(RubyBeans.get_bean('test')).to eq 1
+end
+```
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_beans'
+```
+```ruby
+# load it as soon as possible, for rails create a initializer file
+# main container is the root of all dependent containers
+RubyBeans.main_container = MyContainer
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "ruby_beans"
+
+# 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

data/bin/setup

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

data/lib/ruby_beans/cache.rb

@@ -0,0 +1,26 @@
+module RubyBeans
+  class Cache
+    @@_hash = Hash.new
+
+    class << self
+      def get(name)
+        @@_hash[name]
+      end
+
+      def put(name, obj)
+        @@_hash[name] = obj
+      end
+
+      def get_or_put(name, obj)
+        unless get(name)
+          put(name, obj)
+        end
+        get(name)
+      end
+
+      def hash
+        @@_hash
+      end
+    end
+  end
+end

data/lib/ruby_beans/container.rb

@@ -0,0 +1,51 @@
+require 'singleton'
+module RubyBeans
+  class Container
+    include Singleton
+
+    attr_accessor :dependency_loading_called, :dependent_containers, :dependent_containers_names
+
+    def initialize
+      @dependency_loading_called = false
+      @dependent_containers_names = []
+      @dependent_containers = []
+    end
+    class << self
+      def load_containers(*containers)
+        self.instance.dependency_loading_called = true
+        self.instance.dependent_containers_names = containers
+      end
+
+      def _load_container_instances
+        self.instance.dependent_containers_names.each do |container|
+          self.instance.dependent_containers.push(Object.const_get(container).send(:instance))
+        end
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      name = name.to_s
+
+      if dependency_loading_called && dependent_containers.empty?
+        self.class._load_container_instances
+      end
+
+      if name.start_with?('get_') && name.end_with?('_bean')
+        result = nil
+        dependent_containers.each do |container|
+          result = container.send(name)
+        end
+        result
+      elsif name.end_with?('_bean')
+        bean = RubyBeans::Cache.get name
+        unless bean
+          bean = self.send("get_#{name}")
+          RubyBeans::Cache.put(name, bean)
+        end
+        bean
+      else
+        super
+      end
+    end
+  end
+end

data/lib/ruby_beans/injector.rb

@@ -0,0 +1,12 @@
+module RubyBeans
+  module Injector
+    def inject(*dependencies)
+      dependencies.each do |d|
+        ds = d.to_s
+        define_method(ds) do
+          RubyBeans.get_bean ds
+        end
+      end
+    end
+  end
+end

data/lib/ruby_beans/stub.rb

@@ -0,0 +1,16 @@
+module RubyBeans
+  module Stub
+    def stub_bean(name, obj)
+      RubyBeans::Cache.put(name, obj)
+    end
+
+    def stub_container(&block)
+      Class.new RubyBeans::Container, &block
+    end
+
+    def stub_main_container(&block)
+      klass = stub_container(&block)
+      RubyBeans.main_container = klass
+    end
+  end
+end

data/lib/ruby_beans/version.rb

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

data/lib/ruby_beans.rb

@@ -0,0 +1,19 @@
+require 'ruby_beans/version'
+require 'ruby_beans/container'
+require 'ruby_beans/cache'
+require 'ruby_beans/injector'
+
+module RubyBeans
+  class << self
+    attr_accessor :main_container
+
+    def get_bean(name)
+      bean = RubyBeans::Cache.get(name)
+      unless bean
+        bean = main_container.send(name)
+        RubyBeans::Cache.put(name, bean)
+      end
+      bean
+    end
+  end
+end

data/ruby_beans.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_beans/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_beans"
+  spec.version       = RubyBeans::VERSION
+  spec.authors       = ["sebi"]
+  spec.email         = ["gore.sebyx@yahoo.com"]
+
+  spec.summary       = %q{simple to use and test dependency injection framework}
+  spec.description   = %q{Dependency injection framework for ruby}
+  spec.homepage      = "https://github.com/sebyx07/rubybeans"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ruby_beans
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sebi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Dependency injection framework for ruby
+email:
+- gore.sebyx@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_beans.rb
+- lib/ruby_beans/cache.rb
+- lib/ruby_beans/container.rb
+- lib/ruby_beans/injector.rb
+- lib/ruby_beans/stub.rb
+- lib/ruby_beans/version.rb
+- ruby_beans.gemspec
+homepage: https://github.com/sebyx07/rubybeans
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: simple to use and test dependency injection framework
+test_files: []