array_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91fd7dec868fb4904344f29ad018a588a8ddaf6b
+  data.tar.gz: 0a65945fe5b81e4d097b6cf471d7d44690109b76
+SHA512:
+  metadata.gz: 2dcd05f05d9ac46b9bf61f82fdb7d7a30c9c0ad4db7f67eb97b35ed9ae00082bed48fe84562b87fbad0e7739d764d60dc6b311c4a607f3a2acf37bc68da372e1
+  data.tar.gz: 976908da05a51b7cc8dd18e614f3094128bbbbd6dc3a74a768444afc667a76728552af30f23f2334503cef0dec643b065d7d90e217019f633ce39b8f192d1fdc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 GoGrow
+
+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,78 @@
+# ArrayAttributes
+
+A Rails plugin to encapsulate common array attributes methods.
+
+This gem can be used to avoid repeating the same methods in models when working with arrays.
+
+## Support
+
+**This branch targets Ruby 2.4+ only**
+
+
+## Usage
+
+#### Install gem:
+
+Add this line to your Gemfile:
+```ruby
+gem 'array_attributes'
+```
+
+then run:
+```shell
+bundle install
+```
+
+#### Enable ArrayAttributes
+
+```ruby
+class Book < ActiveRecord::Base
+  string_array_attributes [:authors, :countries]
+end
+```
+
+It assumes you are passing string attributes.
+
+It also supports the following options:
+
+  * `:reject_blank`: whether the attribute should skip blank values
+  * `:reject_if`: condition to reject values
+
+```ruby
+class Device < ActiveRecord::Base
+  string_array_attributes [:ips], reject_blank: true, reject_if: ->(value) { value == '127.0.0.1' }
+end
+```
+
+### attribute_raw
+
+You can invoke `attribute_raw` to get the array values joined by commas.
+
+```ruby
+book = Book.create(authors: ['John Doe', 'Jane Doe'])
+book.authors_raw #=> "John Doe, Jane Doe"
+```
+
+### attribute_raw=
+
+You can invoke `attribute_raw=` to set the array value by entering the values split by commas.
+
+```ruby
+book = Book.new
+book.authors_raw="John Doe, Jane Doe"
+book.save!
+book.authors #=> ["John Doe", "Jane Doe"]
+```
+
+### compact_attribute
+
+You can invoke `compact_attribute` to remove blank items from the array attribute.
+
+```ruby
+book = Book.new(authors: ['John Doe', 'Jane Doe', ''])
+book.compact_authors
+book.save!
+book.authors #=> ["John Doe", "Jane Doe"]
+```
+
+See `LICENSE`.

data/lib/array_attributes/concerns/string_attributes.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ArrayAttributes
+  module Concerns
+    module StringAttributes
+      def string_array_attributes(attrs, opts)
+        attrs.each do |attribute|
+          get_raw_value(attribute)
+          assign_raw_value(attribute, opts)
+        end
+      end
+
+      private
+
+      def get_raw_value(attribute)
+        define_method :"#{attribute}_raw" do
+          send(attribute)&.join(', ')
+        end
+      end
+
+      def assign_raw_value(attribute, opts)
+        define_method :"#{attribute}_raw=" do |values|
+          return unless values.present?
+
+          new_values = values.split(',').map(&:strip)
+
+          new_values.reject!(&:blank?) if opts[:reject_blank] == true
+
+          reject_if = opts[:reject_if]
+          new_values.reject! { |v| reject_if.call(v) } if reject_if.is_a?(Proc)
+
+          assign_attributes("#{attribute}": new_values)
+        end
+      end
+    end
+  end
+end

data/lib/array_attributes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ArrayAttributes
+  VERSION = '0.0.1'
+end

data/lib/array_attributes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'array_attributes/version'
+require 'array_attributes/concerns/string_attributes'
+
+module ArrayAttributes
+  include ArrayAttributes::Concerns::StringAttributes
+end
+
+ActiveRecord::Base.extend ArrayAttributes

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: array_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- GoGrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ArrayAttributes - Rails Concern to encapsulate common array attributes
+  methods
+email: hello@gogrow.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/array_attributes.rb
+- lib/array_attributes/concerns/string_attributes.rb
+- lib/array_attributes/version.rb
+homepage: https://github.com/gogrow-dev/array_attributes
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: ArrayAttributes - Rails Concern to encapsulate common array attributes methods
+test_files: []