activerecord-pg_array 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +57 -0
- data/Rakefile +1 -0
- data/activerecord-pg_array.gemspec +25 -0
- data/lib/activerecord/pg_array/version.rb +5 -0
- data/lib/activerecord/pg_array.rb +67 -0
- metadata +96 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 172e09d68f70267cfa5a3006fed692028654160e
|
4
|
+
data.tar.gz: acc747b399b0329544ca3aa5528fa925ce05709c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 259b080e1115a99c55869a1426b425b1c860817255a4fd075f82812731e3d4064880d2a8a6b3ecab38f3fbadacb4b7d716b393896ef55c3f87dd4d7f33081180
|
7
|
+
data.tar.gz: 53051ee448a0aa5c0b288825391390eea2fb359d5d40c95051de82bf24db51abbf58ce6138fe7a89c33177a8032f7e09902dccb0383a8e5e7eeb89b2c0c5dca6
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Sean McCleary
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
# Activerecord::PgArray
|
2
|
+
|
3
|
+
This gem defines methods in your models for ActiveRecord attributes that use Postgres's arrays.
|
4
|
+
|
5
|
+
I wrote this gem because I realized that working with Postgresql arrays was not as straight-forward as I had hoped.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'activerecord-pg_array'
|
12
|
+
|
13
|
+
## Usage
|
14
|
+
|
15
|
+
Then in your classes that inherit from ActiveRecord `include ActiveRecord::PGArray`
|
16
|
+
|
17
|
+
### Example:
|
18
|
+
|
19
|
+
Given the following migration:
|
20
|
+
|
21
|
+
class CreateMyModel < ActiveRecord::Migration
|
22
|
+
def change
|
23
|
+
create_table :my_models do |t|
|
24
|
+
t.string :name
|
25
|
+
t.integer :friend_ids, array: true, default: []
|
26
|
+
end
|
27
|
+
|
28
|
+
add_index :my_models, :friend_ids, using: 'gin'
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
And class:
|
33
|
+
|
34
|
+
class MyClass < ActiveRecord::Base
|
35
|
+
include ActiveRecord::PGArray
|
36
|
+
end
|
37
|
+
|
38
|
+
The following methods are automatically defined for "friend_ids":
|
39
|
+
|
40
|
+
* add_friend(object)
|
41
|
+
* add_friend!(object)
|
42
|
+
* add_friends(objects)
|
43
|
+
* remove_friend(object)
|
44
|
+
* remove_friend!(object)
|
45
|
+
|
46
|
+
## Roadmap
|
47
|
+
|
48
|
+
* TESTS! Yes I plan on writing tests for this. This gem was pulled out of a rails project and that is where my tests for this are right now. When I have an opportunity, I will add tests.
|
49
|
+
* Atomic operations
|
50
|
+
|
51
|
+
## Contributing
|
52
|
+
|
53
|
+
1. Fork it
|
54
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
55
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
56
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
57
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'activerecord/pg_array/version'
|
5
|
+
require 'activerecord/pg_array'
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = "activerecord-pg_array"
|
9
|
+
spec.version = Activerecord::PgArray::VERSION
|
10
|
+
spec.authors = ["Sean McCleary"]
|
11
|
+
spec.email = ["seanmcc@gmail.com"]
|
12
|
+
spec.description = %q{A ruby gem that makes working with Postgres arrays in ActiveRecord easier}
|
13
|
+
spec.summary = %q{This gem defines methods in your models for ActiveRecord attributes that use Postgres's arrays}
|
14
|
+
spec.homepage = "https://github.com/mrinterweb/activerecord-pg_array"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files`.split($/)
|
18
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
19
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_dependency 'activerecord'
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
24
|
+
spec.add_development_dependency "rake"
|
25
|
+
end
|
@@ -0,0 +1,67 @@
|
|
1
|
+
require "activerecord/pg_array/version"
|
2
|
+
|
3
|
+
module ActiveRecord
|
4
|
+
module PGArray
|
5
|
+
|
6
|
+
def self.included(base)
|
7
|
+
base.class_eval do
|
8
|
+
self.column_types.to_a.select { |c| c[1].instance_variable_get('@array') }.map(&:first).each do |array_column_name|
|
9
|
+
ids_regex = /_ids$/
|
10
|
+
friendly_attr = array_column_name.sub(ids_regex,'')
|
11
|
+
segs = friendly_attr.split('_')
|
12
|
+
segs[-1] = segs[-1].singularize
|
13
|
+
friendly_attr_singular = segs.join('_')
|
14
|
+
segs[-1] = segs[-1].pluralize
|
15
|
+
friendly_attr_plural = segs.join('_')
|
16
|
+
|
17
|
+
obj_convert = ->(obj) do
|
18
|
+
if array_column_name =~ ids_regex && obj.kind_of?(ActiveRecord::Base)
|
19
|
+
obj = obj.id
|
20
|
+
end
|
21
|
+
obj
|
22
|
+
end
|
23
|
+
atr = ->(slf) do
|
24
|
+
slf.send array_column_name.to_sym
|
25
|
+
end
|
26
|
+
atr_will_change = ->(slf) do
|
27
|
+
slf.send(:"#{array_column_name}_will_change!")
|
28
|
+
end
|
29
|
+
|
30
|
+
define_method :"add_#{friendly_attr_singular}" do |obj|
|
31
|
+
obj = obj_convert[obj]
|
32
|
+
unless atr[self].include?(obj)
|
33
|
+
atr[self].push(obj)
|
34
|
+
atr_will_change[self]
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
define_method :"add_#{friendly_attr_singular}!" do |obj|
|
39
|
+
self.send :"add_#{friendly_attr_singular}", obj
|
40
|
+
self.save!
|
41
|
+
end
|
42
|
+
|
43
|
+
define_method :"add_#{friendly_attr_plural}" do |objs|
|
44
|
+
objs.each do |obj|
|
45
|
+
self.send :"add_#{friendly_attr_singular}", obj
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
define_method :"remove_#{friendly_attr_singular}" do |obj|
|
50
|
+
obj = obj_convert.call(obj)
|
51
|
+
if atr[self].include?(obj)
|
52
|
+
atr[self].remove(obj)
|
53
|
+
atr_will_change[self]
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
define_method :"remove_#{friendly_attr_singular}!" do |obj|
|
58
|
+
self.send :"remove_#{friendly_attr_singular}", obj
|
59
|
+
self.save!
|
60
|
+
end
|
61
|
+
|
62
|
+
end
|
63
|
+
end # base.class_eval
|
64
|
+
end # self.include
|
65
|
+
|
66
|
+
end
|
67
|
+
end
|
metadata
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: activerecord-pg_array
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Sean McCleary
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-02-27 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activerecord
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.3'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.3'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: A ruby gem that makes working with Postgres arrays in ActiveRecord easier
|
56
|
+
email:
|
57
|
+
- seanmcc@gmail.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- Gemfile
|
64
|
+
- LICENSE.txt
|
65
|
+
- README.md
|
66
|
+
- Rakefile
|
67
|
+
- activerecord-pg_array.gemspec
|
68
|
+
- lib/activerecord/pg_array.rb
|
69
|
+
- lib/activerecord/pg_array/version.rb
|
70
|
+
homepage: https://github.com/mrinterweb/activerecord-pg_array
|
71
|
+
licenses:
|
72
|
+
- MIT
|
73
|
+
metadata: {}
|
74
|
+
post_install_message:
|
75
|
+
rdoc_options: []
|
76
|
+
require_paths:
|
77
|
+
- lib
|
78
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
84
|
+
requirements:
|
85
|
+
- - ">="
|
86
|
+
- !ruby/object:Gem::Version
|
87
|
+
version: '0'
|
88
|
+
requirements: []
|
89
|
+
rubyforge_project:
|
90
|
+
rubygems_version: 2.2.2
|
91
|
+
signing_key:
|
92
|
+
specification_version: 4
|
93
|
+
summary: This gem defines methods in your models for ActiveRecord attributes that
|
94
|
+
use Postgres's arrays
|
95
|
+
test_files: []
|
96
|
+
has_rdoc:
|