activerecord-pg_array 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 172e09d68f70267cfa5a3006fed692028654160e
+  data.tar.gz: acc747b399b0329544ca3aa5528fa925ce05709c
+SHA512:
+  metadata.gz: 259b080e1115a99c55869a1426b425b1c860817255a4fd075f82812731e3d4064880d2a8a6b3ecab38f3fbadacb4b7d716b393896ef55c3f87dd4d7f33081180
+  data.tar.gz: 53051ee448a0aa5c0b288825391390eea2fb359d5d40c95051de82bf24db51abbf58ce6138fe7a89c33177a8032f7e09902dccb0383a8e5e7eeb89b2c0c5dca6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-pg_array.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sean McCleary
+
+MIT License
+
+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,57 @@
+# Activerecord::PgArray
+
+This gem defines methods in your models for ActiveRecord attributes that use Postgres's arrays.
+
+I wrote this gem because I realized that working with Postgresql arrays was not as straight-forward as I had hoped.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-pg_array'
+
+## Usage
+
+Then in your classes that inherit from ActiveRecord `include ActiveRecord::PGArray`
+
+### Example:
+
+Given the following migration:
+
+    class CreateMyModel < ActiveRecord::Migration
+      def change
+        create_table :my_models do |t|
+          t.string :name
+          t.integer :friend_ids, array: true, default: []
+        end
+    
+        add_index :my_models, :friend_ids, using: 'gin'
+      end
+    end
+
+And class:
+
+    class MyClass < ActiveRecord::Base
+      include ActiveRecord::PGArray
+    end
+
+The following methods are automatically defined for "friend_ids":
+
+* add_friend(object)
+* add_friend!(object)
+* add_friends(objects)
+* remove_friend(object)
+* remove_friend!(object)
+
+## Roadmap
+
+* 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.
+* Atomic operations
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-pg_array.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/pg_array/version'
+require 'activerecord/pg_array'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-pg_array"
+  spec.version       = Activerecord::PgArray::VERSION
+  spec.authors       = ["Sean McCleary"]
+  spec.email         = ["seanmcc@gmail.com"]
+  spec.description   = %q{A ruby gem that makes working with Postgres arrays in ActiveRecord easier}
+  spec.summary       = %q{This gem defines methods in your models for ActiveRecord attributes that use Postgres's arrays}
+  spec.homepage      = "https://github.com/mrinterweb/activerecord-pg_array"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/activerecord/pg_array/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module PgArray
+    VERSION = "0.0.1"
+  end
+end

data/lib/activerecord/pg_array.rb

@@ -0,0 +1,67 @@
+require "activerecord/pg_array/version"
+
+module ActiveRecord
+  module PGArray
+
+    def self.included(base)
+      base.class_eval do
+        self.column_types.to_a.select { |c| c[1].instance_variable_get('@array') }.map(&:first).each do |array_column_name|
+          ids_regex = /_ids$/
+          friendly_attr = array_column_name.sub(ids_regex,'')
+          segs = friendly_attr.split('_')
+          segs[-1] = segs[-1].singularize
+          friendly_attr_singular = segs.join('_')
+          segs[-1] = segs[-1].pluralize
+          friendly_attr_plural = segs.join('_')
+
+          obj_convert = ->(obj) do
+            if array_column_name =~ ids_regex && obj.kind_of?(ActiveRecord::Base)
+              obj = obj.id
+            end
+            obj
+          end
+          atr = ->(slf) do
+            slf.send array_column_name.to_sym
+          end
+          atr_will_change = ->(slf) do
+            slf.send(:"#{array_column_name}_will_change!")
+          end
+
+          define_method :"add_#{friendly_attr_singular}" do |obj|
+            obj = obj_convert[obj]
+            unless atr[self].include?(obj)
+              atr[self].push(obj)
+              atr_will_change[self]
+            end
+          end
+
+          define_method :"add_#{friendly_attr_singular}!" do |obj|
+            self.send :"add_#{friendly_attr_singular}", obj
+            self.save!
+          end
+
+          define_method :"add_#{friendly_attr_plural}" do |objs|
+            objs.each do |obj|
+              self.send :"add_#{friendly_attr_singular}", obj
+            end
+          end
+
+          define_method :"remove_#{friendly_attr_singular}" do |obj|
+            obj = obj_convert.call(obj)
+            if atr[self].include?(obj)
+              atr[self].remove(obj)
+              atr_will_change[self]
+            end
+          end
+
+          define_method :"remove_#{friendly_attr_singular}!" do |obj|
+            self.send :"remove_#{friendly_attr_singular}", obj
+            self.save!
+          end
+
+        end
+      end # base.class_eval
+    end # self.include
+
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pg_array
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean McCleary
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A ruby gem that makes working with Postgres arrays in ActiveRecord easier
+email:
+- seanmcc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-pg_array.gemspec
+- lib/activerecord/pg_array.rb
+- lib/activerecord/pg_array/version.rb
+homepage: https://github.com/mrinterweb/activerecord-pg_array
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This gem defines methods in your models for ActiveRecord attributes that
+  use Postgres's arrays
+test_files: []
+has_rdoc: