fixturama 0.1.0 → 0.2.0

data/lib/fixturama/seed.rb

@@ -1,15 +0,0 @@
-module Fixturama
-  module Seed
-    module_function
-
-    def call(opts)
-      opts   = Utils.symbolize_hash(opts)
-      type   = opts[:type].to_sym
-      traits = Utils.symbolize_array opts[:traits]
-      params = Utils.symbolize_hash  opts[:params]
-      count  = opts.fetch(:count, 1).to_i
-
-      FactoryBot.create_list(type, count, *traits, **params) if count.positive?
-    end
-  end
-end

data/lib/fixturama/stubs.rb

@@ -1,79 +0,0 @@
-module Fixturama
-  #
-  # Collection of stubbed calls
-  #
-  class Stubs
-    require_relative "stubs/chain"
-    require_relative "stubs/const"
-    require_relative "stubs/request"
-
-    #
-    # Register new action and apply the corresponding stub
-    #
-    # @params [Hash<#to_s, _>] options
-    # @return [self] itself
-    #
-    def add(options)
-      options = symbolize(options)
-      find_or_create_stub!(options)&.update!(options)
-      self
-    end
-
-    #
-    # Applies the stub to RSpec example
-    #
-    def apply(example)
-      @stubs.values.each { |stub| stub.apply!(example) }
-    end
-
-    private
-
-    def initialize
-      @stubs = {}
-    end
-
-    def find_or_create_stub!(options)
-      stub = case stub_type(options)
-             when :message_chain then Chain.new(options)
-             when :constant      then Const.new(options)
-             when :request       then Request.new(options)
-             end
-
-      @stubs[stub.key] ||= stub if stub
-    end
-
-    def stub_type(options)
-      key = (TYPES.keys & options.keys).first
-      return TYPES[key] if key
-
-      raise ArgumentError, <<~MESSAGE
-        Cannot figure out what to stub from #{options}.
-        You should define either a class and a message chain, or some const.
-      MESSAGE
-    end
-
-    # Matches keys to the type of the stub
-    TYPES = {
-      arguments: :message_chain,
-      actions: :message_chain,
-      basic_auth: :request,
-      body: :request,
-      chain: :message_chain,
-      class: :message_chain,
-      const: :constant,
-      headers: :request,
-      http_method: :request,
-      object: :message_chain,
-      query: :request,
-      response: :request,
-      responses: :request,
-      uri: :request,
-      url: :request,
-      value: :constant,
-    }.freeze
-
-    def symbolize(options)
-      Hash(options).transform_keys { |key| key.to_s.to_sym }
-    end
-  end
-end

data/lib/fixturama/stubs/chain.rb

@@ -1,90 +0,0 @@
-module Fixturama
-  #
-  # Stubbed chain of messages
-  #
-  class Stubs::Chain
-    require_relative "chain/actions"
-    require_relative "chain/arguments"
-
-    attr_reader :receiver, :messages
-
-    #
-    # Human-readable representation of the chain
-    # @return [String]
-    #
-    def to_s
-      "#{receiver}.#{messages.join(".")}"
-    end
-    alias to_str to_s
-    alias key to_s
-
-    #
-    # Register new action for some arguments
-    #
-    # @option [Array<#to_s>, #to_s] :arguments The specific arguments
-    # @option (see Fixturama::Stubs::Arguments#add_action)
-    # @return [self]
-    #
-    def update!(actions:, arguments: nil, **)
-      Utils.array(arguments).tap do |args|
-        stub = find_by(args)
-        unless stub
-          stub = Stubs::Chain::Arguments.new(self, args)
-          stubs << stub
-        end
-        stub.add!(*actions)
-        stubs.sort_by! { |stub| -stub.arguments.count }
-      end
-
-      self
-    end
-
-    #
-    # Apply the stub to RSpec example
-    #
-    def apply!(example)
-      reset!
-
-      call_action = example.send(:receive_message_chain, *messages) do |*args|
-        call! args
-      end
-
-      example.send(:allow, receiver).to call_action
-    end
-
-    private
-
-    def initialize(**options)
-      @receiver = Utils.constantize options[:class] if options.key?(:class)
-      @receiver ||= Object.send :eval, options[:object] if options.key?(:object)
-      raise SyntaxError, "Undefined receiver of messages" unless receiver
-
-      @messages = Utils.symbolize_array options[:chain]
-      return if messages.any?
-
-      raise SyntaxError, <<~MESSAGE.squish
-        Undefined message chain for stubbing #{receiver}.
-        Use option `chain` to define it.
-      MESSAGE
-    end
-
-    def stubs
-      @stubs ||= []
-    end
-
-    def find_by(arguments)
-      stubs.find { |stub| stub.arguments == arguments }
-    end
-
-    def reset!
-      tap { stubs.each(&:reset!) }
-    end
-
-    def call!(actual_arguments)
-      stub = stubs.find { |item| item.applicable_to?(actual_arguments) }
-      raise "Unexpected arguments #{actual_arguments}" unless stub
-
-      stub.call_next!
-    end
-  end
-end

