valcro 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fcbac62421055229ee2460f427804335464feff1
-  data.tar.gz: cc32e12f3d05f65819d2753efcdb614ad8559ae0
+SHA256:
+  metadata.gz: fe2a894e02ab3ec3cf6539c010830020ee584952e4a2b1f755afb981e86a4fdf
+  data.tar.gz: 053cdef1adc947a580eccfcf8e0b21f64ebfb7653da648490459b00f994ecdd4
 SHA512:
-  metadata.gz: 12a29984eb35f88ad6049a15a0f51c73deb632c2f4321f0efa041a7ba69597cb6f0fa6ecaddc93fc4e8d576c23adce0991dafd09b5fe977f5cf2b6364a3d735b
-  data.tar.gz: f8859de06c414bbad878c92420c40ee712384f054e9a2c47b6486036c98fb56889c7663bedd0ce0cefbaf1ce21b850c77642ff2baca348b3c448ba1fb1fc3f94
+  metadata.gz: fd1978ca04b743e095d8dd178a55c8ba87f5148254a1cd258136668d7f2d873e86a55515ec80f50688c7200c017b1e9f7e1feff4ac5df5b0b251c285bf836a76
+  data.tar.gz: 2a35fbdc02dd27ae2cd7504011498cc45904fbbf5f82d902c4fefd8961c056929e54431c1a508afa33452976d19a44f91a44550c5f90f221cfb9911ccaad8c24

data/.github/workflows/specs.yml

@@ -0,0 +1,23 @@
+name: Specs
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/README.md

@@ -1,16 +1,13 @@
 # Valcro
 
