deep_cloneable_checked 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4e5dde0e5922d0b2eb088d978ac52a98e18d71f1bfd84d0a660d4e9118d6a9f
+  data.tar.gz: d5e02afde0d474a5f9d1059de864899505670d57e93c6c0b91b153474d5f6058
+SHA512:
+  metadata.gz: 4b355de3f95ba257137c67346fb9144d5d31757a50d5379cf20d0c2e35c3755b160ae400bbbf287196ef03310964aa78bda80ed866accfadac7cff3c3b9a9c23
+  data.tar.gz: 21bc6b8c52a092b392cc032f1396870f7ebb7bab72ed8adc692e49f9ee2f8c5904803a1d3cc64077987c3577f0f66e358d4ff880bfa9bbd9f4b7a9c3cc248b4d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2017-06-20
+### Added
+- Deep clone checked method by [@kaori-kk](https://github.com/kaori-kk) [@tinco](https://github.com/tinco).

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kaori@aeroscan.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deep_cloneable_checked.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "sqlite3"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    deep_cloneable_checked (0.1.0)
+      deep_cloneable (~> 3.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    deep_cloneable (3.2.0)
+      activerecord (>= 3.1.0, < 8)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.2)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deep_cloneable_checked!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kaori Kohama
+
+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,53 @@
+# DeepCloneableChecked
+
+Use this gem to enforce explicit mentions of all associations of model you want to `deep_clone` using the `deep_clone_checked` method.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deep_cloneable_checked'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install deep_cloneable_checked
+
+## Usage
+
+Call the `deep_clone_checked` method as you would normally call the `deep_clone` method from [deep_cloneable](https://github.com/moiristo/deep_cloneable) with `:include` and add `:exclude` for any associations you do not want to clone.
+
+```ruby
+human = Animal::Human.create :name => 'Michael'
+human2 = Animal::Human.create :name => 'Jack'
+chicken1 = Animal::Chicken.create :name => 'Chick1'
+chicken2 = Animal::Chicken.create :name => 'Chick2'
+human.chickens << [chicken1, chicken2]
+human2.chickens << [chicken1, chicken2]
+
+deep_clone_human = human.deep_clone_checked(:include => :ownerships, :exclude => [:pigs, {:ownerships=>[:human, :chicken]}, :chickens])
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aeroscan-nl/deep_cloneable_checked. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/aeroscan-nl/deep_cloneable_checked/blob/main/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DeepCloneableChecked project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aeroscan-nl/deep_cloneable_checked/blob/main/CODE_OF_CONDUCT.md).

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 "deep_cloneable_checked"
+
+# 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/deep_cloneable_checked.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/deep_cloneable_checked/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deep_cloneable_checked"
+  spec.version       = DeepCloneableChecked::VERSION
+  spec.authors       = ["Kaori Kohama", "Tinco Andringa"]
+  spec.email         = ["kaori@aeroscan.nl", "tinco@aeroscan.nl"]
+
+  spec.summary       = %q{Use this gem to enforce all associations are explicitly cloned or excluded with deep_clone}
+  spec.description   = %q{Use this gem to enforce all associations are explicitly cloned or excluded with deep_clone}
+  spec.homepage      = "https://github.com/aeroscan-nl/deep_cloneable_checked"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aeroscan-nl/deep_cloneable_checked"
+  spec.metadata["changelog_uri"] = "https://github.com/aeroscan-nl/deep_cloneable_checked/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency('deep_cloneable', '~> 3.2.0')
+end

data/lib/deep_cloneable_checked/deep_clone_checked.rb

@@ -0,0 +1,84 @@
+module DeepCloneableChecked
+  module DeepCloneChecked
+    def deep_clone_checked(options)
+      if options[:include].is_a?(Hash) || options[:include].is_a?(Symbol)
+        options[:include] = [options[:include]]
+      end
+  
+      if options[:exclude].is_a?(Hash) || options[:exclude].is_a?(Symbol)
+        options[:exclude] = [options[:exclude]]
+      end
+  
+      missing = validate_clone_check(options)
+      
+      unless missing.empty?
+        raise MissingAssociationError, "Not all associations cloned: #{missing.inspect}"
+      end
+  
+      deep_clone(options)
+    end
+  
+    def validate_clone_check(options)
+      find_symbol_or_hash = lambda do |options, association_name|
+        
+        result = options.find do |option|
+          if option.is_a? Symbol
+            option.to_s == association_name
+          elsif option.is_a? Hash
+            option[association_name.to_sym]
+          else
+            nil
+          end
+        end
+        result
+      end
+  
+      check_missing = lambda do |klass, includes, excludes|
+        # puts "-----------\n klass: #{klass.name}, includes: #{includes.inspect}, excludes: #{excludes.inspect}"
+        associations = klass.reflections
+  
+        associations.map do |association_name, reflection|
+  
+          to_exclude = find_symbol_or_hash[excludes, association_name]
+          if to_exclude.is_a? Symbol
+            next_excludes = []
+          elsif to_exclude.is_a? Array
+            next_excludes = to_exclude
+          elsif to_exclude.nil?
+            next_excludes = []
+          else
+            next_excludes = to_exclude[association_name.to_sym]
+          end
+  
+          inclusion = find_symbol_or_hash[includes, association_name]
+  
+          if inclusion.is_a? Symbol
+            # puts "inclusion: #{inclusion.inspect}, association_name: #{association_name}" 
+            result = check_missing[reflection.klass, [], next_excludes]
+            if !result.blank?
+              # puts "missing from #{reflection.klass.name}, #{association_name}"
+              Hash[association_name.to_sym, result]
+            end
+          elsif inclusion.is_a? Hash
+            # puts "inclusion: #{inclusion.inspect}, association_name: #{association_name}"
+            result = check_missing[reflection.klass, [inclusion[association_name.to_sym]], next_excludes]
+            if !result.blank?
+              # puts "missing from #{reflection.klass.name}, #{association_name}"
+              Hash[association_name.to_sym, result]
+            end
+          else
+            # puts "No inclusion for #{association_name}, inclusion: #{inclusion.inspect}, to_exclude: #{to_exclude.inspect}"
+            if to_exclude.is_a? Symbol
+              nil
+            else
+              # puts "No exclusion either"
+              association_name.to_sym
+            end
+          end
+        end.compact
+      end
+  
+      check_missing[self.class, options[:include] || [], options[:exclude] || []]
+    end
+  end
+end

data/lib/deep_cloneable_checked/version.rb

@@ -0,0 +1,3 @@
+module DeepCloneableChecked
+  VERSION = "1.0.0"
+end

data/lib/deep_cloneable_checked.rb

@@ -0,0 +1,11 @@
+require "deep_cloneable_checked/version"
+require 'deep_cloneable'
+require 'deep_cloneable_checked/deep_clone_checked'
+
+module DeepCloneableChecked
+  class MissingAssociationError < StandardError; end
+end
+
+ActiveSupport.on_load :active_record do
+  include DeepCloneableChecked::DeepCloneChecked
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: deep_cloneable_checked
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kaori Kohama
+- Tinco Andringa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_cloneable
+  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
+description: Use this gem to enforce all associations are explicitly cloned or excluded
+  with deep_clone
+email:
+- kaori@aeroscan.nl
+- tinco@aeroscan.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deep_cloneable_checked.gemspec
+- lib/deep_cloneable_checked.rb
+- lib/deep_cloneable_checked/deep_clone_checked.rb
+- lib/deep_cloneable_checked/version.rb
+homepage: https://github.com/aeroscan-nl/deep_cloneable_checked
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aeroscan-nl/deep_cloneable_checked
+  source_code_uri: https://github.com/aeroscan-nl/deep_cloneable_checked
+  changelog_uri: https://github.com/aeroscan-nl/deep_cloneable_checked/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Use this gem to enforce all associations are explicitly cloned or excluded
+  with deep_clone
+test_files: []