file_hutch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2b2054f9f101d16f7ea61d375dfcbb9715838b5988c517bd547da595759f454
-  data.tar.gz: b81dc343e6ee21e17d396502b0700ff7e9ed253e5729f928eca28673248c2801
+  metadata.gz: 68acbe5c06713d98ad400877d375ccd63794b11ebe6e381aec9aea714061a0d6
+  data.tar.gz: a9d3896f4d665648edce1641453a92abb12168802a67feae0f8c6d015d1d5fb5
 SHA512:
-  metadata.gz: 48a44a32ed534d38c731ab9cb9be31c856b635a642035ae5942cdcfffca73743c973f8fe11cb7a2dcccf7206e503b650d1997dd98c17f85dbcee705aebb20adc
-  data.tar.gz: 13cfab0ce82a0afa0594818e1508b994ee066790319fb621a18c7bc3033bc787a2a1afa22699c29a92bc1e783b101a1bb9e7bb9ae0e6e08465c813286d18a98a
+  metadata.gz: 1ee3d96af2b6ab2b37d37036b466c4b6ed27ea40db2458c175e49723542464f595830786f228a02162cd65706c46dfac50429aa14213e080ceca1b3d2f78b0da
+  data.tar.gz: 670315688e96fc2170634e086ab5c21871cfe38e516d8aef6a3b1b5212cc64e88088e7bb9d4846f2bca77b4eb1d82a3106929c372335235c5a3489e572450b8f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.2.0 — 2026-09-16
+
+### Rails
+
+- `has_file_hutch_file` is now `has_hutch`, with the same options. The old name still works and
+  logs a deprecation warning; it will be removed in 0.3.
+
 ## 0.1.0 — 2026-09-15
 
 First release.

data/README.md

@@ -161,8 +161,8 @@ bin/rails generate file_hutch:attachment User avatar    # adds users.avatar_file
 
 ```ruby
 class User < ApplicationRecord
-  has_file_hutch_file :avatar, policy: "avatars"
-  has_file_hutch_file :contract, policy: "documents", dependent: false
+  has_hutch :avatar, policy: "avatars"
+  has_hutch :contract, policy: "documents", dependent: false
 end
 
 user.avatar = params[:avatar]           # uploaded IO → uploaded to storage on save
@@ -227,14 +227,14 @@ Submit buttons are disabled while uploading. The element dispatches `filehutch:s
 `filehutch:progress`, `filehutch:complete`, and `filehutch:error`. `directUpload(file, { url,
 policy, onProgress })` is exported for use without Stimulus.
 
-On save, `has_file_hutch_file` verifies the submitted id is a ready file under the declared policy,
+On save, `has_hutch` verifies the submitted id is a ready file under the declared policy,
 so a client cannot attach someone else's upload to the wrong field.
 
 ### Coming from Active Storage
 
 | Active Storage | file_hutch |
 | --- | --- |
-| `has_one_attached :avatar` | `has_file_hutch_file :avatar, policy: "avatars"` |
+| `has_one_attached :avatar` | `has_hutch :avatar, policy: "avatars"` |
 | `active_storage_blobs` + `attachments` tables | `users.avatar_file_id` |
 | `url_for(user.avatar)` | `user.avatar_url` / `user.avatar_signed_url` |
 | `user.avatar.variant(resize_to_fill: [200, 200])` | `user.avatar_transform_url("avatar")`, defined once in the dashboard |

data/lib/file_hutch/rails/attachable.rb

@@ -3,11 +3,11 @@
 require "active_support/concern"
 
 module FileHutch
-  # `has_file_hutch_file` for Active Record. The model stores one string column,
+  # `has_hutch` for Active Record. The model stores one string column,
   # `<name>_file_id`, holding an FileHutch file id. Nothing about storage leaks in.
   #
   #   class User < ApplicationRecord
-  #     has_file_hutch_file :avatar, policy: "avatars"
+  #     has_hutch :avatar, policy: "avatars"
   #   end
   #
   #   user.avatar = params[:avatar]            # uploaded IO: uploaded to storage on save
