rom-support 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70f13f90c6f93d61be77682813072314e9e56ebf
-  data.tar.gz: e69c62e1fb470e01d7e866608abffcf660f02c88
+  metadata.gz: b27f4c3a3be6027778b10770424d5756992cafe6
+  data.tar.gz: 4e0688221d2acb412596ad320ae45f4bdc695266
 SHA512:
-  metadata.gz: d2c8cec18d5f6fd3f9a152bf1821466981437e4dcbb418207bfb7d398d06093a9cc4739a6d796397ef2e777ba163a23bed37d9598383d24edad44ac07aa103c2
-  data.tar.gz: 8b76767a81f8df0002cf4f40b29ca3d79b2114e94ec84a0c699b35c9dba0d12d92e97057bee6fc35c6b93cd5cb694b479fe075b921fced7e8d17f97fe104e5f8
+  metadata.gz: 251b204b77b54f3a31d592a1f90e5ae7e34bc41ab950dda14d92c54248da6dc25b6ea237dcfb0fbd82ce8e62c142cd2d7d2f34ae60cb90076f8d29c6e8a7bc7a
+  data.tar.gz: faf12e5b17d7ef787538e3b197b479607b6fed4178f107d4ac682dc8460e42d029096cd83d61107e284b491a389f076f010d3736f5b713a1af3c3aa3dab3ba95

data/.travis.yml

@@ -6,12 +6,11 @@ env:
 bundler_args: --without tools
 script: "bundle exec rake spec"
 rvm:
-  - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3.1
   - rbx-2
-  - jruby-9000
+  - jruby-9.0.5.0
   - ruby-head
   - jruby-head
 env:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v2.0.0 2016-07-27
+
+### Added
+
+* `AutoCurry.auto_curried_methods` returning a list of methods that were auto-curried (solnic)
+* `ROM::Cache` extension providing `#fetch_or_store` and `.fetch_or_store` (solnic)
+* `ROM::Deprecations.set_logger!` which allows setting a custom logger (solnic)
+
+### Changed
+
+* Refactored `AutoCurry` to use module prepend (solnic)
+* `AutoCurry` skips private methods and methods with 0 arity (solnic)
+
+[Compare v1.0.0...v2.0.0](https://github.com/rom-rb/rom-support/compare/v1.0.0...v2.0.0)
+
 ## v1.0.0 2016-01-06
 
 ### Added

data/Gemfile

@@ -2,16 +2,13 @@ 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
   gem 'pry'
   gem 'pg', platforms: [:mri]
 end
 
 group :test do
-  gem 'activesupport'
+  gem 'activesupport', '~> 4.2'
   gem 'inflecto', '~> 0.0', '>= 0.0.2'
 
   platforms :rbx do
@@ -27,7 +24,7 @@ group :tools do
   gem 'guard-rspec'
   gem 'guard-rubocop'
 
-  gem 'byebug'
+  gem 'byebug', platform: :mri
 
   platform :mri do
     gem 'mutant', '>= 0.8.0', github: 'mbj/mutant', branch: 'master'

data/README.md

@@ -8,7 +8,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/rom-support.svg)][gem]
 [![Build Status](https://travis-ci.org/rom-rb/rom-support.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-support.png)][gemnasium]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-support.svg)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/rom-rb/rom-support/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/rom-rb/rom-support/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/rom-rb/rom-support.svg?branch=master)][inchpages]

data/lib/rom/support/auto_curry.rb

@@ -19,25 +19,37 @@ module ROM
       @__auto_curry_busy__ ||= false
     end
 
+    def auto_curried_methods
+      @__auto_curried_methods__ ||= []
+    end
+
     def auto_curry(name, &block)
-      curried = self.curried
-      meth = instance_method(name)
-      arity = meth.arity
-
-      define_method(name) do |*args|
-        response =
-          if arity < 0 || arity == args.size
-            meth.bind(self).(*args)
+      arity = instance_method(name).arity
+
+      return if private_instance_methods.include?(name) || arity == 0
+
+      mod = Module.new
+
+      mod.module_eval do
+        define_method(name) do |*args|
+          response =
+            if arity < 0 || arity == args.size
+              super(*args)
+            else
+              self.class.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
-
-        if block
-          response.instance_exec(&block)
-        else
-          response
         end
       end
+
+      auto_curried_methods << name
+
+      prepend(mod)
     end
   end
 end

data/lib/rom/support/cache.rb

@@ -0,0 +1,25 @@
+require 'concurrent/map'
+
+module ROM
+  module Cache
+    def self.extended(klass)
+      super
+      klass.include(Methods)
+      klass.instance_variable_set(:@__cache__, Concurrent::Map.new)
+    end
+
+    def cache
+      @__cache__
+    end
+
+    def fetch_or_store(*args, &block)
+      cache.fetch_or_store(args.hash, &block)
+    end
+
+    module Methods
+      def fetch_or_store(*args, &block)
+        self.class.fetch_or_store(*args, &block)
+      end
+    end
+  end
+end

data/lib/rom/support/class_builder.rb

@@ -33,6 +33,10 @@ module ROM
           name
         end
 
+        def self.to_str
+          name
+        end
+
         def self.to_s
           name
         end

data/lib/rom/support/constants.rb

@@ -2,4 +2,5 @@ module ROM
   Undefined = Object.new.freeze
   EMPTY_HASH = {}.freeze
   EMPTY_ARRAY = [].freeze
+  EMPTY_STRING = ''.freeze
 end

data/lib/rom/support/deprecations.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module ROM
   module Deprecations
     # @api private
@@ -14,23 +16,63 @@ module ROM
     end
 
     def deprecate_class_method(old_name, new_name, msg = nil)
+      full_msg =
+        if new_name.is_a?(Symbol)
+          full_msg = Deprecations.deprecation_message "#{self.name}.#{old_name}", <<-MSG
+          Please use #{self.name}.#{new_name} instead.
+          #{msg}
+          MSG
+        else
+          Deprecations.deprecation_message "#{self.name}.#{old_name}", new_name
+        end
+
+      meth = new_name.is_a?(Symbol) ? method(new_name) : method(old_name)
+      instance_eval "undef #{old_name}"
+
       class_eval do
         define_singleton_method(old_name) do |*args, &block|
-          ROM::Deprecations.announce"#{self}.#{old_name} is", <<-MSG
-            Please use #{self}.#{new_name} instead.
-            #{msg}
-          MSG
-          __send__(new_name, *args, &block)
+          Deprecations.warn(full_msg)
+          meth.call(*args, &block)
         end
       end
     end
 
+    def self.warn(msg)
+      logger.warn(msg.gsub(/^\s+/, ''))
+    end
+
     def self.announce(name, msg)
-      warn <<-MSG.gsub(/^\s+/, '')
-        #{name} deprecated and will be removed in 1.0.0.
+      warn(deprecation_message(name, msg))
+    end
+
+    def self.deprecation_message(name, msg)
+      <<-MSG
+        #{name} is deprecated and will be removed in the next major version
+        #{message(msg)}
+      MSG
+    end
+
+    def self.message(msg)
+      <<-MSG
         #{msg}
         #{caller.detect { |l| !l.include?('lib/rom')}}
       MSG
     end
+
+    def self.logger(output = nil)
+      if defined?(@logger)
+        @logger
+      else
+        set_logger!(output)
+      end
+    end
+
+    def self.set_logger!(output = nil)
+      @logger = Logger.new(output || $stdout)
+      @logger.formatter = proc { |severity, datetime, progname, msg|
+        "[rom] #{msg}\n"
+      }
+      @logger
+    end
   end
 end

data/lib/rom/support/registry.rb

@@ -23,12 +23,17 @@ module ROM
     end
 
     def key?(name)
-      elements.key?(name)
+      elements.key?(name.to_sym)
     end
 
-    def [](key)
-      elements.fetch(key) { raise ElementNotFoundError.new(key, name) }
+    def fetch(key)
+      elements.fetch(key.to_sym) do
+        return yield if block_given?
+
+        raise ElementNotFoundError.new(key, name)
+      end
     end
+    alias_method :[], :fetch
 
     def respond_to_missing?(name, include_private = false)
       elements.key?(name) || super

data/lib/rom/support/version.rb

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

data/rom-support.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
   gem.license       = 'MIT'
 
+  gem.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
   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'

data/spec/spec_helper.rb

@@ -8,7 +8,6 @@ if RUBY_ENGINE == "rbx"
 end
 
 require 'rom-support'
-require 'rom-mapper'
 
 begin
   require 'byebug'
@@ -40,7 +39,3 @@ RSpec.configure do |config|
     ConstantLeakFinder.find(example)
   end
 end
-
-def T(*args)
-  ROM::Processor::Transproc::Functions[*args]
-end

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

@@ -6,7 +6,7 @@ describe ROM::ArrayDataset do
       include ROM::ArrayDataset
 
       def self.row_proc
-        T(:symbolize_keys)
+        -> i { i.each_with_object({}) { |(k,v),h| h[k.to_sym] = v } }
       end
     end
   end

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

@@ -32,6 +32,10 @@ RSpec.describe ROM::AutoCurry do
     end
   end
 
+  it 'registers auto-curried methods' do
+    expect(object.class.auto_curried_methods).to eql(%i[arity_1 arity_2 arity_many])
+  end
+
   it 'auto-curries method with arity == 0' do
     expect(object.arity_0).to be(0)
   end

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

@@ -0,0 +1,24 @@
+require 'rom/support/cache'
+
+RSpec.describe ROM::Cache do
+  subject(:klass) do
+    Class.new do
+      extend ROM::Cache
+    end
+  end
+
+  describe '#fetch_or_store' do
+    it 'stores and fetches a value' do
+      args = [1, 2, 3]
+      value = 'foo'
+
+      expect(klass.fetch_or_store(*args) { value }).to be(value)
+      expect(klass.fetch_or_store(*args)).to be(value)
+
+      object = klass.new
+
+      expect(object.fetch_or_store(*args) { value }).to be(value)
+      expect(object.fetch_or_store(*args)).to be(value)
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require 'rom/support/deprecations'
+require 'tempfile'
+
+RSpec.describe ROM::Deprecations do
+  let(:log_file) do
+    Tempfile.new('rom_deprecations')
+  end
+
+  before do
+    ROM::Deprecations.set_logger!(log_file)
+  end
+
+  let(:output) do
+    log_file.close
+    log_file.open.read
+  end
+
+  describe '.warn' do
+    it 'logs a warning message' do
+      ROM::Deprecations.warn('hello world')
+      expect(output).to include('[rom] hello world')
+    end
+  end
+
+  describe '.announce' do
+    it 'warns about a deprecated method' do
+      ROM::Deprecations.announce(:foo, 'hello world')
+      expect(output).to include('[rom] foo is deprecated and will be removed')
+      expect(output).to include('hello world')
+    end
+  end
+
+  describe '.deprecate_class_method' do
+    subject(:klass) do
+      Class.new do
+        extend ROM::Deprecations
+
+        def self.name
+          "Test"
+        end
+
+        def self.log(msg)
+          "log: #{msg}"
+        end
+
+        def self.hello(word)
+          "hello #{word}"
+        end
+        deprecate_class_method :hello, "is no more"
+
+        def self.logging(msg)
+          "logging: #{msg}"
+        end
+        deprecate_class_method :logging, :log
+      end
+    end
+
+    it 'deprecates method that is to be removed' do
+      res = klass.hello("world")
+
+      expect(res).to eql("hello world")
+      expect(output).to include('[rom] Test.hello is deprecated and will be removed')
+      expect(output).to include('is no more')
+    end
+
+    it 'deprecates a method in favor of another' do
+      res = klass.logging('foo')
+
+      expect(res).to eql('log: foo')
+      expect(output).to include('[rom] Test.logging is deprecated and will be removed')
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ describe ROM::EnumerableDataset do
       include ROM::EnumerableDataset
 
       def self.row_proc
-        T(:symbolize_keys)
+        -> i { i.each_with_object({}) { |(k,v),h| h[k.to_sym] = v } }
       end
     end
   end

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

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'rom/support/registry'
+
+shared_examples_for 'registry fetch' do
+  it 'returns registered element identified by name' do
+    expect(registry.public_send(fetch_method, :mars)).to be(mars)
+  end
+
+  it 'raises error when element is not found' do
+    expect { registry.public_send(fetch_method, :twix) }.to raise_error(
+      ROM::Registry::ElementNotFoundError,
+      ":twix doesn't exist in Candy registry"
+    )
+  end
+
+  it 'returns the value from an optional block when key is not found' do
+    value = registry.public_send(fetch_method, :candy) { :twix }
+
+    expect(value).to eq(:twix)
+  end
+
+  it 'calls #to_sym on a key before fetching' do
+    expect(registry.public_send(fetch_method, double(to_sym: :mars))).to be(mars)
+  end
+end
+
+describe ROM::Registry do
+  subject(:registry) { registry_class.new(mars: mars) }
+
+  let(:mars) { double('mars') }
+
+  let(:registry_class) do
+    Class.new(ROM::Registry) do
+      def self.name
+        'Candy'
+      end
+    end
+  end
+
+  describe '#fetch' do
+    let(:fetch_method) { :fetch }
+
+    it_behaves_like 'registry fetch'
+  end
+
+  describe '#[]' do
+    let(:fetch_method) { :[] }
+
+    it_behaves_like 'registry fetch'
+  end
+
+  describe '#method_missing' do
+    it 'returns registered element identified by name' do
+      expect(registry.mars).to be(mars)
+    end
+
+    it 'raises no-method error when element is not there' do
+      expect { registry.twix }.to raise_error(NoMethodError)
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rom-support
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,7 @@ files:
 - lib/rom-support.rb
 - lib/rom/support/array_dataset.rb
 - lib/rom/support/auto_curry.rb
+- lib/rom/support/cache.rb
 - lib/rom/support/class_builder.rb
 - lib/rom/support/class_macros.rb
 - lib/rom/support/constants.rb
@@ -125,10 +140,13 @@ files:
 - spec/support/mutant.rb
 - spec/unit/rom/support/array_dataset_spec.rb
 - spec/unit/rom/support/auto_curry_spec.rb
+- spec/unit/rom/support/cache_spec.rb
 - spec/unit/rom/support/class_builder_spec.rb
+- spec/unit/rom/support/deprecations_spec.rb
 - spec/unit/rom/support/enumerable_dataset_spec.rb
 - spec/unit/rom/support/inflector_spec.rb
 - spec/unit/rom/support/options_spec.rb
+- spec/unit/rom/support/registry_spec.rb
 homepage: http://rom-rb.org
 licenses:
 - MIT
@@ -149,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Object Mapper - Support libraries