deep_freezer 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a257a7231847fe4e8ec496a1e3e8acab76515aabeebecd26eb446546e9e47a
-  data.tar.gz: 2580a0adea1b0aee2365282d3e2405215042d84e3cad6d21c8c1f500ecbc71a3
+  metadata.gz: 5da5f1023b348198c41593af730f028bab393e9a3608a9b2fda5719f4e60b868
+  data.tar.gz: 397bd7359940f94439609de9c757cca26ca53037f3c738b41d6f056b66ee4163
 SHA512:
-  metadata.gz: d02448c1d24e08b91820ee4ddc3934df8ccf4c558f9f5e7f444afe8d7fd911bc1b8e0698eede3f1e07e7807beaf451fb68238c9a8dba2526beac394b31417e86
-  data.tar.gz: fa837c253f3c9758decce750239b86f698e8b1bb47e1adfb49994f7181a09384614300e4fe4624e6aa08376ecfc07a57e0d679dd0bdf1fe6c378eaa98f40912e
+  metadata.gz: 7fa198b5b8a2c099a878fffed3d264bdbe15023eb11e904f6457a50374c66916f2b5ad8b8a82e9e03a40775b91c7f11cde4ec67348e278f1b1f8b9f3c1e25977
+  data.tar.gz: e7b80fc015c9650bef38d56ebe46d201c89bfdfbafbb05d04ceb2128a056f5b5a374ef2f849c9105889bb4156ccba2b16e8597d8448ac4f229cdf8667d9955c6

data/README.md

@@ -22,25 +22,33 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install freezer
+    $ gem install deep_freezer
+
+Requires Ruby 3.1+ and ActiveRecord 7.1+.
 
 ## Usage
 
 ### Config
 Be sure to load your freezer classes in `development.rb`
 ```
-Dir.glob(Rails.root.join("lib", "freezers", "*.rb")).each do |file|
+Dir.glob(Rails.root.join("lib", "freezers", "**", "*.rb")).each do |file|
   require file
 end
 ```
 
 Create an initializer and set the path for fixtures to be saved
 
-`Freezer::Base.fixture_path = Rails.root.join("db", "seeds")`
+`DeepFreezer::Base.fixture_path = Rails.root.join("db", "seeds")`
 
 ### Define Freezers
 
-Define a `DeepFreezer` for your model
+Generate a freezer for a model:
+
+    $ rails g freezer Post
+
+This creates `lib/freezers/post_freezer.rb` with every column of the model (it needs a database connection). Pass attributes to freeze only those, for example `rails g freezer Post title body`. Namespaced models go in matching subdirectories: `rails g freezer Admin::User` creates `lib/freezers/admin/user_freezer.rb`.
+
+Or define a `DeepFreezer` for your model by hand:
 
 ```
 class PostFreezer < DeepFreezer::Base
@@ -87,7 +95,7 @@ This will result in a `posts.yml` file in `db/seeds` which can be loaded by addi
 
 ### Reset Fixtures
 
-Fixtures can be deleted manually in the directory, or by running `Freezers::Base.reset!`
+Fixtures can be deleted manually in the directory, or by running `DeepFreezer::Base.reset!`, which also clears subdirectories used by namespaced models.
 
 ## Development
 
@@ -114,4 +122,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/markprovan/deep_freezer/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DeepFreezer 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

@@ -21,7 +21,7 @@ module DeepFreezer
     end
 
     def self.reset!
-      Dir.glob(DeepFreezer::Base.fixture_path.join("*.yml")).each { |file| File.delete(file) }
+      Dir.glob(DeepFreezer::Base.fixture_path.join("**/*.yml")).each { |file| File.delete(file) }
     end
 
     def initialize(obj)

data/lib/deep_freezer/version.rb

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

data/lib/generators/freezer/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Creates a freezer class for a model in lib/freezers.
+
+    With no attributes, every column of the model is frozen. This needs a
+    database connection. Pass attributes to freeze only those instead.
+
+Example:
+    rails g freezer User
+    rails g freezer User name email
+    rails g freezer Admin::User
+
+    creates lib/freezers/user_freezer.rb
+    creates lib/freezers/admin/user_freezer.rb

data/lib/generators/freezer/freezer_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+# Generates a freezer for a model:
+#
+#   rails g freezer User
+#
+# See USAGE for details.
+class FreezerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  argument :attributes, type: :array, default: [], banner: "attribute attribute"
+
+  def create_freezer_file
+    # Resolve the attributes first: Thor creates the file before rendering the
+    # template, so a failure while rendering would leave an empty file behind.
+    freezer_attributes
+
+    template "freezer.rb.tt", File.join("lib/freezers", class_path, "#{file_name}_freezer.rb")
+  end
+
+  private
+
+  def freezer_class_name
+    "#{class_name}Freezer"
+  end
+
+  # Explicit attributes win; otherwise every column of the model.
+  def freezer_attributes
+    @freezer_attributes ||= attributes.empty? ? model_columns : attributes.map(&:name)
+  end
+
+  def model_columns
+    model = class_name.safe_constantize
+    unless model.is_a?(Class) && model < ActiveRecord::Base
+      raise Thor::Error, "Could not find the model #{class_name}. " \
+                         "Pass the attributes to freeze explicitly: rails g freezer #{class_name} name email"
+    end
+
+    model.column_names
+  rescue ActiveRecord::ActiveRecordError => e
+    raise Thor::Error, "Could not read the columns of #{class_name} (#{e.message}). " \
+                       "Pass the attributes to freeze explicitly: rails g freezer #{class_name} name email"
+  end
+end

data/lib/generators/freezer/templates/freezer.rb.tt

@@ -0,0 +1,11 @@
+# Review the attributes below. Anything personal or secret should be overridden
+# with a method of the same name, for example:
+#
+#   def email
+#     "user#{id}@example.com"
+#   end
+class <%= freezer_class_name %> < DeepFreezer::Base
+<% freezer_attributes.each_with_index do |attribute, index| -%>
+  <%= index.zero? ? "freeze" : "      " %> :<%= attribute %><%= "," unless index == freezer_attributes.size - 1 %>
+<% end -%>
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep_freezer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mark Provan
@@ -43,6 +43,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,9 @@ files:
 - lib/deep_freezer/base.rb
 - lib/deep_freezer/defrost.rb
 - lib/deep_freezer/version.rb
+- lib/generators/freezer/USAGE
+- lib/generators/freezer/freezer_generator.rb
+- lib/generators/freezer/templates/freezer.rb.tt
 homepage: https://github.com/markprovan/deep_freezer
 licenses:
 - MIT