@@ -25,7 +25,7 @@ module FileHutch
     extend ActiveSupport::Concern
 
     class_methods do
-      def has_file_hutch_file(name, policy:, column: "#{name}_file_id", dependent: :delete, verify: true)
+      def has_hutch(name, policy:, column: "#{name}_file_id", dependent: :delete, verify: true)
         include Attachable unless include?(Attachable)
         name = name.to_sym
         column = column.to_s
@@ -45,6 +45,12 @@ module FileHutch
         define_method(:"purge_#{name}") { file_hutch_purge(name) }
       end
 
+      # The 0.1.0 name. Kept for one release so upgrading doesn't break a model.
+      def has_file_hutch_file(name, **options)
+        FileHutch.deprecator.warn("has_file_hutch_file is deprecated and will be removed in file_hutch 0.3. Use has_hutch :#{name} with the same options.")
+        has_hutch(name, **options)
+      end
+
       def file_hutch_files
         @file_hutch_files ||= superclass.respond_to?(:file_hutch_files) ? superclass.file_hutch_files.dup : {}
       end

data/lib/file_hutch/rails/engine.rb

@@ -13,6 +13,10 @@ module FileHutch
   class Engine < ::Rails::Engine
     isolate_namespace FileHutch
 
+    initializer "file_hutch.deprecator" do |app|
+      app.deprecators[:file_hutch] = FileHutch.deprecator if app.respond_to?(:deprecators)
+    end
+
     initializer "file_hutch.active_record" do
       ActiveSupport.on_load(:active_record) { extend FileHutch::Attachable::ClassMethods }
     end

data/lib/file_hutch/rails.rb

@@ -2,4 +2,9 @@
 
 require "rails"
 require_relative "rails/attachable"
+
+module FileHutch
+  def self.deprecator = @deprecator ||= ActiveSupport::Deprecation.new("0.3", "file_hutch")
+end
+
 require_relative "rails/engine"

data/lib/file_hutch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FileHutch
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/file_hutch/attachment/attachment_generator.rb

@@ -6,7 +6,7 @@ require "rails/generators/active_record"
 module FileHutch
   module Generators
     # bin/rails generate file_hutch:attachment User avatar
-    # Adds users.avatar_file_id (string). Pair with `has_file_hutch_file :avatar, policy: "…"`.
+    # Adds users.avatar_file_id (string). Pair with `has_hutch :avatar, policy: "…"`.
     class AttachmentGenerator < ::Rails::Generators::NamedBase
       include ::ActiveRecord::Generators::Migration
 
@@ -18,7 +18,7 @@ module FileHutch
       end
 
       def show_macro
-        say %(Add to #{class_name}:  has_file_hutch_file :#{attachment}, policy: "#{attachment.pluralize}"), :green
+        say %(Add to #{class_name}:  has_hutch :#{attachment}, policy: "#{attachment.pluralize}"), :green
       end
 
       private

data/lib/generators/file_hutch/install/install_generator.rb

@@ -25,7 +25,7 @@ module FileHutch
         say ""
         say "FileHutch installed.", :green
         say "  1. Set FILE_HUTCH_API_KEY (Dashboard → API keys) and, if not production, FILE_HUTCH_URL."
-        say "  2. Add a column and macro:  bin/rails g file_hutch:attachment User avatar  then  has_file_hutch_file :avatar, policy: \"avatars\""
+        say "  2. Add a column and macro:  bin/rails g file_hutch:attachment User avatar  then  has_hutch :avatar, policy: \"avatars\""
         say "  3. For browser uploads, set FileHutch.config.authorize_direct_upload in the initializer and register the"
         say "     Stimulus controller:  application.register(\"filehutch-direct-upload\", DirectUploadController)"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_hutch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Leverenz
@@ -10,8 +10,8 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Talk to the FileHutch file control plane from Ruby. Server-side and browser-direct
-  uploads, signed URLs, and a has_file_hutch_file macro for Active Record that stores
-  only opaque file ids.
+  uploads, signed URLs, and a has_hutch macro for Active Record that stores only opaque
+  file ids.
 email:
 - andy@justalever.com
 executables: