malfunction 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b6142e51495b2460012abc9944a9987683f3d933d7f1f84f3f25b8321cc907
-  data.tar.gz: e13834fbeb64a1a751adccc035a75ddc85cc03c76c7cdc8b5daf6391d48194dd
+  metadata.gz: 291855d70297ba991d40e72253a04dd4fc356ba2a3882d53ba61a9c8919693ec
+  data.tar.gz: 93e6f3406c3c4b25d0a2a0a929ee577472b7e2654b376873de0fffd46e2c179b
 SHA512:
-  metadata.gz: d63564b93f0d409a2256d1e180902ee5ff4153080c2519c51509424cf593ff0d7d4d51c94fb58fa0d567f2a28c0c88c4d9b5880592eef67e65755f2b90c29248
-  data.tar.gz: d1b9157061ce5a63c666cf887f19a826870bf3815b35753bdf2bb112c379c671959336d080172b8382809cc271093eac3542b93a27128ea6164ef1306b1fe9b7
+  metadata.gz: 7b2d4c278613f1f92798773c47583e20f40a9126351488d0a59b8357fbd6d52152fbf03b9d5db60b90a8c2a12c21279bb71608583402941a9b663ca554a6b251
+  data.tar.gz: 57dd0ba88f4a6d8109fd9c9ff6112ac353aba3c23f10ea5b242075e35b313ab01c31958ee8474b89d5fc38c5cb5be961579cbd55a77de1a125ef845864656025

data/README.md

