ringu 0.1.0.pre.alpha

data/example/config/master.key

@@ -0,0 +1 @@
+65a6628c04584f2f6e427511c4de57bd

data/example/config/puma.rb

@@ -0,0 +1,43 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+#
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/example/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  resources :characters, only: :index
+  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
+end

data/example/db/schema.rb

@@ -0,0 +1,15 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+end

data/example/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/example/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/example/test/controllers/characters_controller_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class CharactersControllerTest < ActionDispatch::IntegrationTest
+  setup do
+    @mock_fetcher = mock('object')
+    Container.deps.replace(:characters_fetcher, @mock_fetcher)
+
+  end
+
+  teardown do
+    Container.deps.restore!
+  end
+
+  test "should get index" do
+    characters = []
+    @mock_fetcher.expects(:fetch).returns(characters)
+
+    get characters_url, as: :json
+
+    assert_response :success
+    assert response.body == '[]'
+  end
+end

data/example/test/fetchers/characters_fetcher_test.rb

@@ -0,0 +1,31 @@
+require "test_helper"
+require "minitest/mock"
+
+def stub()
+  mock = MiniTest::Mock.new
+  mock.expect(:is_a?, data, [CharactersFetcher::URL])
+end
+
+class CharactersFetcherTest < ActiveSupport::TestCase
+  setup do
+    @mock_client = mock('object')
+    @mock_parser = mock('object')
+    
+    @subject = CharactersFetcher.new(
+      http_client: @mock_client,
+      characters_parser: @mock_parser
+    )
+  end
+
+  test "should parse characters returns characters" do
+    data = OpenStruct.new body: '[]'
+    characters = []
+
+    @mock_client.expects(:get).with(CharactersFetcher::URL).returns(data)
+    @mock_parser.expects(:parse).returns(characters)
+    
+    results = @subject.fetch
+  
+    assert results == characters
+  end
+end

data/example/test/parsers/characters_parser_test.rb

@@ -0,0 +1,37 @@
+require "test_helper"
+
+class CharactersParserTest < ActiveSupport::TestCase
+  setup do
+    @subject = CharactersParser.new
+  end
+
+  test "should parse characters" do
+    data = <<-JSON
+      { 
+        "results": [
+          { "id": 1, "name": "character 1", "image": "/image1.jpg"},
+          { "id": 2, "name": "character 2", "image": "/image2.jpg"}
+        ]
+      }
+    JSON
+
+    results = @subject.parse(data)
+
+    assert results.length == 2
+    
+    assert results[0][:id] == 1
+    assert results[0][:name] == 'character 1'
+    assert results[0][:image] == '/image1.jpg'
+    
+    assert results[1][:id] == 2
+    assert results[1][:name] == 'character 2'
+    assert results[1][:image] == '/image2.jpg'
+  end  
+  
+  test "should return empty array when result is null" do
+    data = '{ "results": null }'
+    results = @subject.parse(data)
+
+    assert results.length == 0
+  end  
+end

data/example/test/test_helper.rb

@@ -0,0 +1,15 @@
+ENV['RAILS_ENV'] ||= 'test'
+require_relative "../config/environment"
+require "rails/test_help"
+require 'mocha/minitest'
+
+
+class ActiveSupport::TestCase
+  # Run tests in parallel with specified workers
+  parallelize(workers: :number_of_processors)
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/lib/ringu.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "ringu/version"
+require_relative "ringu/deps"
+require_relative "ringu/container"
+require_relative "ringu/injector"
+require_relative "ringu/resolver"
+
+module Ringu
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/ringu/container.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# TODO: add tests
+module Ringu
+  module Container
+    def self.included(base)
+      base.extend(ClassMethods)
+      const_set "Inject", Ringu::Injector.create(base.deps)
+      const_set "Resolve", Ringu::Resolver.create(base.deps)
+    end
+
+    module ClassMethods
+      def deps
+        @deps ||= Ringu::Deps.new
+      end
+
+      def register(name, value)
+        deps.register(name, value)
+      end
+
+      def resolve(name)
+        deps.resolve(name)
+      end
+    end
+  end
+end

