rom-support 0.1.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29285bc52be91138894978734ea97b5ff8cf1916
-  data.tar.gz: cb55485edd81dcf8e45a44a0df2c99a8d156ee10
+  metadata.gz: 79e147630a7e44dd323b446498ff1e39942b9c17
+  data.tar.gz: 27b5f1b27100413d380b2e1d8e0a389ce4bf6443
 SHA512:
-  metadata.gz: 7e107d16dcec735f0ce71c4c6f820102f62fee1852b31329a29d6322233ecb0b10ea713939053b4c8a0737f9544dcfcf72cc72fd67a9ee1253872ff6bd8aa3e1
-  data.tar.gz: 53d9fe73f2c618604142cee6a294d002a9f0f9e0eb0406dbea6697bc57c749c5fa8e2aced4d01aaf225006f72c1eca00b1e4c549747ccb6c5f7b0fb98ab53982
+  metadata.gz: 680c23f519ead5ad0db2e0951f38a25eedbe63e8cb7d2cfc1dafdf56faed15361f60c2ac5b48b56b32805be68eb89caba06827e30500d9f6e796e6b6a4c5ddce
+  data.tar.gz: 3957e00c4f16d4bee3610772e246a630c01526dd8717010ef76489626974e45bed4b801011cbf1865c012b5ded39327ca58aca7fec19c3a3b39d0f5f1c198c9b

data/.travis.yml

@@ -10,7 +10,7 @@ rvm:
   - 2.1
   - 2.2
   - rbx-2
-  - jruby
+  - jruby-9000
   - ruby-head
   - jruby-head
 env:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
-v0.1.0 2015-08-10
+## v0.1.1 to be released
+
+### Added
+
+* Support for `:coercer` option key (nepalez)
+
+## v0.1.0 2015-08-10
 
 First public release. The code was ported from rom 0.8.1

data/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'transproc',  github: 'solnic/transproc',  branch: 'master'
 gem 'rom-mapper', github: 'rom-rb/rom-mapper', branch: 'master'
 
 group :console do

data/lib/rom-support.rb

@@ -1 +1,2 @@
+require 'dry-equalizer'
 require 'rom/support/constants'

data/lib/rom/support/auto_curry.rb

@@ -1,27 +1,41 @@
 module ROM
   module AutoCurry
     def self.extended(klass)
-      busy = false
-
       klass.define_singleton_method(:method_added) do |name|
-        return if busy
-        busy = true
-        auto_curry(name)
-        busy = false
+        return if auto_curry_busy?
+        auto_curry_guard { auto_curry(name) }
         super(name)
       end
     end
 
-    def auto_curry(name)
+    def auto_curry_guard
+      @__auto_curry_busy__ = true
+      yield
+    ensure
+      @__auto_curry_busy__ = false
+    end
+
+    def auto_curry_busy?
+      @__auto_curry_busy__ ||= false
+    end
+
+    def auto_curry(name, &block)
       curried = self.curried
       meth = instance_method(name)
       arity = meth.arity
 
       define_method(name) do |*args|
-        if arity < 0 || arity == args.size
-          meth.bind(self).(*args)
+        response =
+          if arity < 0 || arity == args.size
+            meth.bind(self).(*args)
+          else
+            curried.new(self, name: name, curry_args: args, arity: arity)
+          end
+
+        if block
+          response.instance_exec(&block)
         else
-          curried.new(self, name: name, curry_args: args, arity: arity)
+          response
         end
       end
     end

data/lib/rom/support/class_builder.rb

@@ -8,12 +8,12 @@ module ROM
     include Options
 
     option :name, type: String, reader: true
-    option :parent, type: Class, reader: true, parent: Object
+    option :parent, type: Class, reader: true, default: Object
 
     # Generate a class based on options
     #
     # @example
-    #   builder = ROM::ClasBuilder.new(name: 'MyClass')
+    #   builder = ROM::ClassBuilder.new(name: 'MyClass')
     #
     #   klass = builder.call
     #   klass.name # => "MyClass"

data/lib/rom/support/data_proxy.rb

@@ -1,5 +1,3 @@
-require 'equalizer'
-
 module ROM
   # Helper module for dataset classes
   #
@@ -33,7 +31,7 @@ module ROM
       klass.class_eval do
         extend ClassMethods
 
-        include Equalizer.new(:data)
+        include Dry::Equalizer(:data)
 
         option :row_proc, reader: true, default: proc { |obj| obj.class.row_proc }
       end

data/lib/rom/support/options.rb

@@ -1,3 +1,5 @@
+require 'transproc'
+
 module ROM
   # Helper module for classes with a constructor accepting option hash
   #
@@ -40,39 +42,59 @@ module ROM
     #
     # @api private
     class Option
-      attr_reader :name, :type, :allow, :default
+      attr_reader :name, :reader
 
       def initialize(name, options = {})
-        @name = name
-        @type = options.fetch(:type) { Object }
+        @name   = name
         @reader = options.fetch(:reader) { false }
-        @allow = options.fetch(:allow) { [] }
-        @default = options.fetch(:default) { Undefined }
-        @ivar = :"@#{name}" if @reader
+        # Prepares transformations applied by [#transform]
+        add_coercer options[:coercer]
+        add_default options[:default] if options.key? :default
+        add_type_checker options[:type]
+        add_value_checker options[:allow]
+        add_reader if reader
+      end
+
+      # Takes options of some object, applies current transformations
+      # and returns updated options
+      #
+      # @param [Object] object
+      # @param [Hash] options
+      #
+      # @return [Hash] options
+      #
+      def transform(object, options)
+        transformers.inject(options) { |a, e| e[object, a] }
       end
 
-      def reader?
-        @reader
+      private
+
+      def transformers
+        @transformers ||= []
       end
 
-      def assign_reader_value(object, value)
-        object.instance_variable_set(@ivar, value)
+      def add_reader
+        transformers << Transformers[:reader_assigner, name]
       end
 
-      def default?
-        @default != Undefined
+      def add_default(value)
+        transformer = value.respond_to?(:call) ? :default_proc : :default_value
+        transformers << Transformers[transformer, name, value]
       end
 
-      def default_value(object)
-        default.is_a?(Proc) ? default.call(object) : default
+      def add_coercer(fn)
+        return unless fn.is_a?(Proc)
+        transformers << Transformers[:coercer, name, fn]
       end
 
-      def type_matches?(value)
-        value.is_a?(type)
+      def add_type_checker(type)
+        return unless type.is_a?(Class)
+        transformers << Transformers[:type_checker, name, type]
       end
 
-      def allow?(value)
-        allow.empty? || allow.include?(value)
+      def add_value_checker(values)
+        return unless values.respond_to?(:include?)
+        transformers << Transformers[:value_checker, name, values]
       end
     end
 
@@ -95,18 +117,7 @@ module ROM
 
       def process(object, options)
         ensure_known_options(options)
-
-        each do |name, option|
-          if option.default? && !options.key?(name)
-            options[name] = option.default_value(object)
-          end
-
-          if options.key?(name)
-            validate_option_value(option, name, options[name])
-          end
-
-          option.assign_reader_value(object, options[name]) if option.reader?
-        end
+        each { |_, option| options.update option.transform(object, options) }
       end
 
       def names
@@ -122,23 +133,10 @@ module ROM
       def ensure_known_options(options)
         options.each_key do |name|
           @options.fetch(name) do
-            raise InvalidOptionKeyError,
-              "#{name.inspect} is not a valid option"
+            fail InvalidOptionKeyError, "#{name.inspect} is not a valid option"
           end
         end
       end
-
-      def validate_option_value(option, name, value)
-        unless option.type_matches?(value)
-          raise InvalidOptionValueError,
-            "#{name.inspect}:#{value.inspect} has incorrect type"
-        end
-
-        unless option.allow?(value)
-          raise InvalidOptionValueError,
-            "#{name.inspect}:#{value.inspect} has incorrect value"
-        end
-      end
     end
 
     # @api private
@@ -159,12 +157,13 @@ module ROM
       # @option settings [Boolean] :reader Define a reader? Default: +false+
       # @option settings [Array] :allow Allow certain values. Default: Allow anything
       # @option settings [Object] :default Set default value for missing option
+      # @option settings [Proc] :coercer Set coercer for assigned option
       #
       # @api public
       def option(name, settings = {})
         option = Option.new(name, settings)
         option_definitions.define(option)
-        attr_reader(name) if option.reader?
+        attr_reader(name) if option.reader
       end
 
       # @api private
@@ -194,5 +193,57 @@ module ROM
       self.class.option_definitions.process(self, options)
       @options = options.freeze
     end
+
+    # Collection of transformers for options
+    #
+    module Transformers
+      extend Transproc::Registry
+
+      import :identity, from: Transproc::Coercions
+
+      def self.default_value(_, options, name, value)
+        return options if options.key?(name)
+        options.merge(name => value)
+      end
+
+      def self.default_proc(object, options, name, fn)
+        return options if options.key?(name)
+        options.merge(name => fn.call(object))
+      end
+
+      def self.coercer(_, options, name, fn)
+        return options unless options.key?(name)
+        value = options[name]
+        options.merge name => fn[value]
+      end
+
+      def self.type_checker(_, options, name, type)
+        return options unless options.key?(name)
+        value = options[name]
+
+        return options if options[name].is_a?(type)
+        fail(
+          InvalidOptionValueError,
+          "#{name.inspect}:#{value.inspect} has incorrect type" \
+          " (#{type} is expected)"
+        )
+      end
+
+      def self.value_checker(_, options, name, list)
+        return options unless options.key?(name)
+        value = options[name]
+
+        return options if list.include?(options[name])
+        fail(
+          InvalidOptionValueError,
+          "#{name.inspect}:#{value.inspect} has incorrect value."
+        )
+      end
+
+      def self.reader_assigner(object, options, name)
+        object.instance_variable_set(:"@#{name}", options[name])
+        options
+      end
+    end
   end
 end

data/lib/rom/support/registry.rb

@@ -2,7 +2,7 @@ module ROM
   # @api private
   class Registry
     include Enumerable
-    include Equalizer.new(:elements)
+    include Dry::Equalizer(:elements)
 
     class ElementNotFoundError < KeyError
       def initialize(key, name)

data/lib/rom/support/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Support
-    VERSION = '0.1.0'.freeze
+    VERSION = '1.0.0.beta1'.freeze
   end
 end

data/rom-support.gemspec

@@ -15,7 +15,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
   gem.license       = 'MIT'
 
+  gem.add_runtime_dependency 'dry-equalizer', '~> 0.2'
   gem.add_runtime_dependency 'wisper', '~> 1.6', '>= 1.6.0'
+  gem.add_runtime_dependency 'transproc', '~> 0.4.0'
 
   gem.add_development_dependency 'rake', '~> 10.3'
   gem.add_development_dependency 'rspec', '~> 3.3'

data/spec/unit/rom/support/auto_curry_spec.rb

@@ -0,0 +1,53 @@
+require 'rom/support/auto_curry'
+
+RSpec.describe ROM::AutoCurry do
+  subject(:object) { klass.new }
+
+  let(:klass) do
+    Class.new do
+      extend ROM::AutoCurry
+
+      def self.curried(*)
+        self
+      end
+
+      def initialize(*)
+      end
+
+      def arity_0
+        0
+      end
+
+      def arity_1(x)
+        x
+      end
+
+      def arity_2(x, y)
+        [x,y]
+      end
+
+      def arity_many(*args)
+        args
+      end
+    end
+  end
+
+  it 'auto-curries method with arity == 0' do
+    expect(object.arity_0).to be(0)
+  end
+
+  it 'auto-curries method with arity == 1' do
+    expect(object.arity_1).to be_instance_of(klass)
+    expect(object.arity_1(1)).to be(1)
+  end
+
+  it 'auto-curries method with arity > 0' do
+    expect(object.arity_2).to be_instance_of(klass)
+    expect(object.arity_2(1, 2)).to eql([1, 2])
+  end
+
+  it 'auto-curries method with arity < 0' do
+    expect(object.arity_many).to eql([])
+    expect(object.arity_many(1, 2)).to eql([1, 2])
+  end
+end

data/spec/unit/rom/support/options_spec.rb

@@ -88,6 +88,22 @@ describe ROM::Options do
       expect(object.options).to eql(args: nil)
     end
 
+    it 'coerces assigned values' do
+      klass.option :number, coercer: -> v { v.to_i }
+
+      object = klass.new(number: '1')
+
+      expect(object.options).to eql(number: 1)
+    end
+
+    it 'not coerces default values' do
+      klass.option :number, default: '1', coercer: -> v { v.to_i }
+
+      object = klass.new
+
+      expect(object.options).to eql(number: '1')
+    end
+
     it 'options are frozen' do
       object = klass.new
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rom-support
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: wisper
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: transproc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +110,6 @@ files:
 - lib/rom/support/data_proxy.rb
 - lib/rom/support/deprecations.rb
 - lib/rom/support/enumerable_dataset.rb
-- lib/rom/support/guarded_inheritance_hook.rb
 - lib/rom/support/inflector.rb
 - lib/rom/support/inheritance_hook.rb
 - lib/rom/support/options.rb
@@ -97,6 +124,7 @@ files:
 - spec/support/constant_leak_finder.rb
 - spec/support/mutant.rb
 - spec/unit/rom/support/array_dataset_spec.rb
+- spec/unit/rom/support/auto_curry_spec.rb
 - spec/unit/rom/support/class_builder_spec.rb
 - spec/unit/rom/support/enumerable_dataset_spec.rb
 - spec/unit/rom/support/inflector_spec.rb
@@ -116,9 +144,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -126,3 +154,4 @@ signing_key:
 specification_version: 4
 summary: Ruby Object Mapper - Support libraries
 test_files: []
+has_rdoc: 

data/lib/rom/support/guarded_inheritance_hook.rb

@@ -1,21 +0,0 @@
-require 'rom/support/publisher'
-
-module ROM
-  module Support
-    module GuardedInheritanceHook
-      def self.extended(base)
-        base.class_eval <<-RUBY
-          class << self
-            include ROM::Support::Publisher
-
-            def inherited(klass)
-              super
-              return if klass.superclass == #{base}
-              #{base}.__send__(:broadcast, :inherited, klass)
-            end
-          end
-        RUBY
-      end
-    end
-  end
-end