pavlov 0.0.1

data/lib/pavlov.rb

@@ -0,0 +1,41 @@
+module Pavlov
+  # this method is also available as constantize in Rails,
+  # but we want to be able to write classes and/or tests without Rails
+  def self.get_class_by_string classname
+    classname.constantize
+  end
+
+  def self.string_to_classname string
+    string.to_s.camelize
+  end
+
+  def self.command command_name, *args
+    class_name = "Commands::"+string_to_classname(command_name)
+    klass = get_class_by_string(class_name)
+    klass.new(*args).call
+  end
+
+  def self.interactor command_name, *args
+    class_name = "Interactors::"+string_to_classname(command_name)
+    klass = get_class_by_string class_name
+    klass.new(*args).call
+  end
+
+  def self.query command_name, *args
+    class_name = "Queries::"+string_to_classname(command_name)
+    klass = get_class_by_string class_name
+    klass.new(*args).call
+  end
+end
+
+require_relative 'pavlov/helpers'
+require_relative 'pavlov/utils'
+require_relative 'pavlov/access_denied'
+require_relative 'pavlov/validation_error'
+require_relative 'pavlov/validations'
+require_relative 'pavlov/operation'
+require_relative 'pavlov/command'
+require_relative 'pavlov/query'
+require_relative 'pavlov/interactor'
+require_relative 'pavlov/entity'
+require_relative 'pavlov/version'

data/lib/pavlov/access_denied.rb

@@ -0,0 +1,4 @@
+module Pavlov
+  class AccessDenied < StandardError
+  end
+end

data/lib/pavlov/command.rb

@@ -0,0 +1,11 @@
+require 'active_support/concern'
+
+module Pavlov
+  module Command
+    extend ActiveSupport::Concern
+    include Pavlov::Operation
+    def authorized?
+      true
+    end
+  end
+end

data/lib/pavlov/entity.rb

@@ -0,0 +1,61 @@
+require_relative 'helpers/safe_evaluator'
+
+module Pavlov
+  class Entity
+    def self.attributes *args
+      args.each do |attribute_name|
+        define_attribute_writer attribute_name
+        attr_reader attribute_name
+      end
+    end
+
+    def self.new hash = {}, &block
+      super().send :mutate, hash, &block
+    end
+
+    def update hash = {}, &block
+      self.dup.send :mutate, hash, &block
+    end
+
+    private
+    def mutate hash, &block
+      copy_hash_values hash
+      safely_evaluate_against(&block) if block_given?
+      validate if respond_to? :validate
+      self
+    end
+
+    def copy_hash_values hash
+      make_temporary_mutatable do
+        hash.each {|key,value| send("#{key}=",value)}
+      end
+    end
+
+    def safely_evaluate_against &block
+      make_temporary_mutatable do
+        caller_instance = eval "self", block.binding
+        evaluator = Pavlov::Helpers::SafeEvaluator.new(self, caller_instance)
+        evaluator.instance_eval(&block)
+      end
+      self
+    end
+
+    def make_temporary_mutatable &block
+      @mutable = true
+      block.call
+      @mutable = false
+    end
+
+    def self.define_attribute_writer attribute_name
+      define_method "#{attribute_name}=" do |new_value|
+        raise_not_mutable unless @mutable
+        instance_variable_symbol = "@#{attribute_name}".to_sym
+        instance_variable_set instance_variable_symbol, new_value
+      end
+    end
+
+    def raise_not_mutable
+      raise "This entity is immutable, please use 'instance = #{self.class.name}.new do; self.attribute = 'value'; end' or 'instance = instance.update do; self.attribute = 'value'; end'."
+    end
+  end
+end

data/lib/pavlov/helpers.rb

@@ -0,0 +1,33 @@
+module Pavlov
+  module Helpers
+    def interactor name, *args
+      args = add_pavlov_options args
+      Pavlov.interactor name, *args
+    end
+
+    def query name, *args
+      args = add_pavlov_options args
+      Pavlov.query name, *args, pavlov_options
+    end
+
+    def command name, *args
+      args = add_pavlov_options args
+      Pavlov.command name, *args, pavlov_options
+    end
+
+    def pavlov_options
+      {}
+    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.
+      if pavlov_options != {}
+        args << pavlov_options
+      end
+      args
+    end
+  end
+end

data/lib/pavlov/helpers/safe_evaluator.rb

@@ -0,0 +1,17 @@
+module Pavlov
+  module Helpers
+    class SafeEvaluator < BasicObject
+      def initialize target_instance, caller_instance
+        @target_instance, @caller_instance = target_instance, caller_instance
+      end
+
+      def method_missing method_name, *args
+        if method_name[-1] == '='
+          @target_instance.public_send method_name, *args
+        else
+          @caller_instance.send method_name, *args
+        end
+      end
+    end
+  end
+end

data/lib/pavlov/interactor.rb

@@ -0,0 +1,20 @@
+require 'active_support/concern'
+require 'active_support/inflector'
+
+module Pavlov
+  module Interactor
+    extend ActiveSupport::Concern
+    include Pavlov::Operation
+
+    module ClassMethods
+      # make our interactors behave as Resque jobs
+      def perform(*args)
+        new(*args).call
+      end
+
+      def queue
+        @queue ||= :interactor_operations
+      end
+    end
+  end
+end

data/lib/pavlov/operation.rb

@@ -0,0 +1,72 @@
+require 'active_support/concern'
+
+module Pavlov
+  module Operation
+    extend ActiveSupport::Concern
+    include Pavlov::Helpers
+    include Pavlov::Validations
+    include Pavlov::Utils
+    def pavlov_options
+      @options
+    end
+
+    def raise_unauthorized(message='Unauthorized')
+      raise Pavlov::AccessDenied, message
+    end
+
+    def check_authority
+      raise_unauthorized unless respond_to? :authorized? and authorized?
+    end
+
+    def initialize *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.zip names).each do |pair|
+        name = "@" + pair[0].to_s
+        value = pair[1]
+        instance_variable_set(name, value)
+      end
+
+      validate if respond_to? :validate
+      check_authority
+      finish_initialize if respond_to? :finish_initialize
+    end
+
+    def call
+      self.execute
+    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
+      end
+
+      # make our interactors behave as Resque jobs
+      def perform(*args)
+        new(*args).call
+      end
+
+      def queue
+        @queue || :interactor_operations
+      end
+    end
+  end
+end

data/lib/pavlov/query.rb

@@ -0,0 +1,12 @@
+require 'active_support/concern'
+
+module Pavlov
+  module Query
+    extend ActiveSupport::Concern
+    include Pavlov::Operation
+
+    def authorized?
+      true
+    end
+  end
+end

data/lib/pavlov/utils.rb

@@ -0,0 +1,7 @@
+module Pavlov
+  module Utils
+    def hash_with_index(index, list)
+      list.each_with_object({}) {|u, hash| hash[u.send(index)] = u}
+    end
+  end
+end

data/lib/pavlov/validation_error.rb

@@ -0,0 +1,4 @@
+module Pavlov
+  class ValidationError < StandardError
+  end
+end

data/lib/pavlov/validations.rb

@@ -0,0 +1,38 @@
+require_relative 'validations/errors'
+require_relative 'validations/not_valid'
+
+module Pavlov
+  module Validations
+    def errors
+      @errors ||= Pavlov::Validations::Errors.new
+    end
+
+    def validate_hexadecimal_string param_name, param
+      raise Pavlov::ValidationError, "#{param_name.to_s} should be an hexadecimal string." unless param.is_a? String and /\A[\da-fA-F]+\Z/.match param
+    end
+
+    def validate_regex param_name, param, regex, message
+      raise Pavlov::ValidationError, "#{param_name.to_s} #{message}" unless regex.match param
+    end
+
+    def validate_integer param_name, param
+      raise Pavlov::ValidationError, "#{param_name.to_s} should be an integer." unless param.is_a? Integer
+    end
+
+    def validate_in_set param_name, param, set
+      raise Pavlov::ValidationError, "#{param_name.to_s} should be on of these values: #{set.inspect}." unless set.include? param
+    end
+
+    def validate_string param_name, param
+      raise Pavlov::ValidationError, "#{param_name.to_s} should be a string." unless param.is_a? String
+    end
+
+    def validate_integer_string param_name, param
+      raise Pavlov::ValidationError, "#{param_name.to_s} should be an integer string." unless param.is_a? String and /\A\d+\Z/.match param
+    end
+
+    def validate_not_nil param_name, param
+      raise Pavlov::ValidationError, "#{param_name.to_s} should not be nil." if param.nil?
+    end
+  end
+end

data/lib/pavlov/validations/errors.rb

@@ -0,0 +1,21 @@
+module Pavlov
+  module Validations
+    module Errors
+      include Enumerable
+
+      def initialize 
+        @messages = {}
+      end
+
+      def each &block
+        @messages.each_key do |attribute|
+          @messages[attribute.to_s].each { |error| block.call attribute, error }
+        end
+      end
+
+      def add attribute, error_message
+        (@messages[attribute.to_s] ||= []) << error_message
+      end
+    end
+  end
+end

data/lib/pavlov/validations/not_valid.rb

@@ -0,0 +1,7 @@
+module Pavlov
+  module Validations
+    class NotValid < StandardError 
+      attr_accessor :errors
+    end
+  end
+end

data/lib/pavlov/version.rb

@@ -0,0 +1,6 @@
+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.0.1"
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: pavlov
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark IJbema
+- Tom de Vries
+- Jan Paul Posma
+- Remon Oldenbeuving
+- Jan Deelstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.7
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pavlov is a opinionated toolbox to help you architect your Ruby project.
+email:
+- jan+pavlov@deelstra.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pavlov.rb
+- lib/pavlov/access_denied.rb
+- lib/pavlov/command.rb
+- lib/pavlov/entity.rb
+- lib/pavlov/helpers.rb
+- lib/pavlov/helpers/safe_evaluator.rb
+- lib/pavlov/interactor.rb
+- lib/pavlov/operation.rb
+- lib/pavlov/query.rb
+- lib/pavlov/utils.rb
+- lib/pavlov/validation_error.rb
+- lib/pavlov/validations.rb
+- lib/pavlov/validations/errors.rb
+- lib/pavlov/validations/not_valid.rb
+- lib/pavlov/version.rb
+homepage: https://github.com/Factlink/pavlov/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4075067472850494356
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4075067472850494356
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Infrastructure for defining your Ruby architecture.
+test_files: []