array_attribute_handler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4732afc1a3741de5ad8e4e286e74e835494f94603e2f6f229b9c53aa478f19ad
+  data.tar.gz: 5f40aae3a4a68044eeea99282de2daf3666876e45f6bf15c00da02958c6a2e8d
+SHA512:
+  metadata.gz: 220955b2f49d88ce5e518fcb52465ed883f826eacc4543dd3c65685c2112a627485aa53ed178eb4ba12e07136e8bfdd690d702512b67391705f01121dd30308a
+  data.tar.gz: 2d1abe5e5b6e1af3275e0e7bb206503532b89f2ca6dfbfb240c5b33a20ed0c4ff6555c0ac91df473a9ce8b988186a3841d3eec9b067612373938ef55a6e0f876

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in array_attribute_handler.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    array_attribute_handler (1.0.0)
+      activerecord (>= 6.0, < 7)
+      activesupport (>= 6.0, < 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.7.4)
+      activesupport (= 6.1.7.4)
+    activerecord (6.1.7.4)
+      activemodel (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+    activesupport (6.1.7.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    base64 (0.1.1)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.19.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.6.3-arm64-darwin)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.11)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  array_attribute_handler!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  sqlite3
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jono Feist
+
+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,59 @@
+# ArrayAttributeHandler
+
+ArrayAttributeHandler is a simple Ruby gem designed to facilitate the management of array attributes in Rails-based applications.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add array_attribute_handler
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install array_attribute_handler
+```
+
+For those wanting the cutting-edge version or for specific branches, you can specify the GitHub repo in your Gemfile:
+
+```bash
+gem 'array_attribute_handler', git: 'https://github.com/defaye/array_attribute_handler_gem.git'
+```
+
+## Usage
+
+Detailed instructions on how to use the gem will be provided soon. For now, refer to the documentation and examples within the code.
+
+## Development
+
+Interested in contributing or diving deep into the code? Here's how you can get started:
+
+1. Clone the repository.
+1. Execute `bin/setup` to set up the development environment.
+1. Use `rake spec` to run the test suite and ensure everything works as expected.
+1. `bin/console` provides an interactive console for experimentation.
+
+To install the development version of the gem on your local machine:
+
+```bash
+bundle exec rake install
+```
+
+When it's time to cut a new release:
+
+1. Update the version number in version.rb.
+1. Use bundle exec rake release to handle the rest. This will tag the version, push changes and tags to the repository, and release the gem version on RubyGems.org.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/defaye/array_attribute_handler_gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/array_attribute_handler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ArrayAttributeHandler
+  VERSION = "1.0.0"
+end

data/lib/array_attribute_handler.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "array_attribute_handler/version"
+require "active_support/concern"
+
+module ArrayAttributeHandler
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Public: Handle array attributes.
+    #
+    # attribute_name - The name of the attribute to handle.
+    # options - The options hash.
+    #           :separator - The separator to use when parsing the attribute.
+    #                        Defaults to "\n".
+    #           :spaced_join - Whether to join the parsed values with a space.
+    #                          Defaults to false.
+    def handle_array_attribute(attribute_name, options = {})
+      separator = options.fetch(:separator, "\n")
+      combinator = separator + (options.fetch(:spaced_join, false) ? " " : "")
+
+      # Public: Setter for the attribute.
+      define_method("#{attribute_name}=") do |value|
+        super(parse_values(value, separator))
+      end
+
+      # Public: Getter for the text representation of the attribute.
+      define_method("#{attribute_name}_text") do
+        send(attribute_name).join(combinator)
+      end
+
+      # Public: Setter for the text representation of the attribute.
+      define_method("#{attribute_name}_text=") do |value|
+        send("#{attribute_name}=", parse_values(value, separator))
+      end
+    end
+  end
+
+  private
+
+  # Internal: Parse the given value into an array of strings.
+  #
+  # value - The value to parse.
+  # separator - The separator to use when parsing the value.
+  #
+  # Returns an array of strings.
+  def parse_values(value, separator)
+    array = value.is_a?(String) ? value.split(separator) : value.to_a
+    # Remove any empty strings from the array.
+    array.map { |v| v.strip.presence }.compact
+  end
+end

data/serializers/json_array_serializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "json"
+
+# Is only used for testing purposes
+class JsonArraySerializer
+  def self.dump(array)
+    array.to_json
+  end
+
+  def self.load(json_string)
+    json_string ? JSON.parse(json_string) : []
+  end
+end

data/sig/array_attribute_handler.rbs

@@ -0,0 +1,4 @@
+module ArrayAttributeHandler
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: array_attribute_handler
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jono Feist
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: The `handle_array_attribute` concern provides a flexible way to treat
+  string attributes in a Rails model as arrays. This includes parsing strings based
+  on configurable separators, optional spaces between elements, and optional maximum
+  length validation for each element.
+email:
+- j78258334@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/array_attribute_handler.rb
+- lib/array_attribute_handler/version.rb
+- serializers/json_array_serializer.rb
+- sig/array_attribute_handler.rbs
+homepage: https://github.com/defaye/array_attribute_handler_gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/defaye/array_attribute_handler_gem
+  source_code_uri: https://github.com/defaye/array_attribute_handler_gem
+  changelog_uri: https://github.com/defaye/array_attribute_handler_gem/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby on Rails concern to handle string attributes as arrays with various
+  options.
+test_files: []