spicerack 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cb81265e19c0b0d16717461b0d4cd4c5ca97e0f5c8ae6c0ab66ea47d1c1b980
-  data.tar.gz: 70616ba354fe24be34d0ef6cf786bbd4a090d1411ee183d418c518b108a2e50b
+  metadata.gz: e95ea2fbed7c71289fc97dde75a0eb541cbf6499c4fa53d9ce9e42a7cfaf0592
+  data.tar.gz: 47f05cd6e75645c2a5b4e806c62f9fbda934544ccb9b13ff46a86dd4e368938c
 SHA512:
-  metadata.gz: 199e2b8b16baa887e5cbf2fef2360d8e812b89db3f8737cd0b4dd9def84883db185b062606bd0f9757fd5c69dc00d343949f62648467daeb877a5f6cb6ed9057
-  data.tar.gz: 17a2abba67e0743e71f2df0820c6c59b7bab8ddb6ea52b06ae386bd2da1d2296c10faa61e50542dbb31f9293eeb4fa22ab5e15923c59e1302993cdd818a83ed7
+  metadata.gz: e79d5dee503f0e59125a61b687fd10b8b623591110221619f928a4d7e610c133cd137e3ce08f167e6e5eaaaa91e1e877aac00ae0388cf86abd60d60ee72531f0
+  data.tar.gz: 5f57ab2a707247497a04ce6c99b55a5d3c986ffeb434fc22afe10b7be02661f1d98634817856fab640678331e6c0b38cfb65e8873f45748f55adfeb58add3df1

data/README.md

@@ -35,10 +35,7 @@ Or install it yourself as:
 ## Included Gems
 
 * [AroundTheWorld](around_the_world/README.md) allows you to easily wrap methods with custom logic on any class.
-* [Ascriptor](ascriptor/README.md) facilitates attribute definition on classes to easily create service object.
-* [Instructor](instructor/README.md) allows you to clearly require and validate input with a base class for service object.
 * [RedisHash](redis_hash/README.md) provides a class that matches the Hash api by wrapping Redis.
