instructor 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b9502c71a49683be1cef4a3dcfb742f211dfe2ff9794eab5245999a52f6cfb2
-  data.tar.gz: 2eb47f8d9394e41d8eee700ba494f72b883f64513b1be4b3137850281fb4a426
+  metadata.gz: 7e3514be63395d163fbbffaf7f7bbe99495e537bf8ac54ba3def4d521a034155
+  data.tar.gz: 7e12e5505209f56e7d1040a3d095155c376c29bcb7afc713b6080897785cd215
 SHA512:
-  metadata.gz: d17a0f57c140693e5159056c9c888d8404438b2b2ba31db9a71b5dc438e6f086d1b48e38a7ccc86fadc1906414a7ff1cb9d0adbb09869a02b684f3d95cb37bcd
-  data.tar.gz: ee139f78a6327ed94dbf8a0e8269e37aa5d793475d09ece4ebf38b273c9793519944f5ed38178bfe3c42236018ee9ec8faf14ca57221061a74da0b09e284530e
+  metadata.gz: 1ad95ed38f49b3ae1b3cb5ecdc96e907c90c879a0ef9143083beedf16df8e08c0a4f8bf7a64ea508c59738567ce90c921aebf9fd1b56caeb612dbd848dc43ebf
+  data.tar.gz: 44dcf5d4a5ba8cf0a89fb2015b6fa7f5f13f8ac5ea4e379d7d70951056a604339cc44551e6fb399b3cc37ec2206e4ca6d8eaa450fcd8798434db4a80c31dc94c

data/lib/instructor/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "concerns/callbacks"
+require_relative "concerns/defaults"
+require_relative "concerns/attributes"
+require_relative "concerns/arguments"
+require_relative "concerns/options"
+require_relative "concerns/core"
+require_relative "concerns/string"
+
+module Instructor
+  class Base
+    include ShortCircuIt
+    include Technologic
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+    include Instructor::Callbacks
+    include Instructor::Defaults
+    include Instructor::Attributes
+    include Instructor::Arguments
+    include Instructor::Options
+    include Instructor::Core
+    include Instructor::String
+  end
+end

data/lib/instructor/concerns/arguments.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Arguments describe input required by an Instructor.
+module Instructor
+  module Arguments
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_arguments, instance_writer: false, default: {}
+      set_callback :initialize, :after do
+        missing_arguments = _arguments.reject do |argument, options|
+          options[:allow_nil] ? input.key?(argument) : !input[argument].nil?
+        end
+
+        missing = missing_arguments.keys
+
+        raise ArgumentError, "Missing #{"argument".pluralize(missing.length)}: #{missing.join(", ")}" if missing.any?
+      end
+    end
+
+    class_methods do
+      def inherited(base)
+        dup = _arguments.dup
+        base._arguments = dup.each { |k, v| dup[k] = v.dup }
+        super
+      end
+
+      private
+
+      def argument(argument, allow_nil: true)
+        _arguments[argument] = { allow_nil: allow_nil }
+        define_attribute argument
+      end
+    end
+  end
+end

data/lib/instructor/concerns/attributes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# An Instructor's attributes provide accessors to the input data it was initialized with.
+module Instructor
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::AttributeMethods
+
+      class_attribute :_attributes, instance_writer: false, default: []
+    end
+
+    class_methods do
+      def inherited(base)
+        base._attributes = _attributes.dup
+        super
+      end
+
+      private
+
+      def define_attribute(attribute)
+        _attributes << attribute
+
+        attr_accessor attribute
+        define_attribute_methods attribute
+      end
+      alias_method :attribute, :define_attribute
+    end
+  end
+end

data/lib/instructor/concerns/callbacks.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Callbacks provide an extensible mechanism for hooking into an Instructor.
+module Instructor
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveSupport::Callbacks
+      define_callbacks :initialize
+    end
+  end
+end

data/lib/instructor/concerns/core.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# An Instructor accepts input represented by arguments and options which initialize it.
+module Instructor
+  module Core
+    extend ActiveSupport::Concern
+
+    attr_reader :input
+
+    def initialize(**input)
+      @input = input
+      run_callbacks(:initialize) do
+        input.each { |key, value| __send__("#{key}=".to_sym, value) }
+      end
+    end
+  end
+end

data/lib/instructor/concerns/defaults.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Defaults allow attributes to be initialized with a value if none have been provided.
+module Instructor
+  module Defaults
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_defaults, instance_writer: false, default: {}
+    end
+
+    class_methods do
+      def inherited(base)
+        dup = _defaults.dup
+        base._defaults = dup.each { |k, v| dup[k] = v.dup }
+        super
+      end
+
+      private
+
+      def define_default(attribute, static: nil, &block)
+        _defaults[attribute] = Value.new(static: static, &block)
+      end
+    end
+
+    class Value
+      def initialize(static: nil, &block)
+        @value = (static.nil? && block_given?) ? block : static
+      end
+
+      def value
+        (@value.respond_to?(:call) ? instance_eval(&@value) : @value).dup
+      end
+    end
+  end
+end

data/lib/instructor/concerns/options.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Options describe input which may be provided to define or override default values.
+module Instructor
+  module Options
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_options, instance_writer: false, default: []
+
+      set_callback :initialize, :after do
+        _options.each do |option|
+          next unless _defaults.key?(option)
+
+          public_send("#{option}=".to_sym, _defaults[option].value) if public_send(option).nil?
+        end
+      end
+    end
+
+    class_methods do
+      def inherited(base)
+        base._options = _options.dup
+        super
+      end
+
+      private
+
+      def option(option, default: nil, &block)
+        _options << option
+        define_attribute option
+        define_default option, static: default, &block
+      end
+    end
+  end
+end

