verifly 0.1.0.0 → 0.2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f523cb22087d0d7c74367fd62024dcdfb54304e
-  data.tar.gz: 3d6c1a22923b9e3c2878cbed2dd6df65295a0405
+  metadata.gz: bb480769ef6ceb801e8d09f52eb9eab8a31bd356
+  data.tar.gz: fb911427e5d26cb1f10ae5142af217aae51110fc
 SHA512:
-  metadata.gz: eb92359f062778ff644ccd41576b4023fcfcfe0af935b0c6edcf549ec4f9e5ea439bb24f617a0003935431313762925620f2e10366bffcad860d48873862ebf7
-  data.tar.gz: 033ac456b04c5cfec227311a83ba3f16f32790632ee9966e103c8ea2d2d09fb36ce83642ec7ccefd9316e32ce65166188014cd613c7997b230d900b924be1ab6
+  metadata.gz: e22e09f78908ed3e451c3ce90d1e1c7d439cb1c69c8c356c4fd858ea2bbd3a071713c62666d6c74e364bc57faa61207cd3425e897b76fc834a1394f2bbe8bcb5
+  data.tar.gz: c5f4a1fd4a51b470cc12c5b4f57086a0e526919abbbbb949ef6781d3efb2e2b6645b879a14a4866ebeecb9ffaf4bb504ab2607e6f4258d0f61aa642ef1016c39

data/lib/verifly.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Verifly provides several usefull classes, but most important
-# is Verifier. Other provided classes are it's dependency.
-# See README.md or their own documentation for more info about usage
+# Verifly provides several useful classes, but Verifier is the most
+# important one, while others depend on it.
+# See README.md or in-code documentation for more info.
 module Verifly
   autoload :VERSION, 'verifly/version'
 

data/lib/verifly/applicator.rb

@@ -33,7 +33,7 @@ module Verifly
     end
 
     # MethodExtractor is used when applicable is a symbol.
-    # It extracts extracts method from binding_ and executes it on binding_
+    # It extracts a method from binding_ and executes it on binding_
     # (so it works just like send except it sends nothing
     # when method arity is zero).
     # @example
@@ -42,14 +42,14 @@ module Verifly
     #   # or => User.new.foo, if it does not accept context
     class MethodExtractor < self
       # @param applicable [Symbol]
-      # @return MethodExtractor if applicable is Symbol
+      # @return MethodExtractor if applicable is a Symbol
       # @return [nil] otherwise
       def self.build_class(applicable)
         self if applicable.is_a?(Symbol)
       end
 
-      # @param binding_ [#instance_exec] target to apply applicable
-      # @param context additional info to send it to applicable
+      # @param binding_ [#instance_exec] target to apply applicable to
+      # @param context additional info to send to applicable
       # @return application result
       def call(binding_, context)
         if binding_.is_a?(Binding)
@@ -61,9 +61,9 @@ module Verifly
 
       private
 
-      # When Binding is target, we have to respect both methods and variables
-      # @param binding_ [Binding] target to apply applicable
-      # @param context additional info to send it to applicable
+      # When Binding is a target, we have to respect both methods and variables
+      # @param binding_ [Binding] target to apply applicable to
+      # @param context additional info to send to applicable
       # @return application result
       def call_on_binding(binding_, context)
         if binding_.receiver.respond_to?(applicable)
@@ -74,21 +74,21 @@ module Verifly
       end
     end
 
-    # InstanceEvaluator is used for string. It works like instance_eval or
+    # InstanceEvaluator is used for strings. It works like instance_eval or
     # Binding#eval depending on binding_ class
     # @example
     #   Applicator.call('foo if context[:foo]', binding_, context)
     #   # => foo if context[:foo]
     class InstanceEvaluator < self
       # @param applicable [String]
-      # @return InstanceEvaluator if applicable is String
+      # @return InstanceEvaluator if applicable is a String
       # @return [nil] otherwise
       def self.build_class(applicable)
         self if applicable.is_a?(String)
       end
 
-      # @param binding_ [#instance_exec] target to apply applicable
-      # @param context additional info to send it to applicable
+      # @param binding_ [#instance_exec] target to apply applicable to
+      # @param context additional info to send to applicable
       # @return application result
       def call(binding_, context)
         if binding_.is_a?(Binding)
@@ -111,10 +111,10 @@ module Verifly
     end
 
     # ProcApplicatior is used when #to_proc is available.
-    # It works not just with procs, but also with hashes etc
-    # @example with proc
+    # It works not only with procs, but also with hashes etc
+    # @example with a proc
     #   Applicator.call(-> { foo }, binding_, context) # => foo
-    # @example with hash
+    # @example with a hash
     #   Applicator.call(Hash[foo: true], binding_, :foo) # => true
     #   Applicator.call(Hash[foo: true], binding_, :bar) # => nil
     class ProcApplicatior < self
@@ -125,8 +125,8 @@ module Verifly
         self if applicable.respond_to?(:to_proc)
       end
 
-      # @param binding_ [#instance_exec] target to apply applicable
-      # @param context additional info to send it to applicable
+      # @param binding_ [#instance_exec] target to apply applicable to
+      # @param context additional info to send to applicable
       # @return application result
       def call(binding_, context)
         invoke_lambda(applicable.to_proc, binding_, context)
@@ -151,9 +151,9 @@ module Verifly
     attr_accessor :applicable
 
     # Applies applicable on binding_ with context
-    # @todo add @see #initialize when it's todo done
+    # @todo add @see #initialize when its todo is done
     # @param applicable [applicable]
-    #   see examples in defenitions of sublcasses
+    #   see examples in definitions of subclasses
     # @param binding_ [#instance_exec]
     #   where should applicable be applied. It could be either a generic object,
     #   where it would be `instance_exec`uted, or a binding_
@@ -168,7 +168,7 @@ module Verifly
     # Always use build instead of new
     # @todo add more examples right here
     # @param applicable [applicable]
-    #   see examples in sublcasses defenitions
+    #   see examples in definitions of sublclasses
     # @api private
     def initialize(applicable)
       self.applicable = applicable
@@ -189,7 +189,7 @@ module Verifly
 
     private
 
-    # invokes lambda respecting it's arity
+    # invokes lambda respecting its arity
     # @param [Proc] lambda
     # @param binding_ [#instance_exec] binding_ would be used in application
     # @param context param would be passed if lambda arity > 0

data/lib/verifly/applicator_with_options.rb

@@ -9,25 +9,32 @@ module Verifly
   # @attr action [Applicator]
   #   main action to apply on call
   # @attr if_condition [Applicator]
-  #   main action only apply if this applies to truthy value
+  #   main action only apply if condition evaluates to truthy value
   # @attr unless_condition [Applicator]
-  #   main action only apply if this applies to falsey value
+  #   main action only apply if condition evaluates to falsey value
   class ApplicatorWithOptions
     attr_accessor :action, :if_condition, :unless_condition
 
+    # @!method initialize(action = block, options = {}, &block)
     # @param action [applicable] main action
     # @option options [applicable] :if
-    #   main action only apply if this applies to truthy value
+    #   main action is only applied if this evaluates to truthy value
     # @option options [applicable] :unless
-    #   main action only apply if this applies to falsey value
-    def initialize(action, **options)
+    #   main action is only applied if this evaluates to falsey value
+    # @raise [ArgumentError] if there is more than two arguments and block
+    # @raise [ArgumentError] if there is zero arguments and no block
+    def initialize(*args, &block)
+      action, options, *rest = block ? [block, *args] : args
+      options ||= {}
+      raise ArgumentError unless action && rest.empty?
+
       self.action = Applicator.build(action)
       self.if_condition = Applicator.build(options.fetch(:if, true))
       self.unless_condition = Applicator.build(options.fetch(:unless, false))
     end
 
-    # Applies main action if if_condition applyd to truthy value
-    # and unless_condition applyd to falsey value
+    # Applies main action if if_condition is evaluated to truthy value
+    # and unless_condition is evaluated to falsey value
     # @param binding_ [#instance_exec]
     #   binding to apply (see Applicator)
     # @param context

data/lib/verifly/class_builder.rb

@@ -1,27 +1,28 @@
 # frozen_string_literal: true
 
 module Verifly
-  # ClassBuilder is something like Uber::Builder, but it
-  # allows the child classes to decide whether they will be used.
-  # I find it much more OOPish
+  # ClassBuilder is similar to Uber::Builder, but it
+  # allows child classes to decide whether they will be used.
+  # I find it much more object-oriented
   # @attr klasses [Array(Class)]
   #   classes to iterate during search of most suitable
   class ClassBuilder
