bullet_train 1.4.4 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d073ab349f58c17453f4e4d3f493e97202a56a9c6d521bffe36109f4e78d63b
-  data.tar.gz: 870e67cb3d4b7562f3fb8faad380bc45d3b0866b9f51bedc808481db82ce61f3
+  metadata.gz: 1996b94dbb7fda2db6472e01a23499b91947f4b3faf3a97ac1b5b20630505e3a
+  data.tar.gz: 608ea60207cb19ff2c4b73d8b9129ed5d1e3fe2a0190645754b55372132f1c72
 SHA512:
-  metadata.gz: 02a859e9c7b3be4b50ede0d7f45bf4fb53614953a5056bfc94511facb63179b56d4b8b94227fdce6bd23bf3af78d4e5d5ccc0d92c89abf6662a6c868f8c7a15d
-  data.tar.gz: 648560376f7307b66aa2eb52788c82278f5c277e8d34d22f6808d3053216634c5e482fd6b995102af9313c3aed123062764ca89c171eaa5b562475e2c42ec314
+  metadata.gz: be8f7010714d24a73dd42ef91530e2d61f20b520bc39ca1444d5cf6881df10869d1836823e2dab378b0b8d12e0bb6a00be201db9c896ddd6242bc067e2522713
+  data.tar.gz: 3907fad30d953b8f7e693ec1f3e2bf56917de2fcf0bcbb5e8d8306bdeb7664663408bf013158670f8e55da0428a2313a680446e888cc097b622552ccedfc4865

data/app/helpers/account/users_helper.rb

@@ -1,10 +1,15 @@
 module Account::UsersHelper
+  def photo_url_for_active_storage_attachment attachment, options
+    size_details = {resize_to_limit: [options[:width], options[:height]]}
+    attachment.representation(size_details)
+  end
+
   def profile_photo_for(url: nil, email: nil, first_name: nil, last_name: nil, profile_header: false)
     size_details = profile_header ? {width: 700, height: 200} : {width: 100, height: 100}
     size_details[:crop] = :fill
 
     if cloudinary_enabled? && !url.blank?
-      cl_image_path(url, size_details[:width], size_details[:height], size_details[:crop])
+      cl_image_path(url, size_details)
     elsif !url.blank?
       url + "?" + size_details.to_param
     else
@@ -38,7 +43,7 @@ module Account::UsersHelper
   # leaving them in case we have other developers depending on these methods.
   def profile_header_photo_for(url: nil, email: nil, first_name: nil, last_name: nil)
     if cloudinary_enabled? && !url.blank?
-      cl_image_path(url, width: 700, height: 200, crop: :fill)
+      cl_image_path(url, {width: 700, height: 200, crop: :fill})
     elsif !url.blank?
       url + "?" + {size: 200}.to_param
     else

data/app/views/account/users/_form.html.erb

@@ -10,11 +10,13 @@
       </div>
 
       <div class="sm:col-span-2">
-        <% if cloudinary_enabled? %>
-          <%= render 'shared/fields/cloudinary_image', method: :profile_photo_id %>
-        <% else %>
-          <%= render 'shared/fields/file_field', method: :profile_photo %>
-        <% end %>
+        <%
+            image_method = :profile_photo
+            if cloudinary_enabled?
+              image_method = :profile_photo_id
+            end
+        %>
+        <%= render 'shared/fields/image', method: image_method %>
       </div>
 
       <div class="sm:col-span-2">

data/docs/field-partials.md

@@ -81,12 +81,12 @@ When you're including multiple fields, you can DRY up redundant settings (e.g. `
 <% with_field_settings form: form do %>
   <%= render 'shared/fields/text_field', method: :text_field_value, options: {autofocus: true} %>
   <%= render 'shared/fields/buttons', method: :button_value %>
