readymade 0.1.8 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4fa8901d76050e8ef3597f3e079ebbfa6bcd565dbc05a22dc3578616da556b1
-  data.tar.gz: e52a10d9513e21c61501305edae074bd7e80aa00a993f4f3bba8b266d1e420c1
+  metadata.gz: f26bb52b5176c6325c252ac67735fbd6f21f26ad194d0dbdc9e915e421421840
+  data.tar.gz: b0500fc448b0681c6e436ad2f22fd2f43d880542500042a7bb9853a69d58fdd0
 SHA512:
-  metadata.gz: b5fca515c5b236aa72f49f84326d4e6b02e50d7af50636e8fd79774fb5d246d42a7f82341864729f25051dbf24f9d937c72ef7ae9a76ab794ecca6e0b61eeb3c
-  data.tar.gz: 671f7bdf6ba9362306e790bc6ed02d7c08d3007110d6f256072b4efd5cca0f88719a080489fe023f1e60c3d7ae7de050da252637d2a638fa28665e2f337d7b58
+  metadata.gz: 93cde55d0896d28b379fa699846abed6e3d8e72d2dbae8f7027b2813cc4a5fa277d8b1c07f8d0fe1905890cbf0b2fa654caeed7a8b791ff4ada4ac995d0edfd9
+  data.tar.gz: b1928db06558f7d28c83cda0827f065f3e8278567647844ab9f768fdf70183b2b1126e6fc016cb93df0d36f258152713372c0f8ef899bfbb026b1d11e35c327f

data/CHANGELOG.md

@@ -1,6 +1,24 @@
 Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.2.3] - 2022-05-03
+
+### Features
+
+* Add `Readymade::Model::ApiAttachable` - add base64 format to your ActiveStorage
+
+## [0.2.1] - 2022-04-21
+
+### Improvements
+
+* Update collection_response controller helper
+
+## [0.2.0] - 2022-04-13
+
+### Improvements
+
+* Add support for ruby 3.0, 3.1
+
 ## [0.1.8] - 2022-03-30
 
 ### Improvements

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    readymade (0.1.7)
+    readymade (0.2.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,15 @@
-# Readymade 0.1.8
+# Readymade
+
+[![Gem Version](https://badge.fury.io/rb/readymade.png)](https://badge.fury.io/rb/readymade)
 
 This gems contains basic components to follow [ABDI architecture](https://github.com/OrestF/OrestF/blob/master/abdi/ABDI_architecture.md)
 
+### Tested with ruby:
+
+- 3.1
+- 3.0
+- 2.7
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,7 +40,7 @@ Inherit your components from:
 ```ruby
 response = Readymade::Response.new(:success, my_data: data)
 response.success? # true
-response =Readymade::Response.new(:fail, errors: errors)
+response = Readymade::Response.new(:fail, errors: errors)
 response.success? # false
 response.fail? # true
 response.status # 'fail'
@@ -143,6 +151,49 @@ class Orders::Operations::Create < Readymade::Operation
 end
 ```
 
+### Readymade::Controller::Serialization
+
+```ruby
+class MyController < ApplicationController
+  include Readymade::Controller::Serialization
+end
+```
+
+Serialization helpers for controllers.
+Dependencies that must be installed on your own:
+- [blueprinter](https://rubygems.org/gems/blueprinter/)
+- [pagy](https://rubygems.org/gems/pagy)
+- [api-pagination](https://rubygems.org/gems/api-pagination)
+
+### Readymade::Model::ApiAttachable
+
+Add base64 attachments format for your models
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+  has_many_attached :images
+  include Readymade::Model::ApiAttachable
+  # must be included after has_one_attached, has_many_attached declaration
+  # api_file = {
+  #   base64: 'iVBORw0KGgoAAA....',
+  #   filename: 'my_avatar.png'
+  # }
+  # record.avatar = api_file 🎉
+end
+```
+
+copy [spec/support/api_attachable.rb](./spec/support/api_attachable.rb)
+```ruby
+def to_api_file(file)
+  { base64: Base64.encode64(file.read), filename: file.original_filename }
+end
+```
+```ruby
+# rspec example
+let(:avatar) { Rack::Test::UploadedFile.new(Rails.root.join('spec/support/assets/test-image.png'), 'image/png') }
+let(:params) { { user: attributes_for(:user).merge!(avatar: to_api_file(avatar)) } }
+```
 
 ## Development
 

data/lib/readymade/action.rb

@@ -12,11 +12,10 @@ module Readymade
 
     attr_reader :args, :data
 
-    def initialize(**args)
+    def initialize(args = {})
       raise NonKeywordArgumentsError if args.present? && !args.is_a?(Hash)
 
       @args = @data = args
-
       @args.each do |name, value|
         instance_variable_set("@#{name}", value)
       end

data/lib/readymade/controller/serialization.rb

@@ -25,7 +25,7 @@ module Readymade
 
         render_json(
           {
-            items: serialize_collection(paginate(collection, options), options),
+            (options.delete(:root).presence || :items) => serialize_collection(paginate(collection, options), options),
             count: collection.count
           },
           options[:status] || :ok

data/lib/readymade/form.rb

@@ -177,7 +177,7 @@ module Readymade
       end
 
       def to_h
-        raise Readymade::Error.new('define form_options on your form') unless (f = @f_class.new({}, @args)).respond_to?(:form_options)
+        raise Readymade::Error.new('define form_options on your form') unless (f = @f_class.new({}, **@args)).respond_to?(:form_options)
 
         f.form_options
       end

data/lib/readymade/model/api_attachable.rb

@@ -0,0 +1,61 @@
+require 'active_support/concern'
+
+module Readymade
+  module Model
+    module ApiAttachable
+      extend ActiveSupport::Concern
+      # must be included after has_one_attached, has_many_attached declaration
+      # api_file = {
+      #   base64: 'iVBORw0KGgoAAA....',
+      #   filename: 'my_avatar.png'
+      # }
+      # record.avatar = api_file 🎉
+
+      included do
+        has_one_attached_reflections.map(&:name).each do |attachment_method_name|
+          define_method("#{attachment_method_name}=") do |attachment_file|
+            attachment_file = api_attachment_to_uploaded(attachment_file) if api_attachable_format?(attachment_file)
+            super(attachment_file)
+          end
+        end
+
+        has_many_attached_reflections.map(&:name).each do |attachment_method_name|
+          define_method("#{attachment_method_name}=") do |attachment_file|
+            attachment_file = Array.wrap(attachment_file).map do |af|
+              api_attachment_to_uploaded(af) if api_attachable_format?(af)
+            end
+            super(attachment_file)
+          end
+        end
+      end
+
+      class_methods do
+        # rubocop:disable Naming/PredicateName
+        def has_one_attached_reflections
+          reflect_on_all_attachments.filter { |association| association.instance_of?(ActiveStorage::Reflection::HasOneAttachedReflection) }
+        end
+
+        def has_many_attached_reflections
+          reflect_on_all_attachments.filter { |association| association.instance_of?(ActiveStorage::Reflection::HasManyAttachedReflection) }
+        end
+        # rubocop:enable Naming/PredicateName
+      end
+
+      def api_attachable_format?(attachment_file)
+        attachment_file.respond_to?(:key?) && attachment_file.key?('base64') && attachment_file.key?('filename')
+      end
+
+      def api_attachment_to_uploaded(attachment_file)
+        ActionDispatch::Http::UploadedFile.new(
+          tempfile: Tempfile.new(attachment_file[:filename]).tap do |tf|
+            tf.binmode
+            tf.write(Base64.decode64(attachment_file[:base64]))
+          end,
+          filename: attachment_file[:filename],
+          type: Mime::Type.lookup_by_extension(File.extname(attachment_file[:filename])[1..]).to_s
+        )
+      end
+    end
+  end
+end
+

data/lib/readymade/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Readymade
-  VERSION = '0.1.8'
+  VERSION = '0.2.3'
 end

data/lib/readymade.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'readymade/model/api_attachable'
 require 'readymade/controller/serialization'
 require 'readymade/action'
 require 'readymade/form'

data/readymade.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  spec.files << 'lib/readymade/model/api_attachable.rb'
   spec.files << 'lib/readymade/controller/serialization.rb'
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readymade
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.3
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -76,6 +76,7 @@ files:
 - lib/readymade/controller/serialization.rb
 - lib/readymade/form.rb
 - lib/readymade/instant_form.rb
+- lib/readymade/model/api_attachable.rb
 - lib/readymade/operation.rb
 - lib/readymade/response.rb
 - lib/readymade/version.rb
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Set of base classes for ABDI architecture