-    # Mixin provides useful methods to integrate builder subsystem.
+    # Mixin provides useful methods to integrate into builder subsystem.
     # Feel free to override or just never include it.
     # @attr_writer [Array(Class)] buildable_classes
     #   Array of classes which will be checked if they
     #   suite constructor arguments. Order matters
     module Mixin
-      # Array of classes which would be checked if they
+      # Array of classes which will be checked if they
       # suite constructor arguments. Order matters
       # @param klasses [Array(Class)]
       def buildable_classes=(klasses)
         @class_builder = ClassBuilder.new(klasses).freeze
       end
 
-      # Default implementation of build_class. Feel free to change
-      # You also have to override it in buildable_classes
+      # Default implementation of build_class.
+      # Feel free to change it, but you'll have to override it in
+      # buildable_classes
       def build_class(*args, &block)
         if @class_builder
           @class_builder.call(*args, &block)

data/lib/verifly/verifier.rb

@@ -15,35 +15,54 @@ module Verifly
 
     attr_accessor :model, :messages
 
-    # @example with block
+    # @!method self.verify(action = block, options = {}, &block)
+    # @example with a block
     #   verify { |context| message!() if context[:foo] }
-    # @example with proc
+    # @example with a proc
     #   verify -> (context) { message!() if context[:foo] }
-    # @example with hash
+    # @example with a hash
     #  verify -> { message!() } if: { foo: true }
-    # @example cotnext could be ommited from lambda params
+    # @example context can be provided as a lambda param
     #   verify -> { message!() }, if: -> (context) { context[:foo] }
-    # @example with symbol
+    # @example with a symbol
     #   verify :foo, if: :bar
     #   # calls #foo if #bar is true
-    #   # bar could either accept context or not
-    # @example with string
+    #   # bar can accept context if desired
+    # @example with a string
     #  verify 'message!() if context[:foo]'
     #  verify 'message!()', if: 'context[:foo]'
-    # @example with descedant
-    #   verify DescendantClass
-    #   # calls DescendantClass.call(model, context) and merges it's messages
-    # @param verifier [#to_proc|Symbol|String|Class|nil]
+    # @param action [#to_proc|Symbol|String|nil]
     #   verifier defenition, see examples
     # @option options [#to_proc|Symbol|String|nil] if (true)
+    #   call verifier only if block invocation result is truthy
+    # @option options [#to_proc|Symbol|String|nil] unless (false)
+    #   call verifier only if block invocation result is falsey
+    # @yield [context] yields on `#verfify!` calls
+    # @raise [ArgumentError] if there is more than two arguments and block
+    # @raise [ArgumentError] if there is zero arguments and no block
+    # @return [Array] list of all defined verifiers
+    def self.verify(*args, &block)
+      bound_applicators << ApplicatorWithOptions.new(*args, &block)
+    end
+
+    # Calls DescendantClass.call(model, context) and merges its messages.
+    # DescendantClass should be a descendant of current class
+    # @param name [String, Class]
+    #   name of descendant class or descendant class itself
+    # @option options [#to_proc|Symbol|String|nil] if (true)
     #   call verifier if only block invocation result is truthy
     # @option options [#to_proc|Symbol|String|nil] unless (false)
     #   call verifier if only block invocation result is falsey
-    # @yield context on `#verfify!` calls
     # @return [Array] list of all verifiers already defined
-    def self.verify(*args, &block)
-      bound_applicators <<
-        ApplicatorWithOptionsBuilder.call(self, *args, &block)
+    def self.verify_with(name, options = {})
+      verify(options) do |context|
+        verifier = name.is_a?(String) ? Object.const_get(name, false) : name
+        raise ArgumentError, <<~ERROR unless verifier < self.class
+          Nested verifiers should be inherited from verifier they nested are in
+        ERROR
+
+        messages.concat(verifier.call(model, context))
+      end
     end
 
     # @return [Array(ApplicatorWithOptions)]
@@ -53,8 +72,8 @@ module Verifly
     end
 
     # @param model generic model to validate
-    # @param context context in which it would be valdiated
-    # @return [Array] list of messages yielded by verifier
+    # @param context context in which it is valdiated
+    # @return [Array] list of messages yielded by the verifier
     def self.call(model, context = {})
       new(model).verify!(context)
     end
@@ -65,8 +84,8 @@ module Verifly
       self.messages = []
     end
 
