controller_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dfefb1a267f528e15e8f6569b77762f121b7f55
+  data.tar.gz: 9543cc2bf48569c383cb052b964d501edabc3779
+SHA512:
+  metadata.gz: 326974179e23e24d9111defd871b5121bd5d48be6462e47f63ba78e261857411815b27e8393965f1ac0988b7b8966d55ef44ec5fc68dad3938229a9d864bc84c
+  data.tar.gz: 942e414823657d5ff40141fb7c23d162ad6c6b86505ee66fa82572d97b00c21a8fade932549f531754a11fe4950cdc4f4a1ac56c430ed0b6736cbc9fe85ba3f8

data/.gitignore

@@ -0,0 +1,18 @@
+/.idea
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.sw?
+*.gem
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in controller_validator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Boling
+
+MIT License
+
+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,79 @@
+# ControllerValidator
+
+Simple Validations in the Controller!
+(Re)Use the familiar ActiveModel::Errors pattern for controller validations, so you already know how this works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'controller_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install controller_validator
+
+## Usage
+
+See the integration specs!
+
+```ruby
+class ThingController < ApplicationController
+
+  def create
+
+    @thing = Thing.new
+
+    validator = ValidateThingOnCreate.new()
+    validator.validate_and_push_errors_to(instance: @thing)
+
+    # So far save has not been called on @thing, no callbacks have been run, the model is not involved at all
+
+    if @thing.errors.any?
+      render :new
+    else
+      if @thing.save
+        redirect_to @thing_path(id: @thing.id)
+      else
+        render :new
+      end
+    end
+  end
+
+end
+
+class ValidateThingOnCreate < ControllerValidator::Validator
+
+  # Rules for creating a new thing
+  # 1. There must not be too many things already
+  # 2. There must be no Bobs
+
+  attr_accessor :too_many, :no_bobs
+
+  def initialize()
+    @too_many = Thing.count > 100
+    @no_bobs = Bob.count == 0
+  end
+
+  def validate!
+    errors.add(:too_many, "must not be true") if !self.too_many
+    errors.add(:no_bobs, "must be true") if !self.no_bobs
+    errors.blank?
+  end
+
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/controller_validator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/controller_validator.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'controller_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "controller_validator"
+  spec.version       = ControllerValidator::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+  spec.summary       = %q{Simple Validations in the Controller}
+  spec.description   = %q{Use the familiar ActiveModel::Errors pattern for controller validations}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "reek"
+  spec.add_development_dependency "roodi"
+
+  spec.add_dependency "activemodel", ">= 3"
+end

data/lib/controller_validator.rb

@@ -0,0 +1,6 @@
+require 'controller_validator/version'
+require 'controller_validator/validator'
+
+module ControllerValidator
+
+end

data/lib/controller_validator/validator.rb

@@ -0,0 +1,42 @@
+require 'active_model'
+
+# Nearly entirely lifted from the example code in the Rails Documentation.
+# See: http://www.rubydoc.info/docs/rails/ActiveModel/Errors
+class ControllerValidator::Validator
+
+  include ::ActiveModel::Validations
+
+  attr_reader   :errors
+
+  def initialize(*args)
+    @errors = ::ActiveModel::Errors.new(self)
+  end
+
+  def validate_and_push_errors_to(instance:)
+    unless self.validate!
+      self.errors.full_messages.each do |message|
+        instance.errors.add(:base, message)
+      end
+    end
+  end
+
+  def validate
+    raise RuntimeError, 'Must be defined in subclass of ControllerValidator'
+  end
+
+  # The following methods are needed to be minimally implemented
+
+  def read_attribute_for_validation(attr)
+    send(attr)
+  end
+
+  def self.human_attribute_name(attr, options = {})
+    attr.to_s.humanize
+  end
+
+  def self.lookup_ancestors
+    [self]
+  end
+
+end
+

data/lib/controller_validator/version.rb

@@ -0,0 +1,3 @@
+module ControllerValidator
+  VERSION = "0.0.1"
+end

data/spec/controller_validator/validator_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe ControllerValidator::Validator, :classes do
+  describe 'class methods' do
+
+    describe '.human_attribute_name' do
+      describe 'with required params' do
+        it 'should not raise error' do
+          expect { ControllerValidator::Validator.human_attribute_name(:thing) }.to_not raise_error
+        end
+        it 'should be empty string' do
+          expect( ControllerValidator::Validator.human_attribute_name(:thing) ).to eq 'Thing'
+        end
+      end
+
+      describe 'with optional params' do
+        it 'should not raise error' do
+          expect { ControllerValidator::Validator.human_attribute_name(:thing, {}) }.to_not raise_error
+        end
+        it 'should be empty string' do
+          expect( ControllerValidator::Validator.human_attribute_name(:thing, {}) ).to eq 'Thing'
+        end
+      end
+    end
+
+    describe '.lookup_ancestors' do
+      it 'should not raise error' do
+        expect { ControllerValidator::Validator.lookup_ancestors }.to_not raise_error
+      end
+      it 'should be empty string' do
+        expect( ControllerValidator::Validator.lookup_ancestors ).to eq [ControllerValidator::Validator]
+      end
+    end
+
+  end
+
+  describe 'instance methods' do
+    let(:controller_validator) { ControllerValidator::Validator.new }
+
+    describe '#validate_and_push_errors_to' do
+      let(:active_model_validation_actual) { ControllerValidator::Validator.new }
+      it 'should  raise error' do
+        expect { controller_validator.validate_and_push_errors_to(instance: active_model_validation_actual) }.to raise_error
+      end
+    end
+
+    describe '#validate!' do
+      it 'should raise an error' do
+        expect { controller_validator.validate! }.to raise_error
+      end
+    end
+
+    describe '#read_attribute_for_validation' do
+      it 'should raise error for missing attribute' do
+        expect { controller_validator.read_attribute_for_validation(:thing) }.to raise_error
+      end
+      it 'should not raise error for actual attribute' do
+        expect { controller_validator.read_attribute_for_validation(:errors) }.to_not raise_error
+      end
+      it 'should be nil' do
+        expect( controller_validator.read_attribute_for_validation(:errors) ).to be_a ::ActiveModel::Errors
+      end
+    end
+  end
+
+end

data/spec/integration/my_controller_validator_spec.rb

@@ -0,0 +1,56 @@
+# Integration Spec
+
+class MyControllerValidator < ControllerValidator::Validator
+  attr_accessor :thing
+  def initialize(thing:)
+    @thing = thing
+    super
+  end
+  def validate!
+    self.errors.add(:thing, 'monkeys are flying')
+    self.errors.add(:base, 'cheese so good')
+    self.errors.blank?
+  end
+end
+
+describe MyControllerValidator, :classes do
+
+  describe 'instance methods' do
+    let(:controller_validator) { MyControllerValidator.new(thing: 'hey') }
+
+    describe '.push_errors_to' do
+      let(:active_model_validation_actual) { ControllerValidator::Validator.new }
+      it 'should not raise error' do
+        # instance just needs to be something that implements ActiveModel::Validations
+        expect { controller_validator.validate_and_push_errors_to(instance: active_model_validation_actual) }.to_not raise_error
+      end
+      it 'should be empty string' do
+        expect( controller_validator.validate_and_push_errors_to(instance: active_model_validation_actual) ).to eq ['Thing monkeys are flying','cheese so good']
+      end
+      it 'should add errors to the instance' do
+        controller_validator.validate_and_push_errors_to(instance: active_model_validation_actual)
+        expect( active_model_validation_actual.errors.full_messages ).to eq ['Thing monkeys are flying','cheese so good']
+      end
+    end
+
+    describe '#validate!' do
+      it 'should not raise an error' do
+        expect { controller_validator.validate! }.to_not raise_error
+      end
+      it 'should be false' do
+        expect( controller_validator.validate! ).to eq false
+      end
+    end
+
+    describe '#read_attribute_for_validation' do
+      it 'should not raise error' do
+        expect { controller_validator.read_attribute_for_validation(:thing) }.to_not raise_error
+      end
+      it 'should be nil' do
+        expect( controller_validator.read_attribute_for_validation(:thing) ).to eq 'hey'
+      end
+    end
+
+  end
+
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+-x gems,spec\/

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+require 'controller_validator'
+
+# TODO: Why this deprecation warning?
+# [deprecated] I18n.enforce_available_locales will default to true in the future. If you really want to skip validation of your locale you can set I18n.enforce_available_locales = false to avoid this message.
+I18n.enforce_available_locales = false
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: controller_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: roodi
+  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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Use the familiar ActiveModel::Errors pattern for controller validations
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- controller_validator.gemspec
+- lib/controller_validator.rb
+- lib/controller_validator/validator.rb
+- lib/controller_validator/version.rb
+- spec/controller_validator/validator_spec.rb
+- spec/integration/my_controller_validator_spec.rb
+- spec/rcov.opts
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Simple Validations in the Controller
+test_files:
+- spec/controller_validator/validator_spec.rb
+- spec/integration/my_controller_validator_spec.rb
+- spec/rcov.opts
+- spec/spec_helper.rb