lazy_blob_storage 1.2.1 → 2.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9384630bebc59d8659078936519987b004f1e93716e0ac6e9462bc804beb818
-  data.tar.gz: d83f8c699ceb0cc1076829d558bfc5d2e83753e5f9589b56bb38accfbf1b9f66
+  metadata.gz: 2f76aadde1c8e491a20d9d43ab01b4726ba9039f4a50b0aa60cbcc571493939f
+  data.tar.gz: 0f38de7c7d200daa0208fe363a4ce8a6d7d175121fd1aef55563022e8fe3102b
 SHA512:
-  metadata.gz: d98a3911c8e1988e42eae91827b1ae29a04c138231f2b8ed81cfeb4a61fadcb7e25c49170697dd7c986f8e47f7f87d5f20f957ca611809cc2260a8ad3e2cef16
-  data.tar.gz: 71a963f730b5ab642575494d639a30e6de24bdb4bf279de504725ffa027d601ac7569ffbeb96a454a9969cbe8e118c380a11466d5ff86d4fda981ac315435fde
+  metadata.gz: 0c37f509e254d0494c019dd60510d07d8ad023ad22d6b3413475424afd82ba60ce138019b0526ca7dcee6908d822dea3b95417d8d490710a0a81a0518558b30c
+  data.tar.gz: d1a8b8c8cf70dd6c8d9e4a7cb634781821908ac08e89a54d46fdc9bd98ec40fa8c1910f9ed8dafad6fdee84cd6fdaece89c187afc73767d453f1586d4710623d

data/README.md

@@ -1,26 +1,47 @@
 # LazyBlobStorage
 
-Useful for attaching small (size < 3 MB) database-backed blobs to records. Good
+Useful for attaching small database-backed blobs to records. Good
 when you need small file upload support, but don't want to bother with a cloud
 service because you know you'll have low traffic/user counts. Uses a SHA256
 digest to prevent duplicate blob uploads.
 
-Doesn't do anything fancy. Just stores files and allows public access using the
+Nothing fancy. Just stores files and allows public access using the
 digest as a key. Respects HTTP Cache headers.
 
+You probably want to put a CDN/Cache/RateLimit in front of the 
+`"lazy_blobs#show"` route because somebody could DOS your website 
+if all your workers are serving files from the database.
+
+Basically this is a dumb idea, but setting up AWS buckets and permissions just 
+to upload a dumb logo is :big_sigh_emoji:
+
+Don't use this. I mean it.
+
+## Breaking Changes in 2.0.0-beta.1
+
+- YOLO support for rails > 6 (it's probably fine)
+- Migrations do not get added to rails paths automatically anymore. They must be copied with the `lazy_blob_storage:install:migrations` rake task.
+- Prefixed most attachment methods with `lazy_` to avoid conflicts.
+- The default max blob size is 100kb. It should probably be lower. You can set this to a number of bytes with `LazyBlobStorage.max_blob_size=`
+- !!! Do not use this for high traffic projects. !!!
+- !!! Do not use this to store big files !!!
+- !!! This dumb idea only works for very small files like 10kb logos or icons. !!!
+- !!! you were warned !!!
+
 ## Note
 
 If it's not obvious. This is for inclusion in a Rails app.
 
-Build with Rails 6. It'll ~probably~ work with Rails 4/5, too.
+Built with Rails 6. It could ~probably~ work with Rails 4/5, too.
 
 ## Usage
 
 1. Add `gem "lazy_blob_storage" to Gemfile`
-2. Run `rake db:migrate`
-3. Declare `has_lazy_attached :image` in some model
-4. Add `f.file_field :image_upload` to the form template
-5. Use `image_tag @thing.attached_image_path` or `image_tag @thing.image_url`
+1. Run `rake lazy_blob_storage:install:migrations`
+1. Run `rake db:migrate`
+1. Declare `has_lazy_attached :image` in some model
+1. Add `f.file_field :image_upload` to the form template
+1. Use `image_tag @thing.lazy_attached_image_path` or `image_tag @thing.lazy_image_url`
 
 Note: LazyBlobsController respects HTTP cache directives
 

data/app/models/concerns/lazy_attachable.rb

@@ -7,7 +7,7 @@ module LazyAttachable
         if (send "#{name}_upload").present? && (send "#{name}_upload_size_ok?")
           blob = LazyBlob.from_upload(send "#{name}_upload")
 
-          if (attached = (send "attached_#{name}"))
+          if (attached = (send "lazy_attached_#{name}"))
             attached.lazy_blob = blob
           else
             attachment = LazyAttachment.new(
@@ -15,7 +15,7 @@ module LazyAttachable
               record: self,
               lazy_blob: blob
             )
-            (send "attached_#{name}=", attachment)
+            (send "lazy_attached_#{name}=", attachment)
           end
         end
       end
@@ -30,18 +30,18 @@ module LazyAttachable
         end
       end
 
-      define_method("attached_#{name}_path") do
+      define_method("lazy_attached_#{name}_path") do
         if (send "#{name}_attached?")
-          digest = (send "attached_#{name}").digest
+          digest = (send "lazy_attached_#{name}").digest
           Rails.application.routes.url_helpers.lazy_blob_path(digest)
         else
           ""
         end
       end
 
-      define_method("attached_#{name}_url") do
+      define_method("lazy_attached_#{name}_url") do
         if (send "#{name}_attached?")
-          digest = (send "attached_#{name}").digest
+          digest = (send "lazy_attached_#{name}").digest
           Rails.application.routes.url_helpers.lazy_blob_url(digest)
         else
           ""
@@ -49,12 +49,12 @@ module LazyAttachable
       end
 
       define_method("#{name}_attached?") do
-        (send "attached_#{name}").present?
+        (send "lazy_attached_#{name}").present?
       end
 
       define_method("handle_#{name}_digest") do
         digest = (send "#{name}_digest").presence
-        attached = (send "attached_#{name}").presence
+        attached = (send "lazy_attached_#{name}").presence
         same_as_attached = (attached && digest) && (attached.digest == digest)
 
         if digest && !same_as_attached
@@ -67,7 +67,7 @@ module LazyAttachable
               digest: digest
             )
 
-            (send "attached_#{name}=", attachment)
+            (send "lazy_attached_#{name}=", attachment)
           end
         end
       end
@@ -80,15 +80,15 @@ module LazyAttachable
       attr_accessor "#{name}_upload"
       attr_accessor "#{name}_digest"
 
-      has_one "attached_#{name}".to_sym,
+      has_one "lazy_attached_#{name}".to_sym,
               -> { where(name: name) },
               class_name: "LazyAttachment",
               as: :record,
               autosave: true,
               dependent: :destroy
 
-      scope "with_attached_#{name}".to_sym, -> {
-        includes("attached_#{name}")
+      scope "with_lazy_attached_#{name}".to_sym, -> {
+        includes("lazy_attached_#{name}")
       }
 
       validate "validate_size_of_#{name}_upload".to_sym

data/app/models/lazy_blob.rb

@@ -7,9 +7,9 @@ class LazyBlob < ActiveRecord::Base
   validates :content_type, presence: true
   validates :content_length,
             presence: true,
-            numericality: { greater_than: 0, less_than: 2.gigabytes }
+            numericality: { greater_than: 0, less_than: LazyBlobStorage.max_blob_size || LazyBlobStorage.default_max_blob_size }
   validates :digest, presence: true, uniqueness: true
-  validates :content, presence: true, length: { maximum: 1.megabyte }
+  validates :content, presence: true, length: { maximum: LazyBlobStorage.max_blob_size || LazyBlobStorage.default_max_blob_size }
 
   def self.from_upload(uploaded_file)
     file = File.open(uploaded_file.tempfile.path, 'rb')

data/lib/lazy_blob_storage/engine.rb

@@ -1,13 +1,5 @@
 module LazyBlobStorage
   class Engine < ::Rails::Engine
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match root.to_s
-        config.paths["db/migrate"].expanded.each do |expanded_path|
-          app.config.paths["db/migrate"] << expanded_path
-        end
-      end
-    end
-
     initializer 'mixin_lazy_attachable' do
       ActiveSupport.on_load(:active_record) do
         self.include LazyAttachable

data/lib/lazy_blob_storage/version.rb

@@ -1,3 +1,3 @@
 module LazyBlobStorage
-  VERSION = "1.2.1"
+  VERSION = "2.0.0-beta.1"
 end

data/lib/lazy_blob_storage.rb

@@ -1,4 +1,9 @@
 require "lazy_blob_storage/engine"
 
 module LazyBlobStorage
+  mattr_accessor :max_blob_size
+
+  def self.default_max_blob_size
+    100_000.bytes
+  end
 end

data/lib/tasks/lazy_blob_storage_tasks.rake

@@ -1,4 +1,13 @@
-# desc "Explaining what the task does"
-# task :lazy_blob_storage do
-#   # Task goes here
-# end
+namespace :lazy_blob_storage do
+  # Prevent migration installation task from showing up twice.
+  Rake::Task["install:migrations"].clear_comments
+
+  desc "Copy over the migration needed to the application"
+  task install: :environment do
+    if Rake::Task.task_defined?("lazy_blob_storage:install:migrations")
+      Rake::Task["lazy_blob_storage:install:migrations"].invoke
+    else
+      Rake::Task["app:lazy_blob_storage:install:migrations"].invoke
+    end
+  end
+end

metadata

@@ -1,35 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: lazy_blob_storage
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0.pre.beta.1
 platform: ruby
 authors:
 - Corey Smedstad
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2.1
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +66,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description:
 email:
 - csmedstad@mreach.com
 executables: []
@@ -72,7 +108,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,12 +119,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Low traffic site? Small file upload needs? Don't want to setup a cloud service?
   Lazy Blob Storage is for you!