-    # @param context context in which model would be valdiated
-    # @return [Array] list of messages yielded by verifier
+    # @param context context in which model is valdiated
+    # @return [Array] list of messages yielded by the verifier
     def verify!(context = {})
       self.messages = []
 
@@ -80,7 +99,8 @@ module Verifly
     private
 
     # @abstract
-    #   implement it like `super { Message.new(status, text, description) }`
+    #   implementation example:
+    #   `super { Message.new(status, text, description) }`
     # @return new message (yield result)
     def message!(*)
       new_message = yield

data/lib/verifly/version.rb

@@ -3,10 +3,10 @@
 module Verifly
   # Specifies Verifly version
   #
-  # Semantical naming: 0.a.b.c where
-  # * 0 is for unreleased
-  # * a is for public api changes
-  # * b is for private api changes
-  # * c is for changes, not changing private api
-  VERSION = '0.1.0.0'
+  # Semantic versioning: 0.a.b.c where
+  # * 0 stands for unreleased
+  # * a stands for public api changes
+  # * b stands for private api changes
+  # * c stands for patch changes (not touching public or private api)
+  VERSION = '0.2.0.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: verifly
 version: !ruby/object:Gem::Version
-  version: 0.1.0.0
+  version: 0.2.0.0
 platform: ruby
 authors:
 - Alexander Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-description: ''
+description: 'See more info at http://www.rubydoc.info/gems/verifly/0.2.0.0 '
 email:
 - begdory4@gmail.com
 executables: []
@@ -162,10 +162,10 @@ files:
 - lib/verifly/applicator_with_options.rb
 - lib/verifly/class_builder.rb
 - lib/verifly/verifier.rb
-- lib/verifly/verifier/applicator_with_options_builder.rb
 - lib/verifly/version.rb
-homepage: http://example.com
-licenses: []
+homepage: https://github.com/umbrellio/verifly
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -173,9 +173,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -186,5 +186,6 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: ''
+summary: An api to run sequential checks like 'ActiveModel::Validations' do, but with
+  generic messages instead of errors
 test_files: []

data/lib/verifly/verifier/applicator_with_options_builder.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-module Verifly
-  class Verifier
-    # Builds ApplicatorWithOptions from different invocation styles.
-    # @api private
-    # @attr base [Class]
-    #   class for which applicator_with_options should be built
-    # @attr args [Array]
-    #   array of arguments Verifier.verify invoked with
-    # @attr block [Proc]
-    #   block Verifier.verify invoked with
-    ApplicatorWithOptionsBuilder = Struct.new(:base, :args, :block)
-    class ApplicatorWithOptionsBuilder
-      # @!method self.call(base)
-      # transforms `verify` arguments to class attributes
-      # and invokes calculation
-      # @raise [ArgumentError]
-      # @return [ApplicatorWithOptions] resulting applicator_with_options
-      def self.call(base, *args, &block)
-        new(base, args, block).call
-      end
-
-      # Tries different invocation styles until one matches
-      # @see #try_block
-      # @see #try_nesting
-      # @see #default
-      # @raise [ArgumentError]
-      # @return [ApplicatorWithOptions] resulting applicator_with_options
-      def call
-        try_block || try_nesting || default
-      end
-
-      private
-
-      # @example with options
-      #   verify(if: true) { ... }
-      # @example without options
-      #   verify { ... }
-      # @return [ApplicatorWithOptions]
-      def try_block
-        ApplicatorWithOptions.new(block, *args) if block
-      end
-
-      # @example correct
-      #   verify SubVerifier
-      # @example incorrect
-      #   verify Class
-      # @raise [ArgumentError]
-      # @return [ApplicatorWithOptions]
-      def try_nesting
-        verifier, *rest = args
-        return unless verifier.is_a?(Class)
-        raise ArgumentError, <<~ERROR unless verifier < base
-          Nested verifiers should be inherited from verifier they nested are in
-        ERROR
-
-        applicable = lambda do |context|
-          messages.concat(verifier.call(model, context))
-        end
-
-        ApplicatorWithOptions.new(applicable, *rest)
-      end
-
-      # Simply passes args to ApplicatorWithOptions
-      # @example
-      #   verify(:foo, unless: false)
-      # @return [ApplicatorWithOptions]
-      def default
-        ApplicatorWithOptions.new(*args)
-      end
-    end
-  end
-end