cloned 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7753f2da570340b1d3a81fcb3ee5ca20ce29f35b
+  data.tar.gz: 17a9f319c880d8634d81db7a09df98e9e499acf2
+SHA512:
+  metadata.gz: b65842c27b89bd71c553d4437e54785404a23154f3c18cd72c9b1169c28ed43d8d233df54f2fa7dd25609d119eb303750c0cceda13e563f714f3e95c32266da4
+  data.tar.gz: 1f9c2a962636e9effa00358ddcd012ca70c739f4e628b99506b7440922cb5be67280a04e18c7a3e4cad6e0687747b5634232139762b193afd29c0ec03e62ddb4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cloned.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Askar Zinurov
+
+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,66 @@
+# Cloned
+
+Simple gem for copying trees of ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cloned'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloned
+
+## Usage
+
+First you need to define clonning stategy:
+
+```ruby
+class CompanyCopyStrategy < Cloned::Strategy
+  declare :company do
+    before do |copied_company|
+      copied_company.copied_at = Time.zone.now
+    end
+
+    after do |copied_company|
+      copied_company.departments_count = copied_company.departments.size
+    end
+
+    nullify :created_at, :updated_at
+
+    association(:departments)
+  end
+
+  declare :department do
+    association :employees, if: ->(employee) { employee.salary > 2000 }
+  end
+
+  declare :employee do
+    nullify :last_sickleave, :vacation_at
+  end
+end
+```
+Then you able to build or create clones:
+
+```ruby
+CompanyCopyStrategy.make(Company.first, Account.last.companies)
+```
+or
+```ruby
+CompanyCopyStrategy.create(Company.first, Account.last.companies)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AskarZinurov/cloned.
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloned"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/cloned.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cloned/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloned"
+  spec.version       = Cloned::VERSION
+  spec.authors       = ["Askar Zinurov"]
+  spec.email         = ["mail@asktim.ru"]
+
+  spec.summary       = %q{Rails models copier.}
+  spec.description   = %q{Simple lib for cloning rails models and associations.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 4.2"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cloned/base.rb

@@ -0,0 +1,110 @@
+require 'cloned/dsl'
+
+module Cloned
+  class Base
+    attr_reader :copy, :target, :destination, :options
+    delegate :strategy, to: :class
+
+    def initialize(target, destination, options = {})
+      @target = target
+      @destination = destination
+      @options = options
+    end
+
+    def make
+      if skip_transaction?
+        make_or_fail!
+      else
+        ActiveRecord::Base.transaction { make_or_fail! }
+      end
+      copy
+    end
+
+    def valid?
+      target.presence
+    end
+
+    protected
+
+    def skip_transaction?
+      options[:skip_transaction]
+    end
+
+    def force?
+      options[:force].presence
+    end
+
+    def optional_before(clon)
+      options[:before].call(clon) if options.key?(:before)
+    end
+
+    def optional_after(clon)
+      options[:after].call(clon) if options.key?(:after)
+    end
+
+    class << self
+      attr_accessor :strategy
+
+      include Cloned::DSL
+
+      delegate :find_copier, to: :strategy
+    end
+
+    private
+
+    def copy_association(target_association:, destination:, **options)
+      copier = strategy.find_copier(target_association.proxy_association.klass)
+      target_association.each do |target_item|
+        copier.new(target_item, destination, options.merge(skip_transaction: true)).make
+      end
+    end
+
+    def copy_associations(clon)
+      self.class.associations.each do |association_id, options|
+        copy_association(
+          target_association: target.public_send(association_id),
+          destination: clon.public_send(association_id),
+          **options)
+      end
+    end
+
+    def clearing_attributes
+      []
+    end
+
+    def before(clon)
+      optional_before(clon)
+      declared_before(clon) if respond_to?(:declared_before)
+    end
+
+    def after(clon)
+      optional_after(clon)
+      declared_after(clon) if respond_to?(:declared_after)
+    end
+
+    def prepare(clon)
+      clon.assign_attributes(Hash[clearing_attributes.map { |k| [k, nil] }])
+      clon
+    end
+
+    def validate!
+      raise 'Cloning context not valid!' unless valid?
+    end
+
+    def make_or_fail!
+      validate!
+      return if options.key?(:if) && !options[:if].call(target)
+      @copy = make_copy(target: target, destination: destination)
+      @copy.save! if force?
+    end
+
+    def make_copy(target:, destination:)
+      clon = prepare(target.dup)
+      before(clon)
+      destination.concat(clon) unless destination.nil?
+      copy_associations(clon)
+      after(clon)
+      clon
+    end
+  end
+end

data/lib/cloned/dsl.rb

@@ -0,0 +1,27 @@
+module Cloned
+  module DSL
+    attr_reader :associations
+
+    def before(&block)
+      define_method :declared_before, &block
+    end
+
+    def after(&block)
+      define_method :declared_after, &block
+    end
+
+    def nullify(*attributes)
+      define_method :clearing_attributes do
+        attributes
+      end
+    end
+
+    def association(association_id, options = {})
+      associations[association_id] = options
+    end
+
+    def associations
+      @associations ||= {}
+    end
+  end
+end

data/lib/cloned/strategy.rb

@@ -0,0 +1,26 @@
+class Cloned::Strategy
+  class << self
+    def cloners_map
+      @cloners_map ||= {}
+    end
+
+    def declare(cloner_id, options = {}, &block)
+      cloner_name = options[:class_name] || cloner_id.to_s.camelcase
+      cloner = Class.new(Cloned::Base, &block)
+      cloner.strategy = self
+      cloners_map[cloner_name] = cloner
+    end
+
+    def find_copier(klass)
+      cloners_map[klass.name] || Cloned::Base
+    end
+
+    def make(target, destination, options = {})
+      find_copier(target.class).new(target, destination, options).make
+    end
+
+    def create(target, destination, options = {})
+      make(target, destination, options.merge(force: true))
+    end
+  end
+end

data/lib/cloned/version.rb

@@ -0,0 +1,3 @@
+module Cloned
+  VERSION = "0.1.0"
+end

data/lib/cloned.rb

@@ -0,0 +1,5 @@
+require 'cloned/version'
+require 'cloned/base'
+require 'cloned/strategy'
+
+module Cloned; end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cloned
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Askar Zinurov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple lib for cloning rails models and associations.
+email:
+- mail@asktim.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloned.gemspec
+- lib/cloned.rb
+- lib/cloned/base.rb
+- lib/cloned/dsl.rb
+- lib/cloned/strategy.rb
+- lib/cloned/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Rails models copier.
+test_files: []