data/lib/fixturama/stubs/chain/actions.rb

@@ -1,39 +0,0 @@
-module Fixturama
-  #
-  # Factory to provide a specific action from options
-  #
-  module Stubs::Chain::Actions
-    extend self
-
-    require_relative "actions/raise"
-    require_relative "actions/return"
-
-    #
-    # Builds an action
-    # @option [#to_s]  :raise
-    # @option [Object] :return
-    # @option [true]   :call_original
-    # @return [#call] a callable action
-    #
-    def build(stub, **options)
-      check!(stub, options)
-      key, value = options.to_a.first
-      TYPES[key].new(stub, value)
-    end
-
-    private
-
-    def check!(stub, options)
-      keys = options.keys & TYPES.keys
-      return if keys.count == 1
-
-      raise SyntaxError, <<~MESSAGE.squish
-        Invalid settings for stubbing message chain #{stub}: #{options}.
-        The action MUST have one and only one of the keys:
-        `#{TYPES.keys.join('`, `')}`.
-      MESSAGE
-    end
-
-    TYPES = { raise: Raise, return: Return }.freeze
-  end
-end

data/lib/fixturama/stubs/chain/actions/raise.rb

@@ -1,21 +0,0 @@
-class Fixturama::Stubs::Chain::Actions::Raise
-  def call
-    raise @exception
-  end
-
-  #
-  # Human-readable representation of the expectation
-  # @return [String]
-  #
-  def to_s
-    "#{@stub} # raise #{@exception}"
-  end
-
-  private
-
-  def initialize(stub, name)
-    @stub = stub
-    name = name.to_s
-    @exception = name == "true" ? StandardError : Kernel.const_get(name)
-  end
-end

data/lib/fixturama/stubs/chain/actions/return.rb

@@ -1,23 +0,0 @@
-class Fixturama::Stubs::Chain::Actions::Return
-  attr_reader :stub, :call
-
-  #
-  # Human-readable representation of the expectation
-  # @return [String]
-  #
-  def to_s
-    "#{@stub} # => #{call}"
-  end
-
-  private
-
-  def initialize(stub, output)
-    @stub = stub
-    @call = \
-      begin # in ruby 2.3.0 Fixnum#dup is defined, but raises TypeError
-        output.respond_to?(:dup) ? output.dup : output
-      rescue TypeError
-        output
-      end
-  end
-end

data/lib/fixturama/stubs/chain/arguments.rb

@@ -1,86 +0,0 @@
-module Fixturama
-  #
-  # Collection of arguments for a stub with a list of actions to be called
-  #
-  class Stubs::Chain::Arguments
-    attr_reader :chain, :arguments
-
-    #
-    # Register new action for these set of arguments
-    # @option [#to_i] :repeat (1)
-    #   How much the action should be repeated during the consecutive calls
-    # @return [self] itself
-    #
-    def add!(*actions)
-      actions.each do |settings|
-        settings = Utils.symbolize_hash(settings)
-        repeat   = [0, settings.fetch(:repeat, 1).to_i].max
-        repeat.times { list << Stubs::Chain::Actions.build(self, settings) }
-      end
-
-      self
-    end
-
-    #
-    # Whether the current stub is applicable to actual arguments
-    # @param  [Array<Object>] actual_arguments
-    # @return [Boolean]
-    #
-    def applicable_to?(actual_arguments)
-      last_index = actual_arguments.count
-      @arguments.zip(actual_arguments)
-                .each.with_index(1)
-                .reduce(true) do |obj, ((expected, actual), index)|
-                  obj && (
-                    expected == actual ||
-                    index == last_index &&
-                    Fixturama::Utils.matched_hash_args?(actual, expected)
-                  )
-                end
-    end
-
-    #
-    # Reset the counter of calls
-    # @return [self] itself
-    #
-    def reset!
-      @counter = 0
-      self
-    end
-
-    #
-    # Calls the next action for these set of agruments
-    # @return [Object]
-    # @raise  [StandardError]
-    #
-    def call_next!
-      list.fetch(counter) { list.last }.call.tap { @counter += 1 }
-    end
-
-    #
-    # Human-readable representation of arguments
-    # @return [String]
-    #
-    def to_s
-      args = [*arguments.map(&:to_s), "*"].join(", ")
-      "#{chain}(#{args})"
-    end
-
-    private
-
-    # @param [Fixturama::Stubs::Chain] chain Back reference
-    # @param [Array<Object>] list Definition of arguments
-    def initialize(chain, list)
-      @chain     = chain
-      @arguments = Utils.array(list)
-    end
-
-    def counter
-      @counter ||= 0
-    end
-
-    def list
-      @list ||= []
-    end
-  end
-end

