deep_freezer 0.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 757ca1be556d21ba64174bd0a31162d0032d0a95
-  data.tar.gz: d0499d03070c894044b6f4147c9de99b68ec61a9
+SHA256:
+  metadata.gz: 50a257a7231847fe4e8ec496a1e3e8acab76515aabeebecd26eb446546e9e47a
+  data.tar.gz: 2580a0adea1b0aee2365282d3e2405215042d84e3cad6d21c8c1f500ecbc71a3
 SHA512:
-  metadata.gz: 8906f7a09cff6e5a6407d0af803f7add5fe59019645b577b645d115648aff6fb67b89ad02620ffcc4dd587321c6861fbf0bb4978b017ff6cd78babff6531f910
-  data.tar.gz: fdd036f8df4813a98eb33d4a59a7e44d4b661dd7aecab17ed406ed7f91de79c3b55a3d5f0879027eb64f291ab6cbe76ec8be367c6afbd7939cf4f0c9ba94aed9
+  metadata.gz: d02448c1d24e08b91820ee4ddc3934df8ccf4c558f9f5e7f444afe8d7fd911bc1b8e0698eede3f1e07e7807beaf451fb68238c9a8dba2526beac394b31417e86
+  data.tar.gz: fa837c253f3c9758decce750239b86f698e8b1bb47e1adfb49994f7181a09384614300e4fe4624e6aa08376ecfc07a57e0d679dd0bdf1fe6c378eaa98f40912e

data/README.md

@@ -1,7 +1,12 @@
-# Deep Freezer
-## Freeze ActiveRecord models to Rails compatible fixtures.
+![Logo](https://s3.amazonaws.com/mp-github-files/logo.png)
 
-This gem allows you to 'freeze' your ActiveRecord models to Rails compatible fixture files. This allows you to store real data statically for quick start dev/staging evironments.
+## Freeze production like data for development
+This gem allows you to 'freeze' your ActiveRecord models to create repeatable datasets for development.
+
+---
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/48d23870f47ee5a40404/maintainability)](https://codeclimate.com/github/markprovan/deep_freezer/maintainability)
+[![CI](https://github.com/markprovan/deep_freezer/actions/workflows/ci.yml/badge.svg)](https://github.com/markprovan/deep_freezer/actions/workflows/ci.yml)
 
 ## Installation
 
@@ -31,7 +36,7 @@ end
 
 Create an initializer and set the path for fixtures to be saved
 
-`Freezer::Base.fixture_path = Rails.root.join("test", "fixtures")`
+`Freezer::Base.fixture_path = Rails.root.join("db", "seeds")`
 
 ### Define Freezers
 
@@ -49,6 +54,26 @@ class PostFreezer < DeepFreezer::Base
 end
 ```
 
+#### Overriding Attributes
+
+Attributes can be overrode at time of freeze, similar to ActiveModel Serializers, by defining a method with the same name as the attribute name.
+
+```
+class PostFreezer < DeepFreezer::Base
+
+  freeze :id,
+         :title,
+         :body,
+         :created_at,
+         :updated_at
+
+  def title
+    "Frozen Title"
+  end
+
+end
+```
+
 ### Perform Freeze
 
 And then write a script to select and freeze the records you want:
@@ -58,7 +83,7 @@ And then write a script to select and freeze the records you want:
   posts.map { |p | PostFreezer.new(p).freeze }
 ```
 
-This will result in a `posts.yml` file in `test/fixtures` which can be loaded by running `rake db:fixtures:load`
+This will result in a `posts.yml` file in `db/seeds` which can be loaded by adding `DeepFreezer::Defrost.load!` to your `seeds.rb` file.
 
 ### Reset Fixtures
 
@@ -68,11 +93,20 @@ Fixtures can be deleted manually in the directory, or by running `Freezers::Base
 
 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing
+
+Releases are published by GitHub Actions using RubyGems [trusted publishing](https://guides.rubygems.org/trusted-publishing/), so no API key is needed.
+
+1. Update `VERSION` in `lib/deep_freezer/version.rb` and add an entry to `CHANGELOG.md`.
+2. Merge to `master`, then create a release in the GitHub UI with a new tag (e.g. `v2.0.0`) targeting `master`.
+
+The `Release` workflow checks the tag matches the version, runs the specs and RuboCop, and pushes the gem to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/itison/freezer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/markprovan/deep_freezer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -80,4 +114,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Freezer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/freezer/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Freezer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/markprovan/deep_freezer/blob/master/CODE_OF_CONDUCT.md).

data/lib/deep_freezer/base.rb

@@ -1,50 +1,52 @@
-class DeepFreezer::Base
+# frozen_string_literal: true
 
-  class << self
-    attr_accessor :attrs, :model, :fixture_path
-  end
+module DeepFreezer
+  class Base
+    class << self
+      attr_reader :attrs, :fixture_path
 
-  def initialize(obj)
-    @obj = obj
-  end
+      def fixture_path=(path)
+        @fixture_path = path && Pathname.new(path)
+      end
+    end
 
-  def self.freeze(*attrs)
-    @attrs = attrs
-  end
+    def self.freeze(*attrs)
+      @attrs = attrs
+    end
 
-  def self.model(model)
-    @model = model
-  end
+    # With an argument, sets the model; without, returns it.
+    def self.model(model = nil)
+      @model = model if model
+      @model
+    end
 
-  def freeze
-    freezable = @obj.class.new
-    self.class.attrs.each do |attr|
-      if self.respond_to?(attr)
-        freezable.send("#{attr}=", self.send(attr))
-      else
-        freezable.send("#{attr}=", @obj.send(attr))
-      end
+    def self.reset!
+      Dir.glob(DeepFreezer::Base.fixture_path.join("*.yml")).each { |file| File.delete(file) }
     end
 
-    yaml = ({ "#{freezable.class.to_s.tableize}_#{freezable.id.to_s}" => freezable.attributes }.to_yaml).gsub("---", "")
+    def initialize(obj)
+      @obj = obj
+    end
 
-    write_to_file yaml, freezable.class.to_s.tableize
-  end
+    def freeze
+      freezable = @obj.class.new
+      self.class.attrs.each do |attr|
+        value = respond_to?(attr) ? public_send(attr) : @obj.public_send(attr)
+        freezable.public_send("#{attr}=", value)
+      end
 
-  def self.reset!
-    path = DeepFreezer::Base.fixture_path.to_s + "/*.yml"
-    Dir.glob(path).each { |file| File.delete(file) }
-  end
+      # Drop only the leading document marker, so values containing "---" survive.
+      yaml = [{ freezable.class.to_s => freezable.attributes }].to_yaml.delete_prefix("---")
 
-  private
+      write_to_file yaml, freezable.class.to_s.tableize
+    end
 
-    def write_to_file(yaml, file_name)
-      path = DeepFreezer::Base.fixture_path.to_s + "/#{file_name.pluralize}.yml"
-      dirname = File.dirname(path)
-      unless File.directory?(dirname)
-        FileUtils.mkdir_p(dirname)
-      end
+    private
 
-      open(path, 'a+') { |file| file << yaml }
+    def write_to_file(yaml, file_name)
+      path = DeepFreezer::Base.fixture_path.join("#{file_name.pluralize}.yml")
+      FileUtils.mkdir_p(path.dirname)
+      File.open(path, "a") { |file| file << yaml }
     end
+  end
 end

data/lib/deep_freezer/defrost.rb

@@ -1,40 +1,40 @@
-class DeepFreezer::Defrost
+# frozen_string_literal: true
 
-  def self.load!
+module DeepFreezer
+  class Defrost
+    PERMITTED_YAML_CLASSES = [Date, Time, Symbol, BigDecimal].freeze
 
-    path = DeepFreezer::Base.fixture_path.join("**/*.yml")
-    Dir.glob(path).each do |file|
-      objects = YAML.load(File.read(file))
-      puts "Loading #{objects.first.keys.first}"
-      objects.each do |o|
+    def self.load!
+      Dir.glob(DeepFreezer::Base.fixture_path.join("**/*.yml")).each do |file|
+        objects = YAML.safe_load_file(file, permitted_classes: PERMITTED_YAML_CLASSES, aliases: true)
+        next if objects.blank?
 
-        klass = o.keys.first
-        attrs = o[klass]
-        obj = klass.constantize.new
-
-        attrs.keys.each do |a|
-          obj.send("#{a}=", attrs[a])
+        puts "Loading #{objects.first.keys.first}"
+        objects.each do |object|
+          ActiveRecord::Base.connection.execute sql_for(hash_to_instance(object))
         end
-
-        sql = self.sql_for(obj)
-        ActiveRecord::Base.connection.execute sql
       end
     end
 
-  end
+    def self.hash_to_instance(object)
+      klass, attrs = object.first
+      instance = klass.constantize.new
 
-  def self.sql_for(record)
-    values = record.send(:arel_attributes_with_values_for_create, record.attribute_names)
+      attrs.each { |name, value| instance.public_send("#{name}=", value) }
 
-    model = record.class
-    scope = model.unscoped
+      instance
+    end
+
+    def self.sql_for(record)
+      model = record.class
+      table = model.arel_table
 
-    im = scope.arel.create_insert
-    im.into model.arel_table
+      values = record.attributes_for_database.map { |name, value| [table[name], value] }
 
-    substitutes, binds = scope.substitute_values(values)
-    im.insert substitutes
+      insert = Arel::InsertManager.new(table)
+      insert.insert(values)
 
-    record.class.connection.to_sql(im, binds)
+      model.connection.to_sql(insert)
+    end
   end
 end

data/lib/deep_freezer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepFreezer
-  VERSION = "0.4.2"
+  VERSION = "2.0.0"
 end

data/lib/deep_freezer.rb

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "bigdecimal"
+require "date"
+require "fileutils"
+require "pathname"
+require "yaml"
+
 require "deep_freezer/version"
 require "deep_freezer/base"
 require "deep_freezer/defrost"
 
 module DeepFreezer
-  # Your code goes here...
 end

metadata

@@ -1,88 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: deep_freezer
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Mark Provan
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  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: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: This gem allows you to 'freeze' your ActiveRecord models to Rails compatible
   fixture files. This allows you to store real data statically for quick start dev/staging
-  evironments.
+  environments.
 email:
 - markgprovan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- deep_freezer.gemspec
 - lib/deep_freezer.rb
 - lib/deep_freezer/base.rb
 - lib/deep_freezer/defrost.rb
 - lib/deep_freezer/version.rb
-homepage: https://github.com/itison/deep_freezer
+homepage: https://github.com/markprovan/deep_freezer
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  homepage_uri: https://github.com/markprovan/deep_freezer
+  source_code_uri: https://github.com/markprovan/deep_freezer
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -90,16 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Freeze ActiveRecord models to Rails compatible fixtures.
 test_files: []

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 mark.provan@itison.com. 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 [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    deep_freezer (0.4.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    rake (10.4.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  deep_freezer!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.1

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "deep_freezer"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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_freezer.gemspec

@@ -1,36 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "deep_freezer/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "deep_freezer"
-  spec.version       = DeepFreezer::VERSION
-  spec.authors       = ["Mark Provan"]
-  spec.email         = ["markgprovan@gmail.com"]
-
-  spec.summary       = %q{Freeze ActiveRecord models to Rails compatible fixtures.}
-  spec.description   = %q{This gem allows you to 'freeze' your ActiveRecord models to Rails compatible fixture files. This allows you to store real data statically for quick start dev/staging evironments.}
-  spec.homepage      = "https://github.com/itison/deep_freezer"
-  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_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end