data/lib/ringu/deps.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "dry-container"
+
+# TODO: add tests
+module Ringu
+  class Deps
+    def initialize
+      @deps = {}
+      @backup = {}
+    end
+
+    def restore!
+      @backup.each do |key, value|
+        @deps[key] = value
+      end
+    end
+
+    def register(key, value)
+      @deps[key] = value
+    end
+
+    def replace(key, value)
+      raise "\"#{key}\" key does not exist" \
+        unless @deps.key?(key)
+
+      @backup[key] = @deps[key]
+      @deps[key] = value
+    end
+
+    def resolve(key, term = nil)
+      value = term || @deps.fetch(key)
+
+      value.is_a?(Class) ? value.new : value
+    end
+  end
+end

data/lib/ringu/injector.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# TODO: add tests
+module Ringu
+  module Injector
+    extend self
+
+    def create(deps)
+      Module.new do
+        define_method(:deps) { deps }
+
+        def self.included(klass)
+          klass.extend ClassMethods
+          klass.send :include, InstanceMethods
+        end
+      end
+    end
+
+    module ClassMethods
+      def inject(name, klass = nil)
+        attr_accessor name
+
+        injector[name] = {
+          klass: klass
+        }
+      end
+
+      def injector
+        @injector ||= {}
+      end
+    end
+
+    module InstanceMethods
+      def initialize(**kwargs)
+        self.class.injector.each do |name, options|
+          term = kwargs[name] || options[:klass]
+          resource = deps.resolve(name, term)
+          instance_variable_set("@#{name}", resource)
+        end
+      end
+    end
+  end
+end

data/lib/ringu/resolver.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# TODO: add tests
+module Ringu
+  module Resolver
+    extend self
+
+    def create(deps)
+      Module.new do
+        define_method(:deps) { deps }
+
+        def self.included(klass)
+          klass.extend ClassMethods
+        end
+      end
+    end
+
+    module ClassMethods
+      def resolve(name)
+        define_method(name) do
+          var_name = "@#{name}"
+
+          return instance_variable_get(var_name) \
+            if instance_variable_defined?(var_name)
+
+          instance_variable_set(var_name, deps.resolve(name))
+        end
+      end
+    end
+  end
+end

data/lib/ringu/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ringu
+  VERSION = "0.1.0-alpha"
+end

data/ringu.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/ringu/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ringu"
+  spec.version       = Ringu::VERSION
+  spec.authors       = ["Ramón Soto"]
+
+  spec.summary       = "Dependency Injection for ruby"
+  spec.description   = "A simple dependency injection framework for ruby"
+  spec.homepage      = "http://github.com/clouw/ringu"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = ""
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ringu
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha
+platform: ruby
+authors:
+- Ramón Soto
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-29 00:00:00.000000000 Z
+dependencies: []
+description: A simple dependency injection framework for ruby
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/.ruby-version
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.md
+- example/Rakefile
+- example/app/controllers/application_controller.rb
+- example/app/controllers/characters_controller.rb
+- example/app/controllers/concerns/.keep
+- example/app/deps/container.rb
+- example/app/fetchers/characters_fetcher.rb
+- example/app/models/application_record.rb
+- example/app/models/concerns/.keep
+- example/app/parsers/characters_parser.rb
+- example/bin/bundle
+- example/bin/rails
+- example/bin/rake
+- example/bin/setup
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/credentials.yml.enc
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/application_controller_renderer.rb
+- example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/cors.rb
+- example/config/initializers/filter_parameter_logging.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/mime_types.rb
+- example/config/initializers/wrap_parameters.rb
+- example/config/locales/en.yml
+- example/config/master.key
+- example/config/puma.rb
+- example/config/routes.rb
+- example/db/schema.rb
+- example/db/seeds.rb
+- example/lib/tasks/.keep
+- example/public/robots.txt
+- example/test/controllers/.keep
+- example/test/controllers/characters_controller_test.rb
+- example/test/fetchers/characters_fetcher_test.rb
+- example/test/fixtures/files/.keep
+- example/test/integration/.keep
+- example/test/models/.keep
+- example/test/parsers/characters_parser_test.rb
+- example/test/test_helper.rb
+- example/vendor/.keep
+- lib/ringu.rb
+- lib/ringu/container.rb
+- lib/ringu/deps.rb
+- lib/ringu/injector.rb
+- lib/ringu/resolver.rb
+- lib/ringu/version.rb
+- ringu.gemspec
+homepage: http://github.com/clouw/ringu
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/clouw/ringu
+  source_code_uri: http://github.com/clouw/ringu
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Dependency Injection for ruby
+test_files: []