rioc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efed84a16947db44557f740b62addf35ecdef117110fa990d259afcdbf67872c
+  data.tar.gz: d14427e1bbaec55297a4f0a168c174754eb8f66daf24a849048bb0c9604e58d7
+SHA512:
+  metadata.gz: 74d8089c4ee489fad5f0b8318d8ba2c69dec13d49a4ffc15da27bd9c07377740f78e168793175ca0bd4571e18fbffd1b55a20ae3d2e871d9b6b77055e6f907b7
+  data.tar.gz: a962bd56ee4deae777cf76b089789abd195ccbc1167720af78981ab056d861fff182776c2c43748839fd077fc6f9214345d0b773e0802846ac34c9452371828e

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/EndOfLine:
+  EnforcedStyle: native
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dwcaa0633@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rioc.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    rioc (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rioc!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 cty
+
+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,90 @@
+# Rioc
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rioc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rioc
+
+## Usage
+
+The user experience will be closer to C# Autofac framework. Suppose you want to build a webapp using the repository pattern, here's a typical usecase,
+
+```ruby
+# Initialize a container
+container = Rioc::RiocContainer.new
+
+# Specify the controller to the IoC container, suppose your controller looks like the following
+# 
+# class BusinessController
+#   def initialize(repository)
+#     @repository = repository
+#   end
+#   
+#   def save(text)
+#     @repository.save(text)
+#   end
+# end
+# 
+# Typically for most web application frameworks, the controller is one instance per request, and it
+# would translate to Transient scope in RIOC
+container.register(:biz_controller, scope: Rioc::Bean::Scope::TRANSIENT) do |c| 
+    BusinessController.new(c.resolve(:repository))
+end
+
+# Now you need to have the repository dependency setup so that it can be consumed by the controller
+# and typically repository is Singleton as in Guice or Spring in Java. Suppose the repository looks
+# like this
+# 
+# class Repository
+#   def initialize(credential)
+#     @credential = credential
+#   end
+# end
+#
+# And RIOC uses Singleton scope by default.
+container.register(:repository) { |c| Repository.new(c.resolve(:credential)) }
+
+# Now register the credential, let's assume the credential is an parameterless object
+container.register(:credential) { |_| Credential.create("username", "password") }
+
+# Build container
+container.build_container
+
+# Now we have all dependencies we need registered into the container, we can use them by
+biz_con = container.resolve(:biz_controller)
+biz_con.save("Hello RIOC")
+
+# Of course you can also resolve repository and credential
+repo = container.resolve(:repository)
+cred = container.resolve(:credential)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/rioc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rioc/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rioc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rioc/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,8 @@
+require 'rioc/container'
+require 'rioc/application'
+require 'rioc/version'
+
+# Root module of Rioc library
+module Rioc
+
+end

data/lib/rioc/application.rb

@@ -0,0 +1,15 @@
+require 'rioc/errors'
+
+module Rioc
+
+  # RiocApplication class
+  class RiocApplication
+
+    # This function should be implemented by user
+    def application_start
+      raise Errors::ApplicationUndeclaredError
+    end
+
+  end
+
+end

data/lib/rioc/bean/bean.rb

@@ -0,0 +1,27 @@
+module Rioc
+  module Bean
+    # Defines the scope of the bean
+    class Scope
+      # Single instance throughout the entire lifetime of the framework.
+      SINGLETON = :singleton
+
+      # Create a new instance every time the bean is requested to be resolved.
+      TRANSIENT = :transient
+    end
+
+    # RiocBean class
+    class RiocBean
+
+      attr_reader :name, :factory, :scope, :lazy
+
+      def initialize(name, factory, scope, lazy)
+        @name = name
+        @factory = factory
+        @scope = scope
+        @lazy = lazy
+      end
+
+    end
+
+  end
+end

data/lib/rioc/bean/factory.rb

@@ -0,0 +1,19 @@
+module Rioc
+  module Bean
+    class BeanFactory
+
+      # Initialize the dependency factory class to build the dependency
+      # whenever the dependency is needed.
+      def initialize(container, name, block)
+        @container = container
+        @name = name
+        @block = block
+      end
+
+      def build_instance
+        @block.call(@container)
+      end
+
+    end
+  end
+end

data/lib/rioc/container.rb

@@ -0,0 +1,98 @@
+require 'rioc/bean/bean'
+require 'rioc/bean/factory'
+require 'rioc/errors'
+require 'set'
+
+module Rioc
+  # Rioc container class that is responsible for storing all the beans definitions as well as live instance
+  # of the beans declared.
+  class RiocContainer
+
+    # Initialize the IoC container
+    def initialize
+      @container = {}
+      @beans = {}
+      @in_recursion = false
+
+      # Used to resolve dependencies
+      @visited = Set.new
+      @built = Set.new
+    end
+
+    # Register a instance without any need of resolving dependencies
+    def register(name, scope: Rioc::Bean::Scope::SINGLETON, lazy: false, &block)
+      @beans[name] = Rioc::Bean::RiocBean.new(name,
+                                              Rioc::Bean::BeanFactory.new(self, name, block),
+                                              scope,
+                                              lazy)
+
+    end
+
+    # Resolve bean with the provided bean name
+    # @param name - The name of the bean to resolve
+    # @return A live instance of the bean definition
+    def resolve(name)
+      # Should panic if the bean name is never registered
+      raise UnknownDependencyNameError, name unless @beans[name]
+
+      bean = @beans[name]
+
+      # If the bean already exists in the container and the scope is singleton,
+      # directly return the bean instance
+      return @container[name] if @container[name] && bean.scope == Rioc::Bean::Scope::SINGLETON
+
+      # Call the internal function to create the bean instance and return it
+      resolve_bean(name)
+    end
+
+    # Build container
+    def build_container
+      @beans
+        .reject { |name| @beans[name].lazy }
+        .each { |name, _| resolve(name) }
+    end
+
+    # Start application
+    def start_application; end
+
+    private
+
+    # Internal method to resolve bean if the bean doesn't have an instance
+    # in container or the bean is transient.
+    def resolve_bean(bean)
+      # We need to know if we are recursively resolving the dependencies
+      # in order to detect cyclic dependencies
+      unless @in_recursion
+        @in_recursion = true
+        clear_dfs_history
+
+        instance = build_bean(bean)
+
+        @in_recursion = false
+        clear_dfs_history
+        return instance
+      end
+
+      # Check if it has cyclic dependency
+      raise Rioc::Errors::CyclicDependencyError, bean if @visited.include?(bean) && !@built.include?(bean)
+
+      # Resolve current dependencies before building the instance
+      build_bean(bean)
+    end
+
+    # Internal method to instantiate a new bean
+    def build_bean(bean)
+      @visited.add(bean)
+      instance = @beans[bean].factory.build_instance
+      @container[bean] = instance if @beans[bean].scope == Rioc::Bean::Scope::SINGLETON
+      @built.add(bean)
+      instance
+    end
+
+    # Internal method to clear the history of the DFS search to resolve a bean
+    def clear_dfs_history
+      @visited.clear
+      @built.clear
+    end
+  end
+end

data/lib/rioc/errors.rb

@@ -0,0 +1,26 @@
+module Rioc
+
+  module Errors
+
+    # ApplicationUndeclaredError
+    class ApplicationUndeclaredError < RuntimeError
+      def initialize
+        super('Application is not declared by user')
+      end
+    end
+
+    class CyclicDependencyError < RuntimeError
+      def initialize(name)
+        super("Cyclic dependency detected at #{name}")
+      end
+    end
+
+    # UnknownDependencyNameError
+    class UnknownDependencyNameError < StandardError
+      def initialize(name)
+        super(msg: "Unknown dependency: #{name}, #{name} is not registered in RIOC container, ")
+      end
+    end
+
+  end
+end

data/lib/rioc/version.rb

@@ -0,0 +1,3 @@
+module Rioc
+  VERSION = '0.1.0'.freeze
+end

data/rioc.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/rioc/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rioc'
+  spec.version = Rioc::VERSION
+  spec.authors = ['cty']
+  spec.email = ['ctychen2216@gmail.com']
+
+  spec.summary = 'Ruby IoC container framework'
+  spec.description = 'Ruby Ioc container framework'
+  spec.homepage = 'https://github.com/cty123/RIOC'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/cty123/RIOC'
+  spec.metadata['changelog_uri'] = 'https://github.com/cty123/RIOC/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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']
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rioc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cty
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-04 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Ioc container framework
+email:
+- ctychen2216@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rioc.rb
+- lib/rioc/application.rb
+- lib/rioc/bean/bean.rb
+- lib/rioc/bean/factory.rb
+- lib/rioc/container.rb
+- lib/rioc/errors.rb
+- lib/rioc/version.rb
+- rioc.gemspec
+homepage: https://github.com/cty123/RIOC
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cty123/RIOC
+  source_code_uri: https://github.com/cty123/RIOC
+  changelog_uri: https://github.com/cty123/RIOC/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby IoC container framework
+test_files: []