adama 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e62f6593e1502cfac772a33f167c0bbac14635c
-  data.tar.gz: 2eda051000fc7e546346b3db4eda8a7830542dee
+  metadata.gz: 2e5e10093e87083de3399386195d70dc6e1aa5ea
+  data.tar.gz: 558937d4e7c5b20ea59017c91f00099f3e19b52e
 SHA512:
-  metadata.gz: 8e2c2916e4431d88986df3fc430d0e09ff6a0868011cb30310c2af39b468dc542c74dc74083fdd6c8011f446355d5a9a29f6de1591578dda9618c53dbb78b711
-  data.tar.gz: 504500aec933751018fb61dac3d943ed3e5654cca601de17063ddbe4d1ac69f20582d7e49d7740d08a4afd0edecd4e315e10acfcc7814c4a81e78c9c7da64a1e
+  metadata.gz: ac8141a914574111e31dfd7c74eac7d630a69cee6a47a878111563220951cacd0d8ae8edc0aa8fd1a4787b035dfcf6ad13bc5985ef1c2197d0cd2f812a771efc
+  data.tar.gz: 70ff0ecff1640414b2e28939adac0926bcc47edb266d4a65d77a817cb0fcdb8eb4519c4719fa25cf9f2119c0f7bd0bba35fb8e35daea088f47c091f8b64a4f68

data/README.md

@@ -1,6 +1,6 @@
 # Commander Adama
 
-Commander Adama is a bare bones command pattern library inspired by Collective Idea's [Interactor](https://github.com/collectiveidea/interactor) gem.
+Adama is a bare bones command pattern library inspired by Collective Idea's [Interactor](https://github.com/collectiveidea/interactor) gem.
 
 Commands are small classes that represent individual units of work. Each command is executed by a client "calling" it. An invoker is a class responsible for the execution of one or more commands.
 
@@ -38,8 +38,10 @@ At this point our command `DestroyCylons` doesn't do much. As explained above, t
 class DestroyCylons
   include Adama::Command
 
+  validate_presence_of :captain
+
   def call
-    got_destroy_cylons(kwargs[:captain])
+    got_destroy_cylons(captain)
   end
 
   def rollback
@@ -48,7 +50,7 @@ class DestroyCylons
 end
 ```
 
-The kwargs are available within the `#call` and `#rollback` instance methods due to an `attr_reader` in the `Adama::Command` module.
+Each validated attribute is available as an attr_accessor on the instance of the command, so you can reference them directly in the `#call` method. within the `#call` and `#rollback` instance methods due to an `attr_reader` in the `Adama::Command` module.
 
 ### Invoker
 

data/adama.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 end

data/lib/adama.rb

@@ -1,4 +1,6 @@
+require 'pry'
 require "adama/version"
 require "adama/errors"
+require "adama/validator"
 require "adama/command"
 require "adama/invoker"

data/lib/adama/command.rb

@@ -16,6 +16,7 @@ module Adama
     # Internal: Install Command's behavior in the given class.
     def self.included(base)
       base.class_eval do
+        prepend Validator
         extend ClassMethods
         attr_reader :kwargs
       end
@@ -23,12 +24,12 @@ module Adama
 
     module ClassMethods
       # public invoke a command
-      def call(kwargs = {})
-        new(kwargs).tap(&:run)
+      def call(**kwargs)
+        new(**kwargs).tap(&:run)
       end
     end
 
-    def initialize(kwargs = {})
+    def initialize(**kwargs)
       @kwargs = kwargs
     end
 

data/lib/adama/validator.rb

@@ -0,0 +1,100 @@
+module Adama
+  module Validator
+    def self.prepended(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def validates_presence_of(*attributes)
+        # Assign the validator if it exists, ortherwise create a new one and
+        # append it to the validators array
+        unless validator = validators.find { |v| v.is_a? PresenceValidator }
+          validator = PresenceValidator.new
+          validators << validator
+        end
+
+        # Append the passed in attributes. This will result in a list
+        # of unique attributes.
+        validator.merge_new_attributes(*attributes)
+      end
+
+      # Maintain an array of validators
+      def validators
+        @validators ||= []
+      end
+    end
+
+    # This module is meant to be prepended to another module
+    # Call the child class initializer first, this will set kwargs
+    # Then validate
+    def initialize(**kwargs)
+      super(**kwargs)
+      validate!
+    end
+
+    def errors
+      @errors ||= {}
+    end
+
+    def valid?
+      @valid
+    end
+
+    # Iterate over the validators registered, and for each validator
+    # call `validate!` passing in the instance of the class this module
+    # was prepended to.
+    def validate!
+      @valid = true
+      self.class.validators.each do |validator|
+        validator.validate! self
+        merge_errors validator.errors
+        @valid = validator.valid? && @valid
+      end
+    end
+
+    private
+
+    # Create a uniform error output, per attribute
+    def merge_errors(new_errors)
+      errors.merge!(new_errors) do |key, oldval, newval|
+        (newval.is_a?(Array) ? (oldval + newval) : (oldval << newval)).uniq
+      end
+    end
+
+    class PresenceValidator
+      attr_accessor :errors
+
+      def initialize(*attributes)
+        @attributes = attributes.flatten
+        @errors = {}
+      end
+
+      def valid?
+        @valid
+      end
+
+      def merge_new_attributes(*attributes)
+        @attributes |= attributes
+      end
+
+      def validate!(instance)
+        @valid = true
+        kwargs = instance.kwargs
+        @attributes.each do |attribute|
+          present = kwargs.include? attribute
+          if present
+            set_instance_variable instance, attribute, kwargs[attribute]
+          else
+            @errors[attribute] = ['attribute missing']
+          end
+          @valid = present && @valid
+        end
+      end
+
+      def set_instance_variable(instance, key, value)
+        instance.instance_variable_set "@#{key}", value
+        instance.class.class_eval { attr_accessor :"#{key}" }
+      end
+    end
+  end
+end

data/lib/adama/version.rb

@@ -1,3 +1,3 @@
 module Adama
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adama
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - dradford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.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'
 description: Command and Invoker pattern.
 email:
 - damienradford@gmail.com
@@ -73,6 +87,7 @@ files:
 - lib/adama/command.rb
 - lib/adama/errors.rb
 - lib/adama/invoker.rb
+- lib/adama/validator.rb
 - lib/adama/version.rb
 homepage: https://github.com/bugcrowd/adama
 licenses: