flatter-extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 836dcba21ba1e7372ffb7ba02c0c830caab448da
+  data.tar.gz: d6a27a477a4de896ab938cc9098b5e7e60ebabce
+SHA512:
+  metadata.gz: 3b456cbd8bc8a4064969f0f3182951c779c12b58836d8821f6a1a6ac5737543349c7d16f58ecbeabad18eaec8d9c2a8e81f472a778c65eaedfd59d7c8019c14e
+  data.tar.gz: 44cceaca1a35835e7b0d29be5840baf3edd7747c033f2351e60c53d5ad99d47b97696ca161a475dfb05cd792a1fd9ac1d0924bdd763f1ee0e832cc815571ed38

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flatter-extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Artem Kuzko
+
+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,37 @@
+# Flatter::Extensions
+
+A set of extensions to be used with [Flatter](https://github.com/akuzko/flatter) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flatter-extensions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flatter-extensions
+
+## Usage
+
+Coming soon.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akuzko/flatter-extensions.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flatter/extensions"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flatter-extensions.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flatter/extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flatter-extensions"
+  spec.version       = Flatter::Extensions::VERSION
+  spec.authors       = ["Artem Kuzko"]
+  spec.email         = ["a.kuzko@gmail.com"]
+
+  spec.summary       = %q{Set of extensions for Flatter gem.}
+  spec.description   = %q{Set of extensions to be used with Flatter gem. They
+    provide a number of optional auxiliary functionality, which may be very
+    helpful from case to case, especially if using Flatter for mapping
+    ActiveRecord objects}
+  spec.homepage      = "https://github.com/akuzko/flatter-extensions"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "flatter"
+
+  spec.add_development_dependency "activerecord", ">= 4.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/lib/flatter/extensions.rb

@@ -0,0 +1,16 @@
+require "flatter"
+
+require "flatter/extensions/version"
+
+require "flatter/extensions/multiparam"
+require "flatter/extensions/order"
+require "flatter/extensions/skipping"
+
+if defined? ActiveRecord
+  require "flatter/extensions/active_record"
+end
+
+module Flatter
+  module Extensions
+  end
+end

data/lib/flatter/extensions/active_record.rb

@@ -0,0 +1,132 @@
+if defined? ActiveRecord
+  module Flatter
+    module Extensions
+      module ActiveRecord
+        extend ::Flatter::Extension
+
+        module SkipCallbacks
+          def save_without_callbacks
+            @_saving_without_callbacks = true
+            create_or_update
+          ensure
+            remove_instance_variable('@_saving_without_callbacks')
+          end
+
+          private
+
+          def _run_save_callbacks
+            @_saving_without_callbacks ? yield : super
+          end
+
+          def _run_create_callbacks
+            @_saving_without_callbacks ? yield : super
+          end
+
+          def _run_update_callbacks
+            @_saving_without_callbacks ? yield : super
+          end
+        end
+
+        register_as :active_record
+
+        depends_on :skipping
+
+        hooked do
+          ::ActiveRecord::Base.send(:prepend, SkipCallbacks)
+        end
+
+        factory.extend do
+          def default_target_from(mapper)
+            return super unless mapper.ar?
+
+            target_from_association(mapper.target) || super
+          end
+          private :default_target_from
+
+          def target_from_association(target)
+            reflection = reflection_from_target(target)
+
+            return unless reflection.present?
+
+            case reflection.macro
+            when :has_one, :belongs_to
+              target.public_send(name) || target.public_send("build_#{name}")
+            when :has_many
+              target.association(reflection.name).build
+            end
+          end
+          private :target_from_association
+
+          def reflection_from_target(target)
+            target_class = target.class
+            reflection   = target_class.reflect_on_association(name)
+            reflection || target_class.reflect_on_association(name.pluralize)
+          end
+          private :reflection_from_target
+        end
+
+        mapper.add_options :foreign_key, :mounter_foreign_key do
+          def apply(*)
+            return super unless ar?
+
+            ::ActiveRecord::Base.transaction{ super }
+          end
+
+          def save_target
+            return super unless ar?
+
+            assign_foreign_keys_from_mountings
+
+            was_new = target.new_record?
+            result = target.save_without_callbacks
+
+            if result && was_new
+              assign_foreign_keys_for_mountings
+            end
+
+            result != false
+          end
+          protected :save_target
+
+          def assign_foreign_keys_from_mountings
+            associated_mountings(:mounter_foreign_key).each do |mounting|
+              target[mounting.mounter_foreign_key] = mounting.target.id
+            end
+          end
+          private :assign_foreign_keys_from_mountings
+
+          def assign_foreign_keys_for_mountings
+            associated_mountings(:foreign_key).each do |mounting|
+              mounting.target[mounting.foreign_key] = target.id
+            end
+          end
+          private :assign_foreign_keys_for_mountings
+
+          def associated_mountings(key)
+            root_mountings.select do |mounting|
+              mounter = mounting.mounter
+              mounter = mounter.mounter if mounter.trait?
+              mounting.options.key?(key) && mounter == self
+            end
+          end
+          private :associated_mountings
+
+          def skip!
+            if ar?
+              if target.new_record?
+                target.instance_variable_set('@destroyed', true)
+              else
+                target.restore_attributes
+              end
+            end
+            super
+          end
+
+          def ar?
+            target.class < ::ActiveRecord::Base
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flatter/extensions/multiparam.rb

@@ -0,0 +1,51 @@
+module Flatter
+  module Extensions
+    module Multiparam
+      extend ::Flatter::Extension
+
+      register_as :multiparam
+
+      mapping.add_option :multiparam do
+        def write(value)
+          return super unless multiparam?
+
+          write!(multiparam.new(*value))
+        end
+      end
+
+      mapper.extend do
+        def write(params)
+          extract_multiparams!(params)
+
+          super(params)
+        end
+
+        def extract_multiparams!(params)
+          mappings.each do |name, mapping|
+            next unless mapping.multiparam?
+
+            param_keys = params.keys.
+              select{ |key| key.to_s =~ /#{name}\(\d+[if]\)/ }.
+              sort_by{ |key| key.to_s[/\((\d+).*\)/, 1].to_i }
+
+            next if param_keys.empty?
+
+            args = param_keys.each_with_object([]) do |key, values|
+              value = params.delete key
+              type  = key[/\(\d+([if]*)\)/, 1]
+
+              value = if value.present?
+                type.blank? ? value : value.send("to_#{type}")
+              end
+
+              values.push value
+            end
+
+            params[name] = args
+          end
+        end
+        private :extract_multiparams!
+      end
+    end
+  end
+end

data/lib/flatter/extensions/order.rb

@@ -0,0 +1,23 @@
+module Flatter
+  module Extensions
+    module Order
+      extend ::Flatter::Extension
+
+      register_as :order
+
+      mapper.add_option :index do
+        def index
+          options[:index] || 0
+        end
+
+        def mappers_chain(context)
+          super.sort_by do |mapper|
+            index = mapper.index
+            index.is_a?(Hash) ? (index[context] || 0) : index
+          end
+        end
+        private :mappers_chain
+      end
+    end
+  end
+end

data/lib/flatter/extensions/skipping.rb

@@ -0,0 +1,32 @@
+module Flatter
+  module Extensions
+    module Skipping
+      extend ::Flatter::Extension
+
+      register_as :skipping
+
+      mapper.extend do
+        def run_validations!
+          if skipped?
+            errors.clear
+            true
+          else
+            super
+          end
+        end
+
+        def run_save!
+          skipped? ? true : super
+        end
+
+        def skip!
+          @skipped = true
+        end
+
+        def skipped?
+          !!@skipped
+        end
+      end
+    end
+  end
+end

data/lib/flatter/extensions/version.rb

@@ -0,0 +1,5 @@
+module Flatter
+  module Extensions
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: flatter-extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Kuzko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Set of extensions to be used with Flatter gem. They
+      provide a number of optional auxiliary functionality, which may be very
+      helpful from case to case, especially if using Flatter for mapping
+      ActiveRecord objects
+email:
+- a.kuzko@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flatter-extensions.gemspec
+- lib/flatter/extensions.rb
+- lib/flatter/extensions/active_record.rb
+- lib/flatter/extensions/multiparam.rb
+- lib/flatter/extensions/order.rb
+- lib/flatter/extensions/skipping.rb
+- lib/flatter/extensions/version.rb
+homepage: https://github.com/akuzko/flatter-extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Set of extensions for Flatter gem.
+test_files: []