-  <%= render 'shared/fields/cloudinary_image', method: :cloudinary_image_value %>
+  <%= render 'shared/fields/image', method: :cloudinary_image_value %>
 <% end %>
 ```
 
 ## Field partials that integrate with third-party service providers
- - `cloudinary_image` makes it trivial to upload photos and videos to [Cloudinary](https://cloudinary.com) and store their resulting Cloudinary ID as an attribute of the model backing the form. To enable this field partial, sign up for Cloudinary and copy the "Cloudinary URL" they provide you with into your `config/application.yml` as `CLOUDINARY_URL`. If you use our [Heroku app.json](https://github.com/bullet-train-co/bullet_train/blob/main/app.json) to provision your production environment, this will happen in that environment automatically.
+ - `image` makes it trivial to upload photos and videos to [Cloudinary](https://cloudinary.com) and store their resulting Cloudinary ID as an attribute of the model backing the form. To enable this field partial, sign up for Cloudinary and copy the "Cloudinary URL" they provide you with into your `config/application.yml` as `CLOUDINARY_URL`. If you use our [Heroku app.json](https://github.com/bullet-train-co/bullet_train/blob/main/app.json) to provision your production environment, this will happen in that environment automatically.
 
 ## Yaml Configuration
 The localization Yaml file (where you configure label and option values for a field) is automatically generated when you run Super Scaffolding for a model. If you haven't done this yet, the localization Yaml file for `Scaffolding::CompletelyConcrete::TangibleThing` serves as a good example. Under `en.scaffolding/completely_concrete/tangible_things.fields` you'll see definitions like this:
@@ -126,7 +126,7 @@ Certain form field partials like `buttons` and `super_select` can also have thei
 |--------------------------------------------------------|--------------|------------------|-------------------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
 | `boolean`                                              | `boolean`    |                  | `assign_boolean`        |                                                                                   |                                                                                          |
 | [`buttons`](/docs/field-partials/buttons.md)           | `string`     | Optionally       | `assign_checkboxes`     |                                                                                   |                                                                                          |
-| `cloudinary_image`                                     | `string`     |                  |                         |                                                                                   |                                                                                          |
+| `image`                                                | `string` or `attachment`*  |                  |                         |                                                                                   |                                                                                          |
 | `color_picker`                                         | `string`     |                  |                         | [pickr](https://simonwep.github.io/pickr/)                                        |                                                                                          |
 | `date_and_time_field`                                  | `datetime`   |                  |                  | [Date Range Picker](https://www.daterangepicker.com)                              |                                                                                          |
 | `date_field`                                           | `date`       |                  |                  | [Date Range Picker](https://www.daterangepicker.com)                              |                                                                                          |
@@ -139,9 +139,12 @@ Certain form field partials like `buttons` and `super_select` can also have thei
 | [`super_select`](/docs/field-partials/super-select.md) | `string`     | Optionally       | `assign_select_options` | [Select2](https://select2.org)                                                    | Provides powerful option search, AJAX search, and multi-select functionality.            |
 | `text_area`                                            | `text`       |                  |                         |                                                                                   |                                                                                          |
 | `text_field`                                           | `string`     |                  |                         |                                                                                   |                                                                                          |
-| `number_field`                                           | `integer`     |                  |                         |                                                                                   |                                                                                          |
+| `number_field`                                         | `integer`    |                  |                         |                                                                                   |                                                                                          |
 | `trix_editor`                                          | `text`       |                  |                         | [Trix](https://github.com/basecamp/trix)                                          | Basic HTML-powered formatting features and support for at-mentions amongst team members. |
 
+* The data type for `image` fields will vary based on whether you're using Cloudinary or ActiveStorage.
+For Cloudinary you should use `string`, and for ActiveStorage you should use `attachment`.
+
 ## A Note On Data Types
 Set the data type to `jsonb` whenever passing the `multiple` option to a new attribute.
 ```

data/docs/super-scaffolding.md

@@ -228,6 +228,46 @@ end
 
 Honestly, it's crazy that we got to the point where we can handle this particular use case automatically. It seems simple, but there is so much going on to make this feature work.
 
+### 7. Scaffolding image upload attributes
+
+Bullet Train comes with two different ways to handle image uploads.
+
+* Cloudinary - This option allows your app deployment to be simpler because you don't need to ship any image manipulation libraries. But it does introduce a dependence on a 3rd party service.
+* ActiveStorage - This option doesn't include reliance on a 3rd party service, but you do have to include image manipulation libararies in your deployment process.
+
+#### Scaffolding images with Cloudinary
+
+When you scaffold your model you need to include a `string` where Cloudinary can store a reference to the image.
+
+For instance to scaffold a `Project` model with a `logo` image upload.
+
+```
+rails g model Project team:references name:string logo:string
+```
+
+Then you can use `image` as a field type for super scaffolding:
+
+```
+bin/super-scaffold crud Project Team name:text_field logo:image
+rake db:migrate
+```
+#### Scaffolding images with ActiveStorage
+
+When you scaffold your model you need to generate an `attachment` type attribute.
+
+For instance to scaffold a `Project` model with a `logo` image upload.
+
+```
+rails g model Project team:references name:string logo:attachment
+```
+
+Then you can use `image` as a field type for super scaffolding:
+
+```
+bin/super-scaffold crud Project Team name:text_field logo:image
+rake db:migrate
+```
+
 ## Additional Notes
 
 ### `TangibleThing` and `CreativeConcept`

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.4.4"
+  VERSION = "1.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.5
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard