copyable 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c32d813761a0de036a2ca27bc77200ef2d4a2ac
-  data.tar.gz: dff39390302c0407009525d15daa493abaf58665
+  metadata.gz: df943b2cab1eb85ee8f53faff3a908dbcec38198
+  data.tar.gz: 3229ce6dbef3e246d9327f2bbd2b83377a4b77e0
 SHA512:
-  metadata.gz: b2943740d29f92450b8c1d62b5973459148606c9b6b05d227232bb9ddb7dcddfafd1091830590556a0105656d3dbe45c7e7fddba652992d50383a131215aecc0
-  data.tar.gz: f40e400af14620fa92ecf7d5b1fa783e354ed1e25d4a4726e441efedfe77df69e8ac002652883ce1f6d651b960d47662b9d196fadb9a65cad222904d77e9de63
+  metadata.gz: 8de6edeca4d17dceb962f8921581a20e292380ddb3089d34b8473314e8e0ef1eff494f05b5196f1a040ac9b433a78e99278bd5dc763789912171eb96311623c0
+  data.tar.gz: c0371addf28eb0121008e1720bed8ab975bfd7eaaf78f6a313acc3de7076a967d2e65ab27195869aa0f1ca7f157f6d742c345e1256c811a9d9061b5285fb906d

data/README.md

@@ -1,5 +1,7 @@
 # Copyable
 
+[![Code Climate](https://codeclimate.com/github/dmcouncil/copyable/badges/gpa.svg)](https://codeclimate.com/github/dmcouncil/copyable)
+
 Copyable makes it easy to copy ActiveRecord models.
 
 # Installation
@@ -21,7 +23,7 @@ Or install it yourself as:
 
 ## Basic Usage
 
-Copyable gives you a create_copy! method that you can use to copy ActiveRecord models:
+Copyable gives you a `create_copy!` method that you can use to copy ActiveRecord models:
 
     isaiah = Book.create!(title: "Isaiah")
     copy_of_isaiah = isaiah.create_copy!
@@ -32,7 +34,7 @@ Now there are two books called "Isaiah" in the database.
 
 ## The Copyable Declaration
 
-In order for an ActiveRecord model class to have the create_copy! method defined on it, you need to add a copyable declaration:
+In order for an ActiveRecord model class to have the `create_copy!` method defined on it, you need to add a copyable declaration:
 
     class Book < ActiveRecord::Base
 
@@ -60,15 +62,15 @@ The columns declaration specifies how each individual column should be copied:
       ...
     end
 
-Every column *must* be listed here (with the exception of id, created_at, created_on, updated_at or updated_on).
+Every column *must* be listed here (with the exception of `id`, `created_at`, `created_on`, `updated_at` or `updated_on`).
 
 After each column name, give advice on how to copy that column.  The advice must be one of the following:
 
-* :copy
-* :do_not_copy
-* lambda { |orig| ... }
+* `:copy`
+* `:do_not_copy`
+* `lambda { |orig| ... }`
 
-:copy copies the value from the original model.  :do_not_copy simply places nil in the column.  Using a block lets you calculate the value of the column.  The block is passed the original ActiveRecord model object that is being copied.
+`:copy` copies the value from the original model. `:do_not_copy` simply places `nil` in the column.  Using a block lets you calculate the value of the column.  The block is passed the original ActiveRecord model object that is being copied.
 
 Here's another example:
 
@@ -100,28 +102,28 @@ The associations declaration specifies whether to copy the associated models:
 
 Every association *must* be listed here, with two exceptions:
 
-* belongs_to associations must not be listed here.  Since belongs_to associations will have a foreign key column, the association will be copied when its column is copied.
-* has_many :through associations must not be listed here, because they are always associated with a related has_many association that will already have been listed.
+* `belongs_to` associations must not be listed here.  Since `belongs_to` associations will have a foreign key column, the association will be copied when its column is copied.
+* `has_many :through` associations must not be listed here, because they are always associated with a related `has_many` association that will already have been listed.
 
 The advice must be one of the following:
 
-* :copy
-* :do_not_copy
-* :copy_only_habtm_join_records
+* `:copy`
+* `:do_not_copy`
+* `:copy_only_habtm_join_records`
 
-:copy will iterate through each model in the association, creating a copy.  Note that the associated model class must also have a copyable declaration, so that we know how to copy it!
+`:copy` will iterate through each model in the association, creating a copy.  Note that the associated model class must also have a copyable declaration, so that we know how to copy it!
 
-:do_not_copy does nothing.
+`:do_not_copy` does nothing.
 
-:copy_only_habtm_join_records can only be used on has_and_belongs_to_many associations.  In fact, you can't use :copy on has_and_belongs_to_many associations.  Models associated via habtm are never actually copied, but their associations in the relevant join table can be.
+`:copy_only_habtm_join_records` can only be used on `has_and_belongs_to_many` associations.  In fact, you can't use `:copy` on `has_and_belongs_to_many` associations.  Models associated via habtm are never actually copied, but their associations in the relevant join table can be.
 
 
 
 ## Callbacks
 
-It depends on the situation as to whether you would want a particular callback to be fired when a model is copied.  Since the logic of callbacks is situational, Copyable makes the decision to completely disable all callbacks and observers for the duration of the create_copy! method.  The only exception are callbacks and observers related to validation.
+It depends on the situation as to whether you would want a particular callback to be fired when a model is copied.  Since the logic of callbacks is situational, Copyable makes the decision to completely disable all callbacks and observers for the duration of the `create_copy!` method.  The only exception are callbacks and observers related to validation.
 
-To make it easier to reason about the code, and for the sake of being obvious, every copyable declaration *must* include a declaration called disable_all_callbacks_and_observers_except_validate.  This declaration itself does not do anything; it exists as documentation.
+To make it easier to reason about the code, and for the sake of being obvious, every copyable declaration *must* include a declaration called `disable_all_callbacks_and_observers_except_validate`.  This declaration itself does not do anything; it exists as documentation.
 
     copyable do
       disable_all_callbacks_and_observers_except_validate
@@ -132,7 +134,7 @@ To make it easier to reason about the code, and for the sake of being obvious, e
 
 ## The After Copy Declaration
 
-In case you wanted to make sure a particular callback is run, or in case you had some special custom copying behavior, an after_copy declaration is provided that is called after the model has been copied.  It is passed the original model and the newly copied model.  Note that all callbacks and observers are disabled during the execution of the after_copy block, so you must call them explicitly if you want them to run.
+In case you wanted to make sure a particular callback is run, or in case you had some special custom copying behavior, an `after_copy` declaration is provided that is called after the model has been copied. It is passed the original model and the newly copied model. Note that all callbacks and observers are disabled during the execution of the `after_copy` block, so you must call them explicitly if you want them to run.
 
     copyable do
       ...
@@ -146,7 +148,7 @@ In case you wanted to make sure a particular callback is run, or in case you had
 
 ## Putting It All Together
 
-Here is an example of all four declarations being used in a copyable declaration.  Note that all declarations are required except for after_copy.
+Here is an example of all four declarations being used in a copyable declaration.  Note that all declarations are required except for `after_copy`.
 
     copyable do
       disable_all_callbacks_and_observers_except_validate
@@ -169,17 +171,17 @@ Here is an example of all four declarations being used in a copyable declaration
 
 ## create_copy!
 
-The create_copy! method allows you to override column values by passing in a hash.
+The `create_copy!` method allows you to override column values by passing in a hash.
 
     isaiah = Book.create!(title: "Isaiah")
     copy_of_isaiah = isaiah.create_copy!
     copy_of_isaiah2 = isaiah.create_copy!(override: { title: "Foo" })
 
-copy_of_isaiah.title will be "Copy of Isaiah" (or whatever the advice was given in the columns declaration).
+`copy_of_isaiah.title` will be "Copy of Isaiah" (or whatever the advice was given in the columns declaration).
 
-copy_of_isaiah2.title will be "Foo".
+`copy_of_isaiah2.title` will be "Foo".
 
-Note that you pass in column names only, so if you want to update a belongs to association, you must pass in the column name, not the association name.
+Note that you pass in column names only, so if you want to update a `belongs_to` association, you must pass in the column name, not the association name.
 
     isaiah.create_copy!(override: { author: "Isaiah" })   # NO, bad programmer
     isaiah.create_copy!(override: { author_id: 34 })      # YES
@@ -202,9 +204,9 @@ Currently copyable only has one configuration setting:
 
     Copyable.config.suppress_schema_errors = false
 
-This is false by default.  Set this to true if you don't want Copyable to complain with a ColumnError or AssociationError if your database schema does not match your copyable declarations.
+This is `false` by default. Set this to true if you don't want Copyable to complain with a ColumnError or AssociationError if your database schema does not match your copyable declarations.
 
-You can also set an environment variable called SUPPRESS_SCHEMA_ERRORS to true.
+You can also set an environment variable called `SUPPRESS_SCHEMA_ERRORS` to true.
 
 
 
@@ -221,7 +223,7 @@ You can also set an environment variable called SUPPRESS_SCHEMA_ERRORS to true.
 ## Strengths
 
 * handles polymorphic associations
-* create_copy! is run in a database transaction
+* `create_copy!` is run in a database transaction
 * keeps track of which models have already been copied so that it does not re-copy them if it comes across them again (helpful for complex model hierarchies with redundant associations)
 
 
@@ -231,15 +233,15 @@ You can also set an environment variable called SUPPRESS_SCHEMA_ERRORS to true.
 * not thread-safe
 * copying very large data structures may use a lot of memory
 * not designed with performance (CPU or database) in mind
-* had to monkey-patch Rails, so only guaranteed to work with Rails 3.2 at the moment
+* had to monkey-patch Rails
 * postponed support for single table inheritance until needed
-* postponed support for keeping counter_cache correct until needed
+* postponed support for keeping `counter_cache` correct until needed
 
 
 
 ## Convenience
 
-A rake task is included that will output a basic copyable declaration given a model name.  Basically, this saves you some typing.
+A rake task is included that will output a basic copyable declaration given a model name. Basically, this saves you some typing.
 
     $ rake copyable model=User
 
@@ -247,11 +249,11 @@ A rake task is included that will output a basic copyable declaration given a mo
 
 ## Gotchas
 
-### Creating Objects in after_copy
+### Creating Objects in `after_copy`
 
-copyable keeps track of which models have already been copied so as not to reduplicate models if it comes across the same model through different associations.  If you are creating new objects in after_copy! (such as manually copying an association instead of letting copyable do it), you do not have the benefit of copyable's checking whether the models have already been copied and may end up creating too many copies.
+copyable keeps track of which models have already been copied so as not to reduplicate models if it comes across the same model through different associations. If you are creating new objects in `after_copy!` (such as manually copying an association instead of letting copyable do it), you do not have the benefit of copyable's checking whether the models have already been copied and may end up creating too many copies.
 
-So the recommended approach is to use after_copy to tweak the columns of the copied record but to avoid creating new records here.
+So the recommended approach is to use `after_copy` to tweak the columns of the copied record but to avoid creating new records here.
 
 
 
@@ -262,3 +264,7 @@ So the recommended approach is to use after_copy to tweak the columns of the cop
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## About
+
+Copyable was developed at [the District Management Council](http://dmcouncil.org).

data/copyable.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "= 4.1.12"
+  spec.add_dependency "activerecord", "~>4.1"
 
   spec.add_development_dependency "database_cleaner", "~> 1.4.0"
   spec.add_development_dependency "bundler", "~> 1.6"

data/lib/copyable/version.rb

@@ -1,3 +1,3 @@
 module Copyable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copyable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wyatt Greene
@@ -9,90 +9,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.12
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.12
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Copyable makes it easy to copy ActiveRecord models.
@@ -102,9 +102,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -164,17 +164,17 @@ 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.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: ActiveRecord copier