@@ -3,6 +3,9 @@
 An extensible way to encapsulate the variety of BadStuff that happens in Rails applications
 
 [![Gem Version](https://badge.fury.io/rb/malfunction.svg)](https://badge.fury.io/rb/malfunction)
+[![Build Status](https://semaphoreci.com/api/v1/freshly/malfunction/branches/develop/badge.svg)](https://semaphoreci.com/freshly/malfunction)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9cd538174249bb6b1798/maintainability)](https://codeclimate.com/github/Freshly/malfunction/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9cd538174249bb6b1798/test_coverage)](https://codeclimate.com/github/Freshly/malfunction/test_coverage)
 
 * [Installation](#installation)
 * [Usage](#usage)

data/lib/malfunction/attribute_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Malfunction
+  class AttributeError < Spicerack::InputObject
+    argument :attribute_name
+    argument :error_code
+
+    option :message
+
+    def ==(other)
+      super || other.try(:attribute_name) == attribute_name && other.try(:error_code) == error_code
+    end
+    alias_method :eql?, :==
+  end
+end

data/lib/malfunction/attribute_error_collection.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Malfunction
+  class AttributeErrorCollection < Collectible::CollectionBase
+    ensures_item_class AttributeError
+  end
+end

data/lib/malfunction/malfunction/attribute_errors.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Malfunction
+  module Malfunction
+    module AttributeErrors
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :uses_attribute_errors?, to: :class
+        memoize :attribute_errors
+      end
+
+      class_methods do
+        def uses_attribute_errors?
+          @uses_attribute_errors.present?
+        end
+
+        def inherited(base)
+          base.uses_attribute_errors if uses_attribute_errors?
+          super
+        end
+
+        protected
+
+        def uses_attribute_errors
+          @uses_attribute_errors = true
+        end
+      end
+
+      def attribute_errors?
+        attribute_errors.present?
+      end
+
+      def attribute_errors
+        AttributeErrorCollection.new if uses_attribute_errors?
+      end
+
+      def add_attribute_error(attribute_name, error_code, message = nil)
+        raise ArgumentError, "#{self.class.name} does not use attribute errors" unless uses_attribute_errors?
+
+        attribute_errors << AttributeError.new(attribute_name: attribute_name, error_code: error_code, message: message)
+      end
+    end
+  end
+end

data/lib/malfunction/malfunction/builder.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Malfunction
+  module Malfunction
+    module Builder
+      extend ActiveSupport::Concern
+
+      included do
+        define_callbacks_with_handler :build
+        memoize :build
+      end
+
+      class_methods do
+        def build(*arguments)
+          new(*arguments).build
+        end
+      end
+
+      def build
+        run_callbacks(:build) { self }
+      end
+    end
+  end
+end

data/lib/malfunction/malfunction/context.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Malfunction
+  module Malfunction
+    module Context
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :contextualized?, :allow_nil_context?, to: :class
+        attr_reader :context
+      end
+
+      class_methods do
+        attr_reader :contextualized_as
+
+        def contextualized?
+          @contextualized_as.present?
+        end
+
+        def allow_nil_context?
+          contextualized? && @allow_nil_context
+        end
+
+        def inherited(base)
+          base.contextualize(@contextualized_as, allow_nil: allow_nil_context?) if contextualized?
+          super
+        end
+
+        protected
+
+        def contextualize(contextualize_as, allow_nil: false)
+          @contextualized_as = contextualize_as
+          @allow_nil_context = allow_nil
+          alias_method contextualize_as, :context
+        end
+      end
+    end
+  end
+end

data/lib/malfunction/malfunction/core.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Malfunction
+  module Malfunction
+    module Core
+      extend ActiveSupport::Concern
+
+      included do
+        delegate :problem, to: :class
+        attr_reader :details
+      end
+
+      class_methods do
+        def problem
+          prototype_name.underscore.to_sym
+        end
+      end
+
+      def initialize(context = nil, details: nil)
+        self.context = context
+        self.details = details
+      end
+
+      private
+
+      def context=(context)
+        if context.nil?
+          raise ArgumentError, "#{self.class.name} requires context" if contextualized? && !allow_nil_context?
+        else
+          raise ArgumentError, "#{self.class.name} is not contextualized" unless contextualized?
+        end
+
+        @context = context
+      end
+
+      def details=(details)
+        raise ArgumentError, "details is invalid" unless details.nil? || details.respond_to?(:to_hash)
+
+        @details = details.presence&.to_hash || {}
+      end
+    end
+  end
+end

data/lib/malfunction/malfunction_base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "malfunction/attribute_errors"
+require_relative "malfunction/context"
+require_relative "malfunction/core"
+require_relative "malfunction/builder"
+
+module Malfunction
+  class MalfunctionBase < Spicerack::RootObject
+    include Conjunction::Junction
+    suffixed_with "Malfunction"
+
+    include Malfunction::AttributeErrors
+    include Malfunction::Context
+    include Malfunction::Core
+    include Malfunction::Builder
+  end
+end

data/lib/malfunction/rspec/custom_matchers/contextualize_as.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of the default `MalfunctionBase.contextualize`
+#
+#     class FooMalfunction < Malfunction::Base
+#       contextualize :fringle
+#     end
+#
+#     class BarMalfunction < Malfunction::Base
+#       contextualize :bangle, allow_nil: true
+#     end
+#
+#     RSpec.describe FooMalfunction, type: :malfunction do
+#       it { is_expected.to contextualize_as :fringle }
+#     end
+#
+#     RSpec.describe BarMalfunction, type: :malfunction do
+#       it { is_expected.not_to contextualize_as :bangle, allow_nil: true }
+#     end
+
+RSpec::Matchers.define :contextualize_as do |contextualized_as, allow_nil: false|
+  match do
+    expect(test_subject.contextualized_as).to eq contextualized_as
+    expect(test_subject.allow_nil_context?).to eq allow_nil
+  end
+  description { "use contextualize as #{contextualized_as} with allow_nil: #{allow_nil}" }
+  failure_message do
+    "expected #{test_subject.name} to contextualize as #{contextualized_as} with allow_nil: #{allow_nil}"
+  end
+
+  def test_subject
+    subject.is_a?(Module) ? subject : subject.class
+  end
+end

data/lib/malfunction/rspec/custom_matchers/define_problem.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `MalfunctionBase.problem`
+#
+#     class FooBarMalfunction < Malfunction::Base
+#     end
+#
+#     class BazMalfunction < Malfunction::Base
+#     end
+#
+#     class CustomMalfunction < Malfunction::Base
+#       def self.problem
+#         :something_else
+#       end
+#     end
+#
+#     RSpec.describe FooBarMalfunction, type: :malfunction do
+#       it { is_expected.to define_problem :foo_bar }
+#     end
+#
+#     RSpec.describe BazMalfunction, type: :malfunction do
+#       it { is_expected.to define_problem :baz }
+#     end
+#
+#     RSpec.describe CustomMalfunction, type: :malfunction do
+#       it { is_expected.to define_problem :something_else }
+#     end
+
+RSpec::Matchers.define :define_problem do |problem|
+  match { expect(test_subject.problem).to eq problem }
+  description { "defines problem #{problem}" }
+  failure_message { "expected #{test_subject.name} to define problem #{problem}" }
+
+  def test_subject
+    subject.is_a?(Module) ? subject : subject.class
+  end
+end

data/lib/malfunction/rspec/custom_matchers/have_default_problem.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of the default `MalfunctionBase.problem`
+#
+#     class FooBarMalfunction < Malfunction::Base
+#     end
+#
+#     RSpec.describe FooBarMalfunction, type: :malfunction do
+#       it { is_expected.to have_default_problem }
+#     end
+
+RSpec::Matchers.define :have_default_problem do
+  match { expect(test_subject.problem).to eq test_subject.prototype_name.underscore.to_sym }
+  description { "have default problem" }
+  failure_message { "expected #{test_subject.name} to have default problem" }
+
+  def test_subject
+    subject.is_a?(Module) ? subject : subject.class
+  end
+end

data/lib/malfunction/rspec/custom_matchers/use_attribute_errors.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of the default `MalfunctionBase.uses_attribute_errors`
+#
+#     class FooMalfunction < Malfunction::Base
+#       uses_attribute_errors
+#     end
+#
+#     class BarMalfunction < Malfunction::Base
+#     end
+#
+#     RSpec.describe FooMalfunction, type: :malfunction do
+#       it { is_expected.to use_attribute_errors }
+#     end
+#
+#     RSpec.describe BarMalfunction, type: :malfunction do
+#       it { is_expected.not_to use_attribute_errors }
+#     end
+
+RSpec::Matchers.define :use_attribute_errors do
+  match { expect(test_subject.uses_attribute_errors?).to eq true }
+  description { "use attribute errors" }
+  failure_message { "expected #{test_subject.name} to use attribute errors" }
+
+  def test_subject
+    subject.is_a?(Module) ? subject : subject.class
+  end
+end

data/lib/malfunction/rspec/custom_matchers.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers/contextualize_as"
+require_relative "custom_matchers/define_problem"
+require_relative "custom_matchers/have_default_problem"
+require_relative "custom_matchers/use_attribute_errors"

data/lib/malfunction/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rspec/custom_matchers"

data/lib/malfunction/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Malfunction
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/malfunction.rb

@@ -6,4 +6,9 @@ require "spicery"
 
 require "malfunction/version"
 
+require "malfunction/attribute_error"
+require "malfunction/attribute_error_collection"
+
+require "malfunction/malfunction_base"
+
 module Malfunction; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: malfunction
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -58,20 +58,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -101,54 +87,54 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rspice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -158,7 +144,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -168,7 +154,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -178,24 +164,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.20.4
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.0.1
 description: An extensible way to encapsulate the variety of BadStuff that happens
   in Rails applications
 email:
@@ -207,6 +179,19 @@ files:
 - LICENSE.txt
 - README.md
 - lib/malfunction.rb
+- lib/malfunction/attribute_error.rb
+- lib/malfunction/attribute_error_collection.rb
+- lib/malfunction/malfunction/attribute_errors.rb
+- lib/malfunction/malfunction/builder.rb
+- lib/malfunction/malfunction/context.rb
+- lib/malfunction/malfunction/core.rb
+- lib/malfunction/malfunction_base.rb
+- lib/malfunction/rspec/custom_matchers.rb
+- lib/malfunction/rspec/custom_matchers/contextualize_as.rb
+- lib/malfunction/rspec/custom_matchers/define_problem.rb
+- lib/malfunction/rspec/custom_matchers/have_default_problem.rb
+- lib/malfunction/rspec/custom_matchers/use_attribute_errors.rb
+- lib/malfunction/spec_helper.rb
 - lib/malfunction/version.rb
 homepage: https://github.com/Freshly/malfunction
 licenses: