clowne 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1b3c79ac97f903ed3f2c1f8ae8b894dd7c4f3c4da5ab28350e59482ef08714e
-  data.tar.gz: af3aa849d2ba1dfdc34f8edbb612c384bafefd21d2ef74f2842e659af4690867
+  metadata.gz: 78d20c6640a5bbd59c580555212a4bc17efc623ed2e3e5f0f3b2a8c343e8a7a1
+  data.tar.gz: da533b87dff544ca0ed704507918595bcbdee69145c5c5d4cde7a8ada0333ee5
 SHA512:
-  metadata.gz: bbf985fe91770d1d34ae133492ba58aadc7eeab15b3dcc6f122db94d6e48e42dd8c885c4b145da2325583a98143d28464b128c7f34174a13f4922a72a340cfff
-  data.tar.gz: f47be4fac65591d29754756e2dd59a002d1eec0fcbfd661d2619f113020d97a7f1630d0d738cb3d2c9a7496d4302e2a0e888a3d537c9dcb2fed0053db72ee1db
+  metadata.gz: cdcca7b527663200dca117c21ea0ab89b4bc1e642329b42bb3e084e3cec449925987c9b64deb15032f387bb8e171735ef088728c4768b1d0adf09d81c332868b
+  data.tar.gz: 65052b5da9fd8f9e31782b0bffe3c9c292da95979ccc4546e8b2e660c2c86bee3caef55b4a9c5f9c5c6bfa23c5d1efdc1d9df4a3f749089ed3a099ccc88e0c25

data/.github/workflows/rspec-jruby.yml

@@ -0,0 +1,33 @@
+name: JRuby Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  rspec-jruby:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v1
+      with:
+        path:  /home/runner/bundle
+        key: bundle-${{ hashFiles('**/gemfiles/jruby.gemfile') }}-${{ hashFiles('**/*.gemspec') }}
+        restore-keys: |
+          bundle-
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: jruby-9.2.15.0
+    - name: Bundle install
+      run: |
+        bundle config path /home/runner/bundle
+        bundle config --global gemfile gemfiles/jruby.gemfile
+        bundle install
+    - name: Run RSpec
+      run: |
+        bundle exec rspec --force-color

data/.github/workflows/rspec-truffle.yml

@@ -0,0 +1,35 @@
+name: TruffleRuby Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  rspec-truffle:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v1
+      with:
+        path:  /home/runner/bundle
+        key: bundle-${{ hashFiles('**/Gemfile') }}-${{ hashFiles('**/*.gemspec') }}
+        restore-keys: |
+          bundle-
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: truffleruby-head
+        bundler: 2.2.15
+        bundler-cache: true
+
+    - name: Bundle install
+      run: |
+        bundle config path /home/runner/bundle
+        bundle install
+    - name: Run RSpec
+      run: |
+        bundle exec rspec --force-color

data/.github/workflows/rspec.yml

@@ -0,0 +1,51 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7]
+        gemfile: ["gemfiles/railsmaster.gemfile"]
+        include:
+        - ruby: ruby-head
+          gemfile: "gemfiles/railsmaster.gemfile"
+        - ruby: 3.0
+          gemfile: "Gemfile"
+        - ruby: 2.7
+          gemfile: "Gemfile"
+        - ruby: 2.6.5
+          gemfile: "Gemfile"
+        - ruby: 2.5.7
+          gemfile: "gemfiles/activerecord42.gemfile"
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/cache@v1
+      with:
+        path: /home/runner/bundle
+        key: bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-${{ hashFiles(matrix.gemfile) }}-${{ hashFiles('**/*.gemspec') }}
+        restore-keys: |
+          bundle-${{ matrix.ruby }}-${{ matrix.gemfile }}-
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Bundle install
+      run: |
+        bundle config path /home/runner/bundle
+        bundle config --global gemfile ${{ matrix.gemfile }}
+        bundle install
+        bundle update
+    - name: Run RSpec
+      run: |
+        bundle exec rspec --force-color
+

data/.github/workflows/rubocop.yml

@@ -0,0 +1,20 @@
+name: Lint Ruby
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Lint Ruby code with RuboCop
+      run: |
+        bundle install --jobs 4 --retry 3
+        bundle exec rubocop

data/.rubocop.yml

@@ -1,68 +1,29 @@
 require:
-- 'rubocop-md'
+  # add after moving docs to another tool
+  - 'standard/cop/block_single_line_braces'
+  - '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.7
 
 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:
+Lint/Void:
   Exclude:
-    - 'spec/**/*.rb'
-    - 'Gemfile'
-    - 'Rakefile'
-    - '*.gemspec'
-    - 'CHANGELOG.md'
+    - 'docs/README.md'
     - 'README.md'
 
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Bundler/OrderedGems:
-  Enabled: false
-
-Gemspec/OrderedDependencies:
-  Enabled: false
-
-Lint/Void:
+Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'README.md'
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change log
 
+## 1.3.0 (2021-05-11)
+
+- Added Ruby 3.0 support ([@pomartel][])
+- Fixed Ruby 2.7 warnings ([@mpestov][])
+
+## 1.2.0 (2020-07-03)
+
+- Added TruffleRuby support ([@ssnickolay][])
+- Added Ruby 2.7 support ([@Sub-Xaero][])
+- Fixed JRuby support
+- Fixed all dependencies vulnerabilities
+- Documents moved to Docsify engine ([@ssnickolay][])
+
+## 1.1.0 (2019-03-20)
+
+- Add `after_clone` declaration. ([@elardo][])
+- Add opporotunity to include belongs_to association for active_record adapter. ([@madding][])
+
 ## 1.0.0 (2019-02-26)
 
 - Return `Operation` instance as a rusult of cloning. ([@ssnickolay][])
@@ -36,3 +54,8 @@ See [migration guide](https://clowne.evilmartians.io/docs/from_v02_to_v10.html)
 
 [@palkan]: https://github.com/palkan
 [@ssnickolay]: https://github.com/ssnickolay
+[@elardo]: https://github.com/elardo
+[@madding]: https://github.com/madding
+[@pomartel]: https://github.com/pomartel
+[@mpestov]: https://github.com/mpestov
+[@Sub-Xaero]: https://github.com/Sub-Xaero

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.2", 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", ">= 6.0", "< 6.2.0"
+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,6 @@
 [![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://github.com/clowne-rb/clowne/actions/workflows/rspec.yml/badge.svg?branch=master)](https://github.com/clowne-rb/clowne/actions?query=branch%3Amaster+)
+[![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 +26,7 @@ gem install clowne
 Or add this line to your application's Gemfile:
 
 ```ruby
-gem 'clowne'
+gem "clowne"
 ```
 
 ## Quick Start
@@ -68,7 +68,7 @@ class UserCloner < Clowne::Cloner
   nullify :login
 
   # params here is an arbitrary Hash passed into cloner
-  finalize do |_source, record, params|
+  finalize do |_source, record, **params|
     record.email = params[:email]
   end
 end
@@ -86,7 +86,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
@@ -114,16 +114,16 @@ Take a look at our [documentation](https://clowne.evilmartians.io) for more info
 
 ### Supported ORM adapters
 
-Adapter                                   |1:1         | 1:M         | M:M                     |
-------------------------------------------|------------|-------------|-------------------------|
-[Active Record](https://clowne.evilmartians.io/clowne/docs/active_record.html)  | has_one    | has_many    | has_and_belongs_to|
-[Sequel](https://clowne.evilmartians.io/clowne/docs/sequel.html)                | one_to_one | one_to_many | many_to_many     |
+Adapter                                   |1:1         |*:1         | 1:M         | M:M                     |
+------------------------------------------|------------|------------|-------------|-------------------------|
+[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 'factory_bot', '~> 5'
+  spec.add_development_dependency 'rubocop', '~> 1.22'
+  spec.add_development_dependency 'rubocop-md', '~> 1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
+  spec.add_development_dependency 'standard', '~> 1.4.0'
 end

data/docs/.rubocop.yml

@@ -1,5 +1,5 @@
-Metrics/LineLength:
-  Max: 100
+inherit_gem:
+  standard: config/base.yml
 
 Lint/Void:
   Exclude:
@@ -10,3 +10,6 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Enabled: false
+
+Layout/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)

data/docs/active_record.md

@@ -1,7 +1,4 @@
----
-id: active_record
-title: Active Record
----
+# Active Record
 
 Clowne provides an optional ActiveRecord integration which allows you to configure cloners in your models and adds a shortcut to invoke cloners (`#clowne` method).
 
@@ -9,7 +6,7 @@ To enable this integration, you must require `"clowne/adapters/active_record/dsl
 
 ```ruby
 # config/initializers/clowne.rb
-require 'clowne/adapters/active_record/dsl'
+require "clowne/adapters/active_record/dsl"
 Clowne.default_adapter = :active_record
 ```
 

data/docs/after_clone.md

@@ -0,0 +1,53 @@
+# After Clone
+
+The `after_clone` callbacks can help you to make additional operations on cloned record, like checking it with some business logic or actualizing cloned record attributes, before it will be saved to the database. Also it can help to avoid unneeded usage of [`after_persist`](after_persist) callbacks, and additional queries to database.
+
+Examples:
+
+```ruby
+class User < ActiveRecord::Base
+  # create_table :users do |t|
+  #   t.string :login
+  #   t.integer :draft_count
+  # end
+
+  has_many :posts # all user's posts
+end
+
+class Post < ActiveRecord::Base
+  # create_table :posts do |t|
+  #   t.integer :user_id
+  #   t.boolean :is_draft
+  # end
+
+  scope :draft, -> { where is_draft: true }
+end
+
+class UserCloner < Clowne::Cloner
+# clone user and his posts, which is drafts
+  include_association :posts, scope: :draft
+
+  after_clone do |_origin, clone, **|
+    # actualize user attribute
+    clone.draft_count = clone.posts.count
+  end
+end
+```
+
+`after_clone` runs when you call `Operation#to_record` or [`Operation#persist`](operation) (or `Operation#persist!`)
+
+```ruby
+# prepare data
+user = User.create
+3.times { Post.create(user: user, is_draft: false) }
+2.times { Post.create(user: user, is_draft: true) }
+
+operation = UserCloner.call(user)
+# => <#Clowne::Utils::Operation ...>
+
+clone = operation.to_record
+# => <#User id: nil, draft_count: 2 ...>
+
+clone.draft_count == user.posts.draft.count
+# => true
+```