data/lib/instructor/concerns/string.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Formats the Instructor as a string.
+module Instructor
+  module String
+    extend ActiveSupport::Concern
+
+    def to_s
+      string_for(__method__)
+    end
+
+    def inspect
+      string_for(__method__)
+    end
+
+    private
+
+    def stringable_attributes
+      self.class._attributes
+    end
+
+    def string_for(method)
+      "#<#{self.class.name} #{attribute_string(method)}>"
+    end
+
+    def attribute_string(method)
+      stringable_attribute_values.map { |attribute, value| "#{attribute}=#{value.public_send(method)}" }.join(" ")
+    end
+
+    def stringable_attribute_values
+      stringable_attributes.each_with_object({}) { |attribute, result| result[attribute] = safe_send(attribute) }
+    end
+
+    def safe_send(method)
+      public_send(method)
+    rescue StandardError
+      nil
+    end
+  end
+end

data/lib/instructor/custom_matchers/define_argument.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.argument`
+#
+#     class Example < Instructor::Base
+#       argument :foo
+#       argument :bar, allow_nil: false
+#     end
+#
+#     RSpec.describe Example, type: :instructor do
+#       subject { described_class.new(**input) }
+#
+#       let(:input) { {} }
+#
+#       it { is_expected.to define_argument :foo }
+#       it { is_expected.to define_argument :bar, allow_nil: false }
+#     end
+
+RSpec::Matchers.define :define_argument do |argument, allow_nil: true|
+  match { |instance| expect(instance._arguments[argument]).to eq(allow_nil: allow_nil) }
+  description { "define argument #{argument}" }
+  failure_message do
+    "expected #{described_class} to define argument #{argument} #{prohibit_nil_description unless allow_nil}"
+  end
+
+  def prohibit_nil_description
+    "and prohibit a nil value"
+  end
+end

data/lib/instructor/custom_matchers/define_attribute.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.attribute`
+#
+#     class Example < Instructor::Base
+#       attribute :foo
+#     end
+#
+#     RSpec.describe Example, type: :instructor do
+#       subject { described_class.new(**input) }
+#
+#       let(:input) { {} }
+#
+#       it { is_expected.to define_attribute :foo }
+#     end
+
+RSpec::Matchers.define :define_attribute do |attribute|
+  match { |instance| expect(instance._attributes).to include attribute }
+  description { "define attribute #{attribute}" }
+  failure_message { "expected #{described_class} to defines attribute #{attribute}" }
+end

data/lib/instructor/custom_matchers/define_option.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.option`
+#
+#     class Example < Instructor::Base
+#       option :foo
+#       option :bar, default: :baz
+#       option(:gaz) { :haz }
+#     end
+#
+#     RSpec.describe Example, type: :instructor do
+#       subject { described_class.new(**input) }
+#
+#       let(:input) { {} }
+#
+#       it { is_expected.to define_option :foo }
+#       it { is_expected.to define_option :bar, default: :baz }
+#       it { is_expected.to define_option :gaz, default: :haz }
+#     end
+
+RSpec::Matchers.define :define_option do |option, default: nil|
+  match do |instance|
+    expect(instance._defaults[option]&.value).to eq default
+    expect(instance._options).to include option
+  end
+  description { "define option #{option}" }
+  failure_message { "expected #{described_class} to define option #{option} #{for_default(default)}" }
+
+  def for_default(default)
+    return "without a default value" if default.nil?
+
+    "with default value #{default}"
+  end
+end

data/lib/instructor/custom_matchers.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers/define_argument"
+require_relative "custom_matchers/define_attribute"
+require_relative "custom_matchers/define_option"

data/lib/instructor/shoulda_matcher_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+if defined?(Shoulda::Matchers::ActiveModel)
+  RSpec.configure do |config|
+    config.include(Shoulda::Matchers::ActiveModel, type: :instructor)
+  end
+end

data/lib/instructor/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers"
+require_relative "shoulda_matcher_helper"

data/lib/instructor/version.rb

@@ -2,5 +2,5 @@
 
 module Instructor
   # This constant is managed by spicerack
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

data/lib/instructor.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_model"
+
+require "short_circu_it"
+require "technologic"
 
 require "instructor/version"
 
-module Instructor
-  # Your code goes here...
-end
+require "instructor/base"
+
+module Instructor; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instructor
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
 description: Input structure base object for capturing and validating input with a
   nice DSL
 email:
@@ -35,6 +49,20 @@ files:
 - LICENSE.txt
 - README.md
 - lib/instructor.rb
+- lib/instructor/base.rb
+- lib/instructor/concerns/arguments.rb
+- lib/instructor/concerns/attributes.rb
+- lib/instructor/concerns/callbacks.rb
+- lib/instructor/concerns/core.rb
+- lib/instructor/concerns/defaults.rb
+- lib/instructor/concerns/options.rb
+- lib/instructor/concerns/string.rb
+- lib/instructor/custom_matchers.rb
+- lib/instructor/custom_matchers/define_argument.rb
+- lib/instructor/custom_matchers/define_attribute.rb
+- lib/instructor/custom_matchers/define_option.rb
+- lib/instructor/shoulda_matcher_helper.rb
+- lib/instructor/spec_helper.rb
 - lib/instructor/version.rb
 homepage: https://www.freshly.com
 licenses: