effective_mergery 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 185eb0a320784bf5e9f6cc24b1db3296761469d8
+  data.tar.gz: 79ed4931f61a2c803e50e8b132d9bae2d0060c97
+SHA512:
+  metadata.gz: 29c4448f5df36346b5567795a9548ed8f1bcef9d03d7e83142c479653a26027b3f940cc234b603ec54278988deb14ef1fdfeaf24caf654a3856d1998e04ffab1
+  data.tar.gz: bd52345540fcfd32a37751d8d25e70857158a9ccacd64332850f827988475aa28573dcbc9753b318a8c3eea8451f4c2630f47185baec4b958c049bf07cdea0e8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Code and Effect Inc.
+
+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,68 @@
+# Effective Mergery
+
+Merge any two Active Record objects, along with all associated objects, into one record.
+
+## Getting Started
+
+Add to your Gemfile:
+
+```ruby
+gem 'effective_mergery'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_mergery:install
+```
+
+The generator will install an initializer which describes all configuration options.
+
+Require the javascript on the asset pipeline by adding the following to your application.js:
+
+```ruby
+//= require effective_mergery
+```
+
+Require the stylesheet on the asset pipeline by adding the following to your application.css:
+
+```ruby
+*= require effective_mergery
+```
+
+## Usage
+
+Visit `/admin/merge` and select an object type to merge.
+
+```ruby
+link_to 'Merge', effective_mergery.admin_merge_index_path
+link_to 'Merge: User', effective_mergery.new_admin_merge_path(type: 'User')
+```
+
+## Permissions
+
+Add the following permissions (using CanCan):
+
+```ruby
+can :admin, :effective_mergery
+```
+
+## License
+
+MIT License. Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Bonus points for test coverage
+6. Create new Pull Request
+

data/app/assets/javascripts/effective_mergery.js

@@ -0,0 +1,2 @@
+//= require_tree ./effective_mergery
+

data/app/assets/javascripts/effective_mergery/merge.js.coffee

@@ -0,0 +1,20 @@
+loadAttributes = (event) ->
+  $obj = $(event.currentTarget)
+
+  id = parseInt($obj.val())
+  type = $obj.closest('form').find("input[name='effective_merge[type]']").val()
+
+  selector = if ($obj.attr('name') == 'effective_merge[source_id]') then '.source' else '.target'
+  content = $obj.closest('form').find(selector).first()
+
+  url = "/admin/merge/attributes?id=#{id}&type=#{type}"
+
+  if id != undefined && id != NaN && id > 0 && type.length > 0
+    content.load(url, (response, status, xhr) =>
+      content.html('<p>This item is unavailable (ajax error)</p>') if status == 'error'
+    )
+  else
+    content.html('')
+
+$(document).on 'change', "select[name='effective_merge[source_id]']", (event) -> loadAttributes(event)
+$(document).on 'change', "select[name='effective_merge[target_id]']", (event) -> loadAttributes(event)

data/app/assets/stylesheets/effective_mergery.scss

@@ -0,0 +1 @@
+@import 'effective_mergery/merge';

data/app/assets/stylesheets/effective_mergery/_merge.scss

@@ -0,0 +1,5 @@
+.effective-merge {
+  .source {
+    .table-attributes { opacity: 0.4; }
+  }
+}

data/app/controllers/admin/merge_controller.rb

@@ -0,0 +1,63 @@
+module Admin
+  class MergeController < ApplicationController
+    before_action :authenticate_user! if defined?(Devise)
+
+    layout (EffectiveMergery.layout.kind_of?(Hash) ? EffectiveMergery.layout[:admin_merge] : EffectiveMergery.layout)
+
+    def index
+      @page_title = 'Merges'
+      EffectiveMergery.authorized?(self, :admin, :effective_mergery)
+    end
+
+    def new
+      @page_title = 'New Merge'
+      EffectiveMergery.authorized?(self, :admin, :effective_mergery)
+
+      begin
+        @merge = Effective::Merge.new(type: params[:type])
+        @merge.validate_klass!
+      rescue => e
+        flash[:danger] = "An error occurred while loading #{@merge}: #{e.message}"
+        redirect_to effective_mergery.admin_merge_index_path
+      end
+    end
+
+    def create
+      EffectiveMergery.authorized?(self, :admin, :effective_mergery)
+
+      @merge = Effective::Merge.new(merge_params)
+
+      if @merge.save
+        @page_title = 'Successful Merge'
+        flash[:success] = "Successfully merged #{@merge}"
+
+        @merge.target = @merge.collection.find(@merge.target_id)
+      else
+        @page_title = 'New Merge'
+        flash.now[:danger] = "Unable to merge #{@merge}: #{@merge.errors.full_messages.to_sentence}"
+
+        render :new
+      end
+    end
+
+    # This is the AJAX request for the object's attributes
+    def attributes
+      EffectiveMergery.authorized?(self, :admin, :effective_mergery)
+
+      object = Effective::Merge.new(type: params[:type]).collection.find(params[:id])
+
+      if object.present?
+        render partial: '/admin/merge/attributes', locals: { resource: object }
+      else
+        render body: '<p>None Available</p>'
+      end
+    end
+
+    private
+
+    def merge_params
+      params.require(:effective_merge).permit(:type, :source_id, :target_id)
+    end
+
+  end
+end

data/app/models/effective/access_denied.rb

@@ -0,0 +1,17 @@
+unless defined?(Effective::AccessDenied)
+  module Effective
+    class AccessDenied < StandardError
+      attr_reader :action, :subject
+
+      def initialize(message = nil, action = nil, subject = nil)
+        @message = message
+        @action = action
+        @subject = subject
+      end
+
+      def to_s
+        @message || I18n.t(:'unauthorized.default', :default => 'Access Denied')
+      end
+    end
+  end
+end

data/app/models/effective/merge.rb

@@ -0,0 +1,91 @@
+module Effective
+  class Merge
+    include ActiveModel::Model
+
+    attr_accessor :type, :source, :source_id, :target, :target_id
+
+    validate(if: -> { source_id.present? }) { @source ||= collection.find_by_id(source_id) }
+    validate(if: -> { target_id.present? }) { @target ||= collection.find_by_id(target_id) }
+
+    validates :type, presence: true, inclusion: { in: EffectiveMergery.mergables, message: 'must be a mergable type' }
+    validates :source_id, presence: true, unless: -> { source.present? }
+    validates :target_id, presence: true, unless: -> { target.present? }
+
+    validate(if: -> { source_id.present? && target_id.present? }) do
+      self.errors.add(:target_id, "can't be the same as source") if source_id == target_id
+    end
+
+    validates :source, presence: { message: 'invalid source id' }, if: -> { source_id.present? }
+    validates :target, presence: { message: 'invalid target id' }, if: -> { target_id.present? }
+
+    def to_s
+      return 'New Merge' unless type
+      type.downcase
+    end
+
+    def save(validate: true)
+      return false unless valid?
+      (merge!(validate: validate) rescue false)
+    end
+
+    def save!(validate: true)
+      raise 'is invalid' unless valid?
+      merge!(validate: validate)
+    end
+
+    def collection
+      @collection ||= (klass.respond_to?(:sorted) ? klass.sorted : klass.all)
+    end
+
+    def klass
+      @klass ||= type.safe_constantize
+    end
+
+    # This is called on Admin::Merges#new
+    def validate_klass!
+      raise "type can't be blank" unless type.present?
+      raise 'type must be a mergable type' unless EffectiveMergery.mergables.include?(type)
+      raise "invalid ActiveRecord klass" unless klass
+      raise "invalid ActiveRecord collection" unless collection.kind_of?(ActiveRecord::Relation)
+      true
+    end
+
+    private
+
+    def merge!(validate: true)
+      resource = Effective::Resource.new(source)
+
+      klass.transaction do
+        begin
+
+          # Merge associations
+          (resource.has_ones + resource.has_manys + resource.nested_resources).compact.each do |association|
+            next if association.options[:through].present?
+
+            Array(source.send(association.name)).each do |obj|
+              obj.assign_attributes(association.foreign_key => target.id)
+
+              unless obj.save(validate: validate)
+                raise "associated #{obj.class.name}<#{obj.to_param}> is invalid: #{obj.errors.full_messages.to_sentence}"
+              end
+            end
+          end
+
+          source.destroy!
+
+          unless target.save(validate: validate)
+            raise "merged #{target.class.name} is invalid: #{target.errors.full_messages.to_sentence}"
+          end
+
+          return true
+        rescue => e
+          self.errors.add(:base, e.message)
+          raise ActiveRecord::Rollback
+        end
+      end
+
+      false
+    end
+
+  end
+end

data/app/views/admin/merge/_attributes.html.haml

@@ -0,0 +1,3 @@
+= tableize_hash(resource.attributes, table: 'table table-attributes')
+%hr
+= tableize_hash(Effective::Resource.new(resource).instance_attributes.except(:attributes))

data/app/views/admin/merge/create.html.haml

@@ -0,0 +1,11 @@
+%h1.effective-admin-heading= @page_title
+
+.row
+  .col-sm-2
+  .col-sm-8
+    %p= @merge.target
+    = render partial: '/admin/merge/attributes', locals: { resource: @merge.target }
+  .col-sm-2
+
+.text-center
+  %p= link_to "Merge Another #{@merge}", effective_mergery.new_admin_merge_path(type: @merge.type), class: 'btn btn-primary'

data/app/views/admin/merge/index.html.haml

@@ -0,0 +1,10 @@
+%h1.effective-admin-heading= @page_title
+
+%p Please select one of the following to merge:
+
+- if EffectiveMergery.mergables.blank?
+  %p There is nothing available to merge.
+- else
+  %ul
+    - EffectiveMergery.mergables.each do |name|
+      %li= link_to name, effective_mergery.new_admin_merge_path(type: name)

data/app/views/admin/merge/new.html.haml

@@ -0,0 +1,29 @@
+%h1.effective-admin-heading= @page_title
+
+%p Please select a source and target. The source record's associated data, but not its attributes, will be merged into the target. The source record will then be destroyed.
+
+.effective-merge
+  = simple_form_for [:admin, @merge], (EffectiveOrders.admin_simple_form_options || {}).merge(url: effective_mergery.admin_merge_index_path) do |f|
+    = f.input :type, as: :hidden
+
+    .row
+      .col-sm-6
+        = f.input :source_id, as: (defined?(EffectiveFormInputs) ? :effective_select : :select),
+          collection: f.object.collection,
+          hint: 'This record will be destroyed'
+      .col-sm-6
+        = f.input :target_id, as: (defined?(EffectiveFormInputs) ? :effective_select : :select),
+          collection: f.object.collection,
+          hint: 'This record will be kept'
+
+    .row
+      .col-sm-6.source
+        - if f.object.source.present?
+          = render partial: '/admin/merge/attributes', locals: { resource: f.object.source }
+
+      .col-sm-6.target
+        - if f.object.target.present?
+          = render partial: '/admin/merge/attributes', locals: { resource: f.object.target }
+
+    .text-center
+      = f.button :submit, "Merge #{@merge}", data: { disable_with: 'Merging...', confirm: "Really merge? The source record will be destroyed."}

data/config/effective_mergery.rb

@@ -0,0 +1,48 @@
+EffectiveMergery.setup do |config|
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) } # CanCanCan
+
+  # Admin Screens Layout Settings
+  config.layout = 'application'   # All EffectiveMergery controllers will use this layout
+
+  # config.layout = {
+  #   merge: 'application',
+  #   admin_merge: 'admin',
+  # }
+
+  config.admin_simple_form_options = {}  # For the /admin/merge/new form
+  # config.admin_simple_form_options = {
+  #   :html => {:class => ['form-horizontal']},
+  #   :wrapper => :horizontal_form,
+  #   :wrapper_mappings => {
+  #     :boolean => :horizontal_boolean,
+  #     :check_boxes => :horizontal_radio_and_checkboxes,
+  #     :radio_buttons => :horizontal_radio_and_checkboxes
+  #   }
+  # }
+
+  # Allow merges for only the following ActiveRecord class names:
+  # config.only = ['User']
+
+  # Allow merges on all ActiveRecord classes, except the following:
+  # config.except = []
+
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+EffectiveMergery::Engine.routes.draw do
+  namespace :admin do
+    resources :merge, only: [:index, :new, :create] do
+      get :attributes, on: :collection
+    end
+  end
+end
+
+Rails.application.routes.draw do
+  mount EffectiveMergery::Engine => '/', :as => 'effective_mergery'
+end

data/lib/effective_mergery.rb

@@ -0,0 +1,44 @@
+require 'effective_resources'
+require 'effective_mergery/engine'
+require 'effective_mergery/version'
+
+module EffectiveMergery
+
+  # The following are all valid config keys
+  mattr_accessor :authorization_method
+  mattr_accessor :layout
+  mattr_accessor :admin_simple_form_options
+
+  mattr_accessor :only
+  mattr_accessor :except
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
+      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
+    end
+    true
+  end
+
+  def self.mergables
+    @mergables ||= (
+      Rails.application.eager_load! unless Rails.configuration.cache_classes
+
+      blacklist = ['Delayed::', 'Effective::', 'ActiveRecord::', 'ApplicationRecord']
+
+      ActiveRecord::Base.descendants.map { |obj| obj.name }.tap do |names|
+        names.reject! { |name| blacklist.any? { |b| name.start_with?(b) } }
+
+        if (onlies = Array(only)).present?
+          names.select! { |name| onlies.include?(name) }
+        elsif (excepts = Array(except)).present?
+          names.reject! { |name| excepts.include?(name) }
+        end
+      end.sort
+    )
+  end
+
+end

data/lib/effective_mergery/engine.rb

@@ -0,0 +1,13 @@
+module EffectiveMergery
+  class Engine < ::Rails::Engine
+    engine_name 'effective_mergery'
+
+    config.autoload_paths += Dir["#{config.root}/lib/"]
+
+    # Set up our default configuration options.
+    initializer "effective_mergery.defaults", before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_mergery.rb")
+    end
+
+  end
+end

data/lib/effective_mergery/version.rb

@@ -0,0 +1,3 @@
+module EffectiveMergery
+  VERSION = '0.1'.freeze
+end

data/lib/generators/effective_mergery/install_generator.rb

@@ -0,0 +1,16 @@
+module EffectiveMergery
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveMergery initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_mergery.rb', 'config/initializers/effective_mergery.rb'
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: effective_mergery
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Code and Effect
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  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: coffee-rails
+  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: sass-rails
+  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: simple_form
+  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'
+description: Deep merge any two Active Record objects.
+email:
+- info@codeandeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/assets/javascripts/effective_mergery.js
+- app/assets/javascripts/effective_mergery/merge.js.coffee
+- app/assets/stylesheets/effective_mergery.scss
+- app/assets/stylesheets/effective_mergery/_merge.scss
+- app/controllers/admin/merge_controller.rb
+- app/models/effective/access_denied.rb
+- app/models/effective/merge.rb
+- app/views/admin/merge/_attributes.html.haml
+- app/views/admin/merge/create.html.haml
+- app/views/admin/merge/index.html.haml
+- app/views/admin/merge/new.html.haml
+- config/effective_mergery.rb
+- config/routes.rb
+- lib/effective_mergery.rb
+- lib/effective_mergery/engine.rb
+- lib/effective_mergery/version.rb
+- lib/generators/effective_mergery/install_generator.rb
+homepage: https://github.com/code-and-effect/effective_mergery
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Deep merge any two Active Record objects.
+test_files: []