shaped 0.6.1

data/bin/release

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+BRANCH=$(git rev-parse --abbrev-ref HEAD)
+if [[ "$BRANCH" != "master" ]]; then
+  echo "Aborting release! Not on master. Current branch is '$BRANCH'.";
+  exit 1;
+fi
+
+COMMIT_MESSAGE=$(git log --format=%B -n 1)
+if ! [[ $COMMIT_MESSAGE =~ ^Prepare[[:space:]]to[[:space:]]release[[:space:]]v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+  echo "Aborting release! Commit message is improperly formatted. Commit message is '$COMMIT_MESSAGE'.";
+  exit 1;
+fi
+
+bundle exec rake build release:guard_clean release:source_control_push

data/bin/rspec

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||=
+  File.expand_path(
+    '../../Gemfile',
+    Pathname.new(__FILE__).realpath,
+  )
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort(<<~ERROR)
+      Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+      Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.
+    ERROR
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort(<<~ERROR)
+      Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+      Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.
+    ERROR
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shaped.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Shaped ; end
+module Shaped::Shapes ; end
+
+require 'active_support/all'
+require 'active_model'
+require_relative './shaped/shape.rb'
+Dir[File.dirname(__FILE__) + '/**/*.rb'].sort.each { |file| require file }
+
+module Shaped
+  # rubocop:disable Naming/MethodName, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def self.Shape(*shape_descriptions)
+    validation_options = shape_descriptions.extract_options!
+    if shape_descriptions.size >= 2
+      Shaped::Shapes::Or.new(*shape_descriptions, validation_options)
+    else
+      # If the shape_descriptions argument list was just one hash, then `extract_options!` would
+      # have removed it, making `shape_descriptions` an empty array, so we need to "restore" the
+      # "validation options" to their actual role of a Hash `shape_description` here.
+      shape_description =
+        case
+        when shape_descriptions.empty? && validation_options.is_a?(Hash)
+          validation_options
+        else
+          shape_descriptions.first
+        end
+
+      case shape_description
+      when Hash then Shaped::Shapes::Hash.new(shape_description)
+      when Array then Shaped::Shapes::Array.new(shape_description)
+      when Class then Shaped::Shapes::Class.new(shape_description, validation_options)
+      else
+        if shape_description.respond_to?(:call)
+          Shaped::Shapes::Callable.new(shape_description)
+        else
+          Shaped::Shapes::Equality.new(shape_description)
+        end
+      end
+    end
+  end
+  # rubocop:enable Naming/MethodName, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+end
+
+class Shaped::InvalidShapeDescription < StandardError ; end

data/lib/shaped/shape.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Shaped::Shape
+  def initialize(_shape_description)
+    raise("`#initialize(shape_description)` must be implemented for #{self.class}!")
+  end
+
+  def matched_by?(_tested_object)
+    raise("`#matched_by?(tested_object)` must be implemented for #{self.class}!")
+  end
+
+  def to_s
+    raise("`#to_s` must be implemented for #{self.class}!")
+  end
+end

data/lib/shaped/shapes/array.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Array < Shaped::Shape
+  def initialize(shape_description)
+    if !shape_description.is_a?(Array)
+      raise(Shaped::InvalidShapeDescription, "A #{self.class} description must be an array.")
+    end
+
+    @element_test = Shaped::Shape(*shape_description)
+  end
+
+  def matched_by?(array)
+    return false if !array.is_a?(Array)
+
+    array.all? { |element| @element_test.matched_by?(element) }
+  end
+
+  def to_s
+    "[#{@element_test}]"
+  end
+end

data/lib/shaped/shapes/callable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Callable < Shaped::Shape
+  def initialize(callable)
+    @callable = callable
+  end
+
+  def matched_by?(object)
+    !!@callable.call(object)
+  end
+
+  def to_s
+    case @callable
+    when Proc then "Proc test defined at #{@callable.source_location.map(&:to_s).join(':')}"
+    else "#call test defined at #{@callable.method(:call).source_location.map(&:to_s).join(':')}"
+    end
+  end
+end

data/lib/shaped/shapes/class.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Class < Shaped::Shape
+  def initialize(expected_klass, validations = {})
+    if !expected_klass.is_a?(Class)
+      raise(Shaped::InvalidShapeDescription, "A #{self.class} description must be a Class.")
+    end
+
+    @expected_klass = expected_klass
+    @validations = validations
+    @validator_klass = validator_klass(validations)
+  end
+
+  def matched_by?(object)
+    object.is_a?(@expected_klass) && validations_satisfied?(object)
+  end
+
+  def to_s
+    if @validations.empty?
+      @expected_klass.name
+    else
+      "#{@expected_klass} validating #{@validations}"
+    end
+  end
+
+  private
+
+  def validator_klass(validations)
+    return nil if validations.empty?
+
+    Class.new do
+      include ActiveModel::Validations
+
+      attr_accessor :value
+
+      validates :value, validations
+
+      class << self
+        # ActiveModel requires the class to have a `name`
+        def name
+          'Shaped::Shapes::Class::AnonymousValidator'
+        end
+      end
+    end
+  end
+
+  def validations_satisfied?(object)
+    return true if @validator_klass.nil?
+
+    validator_instance = @validator_klass.new
+    validator_instance.value = object
+    validator_instance.valid?
+  end
+end

data/lib/shaped/shapes/equality.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Equality < Shaped::Shape
+  def initialize(shape_description)
+    @expected_value = shape_description
+  end
+
+  def matched_by?(object)
+    object == @expected_value
+  end
+
+  def to_s
+    @expected_value.inspect
+  end
+end

data/lib/shaped/shapes/hash.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Hash < Shaped::Shape
+  def initialize(shape_description)
+    unless shape_description.is_a?(Hash)
+      raise(Shaped::InvalidShapeDescription, "A #{self.class} description must be a Hash.")
+    end
+
+    @hash_description = shape_description.transform_values { |value| Shaped::Shape(value) }
+  end
+
+  def matched_by?(hash)
+    return false if !hash.is_a?(Hash)
+
+    missing_keys = expected_keys - hash.keys
+    return false if missing_keys.any?
+
+    @hash_description.all? do |key, expected_value_shape|
+      expected_value_shape.matched_by?(hash[key])
+    end
+  end
+
+  def to_s
+    printable_shape_description =
+      @hash_description.map do |key, value|
+        "#{key.inspect} => #{value}"
+      end.join(', ')
+
+    "{ #{printable_shape_description} }"
+  end
+
+  private
+
+  def expected_keys
+    @hash_description.keys
+  end
+end

data/lib/shaped/shapes/or.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Or < Shaped::Shape
+  def initialize(*shape_descriptions)
+    validation_options = shape_descriptions.extract_options!
+    if shape_descriptions.size <= 1
+      raise(Shaped::InvalidShapeDescription, <<~ERROR.squish)
+        A #{self.class} description must be a list of two or more shape descriptions.
+      ERROR
+    end
+
+    @shapes =
+      shape_descriptions.map do |description|
+        Shaped::Shape(description, validation_options)
+      end
+  end
+
+  def matched_by?(object)
+    @shapes.any? { |shape| shape.matched_by?(object) }
+  end
+
+  def to_s
+    @shapes.map(&:to_s).join(' OR ')
+  end
+end

data/lib/shaped/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Shaped
+  VERSION = '0.6.1'
+end

data/shaped.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/shaped/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shaped'
+  spec.version       = Shaped::VERSION
+  spec.authors       = ['David Runger']
+  spec.email         = ['davidjrunger@gmail.com']
+
+  spec.summary       = 'Validate the "shape" of Ruby objects.'
+  spec.description   = 'Validate the "shape" of Ruby objects.'
+  spec.homepage      = 'https://github.com/davidrunger/shaped'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/davidrunger/shaped'
+  spec.metadata['changelog_uri'] = 'https://github.com/davidrunger/shaped/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('activemodel', '~> 6.0')
+  spec.add_runtime_dependency('activesupport', '~> 6.0')
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: shaped
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- David Runger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Validate the "shape" of Ruby objects.
+email:
+- davidjrunger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/release
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- lib/shaped.rb
+- lib/shaped/shape.rb
+- lib/shaped/shapes/array.rb
+- lib/shaped/shapes/callable.rb
+- lib/shaped/shapes/class.rb
+- lib/shaped/shapes/equality.rb
+- lib/shaped/shapes/hash.rb
+- lib/shaped/shapes/or.rb
+- lib/shaped/version.rb
+- shaped.gemspec
+homepage: https://github.com/davidrunger/shaped
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/davidrunger/shaped
+  source_code_uri: https://github.com/davidrunger/shaped
+  changelog_uri: https://github.com/davidrunger/shaped/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Validate the "shape" of Ruby objects.
+test_files: []