tram-examiner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d816f154d33841991a60815a414ebfdf5602d28a
+  data.tar.gz: 4ae299542eb04b2d9f7903623b4bafd7512f67a5
+SHA512:
+  metadata.gz: 3c3e6de927cbb1ca297bc30b787085be44aafa4309d796826d059028ae5928cf399bed8d4fcd48764744121acc5fcf166946c0a4e08b277dc84a07f1b005ae03
+  data.tar.gz: 462a0f758959d001d73f0d3c09abd915e0d49ede32e43cd8b24800e92230d9d3f04d2d28aca6a0d273e469be61db7940547640107500ec1dd5db7bafda26a353

data/.codeclimate.yml

@@ -0,0 +1,18 @@
+---
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/FrozenStringLiteralComment:
+        enabled: false
+      Rubocop/Style/Documentation:
+        enabled: false
+      Rubocop/Style/ClassAndModuleChildren:
+        enabled: false
+      Rubocop/Style/SpaceInLambdaLiteral:
+        enabled: false
+      Style/SingleLineBlockParams:
+        enabled: false
+ratings:
+  paths:
+    - "lib/**.rb"

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rubocop.todo.yml

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,38 @@
+---
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.3
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/tram-examiner.rb'
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  Exclude:
+    - spec/**.rb
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+sudo:     false
+language: ruby
+cache:    bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - '2.3.0'
+  - '2.4.0'
+  - ruby-head
+before_install: gem install bundler -v 1.12.5
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in evil-client.gemspec
+gemspec
+
+gem "dry-memoizer", git: "https://github.com/nepalez/dry-memoizer"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Andrew Kozin (nepalez)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Tram::Examiner
+
+The gem allows to add a standalone validator to Ruby classes.
+
+This is a part of collection of patterns extracted from Rails projects with a special focus on separation and composability of data validators.
+
+[![Gem Version][gem-badger]][gem]
+[![Build Status][travis-badger]][travis]
+[![Dependency Status][gemnasium-badger]][gemnasium]
+[![Code Climate][codeclimate-badger]][codeclimate]
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tram-examiner'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install tram-examiner
+```
+
+## Usage
+
+Include the module to the class and define validation rules inside the `schema` block.
+
+```ruby
+require "tram-examiner"
+
+class User < Struct.new(:name, :age)
+  include Tram::Examiner
+
+  examiner do
+    validates :name, presence: true
+  end
+end
+```
+
+Inside the block you should use standard ActiveModel validations. The trick is that instead of including `ActiveModel::Validations` directly, the examiner adds validations to a separate decorator, wrapped around validated object.
+
+It adds a variable `@__examiner__`, which refers to that standalone decorator. Access to validation result is provided via delegators `valid?`, `validate!` and `errors`.
+
+```ruby
+user = User.new '', 46
+
+user.valid?          # => false
+user.validate!       # Boom with #<<ActiveModel::ValidationError: Validation failed: Name can't be blank>
+user.errors.messages # => { name: ["cannot be blank"] }
+```
+
+Under the hood:
+
+```ruby
+user.is_a? ActiveModel::Validations
+# => false
+
+user.instance_variable_get(:@__examiner__).is_a? ActiveModel::Validations
+# => true
+```
+
+For syntax sugar you can use `let` memoizer helper inside the `examiner` block:
+
+```ruby
+class User < Struct.new(:first_name, :last_name, :age)
+  include Tram::Examiner
+
+  examiner do
+    let(:name) { [first_name, last_name].compact.join(" ") }
+    validates :name, presence: true
+  end
+end
+
+user = User.new '', '', 51
+user.errors.messages # => { name: ["cannot be blank"] }
+```
+
+Notice the block is evaluated in the scope of standalone validator, not the current class!
+That is why neither `let`, nor `validates` are available outside of the block.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[codeclimate-badger]: https://img.shields.io/codeclimate/github/tram-rb/tram-examiner.svg?style=flat
+[codeclimate]: https://codeclimate.com/github/tram-rb/tram-examiner
+[gem-badger]: https://img.shields.io/gem/v/tram-examiner.svg?style=flat
+[gem]: https://rubygems.org/gems/tram-examiner
+[gemnasium-badger]: https://img.shields.io/gemnasium/tram-rb/tram-examiner.svg?style=flat
+[gemnasium]: https://gemnasium.com/tram-rb/tram-examiner
+[travis-badger]: https://img.shields.io/travis/tram-rb/tram-examiner/master.svg?style=flat
+[travis]: https://travis-ci.org/tram-rb/tram-examiner

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/tram/examiner/results.rb

@@ -0,0 +1,36 @@
+require "active_model"
+require "dry-memoizer"
+
+module Tram::Examiner
+  # Container for standalone validation of PORO instance
+  class Results < SimpleDelegator
+    extend  Dry::Memoizer # adds `let` syntax
+    include ActiveModel::Validations
+
+    class << self
+      def subject(value = nil)
+        (value ? @subject = value : @subject)
+      end
+
+      def model_name
+        @model_name ||= ActiveModel::Name.new(subject || Tram::Examiner)
+      end
+
+      def inspect
+        "Tram::Examiner::Results[#{model_name}]"
+      end
+    end
+
+    def inspect
+      "#<Tram::Examiner::Results[#{model_name}] @errors=#{errors}>"
+    end
+
+    private
+
+    def initialize(subject)
+      return super if subject.is_a?(self.class.subject)
+      raise "#{self.class.inspect} was designed as a standalone validator" \
+            " for instances of #{self.class.subject}, not the #{subject.class}."
+    end
+  end
+end

data/lib/tram/examiner.rb

@@ -0,0 +1,35 @@
+module Tram
+  # Adds standalone validator to the instances of current class
+  module Examiner
+    require_relative "examiner/results"
+
+    # Adds class method helper to define validation rules
+    module DSL
+      def examiner(&block)
+        @examiner ||= Class.new(Results).tap { |exam| exam.subject(self) }
+        @examiner.tap { |klass| klass.instance_eval(&block) if block }
+      end
+
+      def inherited(klass)
+        new_examiner = Class.new(@examiner).tap { |exam| exam.subject(klass) }
+        klass.instance_variable_set :@examiner, new_examiner
+      end
+    end
+
+    def self.included(klass)
+      klass.extend DSL
+    end
+
+    def validate!
+      (@__examiner__ = self.class.examiner.new(self)).validate!
+    end
+
+    def valid?
+      (@__examiner__ = self.class.examiner.new(self)).valid?
+    end
+
+    def errors
+      (@__examiner__ ||= self.class.examiner.new(self).tap(&:valid?)).errors
+    end
+  end
+end

data/lib/tram-examiner.rb

@@ -0,0 +1 @@
+require_relative "tram/examiner"

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+begin
+  require "pry"
+rescue LoadError
+  nil
+end
+
+require "tram-examiner"
+
+RSpec.configure do |config|
+  config.order = :random
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  # Prepare the Test namespace for constants defined in specs
+  config.around(:each) do |example|
+    Test = Module.new
+    example.run
+    Object.send :remove_const, :Test
+  end
+end

data/spec/tram/examiner_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe Tram::Examiner do
+  before do
+    class Test::User
+      include Tram::Examiner
+
+      attr_reader :first_name, :second_name
+      def initialize(first_name, second_name)
+        @first_name  = first_name
+        @second_name = second_name
+      end
+
+      examiner do
+        let(:name) { [first_name, second_name].compact.join(" ") }
+        validates :name, presence: true
+      end
+    end
+  end
+
+  it "doesn't include ActiveModel::Validations into the class" do
+    expect(Test::User.new("", "")).not_to be_a ActiveModel::Validations
+  end
+
+  context "#valid?" do
+    it "works" do
+      expect(Test::User.new("", "")).not_to be_valid
+      expect(Test::User.new("Andy", "")).to be_valid
+    end
+  end
+
+  context "#errors" do
+    it "works" do
+      expect(Test::User.new("", "").errors).not_to be_empty
+      expect(Test::User.new("Andy", "").errors).to be_empty
+    end
+  end
+
+  context "#validate!" do
+    it "works" do
+      expect { Test::User.new("", "").validate! }
+        .to raise_error ActiveModel::ValidationError
+
+      expect { Test::User.new("Andy", "").validate! }
+        .not_to raise_error
+    end
+  end
+end

data/tram-examiner.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |gem|
+  gem.name     = "tram-examiner"
+  gem.version  = "0.0.1"
+  gem.author   = "Andrew Kozin (nepalez)"
+  gem.email    = "andrew.kozin@gmail.com"
+  gem.homepage = "https://github.com/nepalez/tram-examiner"
+  gem.summary  = "Standalone validator for Rails objects"
+  gem.license  = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = gem.files.grep(/^spec/)
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
+
+  gem.required_ruby_version = ">= 2.3"
+
+  gem.add_runtime_dependency "dry-memoizer", "~> 0.0.1"
+  gem.add_runtime_dependency "activemodel",  "~> 5.0"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: tram-examiner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kozin (nepalez)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-memoizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 
+email: andrew.kozin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tram-examiner.rb
+- lib/tram/examiner.rb
+- lib/tram/examiner/results.rb
+- spec/spec_helper.rb
+- spec/tram/examiner_spec.rb
+- tram-examiner.gemspec
+homepage: https://github.com/nepalez/tram-examiner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Standalone validator for Rails objects
+test_files:
+- spec/spec_helper.rb
+- spec/tram/examiner_spec.rb