data/lib/fixturama/stubs/const.rb

@@ -1,43 +0,0 @@
-module Fixturama
-  #
-  # Definition for stubbing a constant
-  #
-  class Stubs::Const
-    attr_reader :const, :value
-
-    #
-    # Human-readable representation of the chain
-    # @return [String]
-    #
-    def to_s
-      const.to_s
-    end
-    alias to_str to_s
-    alias key to_s
-
-    #
-    # Overload the definition for the constant
-    # @option [Object] value
-    # @return [self]
-    #
-    def update!(value:, **)
-      @value = value
-      self
-    end
-
-    #
-    # Apply the stub to RSpec example
-    # @return [self]
-    #
-    def apply!(example)
-      example.send(:stub_const, const, value)
-      self
-    end
-
-    private
-
-    def initialize(const:, **)
-      @const = const.to_s
-    end
-  end
-end

data/lib/fixturama/stubs/request.rb

@@ -1,98 +0,0 @@
-#
-# Stubbed request
-#
-class Fixturama::Stubs::Request
-  require_relative "request/response"
-  require_relative "request/responses"
-
-  def to_s
-    "#{http_method.upcase} #{uri.to_s == "" ? "*" : uri}"
-  end
-  alias to_str to_s
-
-  # every stub is unique
-  alias key hash
-  def update!(_); end
-
-  def apply!(example)
-    stub = example.stub_request(http_method, uri)
-    stub = stub.with(request) if request.any?
-    stub.to_return { |_| responses.next }
-  end
-
-  private
-
-  attr_reader :options
-
-  def initialize(options)
-    @options = options
-    with_error { @options = Hash(options).symbolize_keys }
-  end
-
-  HTTP_METHODS = %i[get post put patch delete head options any].freeze
-
-  def http_method
-    value = with_error("method") { options[:method]&.to_sym&.downcase } || :any
-    return value if HTTP_METHODS.include?(value)
-
-    raise ArgumentError, "Invalid HTTP method #{value} in #{@optons}"
-  end
-
-  def uri
-    with_error("uri") { maybe_regexp(options[:uri] || options[:url]) }
-  end
-
-  def headers
-    with_error("headers") do
-      Hash(options[:headers]).transform_keys(&:to_s) if options.key?(:headers)
-    end
-  end
-
-  def query
-    with_error("query") do
-      Hash(options[:query]).transform_keys(&:to_s) if options.key?(:query)
-    end
-  end
-
-  def body
-    with_error("body") do
-      case options[:body]
-      when NilClass then nil
-      when Hash then options[:body]
-      else maybe_regexp(options[:body])
-      end
-    end
-  end
-
-  def basic_auth
-    with_error("basic auth") do
-      value = options[:auth] || options[:basic_auth]
-      Hash(value).transform_keys(&:to_s).values_at("user", "pass") if value
-    end
-  end
-
-  def request
-    @request ||= {
-      headers: headers,
-      body: body,
-      query: query,
-      basic_auth: basic_auth
-    }.select { |_, val| val }
-  end
-
-  def responses
-    @responses ||= Responses.new(options[:response] || options[:responses])
-  end
-
-  def with_error(part = nil)
-    yield
-  rescue RuntimeError
-    message = ["Cannot extract a request", part, "from #{options}"].join(" ")
-    raise ArgumentError, message, __FILE__, __LINE__ - 1
-  end
-
-  def maybe_regexp(str)
-    str = str.to_s
-    str[%r{\A/.*/\z}] ? Regexp.new(str[1..-2]) : str
-  end
-end