validacity 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff1728df7b05d4d9882b039884cba8985df95824810d8f64f2a363d6f109655a
-  data.tar.gz: 1b2071f2cf21c10aeda419eb264e456942550a50fe79acb9fdaabbd7b3110304
+  metadata.gz: 66d3268535c64fc2c2771ef680fa9b58e999e74296ce83687309e7e63f9e0975
+  data.tar.gz: 65c93549bfb2dffc693f7dddddcf588e28595de5c10d8c56187492b10497a9a3
 SHA512:
-  metadata.gz: 15d81cf9ad56fd8255984d73e98a1e825bd380f70b002324f22c7e292b098ee6ec01266b95cae5c90906418fc27f7c4f74974a680cbdb9780cc9a1cb4401b69c
-  data.tar.gz: 9ac2b3080c9c2cd2cc34ad483b58961050d4bf63fca2c33020bc9bdbb185e8499959207fc202463dcd7c8a0bdcf458510d210e8b2fdc154f2ba5900f97aff302
+  metadata.gz: 7392af3b88ec32311a21f80932eb7ff4c798bc2cd5808b88a447fb06e9f2672b935a46bca7fce6080075ad4d3e1ff1ba87a62277ae0f336cde383c289b414fc7
+  data.tar.gz: 9451ed7db81476d1226be00706c6f1d5175e12e9b1f28a45c5da13444a6ffe630a65b3547b967f7d9d58096a27d818191cb8c45ace560b47fe06352a261cc390

data/README.md

@@ -1,16 +1,26 @@
 # Validacity
 
-Move your validation logic out of your models or form objects.
+Move validation definitions out of you models and form objects.
 
 ## Usage
 
-You can append validators on-fly and then remove some of them if not needed.
+You can apply multiple sets of validation rules on-fly,
+remove any them if not needed and re-validate object against
+new rules afterwards.
 
-It can be very suitable if you need to validate different states of the same object differently. Say you're using a state machine and each state have it's own field set and the fields from other satates shouldn't be validated at this time.
+By the way, the validation errors will be putten to the object
+so all your view helpers will be available to display the error list.
 
-Or perhaps you just have to many constructions like `validate :blablabla, presence: true` in your model and you want to get rid of it.
+This approach will suitable if you need to validate different states
+of the same object differently. Say you're using a state machine
+and each state has it's own field set and the fields from the other
+satates shouldn't be validated at this time.
 
-All you need is to add a concern to your model:
+Or perhaps you just have to many constructions like
+`validate :blablabla, presence: true` in your model class and you want to
+get rid of it so you can focus on buisiness logic.
+
+You can add a concern to your model so it becomes **validatable**:
 
 ```ruby
 
@@ -23,52 +33,78 @@ end
 
 ```
 
-And generate a validator:
+Generate new validation:
+
+```bash
+
+$ bundle exec rails g validacity:validation UserPersonalData
+
+```
 
 ```ruby
 
-# app/validators/user_personal_data_validator.rb
+# app/validations/user_personal_data_validation.rb
 
-class UserPersonalDataValidator
+class UserPersonalDataValidation
   validate :name, presence_of: true
-  # ...a ton of different validators
+  # ...a ton of different validations
 end
 
 ```
 
-Now call validator with the regular methods like:
+Now let's try to validate your user object:
 
 
 ```ruby
 
-user.valid?
+user = User.new
+
+user.valid? # => false
+
+user.name = "John"
+
+uesr.valid? # => true
 
 ```
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
+
 gem 'validacity'
+
 ```
 
 And then execute:
+
 ```bash
+
 $ bundle
+
 ```
 
-Now run the validator installation command:
+Now run the validation installation command:
+
 ```bash
+
 $ bundle exec rails g validacity:install
+
 ```
 
-And the event validator:
+And the event validation:
+
 ```bash
