clowne 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a2126fd3d4f4581bb9d06a1d53489dab431e2285683cba815df66a683d154a
-  data.tar.gz: 973bebd26c7e8e33807d6a4a3438d5f72aefb540bbbf4ce4d5aecfcf58761893
+  metadata.gz: '0815485e47677a65023e13711ad70570b79c97057ad8d09bed83f45aa293f939'
+  data.tar.gz: d1f8a39135462f1bca941515d055f19f44cdf92c0152ea0c49d8dd3f39475fb7
 SHA512:
-  metadata.gz: db3a1a9e38b180a2a5ad6cd490fe9852f074de4484df91ff62525fb88497a2785ef9307745a264bcb082a42ff9f1be95848534a949a78c96e591141c24fefea1
-  data.tar.gz: 565def47871791088a954d8ffd7ea374de91d37844fcc3bed97f35c6e299d65bd14f3c817906815b79544a7080a456058ed46dbf375d5d200ba7956b79149ac3
+  metadata.gz: 809ecabf16dc071eda96f03853baaa42b5736804864e417e2d9a03ee3d37425b7e01c649cee2a2b8728813ffb09a3a4fb61a59e53ebdbf5f3da0b0a435a91807
+  data.tar.gz: 9c186a3f86f85f2a08eaea4612329a86f104328c99aa561f82a9b42f9b69f50b159f15b1426aec68585aca6f24c937b0967876689b84a0d04a64ac041169c175

data/.rubocop.yml

@@ -1,68 +1,28 @@
 require:
-- 'rubocop-md'
+  # add after moving docs to another tool
+  - 'standard/cop/semantic_blocks'
+  - 'rubocop-md'
+
+inherit_gem:
+  standard: config/base.yml
+
 AllCops:
   Exclude:
     - 'bin/**/*'
     - 'tmp/**/*'
-    - 'docs/web/**/*'
     - 'vendor/**/*'
     - 'gemfiles/vendor/**/*'
+    - 'clowne.gemspec'
   DisplayCopNames: true
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
 
 Markdown:
   WarnInvalid: true
 
-Rails:
-  Enabled: false
-
-Naming/AccessorMethodName:
-  Enabled: false
-
-Naming/ClassAndModuleCamelCase:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
-Naming/MemoizedInstanceVariableName:
-  Enabled: false
-
-Style/TrivialAccessors:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 100
-
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*.rb'
-    - 'README.md'
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - 'spec/**/*.rb'
-    - 'Gemfile'
-    - 'Rakefile'
-    - '*.gemspec'
-    - 'CHANGELOG.md'
-    - 'README.md'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Gemspec/OrderedDependencies:
+Standard/SemanticBlocks:
   Enabled: false
 
 Lint/Void:
   Exclude:
+    - 'docs/README.md'
     - 'README.md'

data/.travis.yml

@@ -1,11 +1,11 @@
 sudo: false
 language: ruby
+cache: bundler
 
 notifications:
   email: false
 
 before_install:
-  - gem update --system
   - gem install bundler
 
 before_script:
@@ -16,40 +16,28 @@ before_script:
 script:
   - bundle exec rake
   - if [ "$CC_REPORT" == "true" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
-  - if [ "$DEPLOY_ME" == "true" ]; then (cd ./docs/web && yarn && yarn run build); fi
 
 matrix:
   fast_finish: true
   include:
     - rvm: ruby-head
       gemfile: gemfiles/railsmaster.gemfile
-    - rvm: jruby-9.2.5.0
+    - rvm: jruby-9.2.8.0
       gemfile: gemfiles/jruby.gemfile
-    - rvm: jruby-9.1.15.0
-      gemfile: gemfiles/jruby.gemfile
-    - rvm: 2.5.0
+    - rvm: 2.7
+      gemfile: Gemfile
+    - rvm: 2.6.5
       gemfile: Gemfile
-    - rvm: 2.4.3
+    - rvm: 2.5.7
       gemfile: Gemfile
-      env:
-        - CC_REPORT=true
-        - DEPLOY_ME=true
-    - rvm: 2.4.1
+    - rvm: 2.4.9
       gemfile: gemfiles/activerecord42.gemfile
-    - rvm: 2.3.1
+    - rvm: truffleruby-head
       gemfile: Gemfile
   allow_failures:
     - rvm: ruby-head
       gemfile: gemfiles/railsmaster.gemfile
-    - rvm: jruby-9.2.5.0
+    - rvm: jruby-9.2.8.0
       gemfile: gemfiles/jruby.gemfile
-    - rvm: jruby-9.1.15.0
-      gemfile: gemfiles/jruby.gemfile
-deploy:
-  provider: pages
-  skip_cleanup: true
-  github_token: $GITHUB_TOKEN
-  local_dir: "./docs/web/build/clowne"
-  on:
-    branch: master
-    condition: $DEPLOY_ME = true
+    - rvm: truffleruby-head
+      gemfile: Gemfile

data/Gemfile

@@ -1,19 +1,19 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in clowne.gemspec
 gemspec
 
-gem 'pry-byebug', platform: :mri
+gem "pry-byebug", platform: :mri
 
-gem 'sqlite3', '~> 1.3.6', platform: :mri
-gem 'activerecord-jdbcsqlite3-adapter', '~> 50.0', platform: :jruby
-gem 'jdbc-sqlite3', platform: :jruby
+gem "sqlite3", "~> 1.4.1", platform: :ruby
+gem "activerecord-jdbcsqlite3-adapter", "~> 50.0", platform: :jruby
+gem "jdbc-sqlite3", platform: :jruby
 
-gem 'activerecord', '>= 5.0'
-gem 'sequel', '>= 5.0'
-gem 'simplecov'
+gem "activerecord", "~> 5.2"
+gem "sequel", ">= 5.0"
+gem "simplecov"
 
-local_gemfile = 'Gemfile.local'
+local_gemfile = "Gemfile.local"
 
 if File.exist?(local_gemfile)
   eval(File.read(local_gemfile)) # rubocop:disable Security/Eval

data/README.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/clowne.svg)](https://badge.fury.io/rb/clowne)
-[![Build Status](https://travis-ci.org/palkan/clowne.svg?branch=master)](https://travis-ci.org/palkan/clowne)
-[![Test Coverage](https://codeclimate.com/github/palkan/clowne/badges/coverage.svg)](https://codeclimate.com/github/palkan/clowne/coverage)
+[![Build Status](https://travis-ci.org/clowne-rb/clowne.svg?branch=master)](https://travis-ci.org/clowne-rb/clowne)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9143c4f91e9d1d2a4bd1/test_coverage)](https://codeclimate.com/github/clowne-rb/clowne/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9143c4f91e9d1d2a4bd1/maintainability)](https://codeclimate.com/github/clowne-rb/clowne/maintainability)
 [![Docs](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://clowne.evilmartians.io)
 
 # Clowne
@@ -26,7 +27,7 @@ gem install clowne
 Or add this line to your application's Gemfile:
 
 ```ruby
-gem 'clowne'
+gem "clowne"
 ```
 
 ## Quick Start
@@ -86,7 +87,7 @@ Now you can use `UserCloner` to clone existing records:
 user = User.last
 # => <#User id: 1, login: 'clown', email: 'clown@circus.example.com'>
 
-operation = UserCloner.call(user, email: 'fake@example.com')
+operation = UserCloner.call(user, email: "fake@example.com")
 # => <#Clowne::Utils::Operation...>
 
 operation.to_record
@@ -116,14 +117,14 @@ Take a look at our [documentation](https://clowne.evilmartians.io) for more info
 
 Adapter                                   |1:1         |*:1         | 1:M         | M:M                     |
 ------------------------------------------|------------|------------|-------------|-------------------------|
-[Active Record](https://clowne.evilmartians.io/clowne/docs/active_record.html)  | has_one    | belongs_to | has_many    | has_and_belongs_to|
-[Sequel](https://clowne.evilmartians.io/clowne/docs/sequel.html)                | one_to_one | -          | one_to_many | many_to_many     |
+[Active Record](https://clowne.evilmartians.io/#/active_record)  | has_one    | belongs_to | has_many    | has_and_belongs_to|
+[Sequel](https://clowne.evilmartians.io/#/sequel)                | one_to_one | -          | one_to_many | many_to_many     |
 
 ## Maintainers
 
 - [Vladimir Dementyev](https://github.com/palkan)
 
-- [Sverchkov Nikolay](https://github.com/ssnickolay)
+- [Nikolay Sverchkov](https://github.com/ssnickolay)
 
 ## License
 

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new

data/clowne.gemspec

@@ -8,23 +8,29 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Vladimir Dementyev', 'Sverchkov Nikolay']
   spec.email         = ['palkan@evilmartians.com', 'ssnikolay@gmail.com']
 
-  spec.summary       = 'A flexible gem for cloning your models.'
+  spec.summary       = 'A flexible gem for cloning your models'
   spec.description   = 'A flexible gem for cloning your models.'
-  spec.homepage      = 'https://github.com/palkan/clowne'
+  spec.homepage      = 'https://github.com/clowne-rb/clowne'
   spec.license       = 'MIT'
 
   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.metadata = {
+    "bug_tracker_uri" => "http://github.com/clowne-rb/clowne/issues",
+    "changelog_uri" => "https://github.com/clowne-rb/clowne/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://clowne.evilmartians.io/",
+    "homepage_uri" => "https://clowne.evilmartians.io/",
+    "source_code_uri" => "http://github.com/clowne-rb/clowne"
+  }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'factory_bot', '~> 4.8'
-  spec.add_development_dependency 'rubocop', '~> 0.61'
-  spec.add_development_dependency 'rubocop-md', '~> 0.2'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
+  spec.add_development_dependency 'rubocop', '~> 0.75.0'
+  spec.add_development_dependency 'rubocop-md', '~> 0.3.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.36.0'
+  spec.add_development_dependency 'standard', '~> 0.1.5'
 end

data/docs/.rubocop.yml

@@ -1,5 +1,5 @@
-Metrics/LineLength:
-  Max: 100
+inherit_gem:
+  standard: config/base.yml
 
 Lint/Void:
   Exclude:
@@ -8,5 +8,11 @@ Lint/Void:
 Metrics/AbcSize:
   Enabled: false
 
+Standard/SemanticBlocks:
+  Enabled: false
+
 Metrics/BlockLength:
   Enabled: false
+
+Metrics/LineLength:
+  Enabled: false

data/docs/CNAME

@@ -0,0 +1 @@
+clowne.evilmartians.io

data/docs/README.md

@@ -0,0 +1,131 @@
+[![Gem Version](https://badge.fury.io/rb/clowne.svg)](https://badge.fury.io/rb/clowne)
+[![Build Status](https://travis-ci.org/clowne-rb/clowne.svg?branch=master)](https://travis-ci.org/clowne-rb/clowne)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9143c4f91e9d1d2a4bd1/test_coverage)](https://codeclimate.com/github/clowne-rb/clowne/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9143c4f91e9d1d2a4bd1/maintainability)](https://codeclimate.com/github/clowne-rb/clowne/maintainability)
+[![Docs](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://clowne.evilmartians.io)
+
+# Clowne
+
+A flexible gem for cloning your models. Clowne focuses on ease of use and provides the ability to connect various ORM adapters.
+
+📖 Read [Evil Martians Chronicles](https://evilmartians.com/chronicles/clowne-clone-ruby-models-with-a-smile) to learn about possible use cases.
+
+📑 [Documentation](https://clowne.evilmartians.io)
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+
+## Installation
+
+To install Clowne with RubyGems:
+
+```ruby
+gem install clowne
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem "clowne"
+```
+
+## Quick Start
+
+Assume that you have the following model:
+
+```ruby
+class User < ActiveRecord::Base
+  # create_table :users do |t|
+  #  t.string :login
+  #  t.string :email
+  #  t.timestamps null: false
+  # end
+
+  has_one :profile
+  has_many :posts
+end
+
+class Profile < ActiveRecord::Base
+  # create_table :profiles do |t|
+  #   t.string :name
+  # end
+end
+
+class Post < ActiveRecord::Base
+  # create_table :posts
+end
+```
+
+Let's declare our cloners first:
+
+```ruby
+class UserCloner < Clowne::Cloner
+  adapter :active_record
+
+  include_association :profile, clone_with: SpecialProfileCloner
+  include_association :posts
+
+  nullify :login
+
+  # params here is an arbitrary Hash passed into cloner
+  finalize do |_source, record, params|
+    record.email = params[:email]
+  end
+end
+
+class SpecialProfileCloner < Clowne::Cloner
+  adapter :active_record
+
+  nullify :name
+end
+```
+
+Now you can use `UserCloner` to clone existing records:
+
+```ruby
+user = User.last
+# => <#User id: 1, login: 'clown', email: 'clown@circus.example.com'>
+
+operation = UserCloner.call(user, email: "fake@example.com")
+# => <#Clowne::Utils::Operation...>
+
+operation.to_record
+# => <#User id: nil, login: nil, email: 'fake@example.com'>
+
+operation.persist!
+# => true
+
+cloned = operation.to_record
+# => <#User id: 2, login: nil, email: 'fake@example.com'>
+
+cloned.login
+# => nil
+cloned.email
+# => "fake@example.com"
+
+# associations:
+cloned.posts.count == user.posts.count
+# => true
+cloned.profile.name
+# => nil
+```
+
+Take a look at our [documentation](https://clowne.evilmartians.io) for more info!
+
+### Supported ORM adapters
+
+Adapter                                   |1:1         |*:1         | 1:M         | M:M                     |
+------------------------------------------|------------|------------|-------------|-------------------------|
+[Active Record](active_record)  | has_one    | belongs_to | has_many    | has_and_belongs_to|
+[Sequel](sequel)                | one_to_one | -          | one_to_many | many_to_many     |
+
+## Maintainers
+
+- [Vladimir Dementyev](https://github.com/palkan)
+
+- [Nikolay Sverchkov](https://github.com/ssnickolay)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/docs/_sidebar.md

@@ -0,0 +1,25 @@
+* [Getting Started](getting_started.md)
+* DSL
+  * [Operation](operation.md)
+  * [Include Association](include_association.md)
+  * [Exclude Association](exclude_association.md)
+  * [Nullify Attributes](nullify.md)
+  * [Finalization](finalize.md)
+  * [After Clone](after_clone.md)
+  * [After Persist](after_persist.md)
+  * [Initialize Cloning Target](init_as.md)
+  * [Traits](traits.md)
+  * [Parameters](parameters.md)
+* Adapters
+  * [Supported Adapters](supported_adapters.md)
+  * [ActiveRecord](active_record.md)
+  * [Sequel](sequel.md)
+* Advanced Options
+  * [Implicit Cloner](implicit_cloner.md)
+  * [Inline Configuration](inline_configuration.md)
+  * [Clone mapper](clone_mapper.md)
+  * [Architecture](architecture.md)
+  * [Testing](testing.md)
+  * [Customization](customization.md)
+* Upgrade Notes
+  * [From v0.2.x to v1.0.0](from_v02_to_v1.md)