pavlov 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2b9bba30f2268ca3a5856559682efa6e6e2c98a
-  data.tar.gz: f8f72d801376e12afb4594c339fa77f787089729
+  metadata.gz: 8366cdc29ed0e3cf7c91b3d2d106b4cac9df808f
+  data.tar.gz: 882f35ce53f6c187d7d67293db6b70a8589554f8
 SHA512:
-  metadata.gz: 758db67e6925e9810c81ab0745d5741158152c3f5e1b573c6fc9859b457fc750552557f5da539eb55f1e89f5e56b8701917d1822ae95164fac23f71491044e36
-  data.tar.gz: 43662dcef18148abb292bc2aeb6767ede94cf8664e41254eb08c44ad0cc2dab955f0cb44fab9d1676fb93294aa701717d6ce63a0e56f5dcd59bfda090b89f239
+  metadata.gz: 543829b42a71cf377f77bad528bf06cbf2cefc1ff6c534d863a54d036493e77e9a4efd797894b7b91ede168a2093ab7a2576ccdc8dbbb6bf6bad6661613a2117
+  data.tar.gz: fe236450becb09aee747e8c0571b6563323f78a36fe54b74dda601c17ff34b07ff283a006be2b1222dfe7836d2520983679b38e87cb1995360efcbad7d8a1eca

data/lib/generators/pavlov/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Pavlov
+  class InstallGenerator < Rails::Generators::Base
+    def self.source_root
+      @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    def copy_backend_directory
+      directory 'backend', 'app/backend', recursive: true
+    end
+
+    def add_backend_to_autoload_paths
+      application "config.autoload_paths += %W(\#{config.root}/app/backend)"
+    end
+  end
+end

data/lib/generators/pavlov/templates/backend/backend.rb

@@ -0,0 +1,3 @@
+class Backend
+  # This class is a placeholder that will be expanded by a later feature branch
+end

data/lib/generators/pavlov/templates/backend/command.rb

@@ -0,0 +1,3 @@
+class Command
+  include Pavlov::Operation
+end

data/lib/generators/pavlov/templates/backend/interactor.rb

@@ -0,0 +1,16 @@
+class Interactor
+  include Pavlov::Operation
+
+  # If you want your interactors to be compatible with a backgrounding
+  # daemon, you can use this base class to add support.
+  #
+  # Example for Resque:
+  #
+  # def self.perform(*args)
+  #   new(*args).call
+  # end
+
+  def authorized?
+    raise NotImplementedError
+  end
+end

data/lib/generators/pavlov/templates/backend/query.rb

@@ -0,0 +1,3 @@
+class Query
+  include Pavlov::Operation
+end

data/lib/pavlov.rb

@@ -28,6 +28,7 @@ module Pavlov
   end
 end
 
+require_relative 'pavlov/engine' if defined?(Rails)
 require_relative 'pavlov/helpers'
 require_relative 'pavlov/access_denied'
 require_relative 'pavlov/validation_error'

data/lib/pavlov/alpha_compatibility.rb

@@ -1,39 +1,78 @@
 require 'pavlov'
 
 module Pavlov
-  module Operation
-    def pavlov_options
-      @options
-    end
-    def pavlov_options=(options)
-      @options = options
-    end
+  def self.old_command command_name, *args
+    class_name = "Commands::"+string_to_classname(command_name)
+    klass = get_class_by_string(class_name)
+    attributes = arguments_to_attributes(klass, args)
+    klass.new(attributes).call
   end
 
-  def self.old_command *arguments
-    command *arguments
+  def self.old_interactor command_name, *args
+    class_name = "Interactors::"+string_to_classname(command_name)
+    klass = get_class_by_string class_name
+    attributes = arguments_to_attributes(klass, args)
+    klass.new(attributes).call
   end
-  def self.old_query *arguments
-    query *arguments
+
+  def self.old_query command_name, *args
+    class_name = "Queries::"+string_to_classname(command_name)
+    klass = get_class_by_string class_name
+    attributes = arguments_to_attributes(klass, args)
+    klass.new(attributes).call
   end
-  def self.old_interactor *arguments
-    interactor *arguments
+
+  def self.arguments_to_attributes(operation_class, arguments)
+    attribute_keys = operation_class.attribute_set.map(&:name)
+
+    # TODO: this can be done so much better, but I don't know how.
+    hash={}
+    arguments.each_with_index do |value, index|
+      hash[attribute_keys[index].to_sym] = value
+    end
+    return hash
   end
 
   module Helpers
     def old_interactor name, *args
-      args = add_pavlov_options args
+      args = add_compatibility_pavlov_options args
       Pavlov.old_interactor name, *args
     end
 
     def old_query name, *args
-      args = add_pavlov_options args
+      args = add_compatibility_pavlov_options args
       Pavlov.old_query name, *args
     end
 
     def old_command name, *args
-      args = add_pavlov_options args
+      args = add_compatibility_pavlov_options args
       Pavlov.old_command name, *args
     end
+
+    private
+    def add_compatibility_pavlov_options args
+      # TODO: we should do this at a point where we know how many arguments we need
+      # so we can decide if we need to merge with another options object or
+      # just add it.
+      new_args = Array(args)
+      if pavlov_options != {}
+        new_args << pavlov_options
+      end
+      new_args
+    end
+  end
+
+  module Operation
+    module ClassMethods
+      def arguments(*args)
+        # Add generic attribute for each argument
+        args.each do |argument|
+          attribute argument, Object
+        end
+
+        # Add attribute for pavlov_options
+        attribute :pavlov_options, Hash, default: {}
+      end
+    end
   end
 end

