plumbum 0.1.0

data/lib/plumbum/rspec/deferred.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'plumbum/rspec'
+
+module Plumbum::RSpec
+  # Namespace for deferred example groups that assert on Plumbum objects.
+  module Deferred; end
+end

data/lib/plumbum/rspec/stub_provider.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'sleeping_king_studios/tools/toolbox/mixin'
+
+require 'plumbum/rspec'
+
+module Plumbum::RSpec
+  # Helper methods for stubbing the values of Plumbum providers in RSpec tests.
+  module StubProvider
+    extend SleepingKingStudios::Tools::Toolbox::Mixin
+
+    # Class methods to extend when including StubProvider.
+    module ClassMethods
+      # (see Plumbum::RSpec::StubProvider#stub_provider)
+      def stub_provider(provider, key, value)
+        before(:example) { stub_provider(provider, key, value) }
+      end
+    end
+
+    class << self
+      # Verifies the provider has the given key.
+      #
+      # @param provider [Plumbum::Provider] the provider to stub.
+      # @param key [String, Symbol] the key to verify.
+      #
+      # @return void
+      #
+      # @raise [ArgumentError] if the key is not a valid String or Symbol.
+      # @raise [Plumbum::Errors::InvalidKeyError] if the key is not supported
+      #   by the provider.
+      def validate_key(provider, key)
+        SleepingKingStudios::Tools::Toolbelt
+          .instance
+          .assertions
+          .validate_name(key, as: :key)
+
+        return if provider.has?(key)
+
+        return if provider.send(:raw_value, key.to_s) == Plumbum::UNDEFINED
+
+        provider_name =
+          provider.respond_to?(:name) ? provider.name : provider.class.name
+
+        raise Plumbum::Errors::InvalidKeyError,
+          "invalid key #{key.inspect} for #{provider_name}"
+      end
+    end
+
+    # Stubs the value of a specific key for a provider for the current spec.
+    #
+    # @param provider [Plumbum::Provider] the provider to stub.
+    # @param key [String, Symbol] the key to stub.
+    # @param value [Object] the temporary value to assign for the key.
+    #
+    # @return [Symbol] the stubbed key.
+    #
+    # @raise [Plumbum::Errors::InvalidKeyError] if the key is not supported by
+    #   the provider.
+    def stub_provider(provider, key, value) # rubocop:disable Metrics/AbcSize
+      StubProvider.validate_key(provider, key)
+
+      unless RSpec::Mocks.space.registered?(provider)
+        allow(provider).to receive(:get).and_call_original
+        allow(provider).to receive(:has?).and_call_original
+      end
+
+      presence = value != Plumbum::UNDEFINED
+
+      allow(provider).to receive(:get).with(key.to_s).and_return(value)
+      allow(provider).to receive(:get).with(key.to_sym).and_return(value)
+      allow(provider).to receive(:has?).with(key.to_s).and_return(presence)
+      allow(provider).to receive(:has?).with(key.to_sym).and_return(presence)
+    end
+  end
+end

data/lib/plumbum/rspec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'plumbum'
+
+module Plumbum
+  # Namespace for RSpec examples for testing Plumbum implementations.
+  module RSpec; end
+end

data/lib/plumbum/version.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Plumbum
+  # @api private
+  #
+  # The current version of the gem.
+  #
+  # @see http://semver.org/
+  module Version
+    # Major version.
+    MAJOR = 0
+    # Minor version.
+    MINOR = 1
+    # Patch version.
+    PATCH = 0
+    # Prerelease version.
+    PRERELEASE = nil
+    # Build metadata.
+    BUILD = nil
+
+    class << self
+      # Generates the gem version string from the Version constants.
+      #
+      # Inlined here because dependencies may not be loaded when processing a
+      # gemspec, which results in the user being unable to install the gem for
+      # the first time.
+      #
+      # @see SleepingKingStudios::Tools::SemanticVersion#to_gem_version
+      def to_gem_version
+        str = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+        prerelease = value_of(:PRERELEASE)
+        str = "#{str}.#{prerelease}" if prerelease
+
+        build = value_of(:BUILD)
+        str = "#{str}.#{build}" if build
+
+        str
+      end
+
+      private
+
+      def value_of(constant)
+        return nil unless const_defined?(constant)
+
+        value = const_get(constant)
+
+        return nil if value.respond_to?(:empty?) && value.empty?
+
+        value
+      end
+    end
+  end
+
+  # The current version of the gem.
+  VERSION = Version.to_gem_version
+end

data/lib/plumbum.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Dependency injection and management library for Ruby.
+module Plumbum
+  autoload :Consumer,     'plumbum/consumer'
+  autoload :Consumers,    'plumbum/consumers'
+  autoload :Errors,       'plumbum/errors'
+  autoload :ManyProvider, 'plumbum/many_provider'
+  autoload :OneProvider,  'plumbum/one_provider'
+  autoload :Parameters,   'plumbum/parameters'
+  autoload :Provider,     'plumbum/provider'
+  autoload :Providers,    'plumbum/providers'
+
+  # Object representing an undefined or uninitialized value.
+  UNDEFINED = Object.new.freeze
+
+  class << self
+    # @return [String] the current version of the gem.
+    def version
+      VERSION
+    end
+  end
+end
+
+require 'plumbum/version'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: plumbum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob "Merlin" Smith
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sleeping_king_studios-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |-
+  A minimal dependency injection framework for Ruby, using vanilla Ruby
+  semantics to define and reference dependencies from different providers.
+email:
+- merlin@sleepingkingstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- lib/plumbum.rb
+- lib/plumbum/consumer.rb
+- lib/plumbum/consumers.rb
+- lib/plumbum/consumers/class_methods.rb
+- lib/plumbum/consumers/instance_methods.rb
+- lib/plumbum/consumers/scoped_consumer.rb
+- lib/plumbum/errors.rb
+- lib/plumbum/errors/immutable_error.rb
+- lib/plumbum/errors/invalid_dependency_error.rb
+- lib/plumbum/errors/invalid_key_error.rb
+- lib/plumbum/errors/missing_dependency_error.rb
+- lib/plumbum/many_provider.rb
+- lib/plumbum/one_provider.rb
+- lib/plumbum/parameters.rb
+- lib/plumbum/provider.rb
+- lib/plumbum/providers.rb
+- lib/plumbum/providers/lazy.rb
+- lib/plumbum/providers/plural.rb
+- lib/plumbum/providers/singular.rb
+- lib/plumbum/rspec.rb
+- lib/plumbum/rspec/deferred.rb
+- lib/plumbum/rspec/deferred/consumer_examples.rb
+- lib/plumbum/rspec/deferred/provider_examples.rb
+- lib/plumbum/rspec/stub_provider.rb
+- lib/plumbum/version.rb
+homepage: http://sleepingkingstudios.com
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/sleepingkingstudios/plumbum/issues
+  source_code_uri: https://github.com/sleepingkingstudios/plumbum
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: A dependency injection and management library for Ruby.
+test_files: []