rom-support 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29285bc52be91138894978734ea97b5ff8cf1916
+  data.tar.gz: cb55485edd81dcf8e45a44a0df2c99a8d156ee10
+SHA512:
+  metadata.gz: 7e107d16dcec735f0ce71c4c6f820102f62fee1852b31329a29d6322233ecb0b10ea713939053b4c8a0737f9544dcfcf72cc72fd67a9ee1253872ff6bd8aa3e1
+  data.tar.gz: 53d9fe73f2c618604142cee6a294d002a9f0f9e0eb0406dbea6697bc57c749c5fa8e2aced4d01aaf225006f72c1eca00b1e4c549747ccb6c5f7b0fb98ab53982

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+vendor/
+
+.idea/
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.ruby-version

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--order random
+--warnings
+-r ./spec/spec_helper

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+sudo: false
+cache: bundler
+env:
+  - CODECLIMATE_REPO_TOKEN=513a7c6a20ab24a3937cb3a75400c8bba6f86a9405d05241445fdf432c378f77
+bundler_args: --without tools
+script: "bundle exec rake spec"
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+v0.1.0 2015-08-10
+
+First public release. The code was ported from rom 0.8.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,35 @@
+source 'https://rubygems.org'
+
+gemspec
+
+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 'inflecto', '~> 0.0', '>= 0.0.2'
+
+  platforms :rbx do
+    gem 'rubysl-bigdecimal', platforms: :rbx
+    gem 'codeclimate-test-reporter', require: false
+  end
+end
+
+group :tools do
+  gem 'rubocop', '~> 0.31'
+
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+
+  gem 'byebug'
+
+  platform :mri do
+    gem 'mutant', '>= 0.8.0', github: 'mbj/mutant', branch: 'master'
+    gem 'mutant-rspec'
+  end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2015 Ruby Object Mapper Team
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+[gem]: https://rubygems.org/gems/rom-support
+[travis]: https://travis-ci.org/rom-rb/rom-support
+[gemnasium]: https://gemnasium.com/rom-rb/rom-support
+[codeclimate]: https://codeclimate.com/github/rom-rb/rom-support
+[inchpages]: http://inch-ci.org/github/rom-rb/rom-support
+
+# rom-support
+
+[![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]
+[![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]
+
+Support libraries for ROM gems. Most likely some or even all of those will become standalone micro-libs at some point or replaced with existing ones.

data/Rakefile

@@ -0,0 +1,15 @@
+require "rspec/core/rake_task"
+require "rake/testtask"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:ci]
+
+desc 'Run specs in isolation'
+task :"spec:isolation" do
+  FileList["spec/**/*_spec.rb"].each do |spec|
+    sh "rspec", spec
+  end
+end
+
+desc "Run CI tasks"
+task ci: [:spec]

data/lib/rom-support.rb

@@ -0,0 +1 @@
+require 'rom/support/constants'

data/lib/rom/support/array_dataset.rb

@@ -0,0 +1,41 @@
+require 'rom/support/enumerable_dataset'
+
+module ROM
+  # A helper module that adds data-proxy behavior to an array-like object
+  #
+  # @see EnumerableDataset
+  #
+  # @api public
+  module ArrayDataset
+    extend DataProxy::ClassMethods
+    include EnumerableDataset
+
+    # Extends the class with data-proxy behavior
+    #
+    # @api private
+    def self.included(klass)
+      klass.class_eval do
+        include Options
+        include DataProxy
+      end
+    end
+
+    forward(
+      :*, :+, :-, :compact, :compact!, :flatten, :flatten!, :length, :pop,
+      :reverse, :reverse!, :sample, :size, :shift, :shuffle, :shuffle!,
+      :slice, :slice!, :sort!, :uniq, :uniq!, :unshift, :values_at
+    )
+
+    [
+      :map!, :combination, :cycle, :delete_if, :keep_if, :permutation, :reject!,
+      :select!, :sort_by!
+    ].each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args, &block)
+          return to_enum unless block
+          self.class.new(data.send(:#{method}, *args, &block), options)
+        end
+      RUBY
+    end
+  end
+end

data/lib/rom/support/auto_curry.rb

@@ -0,0 +1,29 @@
+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
+        super(name)
+      end
+    end
+
+    def auto_curry(name)
+      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)
+        else
+          curried.new(self, name: name, curry_args: args, arity: arity)
+        end
+      end
+    end
+  end
+end

data/lib/rom/support/class_builder.rb

@@ -0,0 +1,46 @@
+require 'rom/support/options'
+
+module ROM
+  # Internal support class for generating classes
+  #
+  # @private
+  class ClassBuilder
+    include Options
+
+    option :name, type: String, reader: true
+    option :parent, type: Class, reader: true, parent: Object
+
+    # Generate a class based on options
+    #
+    # @example
+    #   builder = ROM::ClasBuilder.new(name: 'MyClass')
+    #
+    #   klass = builder.call
+    #   klass.name # => "MyClass"
+    #
+    # @return [Class]
+    #
+    # @api private
+    def call
+      klass = Class.new(parent)
+
+      klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.name
+          #{name.inspect}
+        end
+
+        def self.inspect
+          name
+        end
+
+        def self.to_s
+          name
+        end
+      RUBY
+
+      yield(klass) if block_given?
+
+      klass
+    end
+  end
+end

data/lib/rom/support/class_macros.rb

@@ -0,0 +1,56 @@
+module ROM
+  # Internal support module for class-level settings
+  #
+  # @private
+  module ClassMacros
+    # Specify what macros a class will use
+    #
+    # @example
+    #   class MyClass
+    #     extend ROM::ClassMacros
+    #
+    #     defines :one, :two
+    #
+    #     one 1
+    #     two 2
+    #   end
+    #
+    #   class OtherClass < MyClass
+    #     two 'two'
+    #   end
+    #
+    #   MyClass.one # => 1
+    #   MyClass.two # => 2
+    #
+    #   OtherClass.one # => 1
+    #   OtherClass.two # => 'two'
+    #
+    # @api private
+    def defines(*args)
+      mod = Module.new
+
+      args.each do |name|
+        mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name}(value = Undefined)
+            if value == Undefined
+              defined?(@#{name}) && @#{name}
+            else
+              @#{name} = value
+            end
+          end
+        RUBY
+      end
+
+      delegates = args.map { |name| "klass.#{name}(#{name})" }.join("\n")
+
+      mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def inherited(klass)
+          super
+          #{delegates}
+        end
+      RUBY
+
+      extend(mod)
+    end
+  end
+end

data/lib/rom/support/constants.rb

@@ -0,0 +1,5 @@
+module ROM
+  Undefined = Object.new.freeze
+  EMPTY_HASH = {}.freeze
+  EMPTY_ARRAY = [].freeze
+end

data/lib/rom/support/data_proxy.rb

@@ -0,0 +1,102 @@
+require 'equalizer'
+
+module ROM
+  # Helper module for dataset classes
+  #
+  # It provides a constructor accepting data, header and an optional row_proc.
+  # This module is used internally by EnumerableDataset and ArrayDataset.
+  #
+  # @private
+  module DataProxy
+    NON_FORWARDABLE = [
+      :each, :to_a, :to_ary, :kind_of?, :instance_of?, :is_a?
+    ].freeze
+
+    # Wrapped data array
+    #
+    # @return [Object] Data object for the iterator
+    #
+    # @api private
+    attr_reader :data
+
+    # @return [Proc] tuple processing proc
+    #
+    # @api private
+    attr_reader :row_proc
+
+    # Extends the class with `forward` DSL and Equalizer using `data` attribute
+    #
+    # @see ClassMethods#forward
+    #
+    # @api private
+    def self.included(klass)
+      klass.class_eval do
+        extend ClassMethods
+
+        include Equalizer.new(:data)
+
+        option :row_proc, reader: true, default: proc { |obj| obj.class.row_proc }
+      end
+    end
+
+    # @api private
+    def initialize(data, options = {})
+      @data = data
+      super(data, options)
+    end
+
+    # Iterate over data using row_proc
+    #
+    # @return [Enumerator] if block is not given
+    #
+    # @api private
+    def each
+      return to_enum unless block_given?
+      data.each { |tuple| yield(row_proc[tuple]) }
+    end
+
+    module ClassMethods
+      # Default no-op tuple proc
+      #
+      # @return [Proc]
+      #
+      # @api private
+      def row_proc
+        -> tuple { tuple }
+      end
+
+      # Forward provided methods to the underlaying data object
+      #
+      # @example
+      #
+      #   class MyDataset
+      #     include DataProxy
+      #
+      #     forward(:find_all, :map)
+      #   end
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def forward(*methods)
+        # FIXME: we should probably raise if one of the non-forwardable methods
+        #       was provided
+        (methods - NON_FORWARDABLE).each do |method_name|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{method_name}(*args, &block)
+              response = data.public_send(#{method_name.inspect}, *args, &block)
+
+              if response.equal?(data)
+                self
+              elsif response.is_a?(data.class)
+                self.class.new(response)
+              else
+                response
+              end
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end