-$ bundle exec rails g validacity:validator Event
+
+$ bundle exec rails g validacity:validation Event
+
 ```
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/validacity/install_generator.rb

@@ -17,16 +17,16 @@ module Validacity
           require_dependency "validacity"
 
           Validacity.configure do |config|
-            config.search_paths "#{__dir__}/../app/validators/**/*_validator.rb"
+            config.search_paths "#{__dir__}/../../app/validations/**/*_validation.rb"
           end
         RUBY
         create_file "config/initializers/validacity_initializer.rb", content
       end
 
       def copy_application_policy
-        validator_file = File.join("app/validators", class_path,
-                                   "application_validator.rb")
-        template "application_validator.rb", validator_file
+        validation_file = File.join("app/validations", class_path,
+                                   "application_validation.rb")
+        template "application_validation.rb", validation_file
       end
 
       include Thor::Actions

data/lib/generators/validacity/templates/application_validation.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class ApplicationValidation < Validacity::BaseValidation
+end
+<% end -%>

data/lib/generators/validacity/templates/validation.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Validation < ApplicationValidation
+end
+<% end -%>

data/lib/generators/validacity/validation_generator.rb

@@ -0,0 +1,13 @@
+module Validacity
+  module Generators
+    class ValidationGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_validation
+        validation_file = File.join("app/validations", class_path,
+                                   "#{file_name}_validation.rb")
+        template "validation.rb", validation_file
+      end
+    end
+  end
+end

data/lib/validacity.rb

@@ -3,7 +3,7 @@ require "active_model"
 
 require "validacity/version"
 require "validacity/configuration"
-require "validacity/base_validator"
+require "validacity/base_validation"
 require "validacity/validatable"
 
 module Validacity
@@ -16,23 +16,23 @@ module Validacity
       yield configuration if block_given?
     end
 
-    def validators
-      @_validators ||= {}
+    def validations
+      @_validations ||= {}
     end
 
-    def find_validator(name)
-      validator = validators[name]
-      return validator if validator
+    def find_validation(name)
+      validation = validations[name]
+      return validation if validation
 
-      reload_validators
-      validators[name]
+      reload_validations
+      validations[name]
     end
 
     private
 
-    def reload_validators
-      Dir.glob(configuration.search_paths) do |validator|
-        send(require_method, validator)
+    def reload_validations
+      Dir.glob(configuration.search_paths) do |validation|
+        send(require_method, validation)
       end
     end
 

data/lib/validacity/{base_validator.rb → base_validation.rb}

@@ -1,16 +1,16 @@
 module Validacity
-  class BaseValidator
+  class BaseValidation
     include ::ActiveModel::Validations
 
     class << self
       def inherited(klass)
-        Validacity.validators[validator_name(klass)] = klass
+        Validacity.validations[validation_name(klass)] = klass
       end
 
       private
 
-      def validator_name(klass)
-        klass.name.gsub(/Validator$/, "").underscore.to_sym
+      def validation_name(klass)
+        klass.name.gsub(/Validation$/, "").underscore.to_sym
       end
     end
 

data/lib/validacity/validatable.rb

@@ -4,44 +4,44 @@ module Validacity
 
     class_methods do
       def validations(*names)
-        names.each { |n| validacity_validators << n }
+        names.each { |n| validacity_validations << n }
       end
 
-      def validacity_validators
-        @_validacity_validators ||= Set.new
+      def validacity_validations
+        @_validacity_validations ||= Set.new
       end
 
       def new(resource)
         instance = super
-        instance.validacity_validators.merge(validacity_validators.dup)
+        instance.validacity_validations.merge(validacity_validations.dup)
         instance
       end
     end
 
-    def validacity_validators
-      @_validacity_validators ||= Set.new
+    def validacity_validations
+      @_validacity_validations ||= Set.new
     end
 
     def valid?(context = nil)
       super
-      validacity_validators_run(context)
+      validacity_validations_run(context)
       errors.empty?
     end
 
     private
 
-    def validacity_validators_run(_context = nil)
-      each_validator_instance(&:validate)
+    def validacity_validations_run(_context = nil)
+      each_validation_instance(&:validate)
     end
 
-    def each_validator_instance
-      @_validacity_validators_instances ||= {}
-      validacity_validators.each do |name|
-        unless (validator = @_validacity_validators_instances[name])
-          validator = Validacity.find_validator(name).new(self)
-          @_validacity_validators_instances[name] = validator
+    def each_validation_instance
+      @_validacity_validations_instances ||= {}
+      validacity_validations.each do |name|
+        unless (validation = @_validacity_validations_instances[name])
+          validation = Validacity.find_validation(name).new(self)
+          @_validacity_validations_instances[name] = validation
         end
-        yield(validator)
+        yield(validation)
       end
     end
   end

data/lib/validacity/version.rb

@@ -1,3 +1,3 @@
 module Validacity
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validacity
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ivan Zinovyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,11 +122,11 @@ files:
 - README.md
 - Rakefile
 - lib/generators/validacity/install_generator.rb
-- lib/generators/validacity/templates/application_validator.rb
-- lib/generators/validacity/templates/validator.rb
-- lib/generators/validacity/validator_generator.rb
+- lib/generators/validacity/templates/application_validation.rb
+- lib/generators/validacity/templates/validation.rb
+- lib/generators/validacity/validation_generator.rb
 - lib/validacity.rb
-- lib/validacity/base_validator.rb
+- lib/validacity/base_validation.rb
 - lib/validacity/configuration.rb
 - lib/validacity/railtie.rb
 - lib/validacity/validatable.rb

data/lib/generators/validacity/templates/application_validator.rb

@@ -1,4 +0,0 @@
-<% module_namespacing do -%>
-class ApplicationValidator < Validacity::BaseValidator
-end
-<% end -%>

data/lib/generators/validacity/templates/validator.rb

@@ -1,4 +0,0 @@
-<% module_namespacing do -%>
-class <%= class_name %>Validator < ApplicationValidator
-end
-<% end -%>

data/lib/generators/validacity/validator_generator.rb

@@ -1,13 +0,0 @@
-module Validacity
-  module Generators
-    class ValidatorGenerator < ::Rails::Generators::NamedBase
-      source_root File.expand_path("templates", __dir__)
-
-      def create_validator
-        validator_file = File.join("app/validators", class_path,
-                                   "#{file_name}_validator.rb")
-        template "validator.rb", validator_file
-      end
-    end
-  end
-end