-* [RootObject](root_object/README.md) is a generic baseplate object full of convenient utility methods.
 * [RSpice](rspice/README.md) is an `RSpec` utility gem of custom matchers, shared contexts and examples.
 * [ShortCircuIt](short_circu_it/README.md) is an intelligent and feature rich memoization gem.
 * [Spicerack::Styleguide](spicerack-styleguide/README.md) is [Freshly](https://www.freshly.com/)'s Rubocop Styleguide for Rails and RSpec.

data/lib/spicerack/attribute_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "objects/defaults"
+require_relative "objects/attributes"
+
+module Spicerack
+  class AttributeObject < Spicerack::RootObject
+    include Spicerack::Objects::Defaults
+    include Spicerack::Objects::Attributes
+  end
+end

data/lib/spicerack/input_model.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Spicerack
+  class InputModel < Spicerack::InputObject
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
+
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+    include ActiveModel::Validations::Callbacks
+  end
+end

data/lib/spicerack/input_object.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "objects/arguments"
+require_relative "objects/options"
+
+module Spicerack
+  class InputObject < Spicerack::AttributeObject
+    define_callbacks :initialize
+
+    include Spicerack::Objects::Arguments
+    include Spicerack::Objects::Options
+
+    def initialize(**input)
+      @input = input
+      run_callbacks(:initialize) do
+        input.each { |key, value| __send__("#{key}=".to_sym, value) }
+      end
+    end
+
+    private
+
+    attr_reader :input
+  end
+end

data/lib/spicerack/objects/arguments.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Arguments describe input that is required (which can be nil, unless otherwise specified).
+module Spicerack
+  module Objects
+    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
+end

data/lib/spicerack/objects/attributes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Attributes are structured data within an object.
+module Spicerack
+  module Objects
+    module Attributes
+      extend ActiveSupport::Concern
+
+      included do
+        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
+        end
+        alias_method :attribute, :define_attribute
+      end
+
+      private
+
+      def stringable_attributes
+        self.class._attributes
+      end
+    end
+  end
+end

data/lib/spicerack/objects/defaults.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Defaults are used as the value when then attribute is unspecified.
+module Spicerack
+  module Objects
+    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
+end

data/lib/spicerack/objects/options.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Options describe input which may be provided to define or override default values.
+module Spicerack
+  module Objects
+    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
+end

data/lib/spicerack/root_object.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Spicerack
+  class RootObject
+    include ActiveSupport::Callbacks
+    include ShortCircuIt
+    include Technologic
+    include Tablesalt::StringableObject
+  end
+end

data/lib/spicerack/rspec/custom_matchers/define_argument.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.argument`
+#
+#     class Example < Spicerack::InputObject
+#       argument :foo
+#       argument :bar, allow_nil: false
+#     end
+#
+#     RSpec.describe Example, type: :input_object 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/spicerack/rspec/custom_matchers/define_attribute.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.attribute`
+#
+#     class Example < Spicerack::InputObject
+#       attribute :foo
+#     end
+#
+#     RSpec.describe Example, type: :input_object 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/spicerack/rspec/custom_matchers/define_option.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `.option`
+#
+#     class Example < Spicerack::InputObject
+#       option :foo
+#       option :bar, default: :baz
+#       option(:gaz) { :haz }
+#     end
+#
+#     RSpec.describe Example, type: :input_object 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/spicerack/rspec/custom_matchers.rb

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

data/lib/spicerack/rspec/shared_examples/an_input_object_with_a_class_collection_attribute.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for "an input object with a class collection attribute" do |method, collection|
+  subject(:define) { example_input_object_class.__send__(method, value) }
+
+  let(:value) { Faker::Lorem.word.to_sym }
+
+  before do
+    allow(example_input_object_class).to receive(:define_default).and_call_original
+    allow(example_input_object_class).to receive(:define_attribute).and_call_original
+  end
+
+  describe "defines value" do
+    let(:default) { Faker::Lorem.word }
+
+    shared_examples_for "an value is defined" do
+      it "adds to _values" do
+        expect { define }.to change { example_input_object_class.public_send(collection) }.from([]).to([ value ])
+      end
+    end
+
+    context "when no block is given" do
+      subject(:define) { example_input_object_class.__send__(method, value, default: default) }
+
+      it_behaves_like "an value is defined"
+
+      it "defines an static default" do
+        define
+        expect(example_input_object_class).to have_received(:define_default).with(value, static: default)
+      end
+    end
+
+    context "when a block is given" do
+      subject(:define) { example_input_object_class.__send__(method, value, default: default, &block) }
+
+      let(:block) do
+        ->(_) { :block }
+      end
+
+      shared_examples_for "values are handed off to define_default" do
+        it "calls define_default" do
+          define
+          expect(example_input_object_class).to have_received(:define_default).with(value, static: default, &block)
+        end
+      end
+
+      context "with a static default" do
+        it_behaves_like "values are handed off to define_default"
+      end
+
+      context "without a static default" do
+        let(:default) { nil }
+
+        it_behaves_like "values are handed off to define_default"
+      end
+    end
+  end
+
+  it "defines an attribute" do
+    define
+    expect(example_input_object_class).to have_received(:define_attribute).with(value)
+  end
+end

data/lib/spicerack/rspec/shared_examples.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "shared_examples/an_input_object_with_a_class_collection_attribute"

data/lib/spicerack/rspec/shoulda_matcher_helper.rb

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

data/lib/spicerack/spec_helper.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require "rspice"
-require "instructor/spec_helper"
 require "redis_hash/spec_helper"
 
-require_relative "custom_matchers"
+require_relative "rspec/custom_matchers"
+require_relative "rspec/shared_examples"
+require_relative "rspec/shoulda_matcher_helper"

data/lib/spicerack/version.rb

@@ -2,5 +2,5 @@
 
 module Spicerack
   # This constant is managed by spicerack
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/lib/spicerack.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "active_support"
+require "active_support/core_ext/class/attribute"
+
 require "spicerack/version"
 
 require "tablesalt"
@@ -9,15 +12,14 @@ require "short_circu_it"
 
 require "technologic"
 
-require "root_object"
-
-require "ascriptor"
-require "instructor"
-
 require "redis_hash"
 
 require "spicerack/array_index"
 require "spicerack/hash_model"
 require "spicerack/redis_model"
+require "spicerack/root_object"
+require "spicerack/attribute_object"
+require "spicerack/input_object"
+require "spicerack/input_model"
 
 module Spicerack; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spicerack
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Eric Garside
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: around_the_world
@@ -17,112 +17,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: ascriptor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: instructor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: redis_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: root_object
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: short_circu_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: technologic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: tablesalt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -241,28 +199,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 description: This collection of gems will spice up your rails and kick your rubies
   up a notch. Bam!
 email:
@@ -276,10 +234,24 @@ files:
 - README.md
 - lib/spicerack.rb
 - lib/spicerack/array_index.rb
-- lib/spicerack/custom_matchers.rb
-- lib/spicerack/custom_matchers/define_field.rb
+- lib/spicerack/attribute_object.rb
 - lib/spicerack/hash_model.rb
+- lib/spicerack/input_model.rb
+- lib/spicerack/input_object.rb
+- lib/spicerack/objects/arguments.rb
+- lib/spicerack/objects/attributes.rb
+- lib/spicerack/objects/defaults.rb
+- lib/spicerack/objects/options.rb
 - lib/spicerack/redis_model.rb
+- lib/spicerack/root_object.rb
+- lib/spicerack/rspec/custom_matchers.rb
+- lib/spicerack/rspec/custom_matchers/define_argument.rb
+- lib/spicerack/rspec/custom_matchers/define_attribute.rb
+- lib/spicerack/rspec/custom_matchers/define_field.rb
+- lib/spicerack/rspec/custom_matchers/define_option.rb
+- lib/spicerack/rspec/shared_examples.rb
+- lib/spicerack/rspec/shared_examples/an_input_object_with_a_class_collection_attribute.rb
+- lib/spicerack/rspec/shoulda_matcher_helper.rb
 - lib/spicerack/spec_helper.rb
 - lib/spicerack/version.rb
 homepage: https://www.freshly.com/

data/lib/spicerack/custom_matchers.rb

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