attr_array 1.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 462ed282fbdbb842057a6f474bcf396a48e9786f
+  data.tar.gz: 8004ca3ce52a3b345734a05dd05ab008210c4a4a
+SHA512:
+  metadata.gz: ea070b1c64a61317c9d302d0e36135e1c27160e269aff6df5187117dae87454fcfd328f8abb2124fab5bb36c911bba5b3cbd43e4837e25a9040e4e3a437f21e1
+  data.tar.gz: 44920a292d02a2b760e93b305a35fbf17f8b7a49c327ebc85f3b660edaaf865929255357b31c5285382539c69dc769c51e3d2fc1a1012680dc065512c7c411e5

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## Unreleased
+
+(nothing)
+
+## 1.0.0.0
+
+- Initial release.

data/README.md

@@ -0,0 +1,99 @@
+# AttrArray
+
+A high performance ActiveRecord concern for Rails using the PostgreSQL array type.
+
+## Installation
+
+To install add the line to your Gemfile:
+
+```ruby
+gem 'attr_array', git: 'https://github.com/brightcommerce/attr_array'
+```
+
+And `bundle install`.
+
+## Dependencies
+
+AttrArray is developed as a ActiveRecord model concern, therefore it is dependent upon ActiveSupport. It is also developed only for use with PostgreSQL. It may work with other databases, but I haven't tried them.
+
+## How To Use
+
+To add AttrArray to a model, include the concern:
+
+```ruby
+class Post < ActiveRecord::Base
+  include AttrArray
+
+  attr_array :tags
+end
+```
+
+To autoload AttrArray for all models, add the following to an initializer:
+
+```ruby
+require 'attr_array/active_record'
+```
+
+You then don't need to `include AttrArray` in any model.
+
+### Scopes
+
+```ruby
+with_any_#{tag_name}
+with_all_#{tag_name}
+without_any_#{tag_name}
+without_all_#{tag_name}
+```
+
+### Class methods
+
+```ruby
+all_#{tag_name}
+{tag_name}_cloud
+```
+
+### Setup
+
+Add the model attributes you want to use with AttrArray in your migration:
+
+```ruby
+class CreatePost < ActiveRecord::Migration[5.1]
+  def change
+    create_table :posts do |table|
+      table.column :tags, :string, array: true, default: [], index: {using: 'gin'}
+      table.column :authors, :string, array: true, default: [], index: {using: 'gin'}
+      table.timestamps
+    end
+  end
+end
+```
+
+You can nominate multiple attributes in the `attr_array` class method:
+
+```ruby
+class Post < ApplicationRecord
+  include AttrArray
+
+  attr_array :tags, :authors
+end
+```
+
+### Usage
+
+```ruby
+@post.tags = ["awesome", "slick"]
+@post.authors = ["Roald Dahl"]
+
+Post.with_any_authors("Roald Dahl")
+Post.without_any_tags("slick")
+```
+
+## Acknowledgements
+
+This gem is based on code from [pg_tags](https://github.com/yosriady/pg_tags). Modified to use ActiveSupport::Concern and doesn't automatically hook into ActiveRecord.
+
+This gem is maintained by [Jurgen Jocubeit](https://github.com/JurgenJocubeit).
+
+## Copyright
+
+Copyright 2017 Pocket Business Co. All rights reserved.

data/lib/attr_array.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+require 'attr_array/version'
+require 'attr_array/attr_array'

data/lib/attr_array/active_record.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.send :include, AttrArray

data/lib/attr_array/attr_array.rb

@@ -0,0 +1,47 @@
+require 'active_support/all'
+
+module AttrArray
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def attr_array(*array_types)
+      array_types = array_types.to_a.flatten.compact.map(&:to_sym)
+
+      class_eval do
+        class_attribute :array_types
+        self.array_types = array_types
+      end
+
+      array_types.each do |array_type|
+        scope :"with_any_#{array_type}", -> (array) {
+          where("#{array_type} && ARRAY[?]::varchar[]", array)
+        }
+        scope :"with_all_#{array_type}", -> (array) {
+          where("#{array_type} @> ARRAY[?]::varchar[]", array)
+        }
+        scope :"without_any_#{array_type}", -> (array) {
+          where.not("#{array_type} && ARRAY[?]::varchar[]", array)
+        }
+        scope :"without_all_#{array_type}", -> (array) {
+          where.not("#{array_type} @> ARRAY[?]::varchar[]", array)
+        }
+
+        self.class.class_eval do
+          define_method :"all_#{array_type}" do |options = {}, &block|
+            subquery_scope = unscoped.select("unnest(#{table_name}.#{array_type}) as array").uniq
+            subquery_scope = subquery_scope.instance_eval(&block) if block
+
+            from(subquery_scope).pluck('array')
+          end
+
+          define_method :"#{array_type}_cloud" do |options = {}, &block|
+            subquery_scope = unscoped.select("unnest(#{table_name}.#{array_type}) as array")
+            subquery_scope = subquery_scope.instance_eval(&block) if block
+
+            from(subquery_scope).group('array').order('array').pluck('array, count(*) as count')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/attr_array/version.rb

@@ -0,0 +1,16 @@
+module AttrArray
+  module Version
+    Major       = 1
+    Minor       = 0
+    Revision    = 0
+    Prerelease  = 0
+    Compact     = [Major, Minor, Revision, Prerelease].compact.join('.')
+    Summary     = "AttrArray v#{Compact}"
+    Description = "A high performance ActiveRecord concern for Rails using the PostgreSQL array type."
+    Author      = "Jurgen Jocubeit"
+    Email       = "support@brightcommerce.com"
+    Homepage    = "https://github.com/brightcommerce/attr_array"
+    Metadata    = {'copyright' => 'Copyright 2017 Pocket Business, Co. All Rights Reserved.'}
+    License     = "UNLICENSED"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: attr_array
+version: !ruby/object:Gem::Version
+  version: 1.0.0.0
+platform: ruby
+authors:
+- Jurgen Jocubeit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+description: A high performance ActiveRecord concern for Rails using the PostgreSQL
+  array type.
+email: support@brightcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/attr_array.rb
+- lib/attr_array/active_record.rb
+- lib/attr_array/attr_array.rb
+- lib/attr_array/version.rb
+homepage: https://github.com/brightcommerce/attr_array
+licenses:
+- UNLICENSED
+metadata:
+  copyright: Copyright 2017 Pocket Business, Co. All Rights Reserved.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: AttrArray v1.0.0.0
+test_files: []