-[![Build Status](https://secure.travis-ci.org/hgmnz/valcro.png?branch=master)](http://travis-ci.org/hgmnz/valcro)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/hgmnz/valcro)
+Valcro is the simple validation library for Ruby. It provides
 
-Valcro is the simple validation library for Ruby. It provides 
-
-* A declarative way to describe what makes an object valid
-* A way to declare validator classes encapsulating validations to be shared
+- A declarative way to describe what makes an object valid
+- A way to declare validator classes encapsulating validations to be shared
   across objects
-* A method for running validations against an instance of your class
-* A method for checking whether an object is valid
-* Visibility into what validations failed
+- A method for running validations against an instance of your class
+- A method for checking whether an object is valid
+- Visibility into what validations failed
 
 It is similar in spirit to ActiveModel's or Sequel's validations, but far
 simpler and with a slightly different API. It does not provide validation
@@ -35,7 +32,7 @@ dog = Dog.new
 dog.name = 'spike'
 dog.validate
 dog.valid?
- => false 
+ => false
 dog.errors[:name]
  => ["must be great"]
 dog.error_messages
@@ -49,8 +46,8 @@ check for validity of objects.
 
 You may also have Cats in your system, which share the same validation. Valcro lets you encapsulate validations in an object with the following contract:
 
-* It is constructed with the object being validated
-* It responds to `call`, which receives a `Valcro::ErrorList`. Add validation errors to this object.
+- It is constructed with the object being validated
+- It responds to `call`, which receives a `Valcro::ErrorList`. Add validation errors to this object.
 
 ```ruby
 class GreatNameValidator

data/Rakefile

@@ -1,13 +1,13 @@
 require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec
 
 namespace :gem do
   desc "Release to rubygems"
   task :release do
-    require File.expand_path('lib/valcro/version', File.dirname(__FILE__))
+    require File.expand_path("lib/valcro/version", File.dirname(__FILE__))
     version = Valcro::VERSION
     message = "Bump to version #{version}"
     system "git tag -a -m '#{message}' v#{version}"

data/lib/valcro/error.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Valcro
   class Error
     attr_accessor :property, :message
 
     def initialize(property, message)
       @property = property
-      @message  = message
+      @message = message
     end
 
     def to_s
       if @property == :base
         message
       else
-        "#{property.to_s} #{message}"
+        "#{property} #{message}"
       end
     end
   end

data/lib/valcro/error_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Valcro
   class ErrorList
     attr_accessor :errors
@@ -26,7 +28,7 @@ module Valcro
     end
 
     def to_s
-      full_messages.join(' ')
+      full_messages.join(" ")
     end
 
     def any?

data/lib/valcro/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Valcro
   class Runner
     attr_accessor :validators, :error_list
@@ -6,6 +8,11 @@ module Valcro
       @error_list = error_list
     end
 
+    def clear!
+      @validators.clear
+      @error_list.clear!
+    end
+
     def add_validator(validator)
       @validators << validator
     end

data/lib/valcro/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Valcro
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/valcro.rb

@@ -1,6 +1,8 @@
-require 'valcro/error'
-require 'valcro/error_list'
-require 'valcro/runner'
+# frozen_string_literal: true
+
+require "valcro/error"
+require "valcro/error_list"
+require "valcro/runner"
 
 module Valcro
   def self.included(base)
@@ -20,9 +22,14 @@ module Valcro
   end
 
   def validate
-    errors.clear!
+    validation_runner.clear!
     self.class.validators.each do |validator_class|
-      validation_runner.add_validator validator_class.new(self)
+      validator = if validator_class.respond_to?(:build)
+        validator_class.build(self)
+      else
+        validator_class.new(self)
+      end
+      validation_runner.add_validator validator
     end
     self.class.validation_blocks.each do |validation_block|
       instance_eval(&validation_block)
@@ -42,6 +49,7 @@ module Valcro
     def validators
       @validators ||= []
     end
+
     def validation_blocks
       @validation_blocks ||= []
     end

data/spec/error_list_spec.rb

@@ -1,78 +1,80 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Valcro::ErrorList, 'adding errors' do
-  it 'supports adding via <<' do
+require "spec_helper"
+
+describe Valcro::ErrorList, "adding errors" do
+  it "supports adding via <<" do
     list = Valcro::ErrorList.new
-    list << Valcro::Error.new(:prop, 'message')
+    list << Valcro::Error.new(:prop, "message")
 
     expect(list.errors.length).to eq(1)
   end
 end
 
-describe Valcro::ErrorList, '#add' do
-  it 'finds and agregates error messages' do
+describe Valcro::ErrorList, "#add" do
+  it "finds and agregates error messages" do
     list = Valcro::ErrorList.new
 
     expect(list[:one]).to be_empty
 
-    list.add(:one, 'message one')
-    list.add(:two, 'message two')
-    list.add(:one, 'another message one')
+    list.add(:one, "message one")
+    list.add(:two, "message two")
+    list.add(:one, "another message one")
 
-    expect(list[:one]).to eq(['message one', 'another message one'])
+    expect(list[:one]).to eq(["message one", "another message one"])
   end
 end
 
-describe Valcro::ErrorList, '#full_messages' do
-  it 'gives a collection of messages' do
+describe Valcro::ErrorList, "#full_messages" do
+  it "gives a collection of messages" do
     list = Valcro::ErrorList.new
 
-    list.add :prop, 'one'
-    list.add :prop, 'two'
-    list.add :prop,'three'
+    list.add :prop, "one"
+    list.add :prop, "two"
+    list.add :prop, "three"
 
     expect(list.full_messages).to eq(["prop one", "prop two", "prop three"])
   end
 end
 
-describe Valcro::ErrorList, '#to_s' do
-  it 'gives messages as one string' do
+describe Valcro::ErrorList, "#to_s" do
+  it "gives messages as one string" do
     list = Valcro::ErrorList.new
 
-    list.add :prop, 'one'
-    list.add :prop, 'two'
-    list.add :prop, 'three'
+    list.add :prop, "one"
+    list.add :prop, "two"
+    list.add :prop, "three"
 
     expect(list.to_s).to eq("prop one prop two prop three")
   end
 end
 
-describe Valcro::ErrorList, '#any?' do
-  it 'is true when there are errors 'do
+describe Valcro::ErrorList, "#any?" do
+  it "is true when there are errors " do
     list = Valcro::ErrorList.new
 
     expect(list.any?).to be_falsey
-    list.add :prop, 'some error'
+    list.add :prop, "some error"
 
     expect(list.any?).to be_truthy
   end
 end
 
-describe Valcro::ErrorList, '#none?' do
-  it 'is true when there no errors 'do
+describe Valcro::ErrorList, "#none?" do
+  it "is true when there no errors " do
     list = Valcro::ErrorList.new
 
     expect(list.none?).to be_truthy
-    list.add :prop, 'some error'
+    list.add :prop, "some error"
 
     expect(list.none?).to be_falsey
   end
 end
 
-describe Valcro::ErrorList, '#clear!' do
-  it 'removes all errors' do
+describe Valcro::ErrorList, "#clear!" do
+  it "removes all errors" do
     list = Valcro::ErrorList.new
-    list.add :prop, 'some error'
+    list.add :prop, "some error"
     expect(list.any?).to be_truthy
 
     list.clear!

data/spec/error_spec.rb

@@ -1,25 +1,26 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Valcro::Error do
-  it 'has a property and a message' do
-    error = create_error(:prop, 'message')
+  it "has a property and a message" do
+    error = create_error(:prop, "message")
 
     expect(error.property).to eq(:prop)
-    expect(error.message).to eq('message')
+    expect(error.message).to eq("message")
   end
 
-  it 'can coerce to a string' do
+  it "can coerce to a string" do
     error = create_error
-    expect(error.to_s).to eq('prop message')
+    expect(error.to_s).to eq("prop message")
   end
 
-  it 'does not include property if it is base' do
+  it "does not include property if it is base" do
     error = create_error(:base)
-    expect(error.to_s).to eq('message')
+    expect(error.to_s).to eq("message")
   end
 
-  def create_error(prop = :prop, message = 'message')
+  def create_error(prop = :prop, message = "message")
     Valcro::Error.new(prop, message)
   end
 end
-

data/spec/runner_spec.rb

@@ -1,16 +1,18 @@
-require 'spec_helper'
+# frozen_string_literal: true
+
+require "spec_helper"
 
 describe Valcro::Runner do
-  it 'can store validators' do
+  it "can store validators" do
     runner = Valcro::Runner.new
     runner.add_validator :some_validator
     expect(runner.validators).to have(1).validator
   end
 
-  it 'runs validators' do
+  it "runs validators" do
     error_list = Valcro::ErrorList.new
-    runner     = Valcro::Runner.new(error_list)
-    runner.add_validator lambda { |errors| errors.add :foo, 'Huge mistake' }
+    runner = Valcro::Runner.new(error_list)
+    runner.add_validator lambda { |errors| errors.add :foo, "Huge mistake" }
 
     runner.validate
 

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
-require 'valcro'
-require 'rspec/collection_matchers'
+# frozen_string_literal: true
+
+require "valcro"
+require "rspec/collection_matchers"
+
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
@@ -8,7 +11,7 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
+  config.order = "random"
 
   config.expect_with :rspec do |c|
     c.syntax = :expect

data/spec/valcro_spec.rb

@@ -1,26 +1,28 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Valcro do
-  class TestClass
-    include Valcro
-  end
+require "spec_helper"
+
+class TestClass
+  include Valcro
+end
 
-  it 'is valid with no validations defined' do
+describe Valcro do
+  it "is valid with no validations defined" do
     expect(TestClass.new.valid?).to be_truthy
   end
 end
 
-describe Valcro, 'adding some errors' do
+describe Valcro, "adding some errors" do
   let(:test_class) do
     Class.new do
-    include Valcro
+      include Valcro
     end
   end
 
-  it 'gives access to the error list' do
+  it "gives access to the error list" do
     test_instance = test_class.new
 
-    test_instance.errors.add(:foo, 'too foo for my taste')
+    test_instance.errors.add(:foo, "too foo for my taste")
 
     expect(test_instance.errors[:foo]).to have(1).error
 
@@ -28,16 +30,17 @@ describe Valcro, 'adding some errors' do
   end
 end
 
-describe Valcro, 'validators' do
-  class StatusFailValidator
-    def initialize(context)
-      @context = context
-    end
-    def call(errors)
-      errors.add(:status, 'big mistake') if @context.status == 'fail'
-    end
+class StatusFailValidator
+  def initialize(context)
+    @context = context
+  end
+
+  def call(errors)
+    errors.add(:status, "big mistake") if @context.status == "fail"
   end
+end
 
+describe Valcro, "validators" do
   let(:test_class) do
     Class.new do
       include Valcro
@@ -49,50 +52,96 @@ describe Valcro, 'validators' do
     end
   end
 
-  it 'can be added validators' do
+  it "can be added validators" do
+    test_instance = test_class.new
+
+    test_instance.validate
+    expect(test_instance).not_to be_valid
+  end
+
+  it "clears validations on subsequent runs" do
+    test_instance = test_class.new
+
+    test_instance.validate
+    expect(test_instance).not_to be_valid
+
+    test_instance.status = "win"
+    test_instance.validate
+    expect(test_instance).to be_valid
+  end
+end
+
+class ScopedStatusFailValidator
+  def self.build(context)
+    new(context.status)
+  end
+
+  def initialize(status)
+    @status = status
+  end
+
+  def call(errors)
+    errors.add(:status, "big mistake") if @status == "fail"
+  end
+end
+
+describe Valcro, "reusable validators" do
+  let(:test_class) do
+    Class.new do
+      include Valcro
+      attr_accessor :status
+      def status
+        @status ||= "fail"
+      end
+
+      validates_with ScopedStatusFailValidator
+    end
+  end
+
+  it "can be added validators" do
     test_instance = test_class.new
 
     test_instance.validate
     expect(test_instance).not_to be_valid
   end
 
-  it 'clears validations on subsequent runs' do
+  it "clears validations on subsequent runs" do
     test_instance = test_class.new
 
     test_instance.validate
     expect(test_instance).not_to be_valid
 
-    test_instance.status = 'win'
+    test_instance.status = "win"
     test_instance.validate
     expect(test_instance).to be_valid
   end
 end
 
-describe Valcro, '#error_messages' do
+describe Valcro, "#error_messages" do
   let(:test_class) do
     Class.new { include Valcro }
   end
 
-  it 'delegates to errors' do
+  it "delegates to errors" do
     test_instance = test_class.new
-    allow(test_instance).to receive(:errors).and_return(double(to_s: 'some errors'))
+    allow(test_instance).to receive(:errors).and_return(double(to_s: "some errors"))
 
-    expect(test_instance.error_messages).to eq('some errors')
+    expect(test_instance.error_messages).to eq("some errors")
   end
 end
 
-describe Valcro, '.validate' do
+describe Valcro, ".validate" do
   let(:test_class) do
     Class.new do
       include Valcro
       attr_accessor :works
       validate do
-        errors.add(:works, 'does not work') unless works
+        errors.add(:works, "does not work") unless works
       end
     end
   end
 
-  it 'sets validations on the included class' do
+  it "sets validations on the included class" do
     test_instance = test_class.new
     test_instance.works = false
     test_instance.validate

data/valcro.gemspec

@@ -1,24 +1,21 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "valcro/version"
 
 Gem::Specification.new do |s|
-  s.name        = "valcro"
-  s.version     = Valcro::VERSION
-  s.authors     = ["Harold Giménez"]
-  s.email       = ["harold.gimenez@gmail.com"]
-  s.homepage    = "https://github.com/hgimenez/valcro"
-  s.summary     = %q{The simplest possible validation library for Ruby}
-  s.description = %q{Valcro is a validation library for arbitrary ruby objects. I's primary goal is to remain as simple as possible so that it can be useful to a large surface of use cases remaining easily extensible.}
+  s.name = "valcro"
+  s.version = Valcro::VERSION
+  s.authors = ["Harold Giménez"]
+  s.email = ["harold.gimenez@gmail.com"]
+  s.homepage = "https://github.com/hgmnz/valcro"
+  s.summary = "The simplest possible validation library for Ruby"
+  s.description = "Valcro is a validation library for arbitrary ruby objects. I's primary goal is to remain as simple as possible so that it can be useful to a large surface of use cases remaining easily extensible."
 
-  s.rubyforge_project = "valcro"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "rspec-collection_matchers"
   s.add_development_dependency "rake"
+  s.add_development_dependency "standardrb"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valcro
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Harold Giménez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Valcro is a validation library for arbitrary ruby objects. I's primary
   goal is to remain as simple as possible so that it can be useful to a large surface
   of use cases remaining easily extensible.
@@ -61,8 +75,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/specs.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -78,10 +92,10 @@ files:
 - spec/spec_helper.rb
 - spec/valcro_spec.rb
 - valcro.gemspec
-homepage: https://github.com/hgimenez/valcro
+homepage: https://github.com/hgmnz/valcro
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,14 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: valcro
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: The simplest possible validation library for Ruby
-test_files:
-- spec/error_list_spec.rb
-- spec/error_spec.rb
-- spec/runner_spec.rb
-- spec/spec_helper.rb
-- spec/valcro_spec.rb
+test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4.1