active_storage_base64 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d0e10c1e524de78865f968bf274c5691a9d1524a8226f2eaebbc0a16a6bd6c
-  data.tar.gz: 4af0027f45088932aff3081f34be56f48480d3f684d06d763bb8f9227f8cb56d
+  metadata.gz: 36dfcca56fbad7ca9bb0d860b2d192d1ac6fd78b49e82e3056e271de47e52103
+  data.tar.gz: b9919fc691756b718216656cd8bf58e6a8a4b2c02f27946ba828caa854233161
 SHA512:
-  metadata.gz: 27892458d50ffcb846561766d75085e74fffc0a02f243a7a9bb32acfa34d9ec5b11cb11cbd1b2a613069ee858bdddaf4629e3d1813a64972c41df7b61adc9932
-  data.tar.gz: eea45fb7c54a365022d24ed4b370eb778336f8ec1564c61b13785f016fba2e67ae1f5a76448927e4f0f221d865ec1e97b15c90bbd589b9bc0aa8492eb007a97c
+  metadata.gz: fbf1cf11a8b1decc8a12c5af113a75fc5ad17b9c8fd2b2190e4252f160bcdc6dc0790ed178b4b6d5230ba18730aef279c1e7e22239feb183c090f71b48b11287
+  data.tar.gz: ce40b3239c679243468cfcd93e45ae1d8b825a123bda0dcc5989a2ec3693fc286971f02feabbaf42cfe3ae1058d00caf4182686e02b9a71bfcb650df2e8fc1af

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+spec/dummy/log
+spec/dummy/db/**.sqlite3

data/.rspec

@@ -0,0 +1 @@
+--format d

data/.rubocop.yml

@@ -0,0 +1,67 @@
+Documentation:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be an Integer or
+  # a Float.
+  Max: 15
+
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Max: 25
+  Exclude:
+    - config/**/*
+    - spec/**/*
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 24
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 200
+
+Metrics/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  Exclude:
+    - spec/dummy/db/schema.rb
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+before_install:
+  - gem install bundler -v "~> 1.17"
+
+rvm:
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+  - 2.5.0
+  - ruby-head
+
+sudo: false
+
+script:
+  - bundle exec rake code_analysis
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+Contributor Covenant Code of Conduct
+
+Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+
+Examples of unacceptable behavior by participants include:
+
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or electronic
+address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+
+Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ricardo@rootstrap.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project’s leadership.
+
+Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+## Contributing ##
+
+You can contribute to this repo if you have an issue, found a bug or think there's some functionality required that would add value to the gem. To do so, please check if there's not already an [issue](https://github.com/rootstrap/active-storage-base64/issues) for that, if you find there's not, create a new one with as much detail as possible.
+
+If you want to contribute with code as well, please follow the next steps:
+
+1. Read, understand and agree to our [code of conduct](https://github.com/rootstrap/active-storage-base64/blob/master/CODE_OF_CONDUCT.md)
+2. [Fork the repo](https://help.github.com/articles/about-forks/)
+3. Clone the project into your machine:
+`$ git clone git@github.com:[YOUR GITHUB USERNAME]/active-storage-base64.git`
+4. Access the repo:
+`$ cd active-storage-base64`
+5. Create your feature/bugfix branch:
+`$ git checkout -b your_new_feature`
+or
+`$ git checkout -b fix/your_fix` in case of a bug fix
+(if your PR is to address an existing issue, it would be good to name the branch after the issue, for example: if you are trying to solve issue 182, then a good idea for the branch name would be `182_your_new_feature`)
+6. Write tests for your changes (feature/bug)
+7. Code your (feature/bugfix)
+8. Run the code analysis tool by doing:
+`$ rake code_analysis`
+9. Run the tests:
+`$ bundle exec rspec`
+All tests must pass. If all tests (both code analysis and rspec) do pass, then you are ready to go to the next step:
+10. Commit your changes:
+`$ git commit -m 'Your feature or bugfix title'`
+11. Push to the branch `$ git push origin your_new_feature`
+12. Create a new [pull request](https://help.github.com/articles/creating-a-pull-request/)
+
+Some helpful guides that will help you know how we work:
+1. [Code review](https://github.com/rootstrap/tech-guides/tree/master/code-review)
+2. [GIT workflow](https://github.com/rootstrap/tech-guides/tree/master/git)
+3. [Ruby style guide](https://github.com/rootstrap/tech-guides/tree/master/ruby)
+4. [Rails style guide](https://github.com/rootstrap/tech-guides/blob/master/ruby/rails.md)
+5. [RSpec style guide](https://github.com/rootstrap/tech-guides/blob/master/ruby/rspec/README.md)
+
+For more information or guides like the ones mentioned above, please check our [tech guides](https://github.com/rootstrap/tech-guides). Keep in mind that the more you know about these guides, the easier it will be for your code to get approved and merged.
+
+Note: We work with one commit per pull request, so if you make your commit and realize you were missing something or want to add something more to it, don't create a new commit with the changes, but use `$ git commit --amend` instead. This same principle also applies for when changes are requested on an open pull request.
+
+
+Thank you very much for your time and for considering helping in this project.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rootstrap
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+[![Build Status](https://travis-ci.org/rootstrap/active-storage-base64.svg?branch=master)](https://travis-ci.org/rootstrap/active-storage-base64)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0da0a0901cedd72aeb10/maintainability)](https://codeclimate.com/github/rootstrap/active-storage-base64/maintainability)
+
+# ActiveStorageBase64
+
+Gem used to add support for base64 images for Rails's ActiveStorage.
+
+## Getting Started
+
+In order to get the gem working on your project you just need to add the gem to your project like this:
+```ruby
+gem 'active-storage-base64'
+```
+
+### Prerequisites
+
+The only two prerequisites for using this gem are having Rails version 5.2.0 or higher installed on your project and having ActiveStorage setup properly (for more information on how to do this, check this [Active Storage Overview](https://edgeguides.rubyonrails.org/active_storage_overview.html))
+
+```ruby
+gem 'rails', '5.2.0'
+```
+
+### Installing
+
+In order to use the gem's functionality, you'll need to include the module into your ActiveRecord inheriting class.
+For example:
+```ruby
+class User < ActiveRecord::Base
+  include ActiveStorageSupport::SupportForBase64
+end
+```
+
+Note:
+We highly recomment using an alternative class that inherits from ActiveRecord and includes the module so instead of including the module for each of your classes, you make them inherit from this new class, check below:
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  include ActiveStorageSupport::SupportForBase64
+end
+
+class User < ApplicationRecord
+  has_one_base64_attached :avatar
+end
+```
+
+After you have the module included in your class you'll be able to use the following two helper methods for working with base64 files:
+When you need a single image attached:
+```ruby
+has_one_base64_attached
+```
+and when you need multiple files attached:
+```ruby
+has_many_base64_attached
+```
+These helpers will work just like the `has_one_attached` and `has_many_attached` helper methods from ActiveStorage.
+
+A working example for this, assuming we have a model `User` with only an `avatar` attached would be:
+```ruby
+class User < ActiveRecord::Base
+  include ActiveStorageSupport::SupportForBase64
+
+  has_one_base64_attached :avatar
+end
+```
+
+on your controller you could do something like this:
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.create(user_params)
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:avatar[data:], :username, :email)
+  end
+end
+```
+
+Or you could also do:
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.create(user_params)
+    user.avatar.attach(params[:avatar])
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:username, :email)
+  end
+end
+```
+
+Here's another option to achieve the same:
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.create(user_params)
+    user.avatar = params[:avatar]
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:username, :email)
+  end
+end
+```
+
+## Specifying a filename or content_type
+
+If you are willing to add a specific filename to your attachment, or send in a specific content_type for your file, you can use `data:` to attach the base64 data and specify your `filename:`, `content_type:` and/or `identify:` hash keys.
+Check the following example:
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.create(user_params)
+    user.avatar.attach(data: params[:avatar], filename: 'your_filename', content_type: 'content/type', identify: 'false')
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:username, :email)
+  end
+end
+```
+Or, in case you want to have the avatar attached as soon as the user is created you can do:
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.create(user_params)
+  end
+
+  private
+
+  def user_params
+    params.require(:user).permit(:username, :email, avatar:[:data,
+                                                            :filename,
+                                                            :content_type,
+                                                            :identify])
+  end
+end
+```
+
+For more information on how to work with ActiveStorage, please check the [Active Storage Overview](https://edgeguides.rubyonrails.org/active_storage_overview.html) mentioned above, all points in there apply to this gem as well.
+
+## Contributing
+
+Please read our [CONTRIBUTING](https://github.com/rootstrap/active-storage-base64/blob/master/CONTRIBUTING.md) and our [CODE_OF_CONDUCT](https://github.com/rootstrap/active-storage-base64/blob/master/CODE_OF_CONDUCT.md) files for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Author
+
+*Ricardo Cortio*
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/rootstrap/active-storage-base64/blob/master/LICENSE.txt) file for details
+
+## Acknowledgments
+
+Special thanks to the people who helped with guidance and ensuring code quality in this project:
+*Santiago Bartesaghi, Santiago Vidal and Matias Mansilla.*

data/Rakefile

@@ -0,0 +1,4 @@
+task :code_analysis do
+  sh 'bundle exec rubocop lib spec'
+  sh 'bundle exec reek lib'
+end

data/active_storage_base64.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = 'active_storage_base64'
+  s.version = '0.1.1'
+  s.summary = 'Base64 support for ActiveStorage'
+  s.description = s.summary
+
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.require_paths = ['lib']
+  s.authors = ['Ricardo Cortio']
+  s.license = 'MIT'
+  s.homepage = 'https://github.com/rootstrap/active-storage-base64'
+  s.email = 'ricardo@rootstrap.com'
+
+  s.required_ruby_version = ">= 2.2.2"
+
+  # Dependencies
+  s.add_dependency 'rails', '~> 5.2.0', '<= 5.2.2'
+
+  # Development dependencies
+  s.add_development_dependency 'rubocop', '~> 0.56.0'
+  s.add_development_dependency 'reek', '~> 4.8.1'
+  s.add_development_dependency 'rspec-rails', '~> 3.8.0'
+  s.add_development_dependency 'sqlite3', '1.3.13'
+  s.add_development_dependency 'pry-rails', '~> 0.3.6'
+end

data/config.reek

@@ -0,0 +1,83 @@
+Attribute:
+  enabled: false
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: false
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+InstanceVariableAssumption:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 4
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 3
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 2
+  ignore_iterators: []
+NilCheck:
+  enabled: false
+  exclude: []
+PrimaDonnaMethod:
+  enabled: false
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 3
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 25
+TooManyStatements:
+  enabled: true
+  exclude: []
+  max_statements: 12
+UncommunicativeMethodName:
+  enabled: false
+UncommunicativeModuleName:
+  enabled: false
+UncommunicativeParameterName:
+  enabled: false
+UncommunicativeVariableName:
+  enabled: false
+UnusedParameters:
+  enabled: true
+  exclude: []
+UnusedPrivateMethod:
+  enabled: false
+UtilityFunction:
+  enabled: false

data/gemfiles/RailsHeadGemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem "rails", github: "rails/rails", branch: "master", require: false
+
+group :test do
+  gem 'rubocop', '~> 0.56.0'
+  gem 'reek', '~> 4.8.1'
+  gem 'rspec-rails', '~> 3.8.0'
+  gem 'sqlite3', '1.3.13'
+  gem 'pry-rails', '~> 0.3.6'
+end

data/lib/active_storage_support/base64_attach.rb

@@ -0,0 +1,20 @@
+# Helper method to decode a base64 file and create a StringIO file
+module ActiveStorageSupport
+  module Base64Attach
+    module_function
+
+    def attachment_from_data(attachment)
+      if attachment.is_a?(Hash)
+        base64_data = attachment.delete(:data)
+        if base64_data.try(:is_a?, String) && base64_data =~ /^data:(.*?);(.*?),(.*)$/
+
+          attachment[:io] = StringIO.new(Base64.decode64(Regexp.last_match(3)))
+          attachment[:content_type] = Regexp.last_match(1) unless attachment[:content_type]
+          attachment[:filename] = Time.current.to_i.to_s unless attachment[:filename]
+        end
+      end
+
+      attachment
+    end
+  end
+end

data/lib/active_storage_support/base64_many.rb

@@ -0,0 +1,13 @@
+module ActiveStorageSupport
+  class Base64Many < ActiveStorage::Attached::Many
+    def attach(*attachables)
+      super base64_attachments(attachables)
+    end
+
+    def base64_attachments(attachments)
+      attachments.flatten.map do |attachment|
+        ActiveStorageSupport::Base64Attach.attachment_from_data(attachment)
+      end
+    end
+  end
+end

data/lib/active_storage_support/base64_one.rb

@@ -0,0 +1,8 @@
+module ActiveStorageSupport
+  class Base64One < ActiveStorage::Attached::One
+    def attach(attachable)
+      attachment = ActiveStorageSupport::Base64Attach.attachment_from_data(attachable)
+      super attachment
+    end
+  end
+end

data/lib/active_storage_support/support_for_base64.rb

@@ -0,0 +1,39 @@
+require 'active_support/concern'
+require 'active_storage/attached'
+
+module ActiveStorageSupport
+  module SupportForBase64
+    extend ActiveSupport::Concern
+    class_methods do
+      def has_one_base64_attached(name, dependent: :purge_later)
+        has_one_attached name, dependent: dependent
+
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{name}
+            @active_storage_attached_#{name} ||=
+              ActiveStorageSupport::Base64One.new("#{name}", self, dependent: #{dependent == :purge_later ? ':purge_later' : 'false'})
+          end
+
+          def #{name}=(data)
+            #{name}.attach(data)
+          end
+        CODE
+      end
+
+      def has_many_base64_attached(name, dependent: :purge_later)
+        has_many_attached name, dependent: dependent
+
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{name}
+            @active_storage_attached_#{name} ||=
+              ActiveStorageSupport::Base64Many.new("#{name}", self, dependent: #{dependent == :purge_later ? ':purge_later' : 'false'})
+          end
+
+          def #{name}=(attachables)
+            #{name}.attach(attachables)
+          end
+        CODE
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_storage_base64
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Nicolas Fabre, Ricardo Cortio
+- Ricardo Cortio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,14 +100,31 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.6
-description: 
-email: 
+description: Base64 support for ActiveStorage
+email: ricardo@rootstrap.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_storage_base64.gemspec
+- config.reek
+- gemfiles/RailsHeadGemfile
 - lib/active_storage_base64.rb
-homepage: 
+- lib/active_storage_support/base64_attach.rb
+- lib/active_storage_support/base64_many.rb
+- lib/active_storage_support/base64_one.rb
+- lib/active_storage_support/support_for_base64.rb
+homepage: https://github.com/rootstrap/active-storage-base64
 licenses:
 - MIT
 metadata: {}
@@ -130,5 +147,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: base64 support for ActiveStorage
+summary: Base64 support for ActiveStorage
 test_files: []