errapi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcae888fc36cd422f1fda237dd5381aa10e776d1
-  data.tar.gz: 757ad4e09cea3666e7279d59d544ff2e99c6bab4
+  metadata.gz: 544cdac914cba1a85759631310e365ffebf9c821
+  data.tar.gz: d33e3f71d0a276dea1d45e767b44db39f96b4e98
 SHA512:
-  metadata.gz: 5fe74be1e6ef55493f04accf713edfc0ce497c982dc84d68e92262bc7183f4d4076fd872d53f15b27a782e7f613054dc76fd8f26c9f2ef95842cfc9bb020c5a3
-  data.tar.gz: 3ff0b1fee2094513a11daf6ef7d8eb12155a23cadcb4d318843d1bb57dbae2e6c4cf570dac8e1015343a50acf928ccaa4c91da8ad3800b4a92075369124d9c2b
+  metadata.gz: 12c749f8d759cc133a292a54d1565838740db17b7bb6127893da00faab32a814bd680ef8f68d313f84386dbb8f91f5861af986bb2fa5cf21fb217067e5170059
+  data.tar.gz: a53453d8aebf3bda928c582d9c02645e1579efe83269a9e1403ce80af91c2458e2637e3096c5eda25123da869be3f86c923d0dbe2c2e6999ddeddca66481d8ee

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/errapi.rb

@@ -1,21 +1,28 @@
 module Errapi
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end
 
 Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }
 
 module Errapi
 
-  def self.configure name = nil, &block
+  def self.configure *args, &block
 
-    init_configs
-    name ||= :default
+    options = args.last.kind_of?(Hash) ? args.pop : {}
+    name = args.shift || :default
 
+    init_configs
     if @configs[name]
-      @configs[name].configure &block
+      raise ArgumentError, %/Configuration "#{name}" has already been configured./
     else
-      @configs[name] = Configuration.new &block
+      @configs[name] = options[:config] || Configuration.new
+    end
+
+    if options.fetch :defaults, true
+      default_config! @configs[name]
     end
+
+    @configs[name].configure &block
   end
 
   def self.config name = nil
@@ -25,23 +32,21 @@ module Errapi
   private
 
   def self.init_configs
-    @configs ? @configs : @configs = { default: default_config }
+    @configs ? @configs : @configs = {}
   end
 
-  def self.default_config
-    Configuration.new.tap do |config|
-      config.plugin Errapi::Plugins::I18nMessages
-      config.plugin Errapi::Plugins::Reason
-      config.plugin Errapi::Plugins::Location
-      config.validation_factory Errapi::Validations::Exclusion
-      config.validation_factory Errapi::Validations::Format
-      config.validation_factory Errapi::Validations::Inclusion
-      config.validation_factory Errapi::Validations::Length
-      config.validation_factory Errapi::Validations::Presence.new
-      config.validation_factory Errapi::Validations::Trim
-      config.validation_factory Errapi::Validations::Type
-      config.register_condition Errapi::Condition::SimpleCheck
-      config.register_condition Errapi::Condition::ErrorCheck
-    end
+  def self.default_config! config
+    config.plugin Errapi::Plugins::I18nMessages.new
+    config.plugin Errapi::Plugins::Reason.new
+    config.plugin Errapi::Plugins::Location.new
+    config.validation_factory Errapi::Validations::Exclusion::Factory.new
+    config.validation_factory Errapi::Validations::Format::Factory.new
+    config.validation_factory Errapi::Validations::Inclusion::Factory.new
+    config.validation_factory Errapi::Validations::Length::Factory.new
+    config.validation_factory Errapi::Validations::Presence::Factory.new
+    config.validation_factory Errapi::Validations::Trim::Factory.new
+    config.validation_factory Errapi::Validations::Type::Factory.new
+    config.condition_factory Errapi::Condition::SimpleCheck
+    config.condition_factory Errapi::Condition::ErrorCheck
   end
 end

data/lib/errapi/configuration.rb

@@ -12,10 +12,29 @@ module Errapi
       @validation_factories = {}
       @condition_factories = {}
       @location_factories = {}
+      @configured = false
+      @configured_blocks = []
+    end
+
+    def configured?
+      @configured
     end
 
     def configure
-      yield self
+      raise "Configuration can only be done once." if @configured
+      yield self if block_given?
+      @configured_blocks.each{ |block| block.call }
+      @configured_blocks.clear
+      @configured = true
+      self
+    end
+
+    def on_configured &block
+      if @configured
+        block.call
+      else
+        @configured_blocks << block
+      end
     end
 
     def new_error options = {}
@@ -35,30 +54,46 @@ module Errapi
     end
 
     def plugin impl, options = {}
-      name = options[:name] || Utils.underscore(impl.to_s.sub(/.*::/, '')).to_sym
+      name = implementation_name impl, options
       impl.config = self if impl.respond_to? :config=
       @plugins[name] = impl
     end
 
+    def remove_plugin name
+      raise ArgumentError, "No plugin registered for name #{name.inspect}" unless @plugins.key? name
+      @plugins.delete name
+    end
+
     def validation_factory factory, options = {}
-      name = options[:name] || Utils.underscore(factory.to_s.sub(/.*::/, '')).to_sym
+      name = implementation_name factory, options
       factory.config = self if factory.respond_to? :config=
       @validation_factories[name] = factory
     end
 
+    def remove_validation_factory name
+      raise ArgumentError, "No validation factory registered for name #{name.inspect}" unless @validation_factories.key? name
+      @validation_factories.delete name
+    end
+
     def validation name, options = {}
       raise ArgumentError, "No validation factory registered for name #{name.inspect}" unless @validation_factories.key? name
       factory = @validation_factories[name]
       factory.respond_to?(:validation) ? factory.validation(options) : factory.new(options)
     end
 
-    def register_condition factory
+    def condition_factory factory
       factory.conditionals.each do |conditional|
         raise ArgumentError, "Conditional #{conditional} should start with 'if' or 'unless'." unless conditional.to_s.match /^(if|unless)/
         @condition_factories[conditional] = factory
       end
     end
 
+    def remove_condition_factory factory
+      factory.conditionals.each do |conditional|
+        @condition_factories.delete conditional
+      end
+    end
+
     def extract_conditions! source, options = {}
       [].tap do |conditions|
         @condition_factories.each_pair do |conditional,factory|
@@ -70,6 +105,16 @@ module Errapi
 
     private
 
+    def implementation_name impl, options = {}
+      if options[:name]
+        options[:name].to_sym
+      elsif impl.respond_to? :name
+        impl.name.to_sym
+      else
+        raise ArgumentError, "Plugins and factories added to a configuration must respond to #name or be supplied with the :name option."
+      end
+    end
+
     def apply_plugins operation, *args
       @plugins.each_pair do |name,plugin|
         plugin.send operation, *args if plugin.respond_to? operation

data/lib/errapi/object_validator.rb

@@ -5,14 +5,18 @@ module Errapi
   class ObjectValidator
     include LocationBuilders
 
+    # TODO: remove "options" or if used, pass them to new validators instantiated in #register_validations
     def initialize config, options = {}, &block
-      # TODO: remove these options or if used, pass them to new validators instantiated in #register_validations
       @config = config
       @validations = []
-      instance_eval &block if block
+
+      @config.on_configured do
+        instance_eval &block if block
+      end
     end
 
     def validates *args, &block
+      check_config!
       register_validations *args, &block
     end
 
@@ -27,6 +31,7 @@ module Errapi
     end
 
     def validate value, context, options = {}
+      check_config!
       # TODO: skip validation by default if previous errors at current location
       # TODO: add support for previous value and skip validation by default if value is unchanged
 
@@ -186,6 +191,10 @@ module Errapi
       @validations << validations_definition
     end
 
+    def check_config!
+      raise "Configuration has not been done. You must call Errapi.config to complete the configuration process." unless @config.configured?
+    end
+
     class ContextProxy
       instance_methods.each{ |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
       attr_accessor :current_location

data/lib/errapi/plugins.rb

@@ -1,4 +1,14 @@
 module Errapi::Plugins
+  class Base
+
+    def self.plugin_name name = nil
+      name ? @name = name : @name
+    end
+
+    def name
+      self.class.name
+    end
+  end
 end
 
 Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }

data/lib/errapi/plugins/i18n_messages.rb

@@ -1,8 +1,9 @@
 require 'i18n'
 
 # TODO: support interpolating source and target name (e.g. "Project name cannot be null.")
-class Errapi::Plugins::I18nMessages
-  class << self
+module Errapi::Plugins
+  class I18nMessages < Base
+    plugin_name :message
 
     def serialize_error error, serialized
       return if serialized.key? :message

data/lib/errapi/plugins/location.rb

@@ -1,29 +1,29 @@
-module Errapi
-  class Plugins::Location
-    class << self
-      attr_writer :config
-      attr_accessor :camelize
+module Errapi::Plugins
+  class Location < Base
+    plugin_name :location
 
-      def serialize_error error, serialized
-        if error.location && error.location.respond_to?(:serialize)
+    attr_writer :config
+    attr_accessor :camelize
 
-          serialized_location = error.location.serialize
-          unless serialized_location.nil?
-            serialized[:location] = serialized_location
-            serialized[location_type_key] = error.location.location_type if error.location.respond_to? :location_type
-          end
+    def serialize_error error, serialized
+      if error.location && error.location.respond_to?(:serialize)
+
+        serialized_location = error.location.serialize
+        unless serialized_location.nil?
+          serialized[:location] = serialized_location
+          serialized[location_type_key] = error.location.location_type if error.location.respond_to? :location_type
         end
       end
+    end
 
-      private
+    private
 
-      def location_type_key
-        camelize? ? :locationType : :location_type
-      end
+    def location_type_key
+      camelize? ? :locationType : :location_type
+    end
 
-      def camelize?
-        @camelize.nil? ? @config.options.camelize : @camelize
-      end
+    def camelize?
+      @camelize.nil? ? @config.options.camelize : @camelize
     end
   end
 end

data/lib/errapi/plugins/reason.rb

@@ -1,22 +1,22 @@
-module Errapi
-  class Plugins::Reason
-    class << self
-      attr_writer :config
-      attr_accessor :camelize
+module Errapi::Plugins
+  class Reason < Base
+    plugin_name :reason
 
-      def serialize_error error, serialized
-        serialized[:reason] = serialized_reason error
-      end
+    attr_writer :config
+    attr_accessor :camelize
 
-      private
+    def serialize_error error, serialized
+      serialized[:reason] = serialized_reason error
+    end
+
+    private
 
-      def serialized_reason error
-        camelize? ? Utils.camelize(error.reason.to_s).to_sym : error.reason
-      end
+    def serialized_reason error
+      camelize? ? Utils.camelize(error.reason.to_s).to_sym : error.reason
+    end
 
-      def camelize?
-        @camelize.nil? ? @config.options.camelize : @camelize
-      end
+    def camelize?
+      @camelize.nil? ? @config.options.camelize : @camelize
     end
   end
 end

data/lib/errapi/validations.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(__FILE__), 'utils.rb')
+
 module Errapi::Validations
 
   class Base
@@ -37,7 +39,28 @@ module Errapi::Validations
     end
   end
 
-  class Factory
+  class ValidationFactory
+
+    def self.build impl, options = {}
+      @validation_class = impl
+      @name = options[:name] || Errapi::Utils.underscore(impl.to_s.sub(/.*::/, '')).to_sym
+    end
+
+    def self.name
+      @name
+    end
+
+    def name
+      self.class.name
+    end
+
+    def self.validation_class
+      @validation_class
+    end
+
+    def validation_class
+      self.class.validation_class
+    end
 
     def config= config
       raise "A configuration has already been set for this factory." if @config
@@ -45,11 +68,7 @@ module Errapi::Validations
     end
 
     def validation options = {}
-      self.class.const_get('Implementation').new options
-    end
-
-    def to_s
-      Errapi::Utils.underscore self.class.name.sub(/.*::/, '')
+      validation_class.new options
     end
   end
 end

data/lib/errapi/validations/exclusion.rb

@@ -2,6 +2,10 @@ require File.join(File.dirname(__FILE__), 'clusivity.rb')
 
 module Errapi::Validations
   class Exclusion < Base
+    class Factory < ValidationFactory
+      build Exclusion
+    end
+
     include Clusivity
 
     def initialize options = {}

data/lib/errapi/validations/format.rb

@@ -1,5 +1,8 @@
 module Errapi::Validations
   class Format < Base
+    class Factory < ValidationFactory
+      build Format
+    end
 
     def initialize options = {}
       unless key = exactly_one_option?(OPTIONS, options)

data/lib/errapi/validations/inclusion.rb

@@ -2,6 +2,10 @@ require File.join(File.dirname(__FILE__), 'clusivity.rb')
 
 module Errapi::Validations
   class Inclusion < Base
+    class Factory < ValidationFactory
+      build Inclusion
+    end
+
     include Clusivity
 
     def initialize options = {}

data/lib/errapi/validations/length.rb

@@ -1,5 +1,9 @@
 module Errapi::Validations
   class Length < Base
+    class Factory < ValidationFactory
+      build Length
+    end
+
     CHECKS = { is: :==, minimum: :>=, maximum: :<= }.freeze
     REASONS = { is: :wrong_length, minimum: :too_short, maximum: :too_long }.freeze
 

data/lib/errapi/validations/presence.rb

@@ -1,38 +1,39 @@
 module Errapi::Validations
-  class Presence < Factory
-    class Implementation < Base
+  class Presence < Base
+    class Factory < ValidationFactory
+      build Presence
+    end
 
-      def validate value, context, options = {}
-        if reason = check(value, options.fetch(:value_set, true))
-          context.add_error reason: reason
-        end
+    def validate value, context, options = {}
+      if reason = check(value, options.fetch(:value_set, true))
+        context.add_error reason: reason
       end
+    end
 
-      private
+    private
 
-      BLANK_REGEXP = /\A[[:space:]]*\z/
+    BLANK_REGEXP = /\A[[:space:]]*\z/
 
-      def check value, value_set
-        # TODO: allow customization (e.g. values that are not required, booleans, etc)
-        if !value_set
-          :missing
-        elsif value.nil?
-          :null
-        elsif value.respond_to?(:empty?) && value.empty?
-          :empty
-        elsif value_blank? value
-          :blank
-        end
+    def check value, value_set
+      # TODO: allow customization (e.g. values that are not required, booleans, etc)
+      if !value_set
+        :missing
+      elsif value.nil?
+        :null
+      elsif value.respond_to?(:empty?) && value.empty?
+        :empty
+      elsif value_blank? value
+        :blank
       end
+    end
 
-      def value_blank? value
-        if value.respond_to? :blank?
-          value.blank?
-        elsif value.kind_of? String
-          BLANK_REGEXP === value
-        else
-          false
-        end
+    def value_blank? value
+      if value.respond_to? :blank?
+        value.blank?
+      elsif value.kind_of? String
+        BLANK_REGEXP === value
+      else
+        false
       end
     end
   end

data/lib/errapi/validations/trim.rb

@@ -1,5 +1,8 @@
 module Errapi::Validations
   class Trim < Base
+    class Factory < ValidationFactory
+      build Trim
+    end
 
     def validate value, context, options = {}
       if value.kind_of?(String) && /(?:\A\s|\s\Z)/.match(value)

data/lib/errapi/validations/type.rb

@@ -1,5 +1,8 @@
 module Errapi::Validations
   class Type < Base
+    class Factory < ValidationFactory
+      build Type
+    end
 
     def initialize options = {}
       unless key = exactly_one_option?(OPTIONS, options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Simon Oulevay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n