data/lib/pavlov/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module Pavlov
+  class Engine < Rails::Engine
+  end
+end

data/lib/pavlov/helpers.rb

@@ -1,18 +1,18 @@
 module Pavlov
   module Helpers
-    def interactor name, *args
-      args = add_pavlov_options args
-      Pavlov.interactor name, *args
+    def interactor name, hash
+      hash = add_pavlov_options hash
+      Pavlov.interactor name, hash
     end
 
-    def query name, *args
-      args = add_pavlov_options args
-      Pavlov.query name, *args
+    def query name, hash
+      hash = add_pavlov_options hash
+      Pavlov.query name, hash
     end
 
-    def command name, *args
-      args = add_pavlov_options args
-      Pavlov.command name, *args
+    def command name, hash
+      hash = add_pavlov_options hash
+      Pavlov.command name, hash
     end
 
     def pavlov_options
@@ -20,14 +20,17 @@ module Pavlov
     end
 
     private
-    def add_pavlov_options args
-      # TODO: we should do this at a point where we know how many arguments we need
-      # so we can decide if we need to merge with another options object or
-      # just add it.
+    def add_pavlov_options hash
       if pavlov_options != {}
-        args << pavlov_options
+        hash ||= {}
+
+        if hash.has_key? 'pavlov_options'
+          hash[:pavlov_options] = pavlov_options.merge(hash[:pavlov_options])
+        else
+          hash[:pavlov_options] = pavlov_options
+        end
       end
-      args
+      hash
     end
   end
 end

data/lib/pavlov/operation.rb

@@ -1,6 +1,7 @@
 require 'active_support/concern'
 require 'pavlov/validations'
 require 'pavlov/helpers'
+require 'virtus'
 require_relative 'access_denied'
 
 module Pavlov
@@ -8,58 +9,25 @@ module Pavlov
     extend ActiveSupport::Concern
     include Pavlov::Helpers
     include Pavlov::Validations
-
-    def initialize(*params)
-      keys, names, @options = extract_arguments(params)
-      set_instance_variables keys, names
-      validate
-
-      check_authorization
-
-      finish_initialize if respond_to? :finish_initialize
-    end
+    include Virtus
 
     def validate
+      return false unless attributes_without_defaults_have_values
       if respond_to? :valid?
-        valid?
+        raise Pavlov::ValidationError, "an argument is invalid" unless valid?
       else
         true
       end
     end
 
     def call(*args, &block)
+      validate
+      check_authorization
       execute(*args, &block)
     end
 
     private
 
-    def pavlov_options
-      @options
-    end
-
-    def extract_arguments(params)
-      keys = (respond_to? :arguments) ? arguments : []
-      names = params.first(keys.length)
-
-      if params.length == keys.length + 1
-        options = params.last
-      elsif params.length == keys.length
-        options = {}
-      else
-        raise "wrong number of arguments."
-      end
-
-      [keys, names, options]
-    end
-
-    def set_instance_variables(keys, names)
-      (keys.zip names).each do |pair|
-        name = "@" + pair[0].to_s
-        value = pair[1]
-        instance_variable_set(name, value)
-      end
-    end
-
     def raise_unauthorized(message='Unauthorized')
       raise Pavlov::AccessDenied, message
     end
@@ -68,25 +36,14 @@ module Pavlov
       raise_unauthorized if respond_to? :authorized?, true and not authorized?
     end
 
-    module ClassMethods
-      # arguments :foo, :bar
-      #
-      # results in
-      #
-      # def initialize(foo, bar)
-      #   @foo = foo
-      #   @bar = bar
-      # end
-      def arguments *keys
-        define_method :arguments do
-          keys
-        end
-
-        class_eval do
-          attr_reader(*keys)
-        end
+    def attributes_without_defaults_have_values
+      attributes_without_value = attribute_set.select do |attribute|
+        not attribute.options.has_key?(:default) and send(attribute.name).nil?
       end
+      attributes_without_value.empty?
+    end
 
+    module ClassMethods
       # make our interactors behave as Resque jobs
       def perform(*args)
         new(*args).call

data/lib/pavlov/validations.rb

@@ -1,3 +1,5 @@
+require 'pavlov/validation_error'
+
 module Pavlov
   module Validations
     def validate_hexadecimal_string param_name, param

data/lib/pavlov/version.rb

@@ -2,5 +2,5 @@ module Pavlov
   # We're doing this because we might write tests that deal
   # with other versions of bundler and we are unsure how to
   # handle this better.
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pavlov
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - marten@veldthuis.com
@@ -43,20 +43,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -176,10 +190,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/generators/pavlov/install_generator.rb
+- lib/generators/pavlov/templates/backend/backend.rb
+- lib/generators/pavlov/templates/backend/command.rb
+- lib/generators/pavlov/templates/backend/interactor.rb
+- lib/generators/pavlov/templates/backend/query.rb
 - lib/pavlov.rb
 - lib/pavlov/access_denied.rb
 - lib/pavlov/alpha_compatibility.rb
 - lib/pavlov/command.rb
+- lib/pavlov/engine.rb
 - lib/pavlov/helpers.rb
 - lib/pavlov/interactor.rb
 - lib/pavlov/operation.rb